d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Use `The .Nm utility'

Browse Source
This commit is contained in:
charnier 2002-04-19 23:44:58 +00:00
parent e0fe548473
commit a07fb1cc07
26 changed files with 159 additions and 112 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
usr.bin/apply/apply.1
View File

@ -45,8 +45,9 @@
.Op Fl #
.Ar command argument ...
.Sh DESCRIPTION
The
.Nm
runs the named
utility runs the named
.Ar command
on each
argument

12
usr.bin/basename/basename.1
View File

@ -48,8 +48,9 @@
.Nm dirname
.Ar string
.Sh DESCRIPTION
.Nm Basename
deletes any prefix ending with the last slash
The
.Nm
utility deletes any prefix ending with the last slash
.Ql \&/
character present in
.Ar string
@ -64,8 +65,9 @@ is not stripped if it is identical to the remaining characters in
The resulting filename is written to the standard output.
A non-existent suffix is ignored.
.Pp
.Nm Dirname
deletes the filename portion, beginning
The
.Nm dirname
utility deletes the filename portion, beginning
with the last slash
.Ql \&/
character to the end of
@ -89,6 +91,6 @@ The
.Nm
and
.Nm dirname
functions are expected to be
utilities are expected to be
.St -p1003.2
compatible.

10
usr.bin/biff/biff.1
View File

@ -42,8 +42,9 @@
.Nm
.Op Cm n | y
.Sh DESCRIPTION
.Nm Biff
informs the system whether you want to be notified when mail arrives
The
.Nm
utility informs the system whether you want to be notified when mail arrives
during the current terminal session.
.Pp
The following options are available:
@ -64,8 +65,9 @@ or
.Pa \&.profile
to be executed at each login.
.Pp
.Nm Biff
operates asynchronously.
The
.Nm
utility operates asynchronously.
For synchronous notification use the
.Ev MAIL
variable of

5
usr.bin/cap_mkdb/cap_mkdb.1
View File

@ -45,8 +45,9 @@
.Ar file
.Op Ar
.Sh DESCRIPTION
.Nm Cap_mkdb
builds a hashed database out of the
The
.Nm
utility builds a hashed database out of the
.Xr getcap 3
logical database constructed by the concatenation of the specified
files.

5
usr.bin/chkey/chkey.1
View File

@ -11,8 +11,9 @@
.Sh SYNOPSIS
.Nm
.Sh DESCRIPTION
.Nm Chkey
prompts the user for their login password,
The
.Nm
utility prompts the user for their login password,
and uses it to encrypt a new encryption key
for the user to be stored in the
.Xr publickey 5

25
usr.bin/chpass/chpass.1
View File

@ -254,8 +254,9 @@ for an explanation of the impact of setting the
.Ev PW_SCAN_BIG_IDS
environment variable.
.Sh NIS INTERACTION
.Nm Chpass
can also be used in conjunction with NIS, however some restrictions
The
.Nm
utility can also be used in conjunction with NIS, however some restrictions
apply.
Currently,
.Nm
@ -311,8 +312,9 @@ change any field.
.Pp
.It
.Em "Password authentication is required" .
.Nm Chpass
will prompt for the user's NIS password before effecting
The
.Nm
utility will prompt for the user's NIS password before effecting
any changes.
If the password is invalid, all changes will be
discarded.
@ -325,8 +327,9 @@ choose to turn off this feature using the
flag, described below.)
.It
.Em "Adding new records to the local password database is discouraged" .
.Nm Chpass
will allow the administrator to add new records to the
The
.Nm
utility will allow the administrator to add new records to the
local password database while NIS is enabled, but this can lead to
some confusion since the new records are appended to the end of
the master password file, usually after the special NIS '+' entries.
@ -341,8 +344,9 @@ to the NIS password maps, provided the
server has been started with the
.Fl a
flag to permitted additions (it refuses them by default).
.Nm Chpass
tries to update the local password database by default; to update the
The
.Nm
utility tries to update the local password database by default; to update the
NIS maps instead, invoke chpass with the
.Fl y
flag.
@ -386,8 +390,9 @@ This flag is largely redundant since
operates on NIS entries by default if NIS is enabled.
.It Fl d Ar domain
Specify a particular NIS domain.
.Nm Chpass
uses the system domain name by default, as set by the
The
.Nm
utility uses the system domain name by default, as set by the
.Xr domainname 1
command.
The

15
usr.bin/col/col.1
View File

@ -46,8 +46,9 @@
.Op Fl bfhpx
.Op Fl l Ar num
.Sh DESCRIPTION
.Nm Col
filters out reverse (and half reverse) line feeds so that the output is
The
.Nm
utility filters out reverse (and half reverse) line feeds so that 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
@ -55,8 +56,9 @@ This can be useful in processing the output of
and
.Xr tbl 1 .
.Pp
.Nm Col
reads from the standard input and writes to the standard output.
The
.Nm
utility reads from the standard input and writes to the standard output.
.Pp
The options are as follows:
.Bl -tag -width indent
@ -117,8 +119,9 @@ reverse line feed (11)
All unrecognized control characters and escape sequences are
discarded.
.Pp
.Nm Col
keeps track of the character set as characters are read and makes
The
.Nm
utility 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,

5
usr.bin/colcrt/colcrt.1
View File

@ -44,8 +44,9 @@
.Op Fl \&2
.Op Ar
.Sh DESCRIPTION
.Nm Colcrt
provides virtual half-line and reverse line feed sequences
The
.Nm
utility provides virtual half-line and reverse line feed sequences
for terminals without such capability, and on which overstriking
is destructive.
Half-line characters and underlining (changed to dashing `\-')

