Add DIAGNOSTICS section name and section name to .Xr.
This commit is contained in:
parent
540939b489
commit
f29410236f
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=58604
@ -57,7 +57,9 @@
|
||||
.Ar file1
|
||||
.Ar file2
|
||||
.Sh DESCRIPTION
|
||||
The join utility performs an ``equality join'' on the specified files
|
||||
The
|
||||
.Nm
|
||||
utility performs an ``equality join'' on the specified files
|
||||
and writes the result to the standard output.
|
||||
The ``join field'' is the field in each file by which the files are compared.
|
||||
The first field in each line is used by default.
|
||||
@ -80,7 +82,7 @@ Many of the options use file and field numbers.
|
||||
Both file numbers and field numbers are 1 based, i.e. the first file on
|
||||
the command line is file number 1 and the first field is field number 1.
|
||||
The following options are available:
|
||||
.Bl -tag -width Fl
|
||||
.Bl -tag -width indent
|
||||
.It Fl a Ar file_number
|
||||
In addition to the default output, produce a line for each unpairable
|
||||
line in file
|
||||
@ -144,12 +146,12 @@ should be ordered in the collating sequence of
|
||||
using the
|
||||
.Fl b
|
||||
option, on the fields on which they are to be joined, otherwise
|
||||
.Nm join
|
||||
.Nm
|
||||
may not report all field matches.
|
||||
When the field delimiter characters are specified by the
|
||||
.Fl t
|
||||
option, the collating sequence should be the same as
|
||||
.Xr sort
|
||||
.Xr sort 1
|
||||
without the
|
||||
.Fl b
|
||||
option.
|
||||
@ -159,21 +161,21 @@ If one of the arguments
|
||||
or
|
||||
.Ar file2
|
||||
is ``-'', the standard input is used.
|
||||
.Pp
|
||||
.Sh DIAGNOSTICS
|
||||
The
|
||||
.Nm join
|
||||
.Nm
|
||||
utility exits 0 on success, and >0 if an error occurs.
|
||||
.Sh COMPATIBILITY
|
||||
For compatibility with historic versions of
|
||||
.Nm join ,
|
||||
.Nm Ns ,
|
||||
the following options are available:
|
||||
.Bl -tag -width Fl
|
||||
.Bl -tag -width indent
|
||||
.It Fl a
|
||||
In addition to the default output, produce a line for each unpairable line
|
||||
in both file 1 and file 2.
|
||||
(To distinguish between this and
|
||||
.Fl a Ar file_number ,
|
||||
.Nm join
|
||||
.Nm
|
||||
currently requires that the latter not include any white space.)
|
||||
.It Fl j1 Ar field
|
||||
Join on the
|
||||
@ -189,22 +191,25 @@ Join on the
|
||||
field of both file 1 and file 2.
|
||||
.It Fl o Ar list ...
|
||||
Historical implementations of
|
||||
.Nm join
|
||||
.Nm
|
||||
permitted multiple arguments to the
|
||||
.Fl o
|
||||
option.
|
||||
These arguments were of the form ``file_number.field_number'' as described
|
||||
These arguments were of the form
|
||||
.Ql file_number.field_number
|
||||
as described
|
||||
for the current
|
||||
.Fl o
|
||||
option.
|
||||
This has obvious difficulties in the presence of files named ``1.2''.
|
||||
This has obvious difficulties in the presence of files named
|
||||
.Ql 1.2 .
|
||||
.El
|
||||
.Pp
|
||||
These options are available only so historic shellscripts don't require
|
||||
modification and should not be used.
|
||||
.Sh STANDARDS
|
||||
The
|
||||
.Nm join
|
||||
.Nm
|
||||
command is expected to be
|
||||
.St -p1003.2
|
||||
compatible.
|
||||
|
Loading…
Reference in New Issue
Block a user