.de1 NOP
.  it 1 an-trap
.  if \\n[.$] \,\\$*\/
..
.ie t \
.ds B-Font [CB]
.ds I-Font [CI]
.ds R-Font [CR]
.el \
.ds B-Font B
.ds I-Font I
.ds R-Font R
.TH columns 1 "2018-01-06" "GNU AutoGen (1.2)" "User Commands"
.\"
.\" DO NOT EDIT THIS FILE (in-mem file)
.\"
.\" It has been AutoGen-ed
.\" From the definitions ./opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
\f\*[B-Font]columns\fP
\- Columnize Input Text
.SH SYNOPSIS
\f\*[B-Font]columns\fP
.\" Mixture of short (flag) options and long options
[\f\*[B-Font]\-flags\f[]]
[\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]]
[\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]]
.sp \n(Ppu
.ne 2

All arguments must be options.
.sp \n(Ppu
.ne 2

.SH "DESCRIPTION"
There is no description for this command.
.SH "OPTIONS"
.SS "Specify the output dimensions"
.TP
.NOP \f\*[B-Font]\-W\f[] \f\*[I-Font]num\f[], \f\*[B-Font]\-\-width\f[]=\f\*[I-Font]num\f[]
Maximum Line Width.
This option takes an integer number as its argument.
The value of
\f\*[I-Font]num\f[]
is constrained to being:
.in +4
.nf
.na
in the range  16 through 4095
.fi
.in -4
The default
\f\*[I-Font]num\f[]
for this option is:
.ti +4
 79
.sp
This option specifies the full width of the output line,
including any start-of-line indentation.  The output will fill
each line as completely as possible, unless the column width has
been explicitly specified.  If the maximum width is less than
the length of the widest input, you will get a single column
of output.
.TP
.NOP \f\*[B-Font]\-c\f[] \f\*[I-Font]count\f[], \f\*[B-Font]\-\-columns\f[]=\f\*[I-Font]count\f[]
Desired number of columns.
This option takes an integer number as its argument.
The value of
\f\*[I-Font]count\f[]
is constrained to being:
.in +4
.nf
.na
in the range  1 through 2048
.fi
.in -4
The default
\f\*[I-Font]count\f[]
for this option is:
.ti +4
 0
.sp
Use this option to specify exactly how many columns to produce.
If that many columns will not fit within \fBline_width\fP, then
the count will be reduced to the number that fit.
.TP
.NOP \f\*[B-Font]\-w\f[] \f\*[I-Font]num\f[], \f\*[B-Font]\-\-col\-width\f[]=\f\*[I-Font]num\f[]
Set width of each column.
This option takes an integer number as its argument.
The value of
\f\*[I-Font]num\f[]
is constrained to being:
.in +4
.nf
.na
in the range  1 through 2048
.fi
.in -4
The default
\f\*[I-Font]num\f[]
for this option is:
.ti +4
 0
.sp
Use this option to specify exactly how many characters are to be
allocated for each column.  If it is narrower than the widest entry,
it will be over-ridden with the required width.
.TP
.NOP \f\*[B-Font]\-\-tab\-width\f[]=\f\*[I-Font]num\f[]
tab width.
This option takes an integer number as its argument.
The default
\f\*[I-Font]num\f[]
for this option is:
.ti +4
 8
.sp
If an indentation string contains tabs, then this value is used to
compute the ending column of the prefix string.
.SS "Specify how to lay out the text"
.TP
.NOP \f\*[B-Font]\-\-spread\f[]=\f\*[I-Font]num\f[]
maximum spread added to column width.
This option takes an integer number as its argument.
The value of
\f\*[I-Font]num\f[]
is constrained to being:
.in +4
.nf
.na
in the range  1 through 1024
.fi
.in -4
The default
\f\*[I-Font]num\f[]
for this option is:
.ti +4
 0
.sp
Use this option to specify exactly how many characters may be
added to each column.  It allows you to prevent columns from
becoming too far apart.  Without this option, \fIcolumns\fP
will attempt to widen columns to fill the full width.
.TP
.NOP \f\*[B-Font]\-\-fill\f[]
Fill lines with input.
This option must not appear in combination with any of the following options:
spread, col_width, by_columns.
.sp
Instead of columnizing the input text, fill the output lines
with the input lines.  Blank lines on input will cause a
blank line in the output, unless the output is sorted.
With sorted output, blank lines are ignored.
.TP
.NOP \f\*[B-Font]\-I\f[] \f\*[I-Font]l\-pfx\f[], \f\*[B-Font]\-\-indent\f[]=\f\*[I-Font]l\-pfx\f[]
Line prefix or indentation.
.sp
If a number, then this many spaces will be inserted at the start of
every line.  Otherwise, it is a line prefix that will be inserted
at the start of every line.
.TP
.NOP \f\*[B-Font]\-\-first\-indent\f[]=\f\*[I-Font]l\-pfx\f[]
First line prefix.
This option must appear in combination with the following options:
indent.
.sp
If a number, then this many spaces will be inserted at the start of
the first line.  Otherwise, it is a line prefix that will be inserted
at the start of that line.  If its length exceeds "indent", then it
will be emitted on a line by itself, suffixed by any line separation
string.  For example:
.sp
.nf
    $ columns \--first='#define TABLE' \-c 2 \-I4 \--line=' \' <<_EOF_
    one
    two
    three
    four
    _EOF_
    #define TABLE \
        one   two \
        three four
.fi
.TP
.NOP \f\*[B-Font]\-f\f[] \f\*[I-Font]fmt\-str\f[], \f\*[B-Font]\-\-format\f[]=\f\*[I-Font]fmt\-str\f[]
Formatting string for each input.
.sp
If you need to reformat each input text, the argument to this
option is interpreted as an \fBsprintf(3)\fP format that is used
to produce each output entry.
.TP
.NOP \f\*[B-Font]\-S\f[] \f\*[I-Font]sep\-str\f[], \f\*[B-Font]\-\-separation\f[]=\f\*[I-Font]sep\-str\f[]
Separation string \- follows all but last.
.sp
Use this option if, for example, you wish a comma to appear after
each entry except the last.
.TP
.NOP \f\*[B-Font]\-\-line\-separation\f[]=\f\*[I-Font]sep\-str\f[]
string at end of all lines but last.
.sp
Use this option if, for example, you wish a backslash to appear at
the end of every line, except the last.
.TP
.NOP \f\*[B-Font]\-\-ending\f[]=\f\*[I-Font]end\-str\f[]
string at end of last line.
.sp
This option puts the specified string at the end of the output.
.SS "Specify the ordering of the entries"
.TP
.NOP \f\*[B-Font]\-\-by\-columns\f[]
Print entries in column order.
.sp
Normally, the entries are printed out in order by rows and then columns.
This option will cause the entries to be ordered within columns.
The final column, instead of the final row, may be shorter than the
others.
.TP
.NOP \f\*[B-Font]\-s\f[] \f\*[I-Font]key\-pat\f[], \f\*[B-Font]\-\-sort\f[] [\f\*[I-Font]key\-pat\f[]]
Sort input text.
.sp
Causes the input text to be sorted.  If an argument is supplied,
it is presumed to be a pattern and the sort is based upon the
matched text.  If the pattern starts with or consists of
an asterisk (\fB*\fP), then the sort is case insensitive.
.SS "Redirecting stdin to an alternate file"
.TP
.NOP \f\*[B-Font]\-i\f[] \f\*[I-Font]file\f[], \f\*[B-Font]\-\-input\f[]=\f\*[I-Font]file\f[]
Input file (if not stdin).
.sp
This program normally runs as a \fBfilter\fP, reading from standard
input, columnizing and writing to standard out.  This option redirects
input to a file.
.TP
.NOP \f\*[B-Font]\-\&?\f[], \f\*[B-Font]\-\-help\f[]
Display usage information and exit.
.TP
.NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more-help\f[]
Pass the extended usage information through a pager.
.TP
.NOP \f\*[B-Font]\->\f[] [\f\*[I-Font]cfgfile\f[]], \f\*[B-Font]\-\-save-opts\f[] [=\f\*[I-Font]cfgfile\f[]]
Save the option state to \fIcfgfile\fP.  The default is the \fIlast\fP
configuration file listed in the \fBOPTION PRESETS\fP section, below.
The command will exit after updating the config file.
.TP
.NOP \f\*[B-Font]\-<\f[] \f\*[I-Font]cfgfile\f[], \f\*[B-Font]\-\-load-opts\f[]=\f\*[I-Font]cfgfile\f[], \f\*[B-Font]\-\-no-load-opts\f[]
Load options from \fIcfgfile\fP.
The \fIno-load-opts\fP form will disable the loading
of earlier config/rc/ini files.  \fI\-\-no-load-opts\fP is handled early,
out of order.
.TP
.NOP \f\*[B-Font]\-v\f[] [{\f\*[I-Font]v|c|n\f[] \f\*[B-Font]\-\-version\f[] [{\f\*[I-Font]v|c|n\f[]}]}]
Output version of program and exit.  The default mode is `v', a simple
version.  The `c' mode will print copyright information and `n' will
print the full copyright notice.
.PP
.SH "OPTION PRESETS"
Any option that is not marked as \fInot presettable\fP may be preset
by loading values from configuration ("RC" or ".INI") file(s) and values from
environment variables named:
.nf
  \fBCOLUMNS_<option-name>\fP or \fBCOLUMNS\fP
.fi
.ad
The environmental presets take precedence (are processed later than)
the configuration files.
The \fIhomerc\fP files are "\fI.\fP", and "\fI$HOME\fP".
If any of these are directories, then the file \fI.columnsrc\fP
is searched for within those directories.
.SH "ENVIRONMENT"
See \fBOPTION PRESETS\fP for configuration environment variables.
.SH "FILES"
See \fBOPTION PRESETS\fP for configuration files.
.SH "EXIT STATUS"
One of the following exit values will be returned:
.TP
.NOP 0 " (EXIT_SUCCESS)"
Successful program execution.
.TP
.NOP 1 " (EXIT_FAILURE)"
The operation failed or the command syntax was not valid.
.TP
.NOP 66 " (EX_NOINPUT)"
A specified configuration file could not be loaded.
.TP
.NOP 70 " (EX_SOFTWARE)"
libopts had an internal operational error.  Please report
it to autogen-users@lists.sourceforge.net.  Thank you.
.PP
.SH "SEE ALSO"
This program is documented more fully in the Columns section
of the Add\-On chapter in the \fBAutoGen\fP Info system documentation.
.SH "AUTHORS"
Bruce Korb
.SH "COPYRIGHT"
Copyright (C) 1999-2014 Bruce Korb all rights reserved.
This program is released under the terms of the GNU General Public License, version 3 or later.
.SH "BUGS"
Please send bug reports to: autogen-users@lists.sourceforge.net
.SH "NOTES"
This manual page was \fIAutoGen\fP-erated from the \fBcolumns\fP
option definitions.