summary refs log tree commit diff
path: root/manual/terminal.texi
diff options
context:
space:
mode:
authorRical Jasan <ricaljasan@pacific.net>2016-12-21 01:36:58 -0800
committerRical Jasan <ricaljasan@pacific.net>2016-12-21 01:36:58 -0800
commit2fe82ca6dc5a2d2ffc91b7df9d136de7bf10bd9a (patch)
tree9bc8f8d16e9de019dc03e46ab994f9f94005b5ca /manual/terminal.texi
parent41c67149b94676347b0068a902058f130e3e88e6 (diff)
downloadglibc-2fe82ca6dc5a2d2ffc91b7df9d136de7bf10bd9a.tar.gz
glibc-2fe82ca6dc5a2d2ffc91b7df9d136de7bf10bd9a.tar.xz
glibc-2fe82ca6dc5a2d2ffc91b7df9d136de7bf10bd9a.zip
manual: Convert @tables of variables to @vtables.
Texinfo @vindex commands add entries to the Variable and Constant
Macro Index.  Similarly, @items in @vtables are automatically indexed.
A number of @tables exist where all @items are @vindexed or all @items
are variables, but not indexed, suggesting an optimization by
converting such @tables to @vtables and dropping the @vindex.

Using a @vtable provides a context for processing @items whereby it
can be known the @items should have header and standards annotations.
This commit converts @tables of such @items to @vtables in order to
establish a framework for automated processing.

A pleasant consequence of these changes is that @items previously
lacking a @vindex are present in the Variable and Constant Macro Index
now.  @vindex entries previously detected by summary.awk will still be
detected as @items with appropriate annotations.

The @vtable of the NSS databases is converted to a @table because 1)
those @items are not variables (and will no longer appear in the
Variable and Constant Macro Index) and 2) they do not need header and
standards annotations, so the incorrect context is fixed.

	* manual/nss.texi: Change incorrect @vtable to @table.
	* manual/arith.texi: Convert @tables of variables to @vtables
	and remove unnecessary indexing.
	* manual/filesys.texi: Likewise.
	* manual/llio.texi: Likewise.
	* manual/memory.texi: Likewise.
	* manual/process.texi: Likewise.
	* manual/resource.texi: Likewise.
	* manual/search.texi: Likewise.
	* manual/signal.texi: Likewise.
	* manual/socket.texi: Likewise.
	* manual/stdio.texi: Likewise.
	* manual/sysinfo.texi: Likewise.
	* manual/syslog.texi: Likewise.
	* manual/terminal.texi: Likewise.
	* manual/time.texi: Likewise.
	* manual/users.texi: Likewise.
Diffstat (limited to 'manual/terminal.texi')
-rw-r--r--manual/terminal.texi23
1 files changed, 6 insertions, 17 deletions
diff --git a/manual/terminal.texi b/manual/terminal.texi
index 49f5097e7f..0c5fdd1a76 100644
--- a/manual/terminal.texi
+++ b/manual/terminal.texi
@@ -326,17 +326,15 @@ structure that @var{termios-p} points to.
 The @var{when} argument specifies how to deal with input and output
 already queued.  It can be one of the following values:
 
-@table @code
+@vtable @code
 @comment termios.h
 @comment POSIX.1
 @item TCSANOW
-@vindex TCSANOW
 Make the change immediately.
 
 @comment termios.h
 @comment POSIX.1
 @item TCSADRAIN
-@vindex TCSADRAIN
 Make the change after waiting until all queued output has been written.
 You should usually use this option when changing parameters that affect
 output.
@@ -344,13 +342,11 @@ output.
 @comment termios.h
 @comment POSIX.1
 @item TCSAFLUSH
-@vindex TCSAFLUSH
 This is like @code{TCSADRAIN}, but also discards any queued input.
 
 @comment termios.h
 @comment BSD
 @item TCSASOFT
-@vindex TCSASOFT
 This is a flag bit that you can add to any of the above alternatives.
 Its meaning is to inhibit alteration of the state of the terminal
 hardware.  It is a BSD extension; it is only supported on BSD systems
@@ -359,7 +355,7 @@ and @gnuhurdsystems{}.
 Using @code{TCSASOFT} is exactly the same as setting the @code{CIGNORE}
 bit in the @code{c_cflag} member of the structure @var{termios-p} points
 to.  @xref{Control Modes}, for a description of @code{CIGNORE}.
-@end table
+@end vtable
 
 If this function is called from a background process on its controlling
 terminal, normally all processes in the process group are sent a
@@ -1846,22 +1842,19 @@ argument specifies which queue(s) to clear, and can be one of the
 following values:
 
 @c Extra blank lines here make it look better.
-@table @code
-@vindex TCIFLUSH
+@vtable @code
 @item TCIFLUSH
 
 Clear any input data received, but not yet read.
 
-@vindex TCOFLUSH
 @item TCOFLUSH
 
 Clear any output data written, but not yet transmitted.
 
-@vindex TCIOFLUSH
 @item TCIOFLUSH
 
 Clear both queued input and output.
-@end table
+@end vtable
 
 The return value is normally zero.  In the event of an error, a value
 of @math{-1} is returned.  The following @code{errno} error conditions
@@ -1901,23 +1894,19 @@ XON/XOFF flow control on the terminal file specified by @var{filedes}.
 The @var{action} argument specifies what operation to perform, and can
 be one of the following values:
 
-@table @code
-@vindex TCOOFF
+@vtable @code
 @item TCOOFF
 Suspend transmission of output.
 
-@vindex TCOON
 @item TCOON
 Restart transmission of output.
 
-@vindex TCIOFF
 @item TCIOFF
 Transmit a STOP character.
 
-@vindex TCION
 @item TCION
 Transmit a START character.
-@end table
+@end vtable
 
 For more information about the STOP and START characters, see @ref{Special
 Characters}.