Use `The .Nm utility'

This commit is contained in:
Philippe Charnier 2002-04-20 12:27:18 +00:00
parent c720dea0f2
commit 7f94b8deee
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=95127
29 changed files with 181 additions and 102 deletions

View File

@ -12,8 +12,9 @@
.Op Fl f Ar device
.Op Ar command ...
.Sh DESCRIPTION
.Nm Cdcontrol
is a program to control audio features of a CD drive.
The
.Nm
utility is a program to control audio features of a CD drive.
The device is a name such
as
.Pa cd0

View File

@ -35,8 +35,9 @@
.Fl e
}
.Sh DESCRIPTION
.Nm Crontab
is the program used to install, deinstall or list the tables
The
.Nm
utility is the program used to install, deinstall or list the tables
used to drive the
.Xr cron 8
daemon in Vixie Cron. Each user can have their own crontab, and though

View File

@ -52,8 +52,9 @@ The main reason to crunch programs together is for fitting
as many programs as possible onto an installation or system recovery
floppy.
.Pp
The
.Nm
reads in the specifications in
utility reads in the specifications in
.Ar conf-file
for a crunched binary, and generates a
.Pa Makefile
@ -66,14 +67,16 @@ can optionally attempt to determine the object (.o) files that make up
the program from its source directory
.Pa Makefile .
This information is cached between runs.
The
.Nm
uses the companion program
utility uses the companion program
.Xr crunchide 1
to eliminate link-time conflicts between the component programs by
hiding all unnecessary symbols.
.Pp
The
.Nm
places specific requirements on package
utility places specific requirements on package
.Pa Makefile Ns s
which make it unsuitable for use with
.No non- Ns Bx
@ -165,15 +168,17 @@ Quiet operation.
Status messages are suppressed.
.El
.Sh CRUNCHGEN CONFIGURATION FILE COMMANDS
The
.Nm
reads specifications from the
utility reads specifications from the
.Ar conf-file
that describe the components of the crunched binary.
In its simplest
use, the component program names are merely listed along with the
top-level source directories in which their sources can be found.
The
.Nm
then calculates (via the source makefiles) and caches the
utility then calculates (via the source makefiles) and caches the
list of object files and their locations.
For more specialized
situations, the user can specify by hand all the parameters that
@ -434,8 +439,9 @@ The
must then be used to get those object files built, or
some other arrangements made.
.Sh AUTHORS
The
.Nm
was written by
utility was written by
.An James da Silva Aq jds@cs.umd.edu .
.Pp
Copyright (c) 1994 University of Maryland.

View File

@ -36,8 +36,9 @@
.Op Fl k Ar keep-symbol
.Op Ar object-file ...
.Sh DESCRIPTION
.Nm Crunchide
hides the global symbols of
The
.Nm
utility hides the global symbols of
.Ar object-file
such that they are ignored by subsequent runs of the linker,
.Xr ld 1 .
@ -59,8 +60,9 @@ visible, the option
.Dq -k foo
should be used.
.Pp
.Nm Crunchide
is designed as a companion program for
The
.Nm
utility is designed as a companion program for
.Xr crunchgen 1 ,
which automates the process of creating crunched binaries from
multiple component programs.
@ -68,8 +70,9 @@ multiple component programs.
.Xr crunchgen 1 ,
.Xr ld 1
.Sh AUTHORS
.Nm Crunch
was written by
The
.Nm crunch
utility was written by
.An James da Silva Aq jds@cs.umd.edu .
.Pp
Copyright (c) 1994 University of Maryland. All Rights Reserved.

View File

@ -30,14 +30,16 @@
.Op Fl x Ar exclude-regex
.Ar
.Sh DESCRIPTION
.Nm Ctm
was originally
The
.Nm
utility was originally
.Dq Cvs Through eMail ,
but now instead it seems more fitting to call it
.Dq Current Through eMail .
.Pp
.Nm Ctm
is now meant to be the definitive way to make and apply a delta between
The
.Nm
utility is now meant to be the definitive way to make and apply a delta between
two versions of a directory tree.
.Pp
There are two parts to this, making the delta and applying it. These are two
@ -106,7 +108,9 @@ filter that matched a given file name determines whether the file would be
operated on or left alone by
.Nm .
.Pp
.Nm Ctm
The
.Nm
utility
will extract the file hierarchy below its working directory. Absolute
filenames or filenames containing references through
.Sq Pa .\&

View File

@ -45,8 +45,9 @@ command,
and
.Nm ctm_rmail
are used to distribute changes to a source tree via email.
The
.Nm ctm_smail
is given a compressed
utility is given a compressed
.Xr ctm
delta, and a mailing list to send it to. It splits the delta into manageable
pieces, encodes them as mail messages and sends them to the mailing list
@ -362,7 +363,7 @@ manipulation in
which allows
.Nm ctm_rmail
to execute
.Xr ctm
.Xr ctm 1
on the
.Pq non- Ns Fx
machine that this example was taken from.
@ -418,13 +419,15 @@ File containing the name and number of the next delta to be applied to this
source tree.
.El
.Sh DIAGNOSTICS
The
.Nm ctm_smail ,
.Nm ctm_dequeue
and
.Nm ctm_rmail
return exit status 0 for success, and 1 for various failures.
utilities return exit status 0 for success, and 1 for various failures.
The
.Nm ctm_rmail
is expected to be called from a mail transfer program, and thus signals
utility is expected to be called from a mail transfer program, and thus signals
failure only when the input mail message should be bounced (preferably into
your regular maildrop, not back to the sender). In short, failure to
apply a completed delta with
@ -445,14 +448,16 @@ or, if queueing,
ctm_smail: src-cur.0250.gz 1/2 queued for src-guys
.Ed
.Pp
The
.Nm ctm_dequeue
will report messages like:
utility will report messages like:
.Bd -literal -offset indent
ctm_dequeue: src-cur.0250.gz 1/2 sent
.Ed
.Pp
The
.Nm ctm_rmail
will report messages like:
utility will report messages like:
.Bd -literal -offset indent
ctm_rmail: src-cur.0250.gz 1/2 stored
ctm_rmail: src-cur.0250.gz 2/2 stored
@ -472,7 +477,7 @@ back into your real mailbox if your mail filter goes wonky.
These messages go to
.Em stderr
or to the log file. Messages from
.Xr ctm
.Xr ctm 1
turn up here too. Error messages should be self explanatory.
.Sh SEE ALSO
.Xr ctm 1 ,

View File

@ -49,7 +49,9 @@ utility reads floppy disks. Effective read blocking based on the track
size is performed, and floppy-specific error recovery of otherwise
bad blocks can be enabled.
.Pp
The
.Nm
utility
will always read an entire floppy medium, and write its contents to
the respective output file. Unlike other tools like
.Xr dd 1 ,
@ -150,8 +152,9 @@ option.
Default device to read from.
.El
.Sh DIAGNOSTICS
The
.Nm
sets the exit value according to
utility sets the exit value according to
.Xr sysexits 3 .
In recovery mode, the exit value will be set to
.Dv EX_IOERR

View File

@ -22,12 +22,14 @@
.Op Fl f Ar inputfile
.Op Fl d Ar device
.Sh DESCRIPTION
.Nm Fdwrite
formats and writes one and more floppy disks.
The
.Nm
utility formats and writes one and more floppy disks.
Any floppy disk device capable of formatting can be used.
.Pp
.Nm Fdwrite
will ask the user
The
.Nm
utility will ask the user
(on
.Pa /dev/tty )
to insert a new floppy and press return.
@ -62,8 +64,9 @@ The name of the floppy device to write to. Default is
.Pa /dev/fd0 .
.El
.Pp
.Nm Fdwrite
actually closes the
The
.Nm
utility actually closes the
.Ar device
while it waits for the user to press return,
it is thus quite possible to use the drive for other purposes at this
@ -76,7 +79,9 @@ If custom formatting is needed, please use
.Xr fdformat 1
instead.
.Sh EXAMPLES
.Nm Fdwrite
The
.Nm
utility
was planned as a tool to make life easier when writing a set of floppies,
one such use could be to write a tar-archive:
.Pp
@ -90,8 +95,9 @@ thus reducing the amount of work for the floppy-jockey.
.Sh SEE ALSO
.Xr fdformat 1
.Sh HISTORY
.Nm Fdwrite
was written while waiting for ``make world'' to complete.
The
.Nm
utility was written while waiting for ``make world'' to complete.
Some of the code was taken from
.Xr fdformat 1 .
.Sh AUTHORS

View File

@ -38,7 +38,9 @@
.Sh SYNOPSIS
.Nm
.Sh DESCRIPTION
The
.Nm
utility
is part of the isdn4bsd package and is used to detect DTMF tones in the
audio stream.
.Pp

View File

@ -42,7 +42,9 @@
.Op Fl A
.Op Fl R
.Sh DESCRIPTION
The
.Nm
utility
is part of the isdn4bsd package and is used to convert between the A-Law and
u-law formats as specified in ITU G.711. It is based on a freely available
and freely usable reference implementation done by Sun Microsystems, Inc.

View File

@ -42,8 +42,9 @@
.Op Fl s | Fl show
.Op Fl v | Fl verbose
.Sh DESCRIPTION
.Nm Kbdmap
allows easy setting of available keymaps.
The
.Nm
utility allows easy setting of available keymaps.
The
.Nm vidfont
command allows the setting of fonts.
@ -121,10 +122,11 @@ values
.\" is iso-8859-1 and you chose lang 'ru' (for Russian)
.\" you get funny latin1 characters and not russkij shrift.
.\"
The
.Nm
and
.Nm vidfont
work only on a (virtual) console and not with
utilities work only on a (virtual) console and not with
.Tn X11 .
.Sh SEE ALSO
.Xr dialog 1 ,

View File

@ -47,8 +47,9 @@
.Op Fl n Ar num
.Op Ar name ...
.Sh DESCRIPTION
.Nm \&Lp
is a front-end to the print spooler as required by the
The
.Nm
utility is a front-end to the print spooler as required by the
.St -p1003.2
specification. It effectively invokes
.Xr lpr 1

View File

@ -46,13 +46,15 @@
.Op job # ...\&
.Op user ...\&
.Sh DESCRIPTION
.Nm Lpq
examines the spooling area used by
The
.Nm
utility examines the spooling area used by
.Xr lpd 8
for printing files on the line printer, and reports the status of the
specified jobs or all jobs associated with a user.
.Nm Lpq
invoked
The
.Nm
utility invoked
without any arguments reports on any jobs currently in the queue.
.Pp
Options:
@ -123,8 +125,9 @@ The lock file to obtain the currently active job.
.Xr lpc 8 ,
.Xr lpd 8
.Sh HISTORY
.Nm Lpq
appeared in
A
.Nm
utility appeared in
.Bx 3 .
.Sh BUGS
Due to the dynamic nature of the information in the spooling directory

View File

@ -54,8 +54,9 @@
.Op Fl cdfghlnmprstv
.Op Ar name ...
.Sh DESCRIPTION
.Nm Lpr
uses a spooling daemon to print the named files when facilities
The
.Nm
utility uses a spooling daemon to print the named files when facilities
become available. If no names appear, the standard input is assumed.
.Pp
The following single letter options are used to notify the line printer
@ -272,8 +273,9 @@ command appeared in
.Bx 3 .
.Sh DIAGNOSTICS
If you try to spool too large a file, it will be truncated.
.Nm Lpr
will object to printing binary files.
The
.Nm
utility will object to printing binary files.
If a user other than root prints a file and spooling is disabled,
.Nm
will print a message saying so and will not put jobs in the queue.

View File

@ -45,8 +45,9 @@
.Op job # ...\&
.Op Ar user ...\&
.Sh DESCRIPTION
.Nm Lprm
will remove a job, or jobs, from a printer's spool queue.
The
.Nm
utility will remove a job, or jobs, from a printer's spool queue.
Since the spooling directory is protected from users, using
.Nm
is normally the only method by which a user may remove a job.
@ -97,12 +98,14 @@ will delete the currently active job if it is
owned by the user who invoked
.Nm .
.Pp
.Nm Lprm
announces the names of any files it removes and is silent if
The
.Nm
utility announces the names of any files it removes and is silent if
there are no jobs in the queue which match the request list.
.Pp
.Nm Lprm
will kill off an active daemon, if necessary, before removing
The
.Nm
utility will kill off an active daemon, if necessary, before removing
any spooling files. If a daemon is killed, a new one is
automatically restarted upon completion of file removals.
.Sh ENVIRONMENT

View File

@ -43,8 +43,9 @@
.Op Ar length
.Op Ar count
.Sh DESCRIPTION
.Nm Lptest
writes the traditional "ripple test" pattern on standard output.
The
.Nm
utility writes the traditional "ripple test" pattern on standard output.
In 96 lines,
this pattern will print all 96 printable
.Tn ASCII
@ -70,6 +71,7 @@ is to be specified,
.Ar length
must be also be specified.
.Sh HISTORY
.Nm Lptest
appeared in
A
.Nm
utility appeared in
.Bx 4.3 .

View File

@ -36,13 +36,15 @@
.Nm
filename
.Sh DESCRIPTION
The
.Nm
is a curses based fullscreen application which allows to edit
utility is a curses based fullscreen application which allows to edit
.Xr pcvt 4
fontfiles interactively.
.Pp
The
.Nm
displays a command window, a character display window and a
utility displays a command window, a character display window and a
character select window.
.Pp
In character select mode, it allows to move a character font to

View File

@ -10,8 +10,9 @@
.Nm
.Ar file
.Sh DESCRIPTION
.Nm Fontedit
is used to edit the down line reloadable character set (DRCS) of a
The
.Nm
utility is used to edit the down line reloadable character set (DRCS) of a
.Tn VT220
terminal.
The editor has two display areas, one for displaying the
@ -19,7 +20,9 @@ entry currently being manipulated, and one for displaying the complete
DRCS.
Commands to the editor take the form of function keys.
.Pp
.Nm Fontedit
The
.Nm
utility
takes one command line parameter, a
.Ar file
name.
@ -76,7 +79,9 @@ The DRCS will be saved in
To exit without saving the DRCS, hit interrupt (usually
DEL).
.Sh DIAGNOSTICS
.Nm Fontedit
The
.Nm
utility
will issue a warning when the entry being worked on is not saved, and
some potentially destructive command, like
.Ic Select

View File

@ -45,7 +45,9 @@
.Op Fl t Ns Ar +/-
.Op Fl x
.Sh DESCRIPTION
The
.Nm
utility
is used for controlling all aspects of keyboard configuration for the 'pcvt'
video driver.
.Pp
@ -105,8 +107,9 @@ Keyboard raw device.
.Xr keycap 3 ,
.Xr keycap 5
.Sh BUGS
The
.Nm
detects several inconsistencies in the keycap database.
utility detects several inconsistencies in the keycap database.
In case of errors
.Nm
exits with an error message.

View File

@ -11,8 +11,9 @@
.Op Fl cil
.Op Ar keyname keystring ...
.Sh DESCRIPTION
.Nm Vt220keys
sets up a
The
.Nm
utility sets up a
.Dq "vt220 terminal"
in vt200 mode to allow user
definition of the SHIFTED function keys.
@ -30,8 +31,9 @@ is one of the following words:
.Ar Keystrings
must be quoted if spaces, tabs, or shell metacharacters are included.
.Pp
.Nm Vt220keys
expects to receive some combination of option flags and/or
The
.Nm
utility expects to receive some combination of option flags and/or
argument pair(s), otherwise a usage message
is printed.
.Pp
@ -89,8 +91,9 @@ Therefore
F6 can perform two commands, depending if pressed with/without the SHIFT
key.
.Pp
.Nm Vt220keys
can be called from your
The
.Nm
utility can be called from your
.Pa .login
or
.Pa .profile

View File

@ -9,8 +9,9 @@
.Sh SYNOPSIS
.Nm
.Sh DESCRIPTION
.Nm Vttest
is a program designed to test the functionality of a
The
.Nm
utility is a program designed to test the functionality of a
.Tn VT100
terminal
(or emulator thereof).

View File

@ -206,8 +206,9 @@ passive mode
.Ef
ftp.
.Sh TECHNICAL DETAILS
The
.Nm
is fairly simple. It extracts each package's "packing list"
utility is fairly simple. It extracts each package's "packing list"
into a special staging directory, parses it,
and then runs through the following sequence to fully extract the contents:
.Bl -enum

View File

@ -124,7 +124,9 @@ Recursive removal. In addition to specified packages, delete all
packages that depend on those packages as well.
.El
.Sh TECHNICAL DETAILS
The
.Nm
utility
does pretty much what it says. It examines installed package records in
.Pa /var/db/pkg/<pkg-name> ,
deletes the package contents, and finally removes the package records.

View File

@ -47,8 +47,9 @@
.Op Fl k Ar cert
.Op Ar
.Sh DESCRIPTION
The
.Nm
embeds a cryptographic signature within a gzip file
utility embeds a cryptographic signature within a gzip file
.Ar file .
.Ar type
can be
@ -72,8 +73,9 @@ you must supply an
which will be recorded as the name of the package, and printed as the
SHA1 checksum.
.Pp
The
.Nm pkg_check
checks that cryptographic signature.
utility checks that cryptographic signature.
It currently disregards
.Ar type
and checks only the topmost signature.
@ -126,10 +128,11 @@ signing scheme uses eight bytes markers such
+ length for its signatures (those markers are conveniently
eight bytes long).
.Sh DIAGNOSTICS
The
.Nm
and
.Nm pkg_check
return with an exit code >0 if anything went wrong for any
utilities return with an exit code >0 if anything went wrong for any
.Ar file .
For
.Nm pkg_check ,
@ -138,8 +141,9 @@ signature is forged.
.Bl -diag
.It "File %s is already signed"
There is a signature embedded within the gzip file already.
The
.Nm
currently does not handle multiple signatures.
utility currently does not handle multiple signatures.
.It "File %s is not a signed gzip file"
This is an unsigned package.
.It "File %s is not a gzip file"
@ -191,8 +195,9 @@ Default package verification certificate(s).
.Xr sha1 1
.Sh AUTHORS
.An -nosplit
A
.Nm
was created by
utility was created by
.An Marc Espie
for the
.Ox

View File

@ -106,8 +106,9 @@ was unable to compare the version number of the installed package
with the corresponding entry in the index.
.El
.Sh OPTIONS
The
.Nm
supports several command-line arguments:
utility supports several command-line arguments:
.Bl -tag -width indent
.It Fl c
Enable commands output. Commands output includes the commands you should

View File

@ -57,11 +57,13 @@ or idletime scheduling priority
.Fl t
.Fl Ar pid
.Sh DESCRIPTION
.Nm Rtprio
is used for controlling realtime process scheduling.
The
.Nm
utility is used for controlling realtime process scheduling.
.Pp
.Nm Idprio
is used for controlling idletime process scheduling, and can be called
The
.Nm idprio
utility is used for controlling idletime process scheduling, and can be called
with the same options as
.Nm .
.Pp
@ -73,7 +75,8 @@ A process with an idle priority will run only when no other
process is runnable and then only if its idle priority is equal or
greater than all other runnable idle priority processes.
.Pp
.Nm Rtprio
Both
.Nm
or
.Nm idprio
when called without arguments will return the realtime priority

View File

@ -32,8 +32,9 @@
.Op Ar start-time Op end-time
.Ar
.Sh DESCRIPTION
.Nm Tcpslice
is a program for extracting portions of packet-trace files generated using
The
.Nm
utility extracts portions of packet-trace files generated using
.Xr tcpdump 1 Ns 's
.Fl w
flag.
@ -231,14 +232,16 @@ with a start/end time. Such filenames can be specified with a
leading `./'; for example, specify the file `04Jul76.trace' as
`./04Jul76.trace'.
.Pp
.Nm Tcpslice
cannot read its input from
The
.Nm
utility cannot read its input from
.Pa stdin ,
since it uses random-access
to rummage through its input files.
.Pp
.Nm Tcpslice
refuses to write to its output if it is a terminal
The
.Nm
utility refuses to write to its output if it is a terminal
(as indicated by
.Xr isatty 3 ) .
This is not a bug but a feature,
@ -249,8 +252,9 @@ or specify an
output file via
.Fl w .
.Pp
.Nm Tcpslice
will not work properly on
The
.Nm
utility will not work properly on
.Xr tcpdump 1
files spanning more than one year;
with files containing portions of packets whose original length was

View File

@ -194,8 +194,9 @@ daemon for text mode cut & paste functionality.
.It Fl p
Capture the current contents of the video buffer corresponding
to the terminal device referred to by standard input.
The
.Nm
writes contents of the video buffer to the standard
utility writes contents of the video buffer to the standard
output in a raw binary format.
For details about that
format see
@ -286,8 +287,9 @@ utility uses the
.Dv CONS_SCRSHOT
.Xr ioctl 2
to capture the current contents of the video buffer.
The
.Nm
writes version and additional information to the standard
utility writes version and additional information to the standard
output, followed by the contents of the terminal device.
.Pp
VGA video memory is typically arranged in two byte tuples,

View File

@ -46,8 +46,9 @@
.Ar ...
.Oc
.Sh DESCRIPTION
.Nm Xten
is a command-line interface to the X-10 daemon.
The
.Nm
utility is a command-line interface to the X-10 daemon.
When invoked with a one-letter house code (A-P) and a series of key/unit
codes as arguments, it requests the X-10 daemon to transmit a corresponding
series of X-10 packets. The X-10 daemon makes its best effort to ensure