From d1daf8e1ddcff2e5ab88fba1dc9c540538095b5b Mon Sep 17 00:00:00 2001 From: Sami Kerola Date: Sun, 18 Sep 2011 11:49:08 +0200 Subject: [PATCH] docs: align col.1 with howto-man-page.txt Signed-off-by: Sami Kerola --- text-utils/col.1 | 180 +++++++++++++++++++++++++---------------------- 1 file changed, 97 insertions(+), 83 deletions(-) diff --git a/text-utils/col.1 b/text-utils/col.1 index bbec8feeee..9efc72f53b 100644 --- a/text-utils/col.1 +++ b/text-utils/col.1 @@ -34,114 +34,128 @@ .\" .\" @(#)col.1 6.8 (Berkeley) 6/17/91 .\" -.Dd May 2011 " " -.Dt COL(1) "" "User Commands" -.Os util-linux -.Sh NAME -.Nm col -.Nd filter reverse line feeds from input -.Sh SYNOPSIS -.Nm col -.Op Fl bfphx -.Op Fl l Ar num -.Sh DESCRIPTION -.Nm -filters out reverse (and half-reverse) line feeds so the output is -in the correct order with only forward and half-forward line -feeds, and replaces white-space characters with tabs where possible. -This can be useful in processing the output of -.Xr nroff 1 +.TH COL "1" "September 2011" "util-linux" "User Commands" +.SH COL +col - filter reverse line feeds from input +.SH SYNOPSIS +.B col +[options] +.SH DESCRIPTION +.B col +filters out reverse (and half-reverse) line feeds so the output is in the +correct order with only forward and half-forward line feeds, and replaces +white-space characters with tabs where possible. This can be useful in +processing the output of +.BR nroff (1) and -.Xr tbl 1 . -.Pp -.Nm +.BR tbl (1). +.PP +.B col reads from standard input and writes to standard output. -.Pp -The options are as follows: -.Bl -tag -width "-lnum" -.It Fl b, Fl Fl no-backspaces -Do not output any backspaces, printing only the last character -written to each column position. -.It Fl f, Fl Fl fine -Forward half line feeds are permitted (``fine'' mode). -Normally characters printed on a half-line boundary are printed -on the following line. -.It Fl p, Fl Fl pass -Force unknown control sequences to be passed through unchanged. -Normally, -.Nm col +.SH OPTIONS +.TP +\fB\-b\fR, \fB\-\-no-backspaces\fR +Do not output any backspaces, printing only the last character written to +each column position. +.TP +\fB\-f\fR, \fB\-\-fine\fR +Forward half line feeds are permitted +.I fine +mode. Normally characters printed on a half-line boundary are printed on the +following line. +.TP +\fB\-p\fR, \fB\-\-pass\fR +Force unknown control sequences to be passed through unchanged. Normally, +.B col will filter out any control sequences from the input other than those recognized and interpreted by itself, which are listed below. -.It Fl h, Fl Fl tabs +.TP +\fB\-h\fR, \fB\-\-tabs\fR Output tabs instead of multiple spaces. -.It Fl x, Fl Fl spaces +.TP +\fB\-x\fR, \fB\-\-spaces\fR Output multiple spaces instead of tabs. .It Fl l, Fl Fl lines Ar num +.TP +\fB\-l\fR, \fB\-\-lines\fR \fInumber\fR Buffer at least -.Ar num -lines in memory. -By default, 128 lines are buffered. +.I number +lines in memory. By default, 128 lines are buffered. .It Fl V, Fl Fl version +.TP +\fB\-V\fR, \fB\-\-version\fR Output version information and exit. -.It Fl H, Fl Fl help +.TP +\fB\-H\fR, \fB\-\-help\fR Output help and exit. -.El -.Pp +.SH NOTES The control sequences for carriage motion that -.Nm col -understands and their decimal values are listed in the following -table: -.Pp -.Bl -tag -width "carriage return" -compact -.It ESC\-7 +.B col +understands and their decimal values are listed in the following table: +.PP +.RS +.PD 0 +.TP 18 +.B ESC\-7 reverse line feed (escape then 7) -.It ESC\-8 +.TP +.B ESC\-8 half reverse line feed (escape then 8) -.It ESC\-9 +.TP +.B ESC\-9 half forward line feed (escape then 9) -.It backspace +.TP +.B backspace moves back one column (8); ignored in the first column -.It carriage return -(13) -.It newline +.TP +.B newline forward line feed (10); also does carriage return -.It shift in +.TP +.B carriage return +(13) +.TP +.B shift in shift to normal character set (15) -.It shift out +.TP +.B shift out shift to alternate character set (14) -.It space +.TP +.B space moves forward one column (32) -.It tab +.TP +.B tab moves forward to next tab stop (9) -.It vertical tab +.TP +.B vertical tab reverse line feed (11) -.El -.Pp -All unrecognized control characters and escape sequences are -discarded. -.Pp -.Nm -keeps track of the character set as characters are read and makes -sure the character set is correct when they are output. -.Pp +.PD +.RE +.PP +All unrecognized control characters and escape sequences are discarded. +.PP +.B col +keeps track of the character set as characters are read and makes sure the +character set is correct when they are output. +.PP If the input attempts to back up to the last flushed line, -.Nm col +.B col will display a warning message. -.Sh SEE ALSO -.Xr expand 1 , -.Xr nroff 1 , -.Xr tbl 1 -.Sh STANDARDS +.SH SEE ALSO +.BR expand (1), +.BR nroff (1), +.BR tbl (1) +.SH STANDARDS The -.Nm col -utility conforms to the Single UNIX Specification, Version 2. The -.Fl l +.B col +utility conforms to the Single UNIX Specification, Version 2. The +.B \-l option is an extension to the standard. -.Sh HISTORY +.SH HISTORY A -.Nm col -command -appeared in Version 6 AT&T UNIX. -.Sh AVAILABILITY +.B col +command appeared in Version 6 AT&T UNIX. +.SH AVAILABILITY The col command is part of the util-linux package and is available from -ftp://ftp.kernel.org/pub/linux/utils/util-linux/. +.UR ftp://\:ftp.kernel.org\:/pub\:/linux\:/utils\:/util-linux/ +Linux Kernel Archive +.UE . -- 2.39.2