5
usr.bin/colrm/colrm.1
View File

@ -42,8 +42,9 @@
.Nm
.Op Ar start Op Ar stop
.Sh DESCRIPTION
.Nm Colrm
removes selected columns from the lines of a file.
The
.Nm
utility removes selected columns from the lines of a file.
A column is defined as a single character in a line.
Input is read from the standard input.
Output is written to the standard output.

5
usr.bin/comm/comm.1
View File

@ -80,8 +80,9 @@ For example, if column number two is being suppressed, lines printed
in column number one will not have any tabs preceding them, and lines
printed in column number three will have one.
.Pp
.Nm Comm
assumes that the files are lexically sorted; all characters
The
.Nm
utility assumes that the files are lexically sorted; all characters
participate in line comparisons.
.Sh DIAGNOSTICS
.Ex -std

15
usr.bin/compress/compress.1
View File

@ -52,8 +52,9 @@
.Op Fl cfv
.Op Ar
.Sh DESCRIPTION
.Nm Compress
reduces the size of the named files using adaptive Lempel-Ziv coding.
The
.Nm
utility reduces the size of the named files using adaptive Lempel-Ziv coding.
Each
.Ar file
is renamed to the same name plus the extension
@ -65,8 +66,9 @@ If compression would not reduce the size of a
.Ar file ,
the file is ignored.
.Pp
.Nm Uncompress
restores the compressed files to their original form, renaming the
The
.Nm uncompress
utility restores the compressed files to their original form, renaming the
files by deleting the
.Dq .Z
extension.
@ -101,8 +103,9 @@ Additionally, files are overwritten without prompting for confirmation.
Print the percentage reduction of each file.
.El
.Pp
.Nm Compress
uses a modified Lempel-Ziv algorithm.
The
.Nm
utility uses a modified Lempel-Ziv algorithm.
Common substrings in the file are first replaced by 9-bit codes 257 and up.
When code 512 is reached, the algorithm switches to 10-bit codes and
continues to use more bits until the

6
usr.bin/ctags/ctags.1
View File

@ -209,16 +209,18 @@ for Fortran and Pascal is done in a very simpleminded way.
No attempt
is made to deal with block structure; if you have two Pascal procedures
in different blocks with the same name you lose.
The
.Nm
does not
utility does not
understand about Pascal types.
.Pp
The method of deciding whether to look for C, Pascal or
Fortran
functions is a hack.
.Pp
The
.Nm
relies on the input being well formed, and any syntactical
utility relies on the input being well formed, and any syntactical
errors will completely confuse it.
It also finds some legal syntax
confusing; for example, since it does not understand

10
usr.bin/doscmd/doscmd.1
View File

@ -51,8 +51,9 @@
.Fl U Ar int
.Op Ar cmd Op Ar args ...
.Sh DESCRIPTION
.Nm Doscmd
can either emulate a subset of DOS and run the
The
.Nm
utility can either emulate a subset of DOS and run the
single command
.Ar cmd
.Ar args ,
@ -542,8 +543,9 @@ or
to let the X server find it.
.El
.Sh FILE TRANSLATION
.Nm Doscmd
translates
The
.Nm
utility translates
.Bsx
file names into
.Tn DOS

5
usr.bin/du/du.1
View File

@ -102,8 +102,9 @@ Display block counts in 1024-byte (1-Kbyte) blocks.
Filesystem mount points are not traversed.
.El
.Pp
.Nm Du
counts the storage used by symbolic links and not the files they
The
.Nm
utility counts the storage used by symbolic links and not the files they
reference unless the
.Fl H
or

15
usr.bin/ee/ee.1
View File

@ -17,13 +17,14 @@
.Op +#
.Op Ar
.Sh DESCRIPTION
The command
The
.Nm
utility
is a simple screen oriented text editor. It is always in text insertion
mode unless there is a prompt at the bottom of the terminal, or a
menu present (in a box in the middle of the terminal). The command
menu present (in a box in the middle of the terminal). The
.Nm ree
is the same as
utility is the same as
.Nm ,
but restricted to editing the named
file (no file operations, or shell escapes are allowed).
@ -383,8 +384,9 @@ run on the file, and the file read back in once
has completed making changes to the file.
.Ss "Printing the contents of the editor"
The user may select a menu item which prints the contents of the editor.
The
.Nm
pipes the text in the editor to the command specified by the
utility pipes the text in the editor to the command specified by the
initialization command
.Em printcommand
(see the section
@ -544,8 +546,9 @@ supported materials.
Always make a copy of files that cannot be easily reproduced before
editing. Save files early, and save often.
.Ss "International Code Set Support"
.Nm Ee
supports single-byte character code sets (eight-bit clean), or the
The
.Nm
utility supports single-byte character code sets (eight-bit clean), or the
Chinese Big-5 code set. (Other multi-byte code sets may function, but the
reason Big-5 works is that a two-byte character also takes up two columns on
the screen.)

5
usr.bin/enigma/enigma.1
View File

@ -23,8 +23,9 @@
.Op Fl k
.Op Ar password
.Sh DESCRIPTION
.Nm Enigma ,
also known as
The
.Nm
utility, also known as
.Nm crypt
is a
.Em very

15
usr.bin/expand/expand.1
View File

@ -53,13 +53,15 @@
.Op Fl a
.Op Ar
.Sh DESCRIPTION
.Nm Expand
processes the named files or the standard input writing
The
.Nm
utility processes the named files or the standard input writing
the standard output with tabs changed into blanks.
Backspace characters are preserved into the output and decrement
the column count for tab calculations.
.Nm Expand
is useful for pre-processing character files
The
.Nm
utility is useful for pre-processing character files
(before sorting, looking at specific columns, etc.) that
contain tabs.
.Pp
@ -71,8 +73,9 @@ spaces apart instead of the default 8.
If multiple tabstops are given then the tabs are set at those
specific columns.
.Pp
.Nm Unexpand
puts tabs back into the data from the standard input or the named
The
.Nm unexpand
utility puts tabs back into the data from the standard input or the named
files and writes the result on the standard output.
.Pp
Option (with

5
usr.bin/fetch/fetch.1
View File

@ -48,8 +48,9 @@
.Op Fl f Ar file
.Op Ar URL ...
.Sh DESCRIPTION
.Nm Fetch
provides a command-line interface to the
The
.Nm
utility provides a command-line interface to the
.Xr fetch 3
library.
Its purpose is to retrieve the file(s) pointed to by the URL(s) on the

10
usr.bin/file/file.1
View File

@ -18,10 +18,7 @@
.Sh DESCRIPTION
This manual page documents version 3.37 of the
.Nm
command.
.Pp
.Nm File
tests each argument in an attempt to classify it.
utility which tests each argument in an attempt to classify it.
There are three sets of tests, performed in this order:
filesystem tests, magic number tests, and language tests.
The
@ -429,8 +426,9 @@ strings for use in heterogenous network environments) for faster startup.
Then the program would run as fast as the Version 7 program of the same name,
with the flexibility of the System V version.
.Pp
.Nm File
uses several algorithms that favor speed over accuracy,
The
.Nm
utility uses several algorithms that favor speed over accuracy,
thus it can be misled about the contents of
text
files.

19
usr.bin/finger/finger.1
View File

@ -46,13 +46,12 @@
.Sh DESCRIPTION
The
.Nm
displays information about the system users.
utility displays information about the system users.
.Pp
Options are:
.Bl -tag -width flag
.It Fl s
.Nm Finger
displays the user's login name, real name, terminal name and write
Display the user's login name, real name, terminal name and write
status (as a ``*'' before the terminal name if write permission is
denied), idle time, login time, and either office location and office
phone number, or the remote host.
@ -89,7 +88,7 @@ option, the office location and office phone information is displayed
instead of the name of the remote host.
.Pp
.It Fl l
Produces a multi-line format displaying all of the information
Produce a multi-line format displaying all of the information
described for the
.Fl s
option as well as the user's home directory, home phone number, login
@ -124,7 +123,7 @@ mailbox since new mail arriving, or ``New mail received ...'', ``Unread
since ...'' if they have new mail.
.Pp
.It Fl p
Prevents
Prevent
the
.Fl l
option of
@ -168,8 +167,9 @@ If no arguments are specified,
.Nm
will print an entry for each user currently logged into the system.
.Pp
.Nm Finger
may be used to look up users on a remote machine.
The
.Nm
utility may be used to look up users on a remote machine.
The format is to specify a
.Ar user
as
@ -201,8 +201,9 @@ is invoked by
.Xr fingerd 8 ,
aliases will work for both local and network queries.
.Sh ENVIRONMENT
.Nm Finger
utilizes the following environment variable, if it exists:
The
.Nm
utility utilizes the following environment variable, if it exists:
.Bl -tag -width Fl
.It Ev FINGER
This variable may be set with favored options to

8
usr.bin/fmt/fmt.1
View File

@ -49,8 +49,9 @@
.Op Ar goal Oo Ar maximum Oc | Fl Ns Ar width | Fl w Ar width
.Op Ar
.Sh DESCRIPTION
The
.Nm
is a simple text formatter which reads the concatenation of input
utility is a simple text formatter which reads the concatenation of input
files (or standard input if none are given) and produces on standard
output a version of its input with lines as close to the
.Ar goal
@ -137,7 +138,9 @@ spaces per tab stop.
The default is 8.
.El
.Pp
The
.Nm
utility
is meant to format mail messages prior to sending, but may also be useful
for other simple tasks.
For instance,
@ -177,6 +180,7 @@ When the first line of an indented paragraph is very long (more than
about twice the goal length), the indentation in the output can be
wrong.
.Pp
The
.Nm
is not infallible in guessing what lines are mail headers and what
utility is not infallible in guessing what lines are mail headers and what
lines are not.

5
usr.bin/fold/fold.1
View File

@ -44,8 +44,9 @@
.Op Fl w Ar width
.Op Ar
.Sh DESCRIPTION
.Nm Fold
is a filter which folds the contents of the specified files,
The
.Nm
utility is a filter which folds the contents of the specified files,
or the standard input if no files are specified,
breaking the lines to have a maximum of 80 characters.
.Pp

23
usr.bin/gcore/gcore.1
View File

@ -42,11 +42,12 @@
.Nm
.Op Fl s
.Op Fl c Ar core
.Op Ar exec
.Op Ar executable
.Ar pid
.Sh DESCRIPTION
.Nm Gcore
creates a core image of the specified process,
The
.Nm
utility creates a core image of the specified process,
suitable for use with
.Xr gdb 1 .
By default, the core is written to the file
@ -60,7 +61,7 @@ specified,
will use
.Dq Pa /proc/<pid>/file .
.Pp
The options are:
The following options are available:
.Bl -tag -width indent
.It Fl c
Write the core file to the specified file instead of
@ -76,13 +77,14 @@ The same effect can be achieved manually with
.Sh FILES
.Bl -tag -width /var/log/messages -compact
.It Pa core.<pid>
The core image.
the core image
.It Pa /proc/<pid>/file
The executable image.
the executable image
.El
.Sh HISTORY
.Nm Gcore
appeared in
A
.Nm
utility appeared in
.Bx 4.2 .
.Sh BUGS
Context switches or paging activity that occur while
@ -92,7 +94,8 @@ For best results, use
.Fl s
to temporarily stop the target process.
.Pp
.Nm Gcore
is not compatible with the original
The
.Nm
utility is not compatible with the original
.Bx 4.2
version.

15
usr.bin/getopt/getopt.1
View File

@ -10,8 +10,9 @@
.Nm args=\`getopt Ar optstring $*\`
; errcode=$?; set \-\- $args
.Sh DESCRIPTION
.Nm Getopt
is used to break up options in command lines for easy parsing by
The
.Nm
utility is used to break up options in command lines for easy parsing by
shell procedures, and to check for legal options.
.Ar Optstring
is a string of recognized option letters (see
@ -22,8 +23,9 @@ separated from it by white space.
The special option
.Ql \-\-
is used to delimit the end of the options.
.Nm Getopt
will place
The
.Nm
utility will place
.Ql \-\-
in the arguments at the end of the options,
or recognize it if used explicitly.
@ -87,8 +89,9 @@ cmd \-a \-oarg \-\- file file
.Xr sh 1 ,
.Xr getopt 3
.Sh DIAGNOSTICS
.Nm Getopt
prints an error message on the standard error output and exits with
The
.Nm
utility prints an error message on the standard error output and exits with
status > 0 when it encounters an option letter not included in
.Ar optstring .
.Sh HISTORY

15
usr.bin/hexdump/hexdump.1
View File

@ -65,7 +65,7 @@ the standard input, if no files are specified, in a user specified
format.
.Pp
The options are as follows:
.Bl -tag -width Fl
.Bl -tag -width indent
.It Fl b
.Em One-byte octal display .
Display the input offset in hexadecimal, followed by sixteen
@ -137,9 +137,7 @@ or
.Li 1048576 ,
respectively.
.It Fl v
The
.Fl v
option causes
Cause
.Nm
to display all input data.
Without the
@ -218,8 +216,9 @@ described in the C standard are supported:
.Ed
.El
.Pp
.Nm Hexdump
also supports the following additional conversion strings:
The
.Nm
utility also supports the following additional conversion strings:
.Bl -tag -width Fl
.It Cm \&_a Ns Op Cm dox
Display the input offset, cumulative across input files, of the
@ -247,7 +246,9 @@ Output characters in the default character set.
Nonprinting characters are displayed as a single
.Dq Cm \&. .
.It Cm _u
Output US ASCII characters, with the exception that control characters are
Output US
.Tn ASCII
characters, with the exception that control characters are
displayed using the following, lower-case, names.
Characters greater than 0xff, hexadecimal, are displayed as hexadecimal
strings.

10
usr.bin/hexdump/od.1
View File

@ -51,12 +51,14 @@
.Sm on
.Ar file
.Sh DESCRIPTION
.Nm Od
has been deprecated in favor of
The
.Nm
utility has been deprecated in favor of
.Xr hexdump 1 .
.Pp
.Nm Hexdump ,
if called as
The
.Nm hexdump
utility, if called as
.Nm ,
provides compatibility for the options listed above.
.Pp