diff options
| author | sheldonh <sheldonh@FreeBSD.org> | 2000-03-01 12:20:22 +0000 |
|---|---|---|
| committer | sheldonh <sheldonh@FreeBSD.org> | 2000-03-01 12:20:22 +0000 |
| commit | 49c4458c80d7fc0c739164002a85966499593dbf (patch) | |
| tree | 7324d2cb3e29b7c8220abd41fce86411f633eddc /usr.bin | |
| parent | 56aefdcd1008df3702556867ce63eb3fc801508b (diff) | |
| download | FreeBSD-src-49c4458c80d7fc0c739164002a85966499593dbf.zip FreeBSD-src-49c4458c80d7fc0c739164002a85966499593dbf.tar.gz | |
Remove single-space hard sentence breaks. These degrade the quality
of the typeset output, tend to make diffs harder to read and provide
bad examples for new-comers to mdoc.
Diffstat (limited to 'usr.bin')
53 files changed, 583 insertions, 292 deletions
diff --git a/usr.bin/biff/biff.1 b/usr.bin/biff/biff.1 index 83ebdc7..c7a8e57 100644 --- a/usr.bin/biff/biff.1 +++ b/usr.bin/biff/biff.1 @@ -85,5 +85,6 @@ The .Nm command appeared in .Bx 4.0 . -It was named after the dog of Heidi Stettner. He died +It was named after the dog of Heidi Stettner. +He died in August 1993, at 15. diff --git a/usr.bin/calendar/calendar.1 b/usr.bin/calendar/calendar.1 index cfe76c4..d783c49 100644 --- a/usr.bin/calendar/calendar.1 +++ b/usr.bin/calendar/calendar.1 @@ -86,7 +86,8 @@ For test purposes only: set date directly to argument values. .Pp To handle calendars in your national code table you can specify .Dq LANG=<locale_name> -in the calendar file as early as possible. To handle national Easter +in the calendar file as early as possible. +To handle national Easter names in the calendars .Dq Easter=<national_name> (for Catholic Easter) or diff --git a/usr.bin/chat/chat.8 b/usr.bin/chat/chat.8 index efcf194..55a68d5 100644 --- a/usr.bin/chat/chat.8 +++ b/usr.bin/chat/chat.8 @@ -18,39 +18,52 @@ chat \- Automated conversational script with a modem .SH DESCRIPTION .LP The \fIchat\fR program defines a conversational exchange between the -computer and the modem. Its primary purpose is to establish the +computer and the modem. +Its primary purpose is to establish the connection between the Point-to-Point Protocol Daemon (\fIpppd\fR) and the remote's \fIpppd\fR process. .SH OPTIONS .TP .B -f \fI<chat file> -Read the chat script from the chat \fIfile\fR. The use of this option -is mutually exclusive with the chat script parameters. The user must -have read access to the file. Multiple lines are permitted in the -file. Space or horizontal tab characters should be used to separate +Read the chat script from the chat \fIfile\fR. +The use of this option +is mutually exclusive with the chat script parameters. +The user must +have read access to the file. +Multiple lines are permitted in the +file. +Space or horizontal tab characters should be used to separate the strings. .TP .B -t \fI<timeout> -Set the timeout for the expected string to be received. If the string +Set the timeout for the expected string to be received. +If the string is not received within the time limit then the reply string is not -sent. An alternate reply may be sent or the script will fail if there -is no alternate reply string. A failed script will cause the +sent. +An alternate reply may be sent or the script will fail if there +is no alternate reply string. +A failed script will cause the \fIchat\fR program to terminate with a non-zero error code. .TP .B -r \fI<report file> -Set the file for output of the report strings. If you use the keyword -\fIREPORT\fR, the resulting strings are written to this file. If this +Set the file for output of the report strings. +If you use the keyword +\fIREPORT\fR, the resulting strings are written to this file. +If this option is not used and you still use \fIREPORT\fR keywords, the \fIstderr\fR file is used for the report strings. .TP .B -e -Start with the echo option turned on. Echoing may also be turned on +Start with the echo option turned on. +Echoing may also be turned on or off at specific points in the chat script by using the \fIECHO\fR -keyword. When echoing is enabled, all output from the modem is echoed +keyword. +When echoing is enabled, all output from the modem is echoed to \fIstderr\fR. .TP .B -v -Request that the \fIchat\fR script be executed in a verbose mode. The +Request that the \fIchat\fR script be executed in a verbose mode. +The \fIchat\fR program will then log the execution state of the chat script as well as all text received from the modem and the output strings sent to the modem. The default is to log through @@ -62,8 +75,10 @@ and level \fIerr\fR for some errors. .TP .B -V Request that the \fIchat\fR script be executed in a stderr verbose -mode. The \fIchat\fR program will then log all text received from the -modem and the output strings sent to the modem to the stderr device. This +mode. +The \fIchat\fR program will then log all text received from the +modem and the output strings sent to the modem to the stderr device. +This device is usually the local console at the station running the chat or pppd program. .TP @@ -113,20 +128,24 @@ Once it received the login prompt the \fIchat\fR program will send the string ppp and then expect the prompt "ssword:". When it receives the prompt for the password, it will send the password hello2u2. .LP -A carriage return is normally sent following the reply string. It is not +A carriage return is normally sent following the reply string. +It is not expected in the "expect" string unless it is specifically requested by using the \\r character sequence. .LP The expect sequence should contain only what is needed to identify the -string. Since it is normally stored on a disk file, it should not contain -variable information. It is generally not acceptable to look for time +string. +Since it is normally stored on a disk file, it should not contain +variable information. +It is generally not acceptable to look for time strings, network identification strings, or other variable pieces of data as an expect string. .LP To help correct for characters which may be corrupted during the initial sequence, look for the string "ogin:" rather than "login:". It is possible that the leading "l" character may be received in error and you may never -find the string even though it was sent by the system. For this reason, +find the string even though it was sent by the system. +For this reason, scripts look for "ogin:" rather than "login:" and "ssword:" rather than "password:". .LP @@ -136,21 +155,27 @@ ogin: ppp ssword: hello2u2 .LP In other words, expect ....ogin:, send ppp, expect ...ssword:, send hello2u2. .LP -In actual practice, simple scripts are rare. At the vary least, you +In actual practice, simple scripts are rare. +At the vary least, you should include sub-expect sequences should the original string not be -received. For example, consider the following script: +received. +For example, consider the following script: .IP ogin:--ogin: ppp ssword: hello2u2 .LP -This would be a better script than the simple one used earlier. This would look +This would be a better script than the simple one used earlier. +This would look for the same login: prompt, however, if one was not received, a single -return sequence is sent and then it will look for login: again. Should line +return sequence is sent and then it will look for login: again. +Should line noise obscure the first login prompt then sending the empty line will usually generate a login prompt again. .SH COMMENTS -Comments can be embedded in the chat script. A comment is a line which +Comments can be embedded in the chat script. +A comment is a line which starts with the \fB#\fR (hash) character in column 1. Such comment -lines are just ignored by the chat program. If a '#' character is to +lines are just ignored by the chat program. +If a '#' character is to be expected as the first character of the expect sequence, you should quote the expect string. If you want to wait for a prompt that starts with a # (hash) @@ -162,27 +187,41 @@ character, you would have to write something like this: .LP .SH ABORT STRINGS -Many modems will report the status of the call as a string. These -strings may be \fBCONNECTED\fR or \fBNO CARRIER\fR or \fBBUSY\fR. It +Many modems will report the status of the call as a string. +These +strings may be \fBCONNECTED\fR or \fBNO CARRIER\fR or \fBBUSY\fR. +It is often desirable to terminate the script should the modem fail to -connect to the remote. The difficulty is that a script would not know -exactly which modem string it may receive. On one attempt, it may +connect to the remote. +The difficulty is that a script would not know +exactly which modem string it may receive. +On one attempt, it may receive \fBBUSY\fR while the next time it may receive \fBNO CARRIER\fR. .LP These "abort" strings may be specified in the script using the \fIABORT\fR -sequence. It is written in the script as in the following example: +sequence. +It is written in the script as in the following example: .IP ABORT BUSY ABORT 'NO CARRIER' '' ATZ OK ATDT5551212 CONNECT .LP -This sequence will expect nothing; and then send the string ATZ. The -expected response to this is the string \fIOK\fR. When it receives \fIOK\fR, -the string ATDT5551212 to dial the telephone. The expected string is -\fICONNECT\fR. If the string \fICONNECT\fR is received the remainder of the -script is executed. However, should the modem find a busy telephone, it will -send the string \fIBUSY\fR. This will cause the string to match the abort -character sequence. The script will then fail because it found a match to -the abort string. If it received the string \fINO CARRIER\fR, it will abort -for the same reason. Either string may be received. Either string will +This sequence will expect nothing; and then send the string ATZ. +The +expected response to this is the string \fIOK\fR. +When it receives \fIOK\fR, +the string ATDT5551212 to dial the telephone. +The expected string is +\fICONNECT\fR. +If the string \fICONNECT\fR is received the remainder of the +script is executed. +However, should the modem find a busy telephone, it will +send the string \fIBUSY\fR. +This will cause the string to match the abort +character sequence. +The script will then fail because it found a match to +the abort string. +If it received the string \fINO CARRIER\fR, it will abort +for the same reason. Either string may be received. +Either string will terminate the \fIchat\fR script. .SH CLR_ABORT STRINGS This sequence allows for clearing previously set \fBABORT\fR strings. @@ -196,7 +235,8 @@ pppd, and pppd is running as a daemon (detached from its controlling terminal), standard error will normally be redirected to the file /etc/ppp/connect-errors. .LP -\fBSAY\fR strings must be enclosed in single or double quotes. If +\fBSAY\fR strings must be enclosed in single or double quotes. +If carriage return and line feed are needed in the string to be output, you must explicitly add them to your string. .LP @@ -229,7 +269,8 @@ SAY "Logged in OK ...\n" \fIetc ...\fR .LP This sequence will only present the SAY strings to the user and all -the details of the script will remain hidden. For example, if the +the details of the script will remain hidden. +For example, if the above script works, the user will see: .IP Dialling your ISP... @@ -240,28 +281,35 @@ Logged in OK ... .LP .SH REPORT STRINGS -A \fBreport\fR string is similar to the ABORT string. The difference +A \fBreport\fR string is similar to the ABORT string. +The difference is that the strings, and all characters to the next control character such as a carriage return, are written to the report file. .LP The report strings may be used to isolate the transmission rate of the -modem's connect string and return the value to the chat user. The +modem's connect string and return the value to the chat user. +The analysis of the report string logic occurs in conjunction with the -other string processing such as looking for the expect string. The use +other string processing such as looking for the expect string. +The use of the same string for a report and abort sequence is probably not very useful, however, it is possible. .LP The report strings to no change the completion code of the program. .LP These "report" strings may be specified in the script using the \fIREPORT\fR -sequence. It is written in the script as in the following example: +sequence. +It is written in the script as in the following example: .IP REPORT CONNECT ABORT BUSY '' ATDT5551212 CONNECT '' ogin: account .LP This sequence will expect nothing; and then send the string -ATDT5551212 to dial the telephone. The expected string is -\fICONNECT\fR. If the string \fICONNECT\fR is received the remainder -of the script is executed. In addition the program will write to the +ATDT5551212 to dial the telephone. +The expected string is +\fICONNECT\fR. +If the string \fICONNECT\fR is received the remainder +of the script is executed. +In addition the program will write to the expect-file the string "CONNECT" plus any characters which follow it such as the connection rate. .SH CLR_REPORT STRINGS @@ -271,11 +319,15 @@ compilation time); \fBCLR_REPORT\fR will reclaim the space for cleared entries so that new strings can use that space. .SH ECHO The echo options controls whether the output from the modem is echoed -to \fIstderr\fR. This option may be set with the \fI-e\fR option, but -it can also be controlled by the \fIECHO\fR keyword. The "expect-send" +to \fIstderr\fR. +This option may be set with the \fI-e\fR option, but +it can also be controlled by the \fIECHO\fR keyword. +The "expect-send" pair \fIECHO\fR \fION\fR enables echoing, and \fIECHO\fR \fIOFF\fR -disables it. With this keyword you can select which parts of the -conversation should be visible. For instance, with the following +disables it. +With this keyword you can select which parts of the +conversation should be visible. +For instance, with the following script: .IP ABORT 'BUSY' @@ -341,7 +393,8 @@ ogin:--BREAK--ogin: real_account \fIetc ...\fR .LP .SH TIMEOUT -The initial timeout value is 45 seconds. This may be changed using the \fB-t\fR +The initial timeout value is 45 seconds. +This may be changed using the \fB-t\fR parameter. .LP To change the timeout value for the next expect string, the following @@ -350,21 +403,25 @@ example may be used: ATZ OK ATDT5551212 CONNECT TIMEOUT 10 ogin:--ogin: TIMEOUT 5 assword: hello2u2 .LP This will change the timeout to 10 seconds when it expects the login: -prompt. The timeout is then changed to 5 seconds when it looks for the +prompt. +The timeout is then changed to 5 seconds when it looks for the password prompt. .LP The timeout, once changed, remains in effect until it is changed again. .SH SENDING EOT The special reply string of \fIEOT\fR indicates that the chat program -should send an EOT character to the remote. This is normally the -End-of-file character sequence. A return character is not sent +should send an EOT character to the remote. +This is normally the +End-of-file character sequence. +A return character is not sent following the EOT. .PR The EOT sequence may be embedded into the send string using the sequence \fI^D\fR. .SH GENERATING BREAK The special reply string of \fIBREAK\fR will cause a break condition -to be sent. The break is a special signal on the transmitter. The +to be sent. The break is a special signal on the transmitter. +The normal processing on the receiver is to change the transmission rate. It may be used to cycle through the available transmission rates on the remote until you are able to receive a valid login prompt. @@ -372,27 +429,35 @@ the remote until you are able to receive a valid login prompt. The break sequence may be embedded into the send string using the \fI\\K\fR sequence. .SH ESCAPE SEQUENCES -The expect and reply strings may contain escape sequences. All of the -sequences are legal in the reply string. Many are legal in the expect. +The expect and reply strings may contain escape sequences. +All of the +sequences are legal in the reply string. +Many are legal in the expect. Those which are not valid in the expect sequence are so indicated. .TP .B '' -Expects or sends a null string. If you send a null string then it will still -send the return character. This sequence may either be a pair of apostrophe +Expects or sends a null string. +If you send a null string then it will still +send the return character. +This sequence may either be a pair of apostrophe or quote characters. .TP .B \\\\b represents a backspace character. .TP .B \\\\c -Suppresses the newline at the end of the reply string. This is the only -method to send a string without a trailing return character. It must -be at the end of the send string. For example, +Suppresses the newline at the end of the reply string. +This is the only +method to send a string without a trailing return character. +It must +be at the end of the send string. +For example, the sequence hello\\c will simply send the characters h, e, l, l, o. .I (not valid in expect.) .TP .B \\\\d -Delay for one second. The program uses sleep(1) which will delay to a +Delay for one second. +The program uses sleep(1) which will delay to a maximum of one second. .I (not valid in expect.) .TP @@ -404,11 +469,13 @@ Insert a BREAK Send a newline or linefeed character. .TP .B \\\\N -Send a null character. The same sequence may be represented by \\0. +Send a null character. +The same sequence may be represented by \\0. .I (not valid in expect.) .TP .B \\\\p -Pause for a fraction of a second. The delay is 1/10th of a second. +Pause for a fraction of a second. +The delay is 1/10th of a second. .I (not valid in expect.) .TP .B \\\\q @@ -422,8 +489,10 @@ written to the log in its place. Send or expect a carriage return. .TP .B \\\\s -Represents a space character in the string. This may be used when it -is not desirable to quote the strings which contains spaces. The +Represents a space character in the string. +This may be used when it +is not desirable to quote the strings which contains spaces. +The sequence 'HI TIM' and HI\\sTIM are the same. .TP .B \\\\t @@ -446,22 +515,26 @@ The \fIchat\fR program will terminate with the following completion codes. .TP .B 0 -The normal termination of the program. This indicates that the script +The normal termination of the program. +This indicates that the script was executed without error to the normal conclusion. .TP .B 1 One or more of the parameters are invalid or an expect string was too -large for the internal buffers. This indicates that the program as not +large for the internal buffers. +This indicates that the program as not properly executed. .TP .B 2 -An error occurred during the execution of the program. This may be due +An error occurred during the execution of the program. +This may be due to a read or write operation failing for some reason or chat receiving a signal such as SIGINT. .TP .B 3 A timeout event occurred when there was an \fIexpect\fR string without -having a "-subsend" string. This may mean that you did not program the +having a "-subsend" string. +This may mean that you did not program the script correctly for the condition or that some unexpected event has occurred and the expected string could not be found. .TP @@ -482,16 +555,20 @@ The other termination codes are also strings marked as an \fIABORT\fR condition. .LP Using the termination code, it is possible to determine which event -terminated the script. It is possible to decide if the string "BUSY" +terminated the script. +It is possible to decide if the string "BUSY" was received from the modem as opposed to "NO DIAL TONE". While the first event may be retried, the second will probably have little chance of succeeding during a retry. .SH SEE ALSO Additional information about \fIchat\fR scripts may be found with UUCP -documentation. The \fIchat\fR script was taken from the ideas proposed +documentation. +The \fIchat\fR script was taken from the ideas proposed by the scripts used by the \fIuucico\fR program. .LP uucico(1), uucp(1), syslog(3), syslogd(8). .SH COPYRIGHT -The \fIchat\fR program is in public domain. This is not the GNU public -license. If it breaks then you get to keep both pieces. +The \fIchat\fR program is in public domain. +This is not the GNU public +license. +If it breaks then you get to keep both pieces. diff --git a/usr.bin/chpass/chpass.1 b/usr.bin/chpass/chpass.1 index 615751b..2722bb3 100644 --- a/usr.bin/chpass/chpass.1 +++ b/usr.bin/chpass/chpass.1 @@ -89,7 +89,8 @@ in the format used by .Xr crypt 3 , as an argument. .It Fl e Ar expiretime -Change the account expire time. This option is used to set the expire time +Change the account expire time. +This option is used to set the expire time from a script as if it was done in the interactive editor. .It Fl s Ar newshell Attempt to change the user's shell to @@ -259,7 +260,8 @@ Currently, can only make changes to the NIS passwd maps through .Xr rpc.yppasswdd 8 , which normally only permits changes to a user's password, shell and GECOS -fields. Except when invoked by the super-user on the NIS master server, +fields. +Except when invoked by the super-user on the NIS master server, .Nm (and, similarly, .Xr passwd 1 ) @@ -270,7 +272,8 @@ add new records to the NIS passwd maps. Furthermore, .Xr rpc.yppasswdd 8 requires password authentication before it will make any -changes. The only user allowed to submit changes without supplying +changes. +The only user allowed to submit changes without supplying a password is the super-user on the NIS master server; all other users, including those with root privileges on NIS clients (and NIS slave servers) must enter a password. @@ -308,7 +311,8 @@ change any field. .Em "Password authentication is required" . .Nm Chpass will prompt for the user's NIS password before effecting -any changes. If the password is invalid, all changes will be +any changes. +If the password is invalid, all changes will be discarded. .Pp Exception: the super-user on the NIS master server is allowed to @@ -345,7 +349,8 @@ Users should use .Xr passwd 1 or .Xr yppasswd 1 -to change their NIS passwords. The super-user is allowed to specify +to change their NIS passwords. +The super-user is allowed to specify a new password (even though the .Dq Password: field does not show @@ -381,20 +386,24 @@ Specify a particular NIS domain. .Nm Chpass uses the system domain name by default, as set by the .Xr domainname 1 -command. The +command. +The .Fl d option can be used to override a default, or to specify a domain when the system domain name is not set. .It Fl h Ar host -Specify the name or address of an NIS server to query. Normally, +Specify the name or address of an NIS server to query. +Normally, .Nm will communicate with the NIS master host specified in the .Pa master.passwd or .Pa passwd -maps. On hosts that have not been configured as NIS clients, there is +maps. +On hosts that have not been configured as NIS clients, there is no way for the program to determine this information unless the user -provides the hostname of a server. Note that the specified hostname need +provides the hostname of a server. +Note that the specified hostname need not be that of the NIS master server; the name of any server, master or slave, in a given NIS domain will do. .Pp @@ -422,7 +431,8 @@ domain socket). The .Fl o flag can be used to force .Nm -to use the standard update mechanism instead. This option is provided +to use the standard update mechanism instead. +This option is provided mainly for testing purposes. .El .Pp diff --git a/usr.bin/colldef/colldef.1 b/usr.bin/colldef/colldef.1 index 9f4f781..f36d0b4 100644 --- a/usr.bin/colldef/colldef.1 +++ b/usr.bin/colldef/colldef.1 @@ -43,12 +43,14 @@ into a format usable by the .Fn strxfrm and .Fn strcoll -functions. It is used to define the many ways in which +functions. +It is used to define the many ways in which strings can be ordered and collated. .Fn strxfrm transforms its first argument and places the result in its second -argument. The transformed string is such that it can be +argument. +The transformed string is such that it can be correctly ordered with other transformed strings by using .Fn strcmp , .Fn strncmp , @@ -89,18 +91,21 @@ and .Pp Of these, only the .Ar order -statement is required. When +statement is required. +When .Ar charmap or .Ar substitute is -supplied, these statements must be ordered as above. Any +supplied, these statements must be ordered as above. +Any statements after the order statement are ignored. .Pp Lines in the specification file beginning with a .Ar # are -treated as comments and are ignored. Blank lines are also +treated as comments and are ignored. +Blank lines are also ignored. .Pp .Ar charmap charmapfile @@ -112,7 +117,8 @@ character encoding can be found. .Pp The format of .Ar charmapfile -is shown below. Symbol +is shown below. +Symbol names are separated from their values by TAB or SPACE characters. symbol-value can be specified in a hexadecimal (\ex\fI??\fR) or octal (\e\fI???\fR) @@ -150,7 +156,8 @@ statement is optional. .Pp .Ar order_list is a list of symbols, separated by semi colons, that defines the -collating sequence. The +collating sequence. +The special symbol .Ar ... specifies, in a short-hand @@ -230,7 +237,8 @@ are assigned the same primary ordering only. .Pp The backslash character .Ar \e -is used for continuation. In this case, no characters are permitted +is used for continuation. +In this case, no characters are permitted after the backslash character. .Sh EXIT STATUS .Nm Colldef diff --git a/usr.bin/cut/cut.1 b/usr.bin/cut/cut.1 index e0e9a71..a71e7e1 100644 --- a/usr.bin/cut/cut.1 +++ b/usr.bin/cut/cut.1 @@ -66,7 +66,8 @@ standard output. The items specified by .Ar list can be in terms of column position or in terms of fields delimited -by a special character. Column numbering starts from 1. +by a special character. +Column numbering starts from 1. .Pp .Ar list is a comma or whitespace separated set of increasing numbers and/or diff --git a/usr.bin/du/du.1 b/usr.bin/du/du.1 index 9dd28ff..63fe0aa 100644 --- a/usr.bin/du/du.1 +++ b/usr.bin/du/du.1 @@ -122,7 +122,8 @@ If the environment variable .Ev BLOCKSIZE is set, and the .Fl k -option is not specified, the block counts will be displayed in 1024-byte blocks. If +option is not specified, the block counts will be displayed in 1024-byte blocks. +If .Ev BLOCKSIZE is not set, and the .Fl k diff --git a/usr.bin/fetch/fetch.1 b/usr.bin/fetch/fetch.1 index 919b559..b2b2ea0 100644 --- a/usr.bin/fetch/fetch.1 +++ b/usr.bin/fetch/fetch.1 @@ -27,7 +27,8 @@ either the .Tn FTP or the .Tn HTTP -protocol. In the first form of the command, the +protocol. +In the first form of the command, the .Ar URL may be of the form .Li http://site.domain/path/to/the/file @@ -108,7 +109,8 @@ Use the passive mode of the .Tn FTP protocol. This is useful for crossing certain sorts of firewalls. .It Fl q -Quiet mode. Do not report transfer progress on the terminal. +Quiet mode. +Do not report transfer progress on the terminal. .It Fl R The filenames specified are ``precious'', and should not be deleted under any circumstances, even if the transfer failed or was incomplete. @@ -128,7 +130,8 @@ This option is useful to prevent from downloading a file that is either incomplete or the wrong version, given the correct size of the file in advance. .It Fl s -Ask server for size of file in bytes and print it to stdout. Do not +Ask server for size of file in bytes and print it to stdout. +Do not actually fetch the file. .It Fl T Ar seconds Set timeout value to diff --git a/usr.bin/file/file.1 b/usr.bin/file/file.1 index bff4b99..e4cef28 100644 --- a/usr.bin/file/file.1 +++ b/usr.bin/file/file.1 @@ -330,7 +330,8 @@ from his public-domain program, and are not covered by the above restrictions. .Sh BUGS There must be a better way to automate the construction of the Magic -file from all the glop in Magdir. What is it? +file from all the glop in Magdir. +What is it? Better yet, the magic file should be compiled into binary (say, .Xr ndbm 3 or, better yet, fixed-length diff --git a/usr.bin/file/magic.5 b/usr.bin/file/magic.5 index 12923ac..30cfff1 100644 --- a/usr.bin/file/magic.5 +++ b/usr.bin/file/magic.5 @@ -96,7 +96,8 @@ that are set in the specified value, to specify that the value from the file must have clear any of the bits that are set in the specified value, or .Em x , -to specify that any value will match. If the character is omitted, +to specify that any value will match. +If the character is omitted, it is assumed to be .Em = . .It "" @@ -158,21 +159,27 @@ is a .Em ( then the string after the parenthesis is interpreted as an indirect offset. That means that the number after the parenthesis is used as an offset in -the file. The value at that offset is read, and is used again as an offset -in the file. Indirect offsets are of the form: +the file. +The value at that offset is read, and is used again as an offset +in the file. +Indirect offsets are of the form: .Em (x[.[bsl]][+-][y]) . The value of .Em x -is used as an offset in the file. A byte, short or long is read at that offset +is used as an offset in the file. +A byte, short or long is read at that offset depending on the .Em [bsl] -type specifier. To that number the value of +type specifier. +To that number the value of .Em y -is added and the result is used as an offset in the file. The default type +is added and the result is used as an offset in the file. +The default type if one is not specified is long. .Pp Sometimes you do not know the exact offset as this depends on the length of -preceding fields. You can specify an offset relative to the end of the +preceding fields. +You can specify an offset relative to the end of the last uplevel field (of course this may only be done for sublevel tests, i.e. test beginning with .Em > Ns ). diff --git a/usr.bin/finger/finger.1 b/usr.bin/finger/finger.1 index 4fa1860..68306b8 100644 --- a/usr.bin/finger/finger.1 +++ b/usr.bin/finger/finger.1 @@ -55,7 +55,8 @@ Options are: displays 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. If +phone number, or the remote host. +If .Fl h is given, the remote host is printed (the default). If .Fl o diff --git a/usr.bin/gcore/gcore.1 b/usr.bin/gcore/gcore.1 index ed3d0d6..7efe6ff 100644 --- a/usr.bin/gcore/gcore.1 +++ b/usr.bin/gcore/gcore.1 @@ -53,7 +53,8 @@ By default, the core is written to the file .Dq Pa core.<pid> . The process identifier, .Ar pid , -must be given on the command line. If no executable image is +must be given on the command line. +If no executable image is specified, .Nm will use diff --git a/usr.bin/genassym/genassym.8 b/usr.bin/genassym/genassym.8 index 8ee2581..60a3b83 100644 --- a/usr.bin/genassym/genassym.8 +++ b/usr.bin/genassym/genassym.8 @@ -16,12 +16,14 @@ The .Nm command is a special-purpose program to generate assembler symbols from C code and is used to interface the low-level -assembly code with the C code. This, for example, is used +assembly code with the C code. +This, for example, is used to build a FreeBSD kernel or module. Its .Ar objfile argument is the name of an ELF object file that holds the -symbol definitions. These definitions are extracted from +symbol definitions. +These definitions are extracted from the object file and written to standard output or to the file specified with .Ar outfile , @@ -33,7 +35,8 @@ command only extracts symbols from the object file if they are prefixed by .Nm assym_ and are global data types, whose value is the value given -to the symbol. The following C declaration +to the symbol. +The following C declaration .Bd -literal -offset indent -compact int assym_MY_SYMBOL = 3; .Ed @@ -57,10 +60,12 @@ and was based on the command. .Sh BUGS Not all linkers store the size of the symbol in the ELF -object file. The GNU linker for Alpha has this bug for +object file. +The GNU linker for Alpha has this bug for example (binutils 2.9.1). In those cases the size of the symbol is assumed to be equal to the word size of the ELF -object file. For Alpha this is 64 bits and for i386 this +object file. +For Alpha this is 64 bits and for i386 this is 32 bits. .Sh HISTORY The diff --git a/usr.bin/getopt/getopt.1 b/usr.bin/getopt/getopt.1 index 80e51d7..72ae418 100644 --- a/usr.bin/getopt/getopt.1 +++ b/usr.bin/getopt/getopt.1 @@ -96,7 +96,8 @@ status > 0 when it encounters an option letter not included in Written by .An Henry Spencer , working from a Bell Labs manual page. -Behavior believed identical to the Bell version. Example changed in +Behavior believed identical to the Bell version. +Example changed in .Fx version 3.2 and 4.0. .Sh BUGS diff --git a/usr.bin/gprof/gprof.1 b/usr.bin/gprof/gprof.1 index df83a70..b251def 100644 --- a/usr.bin/gprof/gprof.1 +++ b/usr.bin/gprof/gprof.1 @@ -62,7 +62,8 @@ that are compiled for profiling. reads the given object file (the default is .Pa a.out) and establishes the relation between it's symbol table -and the call graph profile. The default graph profile file name is the name +and the call graph profile. +The default graph profile file name is the name of the executable with the suffix .Pa .gmon appended. diff --git a/usr.bin/keyinit/keyinit.1 b/usr.bin/keyinit/keyinit.1 index ee3dba1..13a545c 100644 --- a/usr.bin/keyinit/keyinit.1 +++ b/usr.bin/keyinit/keyinit.1 @@ -15,7 +15,8 @@ .Nm Keyinit initializes the system so you can use S/Key one-time passwords to login. The program will ask you to enter a secret pass phrase; enter a -phrase of several words in response. After the S/Key database has been +phrase of several words in response. +After the S/Key database has been updated you can login using either your regular UNIX password or using S/Key one-time passwords. .Pp @@ -32,8 +33,10 @@ command and carry them with you on a piece of paper. .Pp .Nm Keyinit requires you to type your secret password, so it should -be used only on a secure terminal. For example, on the console of a -workstation. If you are using +be used only on a secure terminal. +For example, on the console of a +workstation. +If you are using .Nm while logged in over an untrusted network, follow the instructions given below with the @@ -64,7 +67,8 @@ in one window and put in your count and seed then run .Nm key in another window to generate the correct 6 English words -for that count and seed. You can then +for that count and seed. +You can then "cut" and "paste" them or copy them into the .Nm window. diff --git a/usr.bin/keylogin/keylogin.1 b/usr.bin/keylogin/keylogin.1 index 501d002..656e22e 100644 --- a/usr.bin/keylogin/keylogin.1 +++ b/usr.bin/keylogin/keylogin.1 @@ -15,7 +15,8 @@ prompts the user for their login password, and uses it to decrypt the user's secret key stored in the .Xr publickey 5 -database. Once decrypted, the user's key is stored by the local +database. +Once decrypted, the user's key is stored by the local key server process .Xr keyserv 8 to be used by any secure network services, such as NFS. diff --git a/usr.bin/last/last.1 b/usr.bin/last/last.1 index 27be940..2bdfc50 100644 --- a/usr.bin/last/last.1 +++ b/usr.bin/last/last.1 @@ -98,7 +98,8 @@ arguments is printed, e.g., .Dq Li "last root -t console" would list all of .Dq Li root Ns 's -sessions as well as all sessions on the console terminal. If no +sessions as well as all sessions on the console terminal. +If no users, hostnames or terminals are specified, .Nm last prints a record of @@ -128,7 +129,8 @@ login data base .Xr ac 8 .Sh BUGS If a login shell should terminate abnormally for some reason, it is likely -that a logout record won't be written to the wtmp file. In this case, +that a logout record won't be written to the wtmp file. +In this case, .Nm last will indicate the logout time as "shutdown". .Sh HISTORY diff --git a/usr.bin/ldd/ldd.1 b/usr.bin/ldd/ldd.1 index 6c16eef..9920746 100644 --- a/usr.bin/ldd/ldd.1 +++ b/usr.bin/ldd/ldd.1 @@ -21,11 +21,13 @@ depend on yet other shared objects. .Pp Zero, one or two .Fl f -options may be given. The argument is a format string passed to +options may be given. +The argument is a format string passed to .Xr rtld 1 and allows customization of .Nm ldd Ns 's -output. See +output. +See .Xr rtld 1 for a list of recognized conversion characters. .Pp diff --git a/usr.bin/locate/locate/locate.1 b/usr.bin/locate/locate/locate.1 index be14387..57aac3a 100644 --- a/usr.bin/locate/locate/locate.1 +++ b/usr.bin/locate/locate/locate.1 @@ -85,7 +85,8 @@ current implementation store any character except newline and NUL .Pq Sq \e0 . The 8-bit character support doesn't waste extra space for -plain ASCII file names. Characters less than 32 or greater than 127 +plain ASCII file names. +Characters less than 32 or greater than 127 are stored in 2 bytes. The following options are available: @@ -107,7 +108,8 @@ of databases to be searched. The option .Ar database -may be a colon-separated list of databases. A single colon is a reference +may be a colon-separated list of databases. +A single colon is a reference to the default database. $ locate -d $HOME/lib/mydb: foo @@ -164,7 +166,8 @@ Use .Xr mmap 2 instead of the .Xr stdio 3 -library. This is the default behavior. Usually faster in most cases. +library. This is the default behavior. +Usually faster in most cases. .It Fl s Use the .Xr stdio 3 @@ -223,14 +226,16 @@ which are not readable for user group .Dq nobody , or -world. E.g. if your HOME directory is not world-readable, all your +world. +E.g. if your HOME directory is not world-readable, all your files are .Ar not in the database. The .Nm -database is not byte order independent. It is not possible +database is not byte order independent. +It is not possible to share the databases between machines with different byte order. The current .Nm diff --git a/usr.bin/login/login.access.5 b/usr.bin/login/login.access.5 index 500eb3a..f9f0eb5 100644 --- a/usr.bin/login/login.access.5 +++ b/usr.bin/login/login.access.5 @@ -26,7 +26,8 @@ Each line of the login access control table has three fields separated by a ":" character: permission : users : origins .Pp The first field should be a "+" (access granted) or "-" (access denied) -character. The second field should be a list of one or more login names, +character. +The second field should be a list of one or more login names, group names, or ALL (always matches). The third field should be a list of one or more tty names (for non-networked logins), host names, domain names (begin with "."), host addresses, internet network numbers (end @@ -37,7 +38,8 @@ in host or user patterns. The EXCEPT operator makes it possible to write very compact rules. .Pp The group file is searched only when a name does not match that of the -logged-in user. Only groups are matched in which users are explicitly +logged-in user. +Only groups are matched in which users are explicitly listed: the program does not look at a user's primary group id value. .Sh FILES .Bl -tag -width /etc/login.access -compact diff --git a/usr.bin/mail/mail.1 b/usr.bin/mail/mail.1 index a76a190..5768456 100644 --- a/usr.bin/mail/mail.1 +++ b/usr.bin/mail/mail.1 @@ -1037,7 +1037,8 @@ Help files. .It Pa /usr/share/misc/mail.rc .It Pa /usr/local/etc/mail.rc .It Pa /etc/mail.rc -System-wide initialization files. Each file will be sourced, in order, +System-wide initialization files. +Each file will be sourced, in order, if it exists. .El .Sh SEE ALSO diff --git a/usr.bin/make/make.1 b/usr.bin/make/make.1 index ee9b7e5..515ceca 100644 --- a/usr.bin/make/make.1 +++ b/usr.bin/make/make.1 @@ -108,7 +108,8 @@ Print debugging information about conditional evaluation. .It Ar d Print debugging information about directory searching and caching. .It Ar f -Print debugging information about the execution of for loops. Currently a +Print debugging information about the execution of for loops. +Currently a no-op. .It Ar "g1" Print the input graph before making anything. @@ -157,7 +158,8 @@ before each command line in the makefile. .It Fl j Ar max_jobs Specify the maximum number of jobs that .Nm -may have running at any one time. Turns compatibility mode off, unless the +may have running at any one time. +Turns compatibility mode off, unless the .Ar B flag is also specified. .It Fl k @@ -497,7 +499,8 @@ The environment variable may contain anything that may be specified on .Nm make Ns 's -command line. Its contents are stored in +command line. +Its contents are stored in .Nm make Ns 's .Va .MAKEFLAGS variable. @@ -671,7 +674,8 @@ do not contain the pattern matching character .Ar % then it is assumed that they are anchored at the end of each word, so only suffixes or entire -words may be replaced. Otherwise +words may be replaced. +Otherwise .Ar % is the substring of .Ar old_string @@ -701,7 +705,8 @@ makefile directory. Un-define the specified global variable. Only global variables may be un-defined. .It Ic \&.error Ar message -Terminate processing of the makefile immediately. The filename of the +Terminate processing of the makefile immediately. +The filename of the makefile, the line on which the error was encountered and the specified message are printed to standard output and .Nm make @@ -912,7 +917,8 @@ The syntax of a for loop is: .El After the for .Ar expression -is evaluated, it is split into words. The +is evaluated, it is split into words. +The iteration .Ar variable is successively set to each word, and substituted in the @@ -974,7 +980,8 @@ to them. If special .Ic .WAIT source is appears in a dependency line, the sources that precede it are -made before the sources that succeed it in the line. Loops are not being +made before the sources that succeed it in the line. +Loops are not being detected and targets that form loops will be silently ignored. .El .Sh "SPECIAL TARGETS" @@ -1010,7 +1017,8 @@ If no sources are specified, this is the equivalent of specifying the option. .It Ic .INCLUDES A list of suffixes that indicate files that can be included in a source -file. The suffix must have already been declared with +file. +The suffix must have already been declared with .Ic .SUFFIXES ; any suffix so declared will have the directories on its search path (see .Ic .PATH ) @@ -1083,7 +1091,8 @@ to work. .It Ic .PHONY Apply the .Ic .PHONY -attribute to any specified sources. Targets with this attribute are always +attribute to any specified sources. +Targets with this attribute are always considered to be out of date. .It Ic .PRECIOUS Apply the @@ -1173,7 +1182,8 @@ special target exists. .Pp The evaluation of .Ar expression -in a test is very simple-minded. Currently, the only form that works is +in a test is very simple-minded. +Currently, the only form that works is .Ql .if ${VAR} op something For instance, you should write tests as .Ql .if ${VAR} = "string" diff --git a/usr.bin/mkstr/mkstr.1 b/usr.bin/mkstr/mkstr.1 index 9486c8c..c13fd49 100644 --- a/usr.bin/mkstr/mkstr.1 +++ b/usr.bin/mkstr/mkstr.1 @@ -129,7 +129,8 @@ appeared in .Sh BUGS .Nm was intended for the limited architecture of the PDP 11 family. -Very few programs actually use it. The Pascal interpreter, +Very few programs actually use it. +The Pascal interpreter, .Xr \&pi 1 and the editor, .Xr \&ex 1 diff --git a/usr.bin/mktemp/mktemp.1 b/usr.bin/mktemp/mktemp.1 index 98aab7e..586faad 100644 --- a/usr.bin/mktemp/mktemp.1 +++ b/usr.bin/mktemp/mktemp.1 @@ -89,7 +89,8 @@ will generate an template string based on the .Ar prefix and the .Ev TMPDIR -environment variable if set. The default location if +environment variable if set. +The default location if .Ev TMPDIR is not set is .Pa /tmp . diff --git a/usr.bin/more/more.1 b/usr.bin/more/more.1 index a01b837..dc78923 100644 --- a/usr.bin/more/more.1 +++ b/usr.bin/more/more.1 @@ -135,7 +135,8 @@ The .Fl x option sets tab stops every .Ar N -positions. The default for +positions. +The default for .Ar N is 8. .It Fl / diff --git a/usr.bin/msgs/msgs.1 b/usr.bin/msgs/msgs.1 index 3139f00..eea9e20 100644 --- a/usr.bin/msgs/msgs.1 +++ b/usr.bin/msgs/msgs.1 @@ -87,7 +87,8 @@ the next time will pick up where it last left off. .It Fl s Append the current message to the file ``Messages'' in the current directory; -`s\-' will save the previously displayed message. A `s' or `s\-' may +`s\-' will save the previously displayed message. +A `s' or `s\-' may be followed by a space and a file name to receive the message replacing the default ``Messages''. .It Fl m diff --git a/usr.bin/mt/mt.1 b/usr.bin/mt/mt.1 index 5647313..60ff707 100644 --- a/usr.bin/mt/mt.1 +++ b/usr.bin/mt/mt.1 @@ -94,17 +94,22 @@ Backward space .Ar count setmarks. .It Cm rdhpos -Read Hardware block position. Some drives do not support this. The block -number reported is specific for that hardware only. The count argument is +Read Hardware block position. Some drives do not support this. +The block +number reported is specific for that hardware only. +The count argument is ignored. .It Cm rdspos -Read SCSI logical block position. Some drives do not support this. The +Read SCSI logical block position. Some drives do not support this. +The count argument is ignored. .It Cm sethpos -Set Hardware block position. Some drives do not support this. The count +Set Hardware block position. Some drives do not support this. +The count argument is interpreted as a hardware block to which to position the tape. .It Cm setspos -Set SCSI logical block position. Some drives do not support this. The count +Set SCSI logical block position. Some drives do not support this. +The count argument is interpreted as a SCSI logical block to which to position the tape. .It Cm rewind Rewind the tape @@ -119,20 +124,26 @@ A count of 0 disables long erase, which is on by default. Re-tension the tape (one full wind forth and back, Count is ignored). .It Cm status -Print status information about the tape unit. For SCSI magnetic tape devices, +Print status information about the tape unit. +For SCSI magnetic tape devices, the current operating modes of density, blocksize, and whether compression -is enabled is reported. The current state of the driver (what it thinks that -it is doing with the device) is reported. If the driver knows the relative -position from BOT (in terms of filemarks and records), it prints that. Note +is enabled is reported. +The current state of the driver (what it thinks that +it is doing with the device) is reported. +If the driver knows the relative +position from BOT (in terms of filemarks and records), it prints that. +Note that this information is not definitive (only BOT, End of Recorded Media, and hardware or SCSI logical block position (if the drive supports such) are considered definitive tape positions). .It Cm errstat -Print (and clear) error status information about this device. For every normal +Print (and clear) error status information about this device. +For every normal operation (e.g., a read or a write) and every control operation (e.g,, a rewind), the driver stores up the last command executed and it's associated status and any residual counts (if any). This command retrieves and prints this -information. If possible, this also clears any latched error information. +information. +If possible, this also clears any latched error information. .It Cm blocksize Set the block size for the tape unit. Zero means variable-length blocks. @@ -147,18 +158,21 @@ given string and the resulting canonical density name do not match exactly, an informational message is printed about what the given string has been taken for. .It Cm geteotmodel -Fetch and print out the current EOT filemark model. The model states how +Fetch and print out the current EOT filemark model. +The model states how many filemarks will be written at close if a tape was being written. .It Cm seteotmodel Set (from the .Ar count argument) -and print out the current and EOT filemark model. Typically this will be +and print out the current and EOT filemark model. +Typically this will be .Ar 2 filemarks, but some devices (typically QIC cartridge drives) can only write .Ar 1 -filemark. Currently you can only choose a value of +filemark. +Currently you can only choose a value of .Ar 1 or .Ar 2 . @@ -282,7 +296,7 @@ NOTES 2. Parallel recorded. 3. Old format known as QIC-11. 5. Helical scan. -6. This is not an American National Standard. The reference is based on +6. This is not an American National Standard. The reference is based on an industry standard definition of the media format. .Ed diff --git a/usr.bin/ncplist/ncplist.1 b/usr.bin/ncplist/ncplist.1 index 96c9f1e..af650e1 100644 --- a/usr.bin/ncplist/ncplist.1 +++ b/usr.bin/ncplist/ncplist.1 @@ -12,7 +12,8 @@ .Sh DESCRIPTION The .Nm -command used to display state of ncplib and NetWare servers. First argument +command used to display state of ncplib and NetWare servers. +First argument are one letter .Ar command following by optional @@ -57,7 +58,8 @@ Displays mounted volumes on given .Sh FILES .Bl -tag -width /var/log/wtmp -compact .It Pa ~/.nwfsrc -keeps description for each connection. See +keeps description for each connection. +See .Pa /usr/share/examples/nwclient/dot.nwfsrc for details. diff --git a/usr.bin/ncplogin/ncplogin.1 b/usr.bin/ncplogin/ncplogin.1 index e17b4d7..eacd12b 100644 --- a/usr.bin/ncplogin/ncplogin.1 +++ b/usr.bin/ncplogin/ncplogin.1 @@ -26,15 +26,19 @@ .Sh DESCRIPTION Connections to a NetWare server can be created and used independently from .Xr mount_nwfs 8 -command. Connection can be created by any user. Each user can have multiple +command. Connection can be created by any user. +Each user can have multiple connections, but NetWareServer:NetWareUser pair should be unique. .Pp The .Nm ncplogin -command used to create permanent connection to a NetWare server. Permanent -connection will stay connected even if no applications use it. This allows +command used to create permanent connection to a NetWare server. +Permanent +connection will stay connected even if no applications use it. +This allows user to run different ncp* programs without specifying file server and user -to use. This connection can be destroyed by +to use. +This connection can be destroyed by .Xr ncplogout 1 command. .Pp @@ -52,7 +56,8 @@ syntax. The options are: .Bl -tag -width indent .It Fl S Ar server -name of NetWare server to connect. This affect only IPX severs for native IP +name of NetWare server to connect. +This affect only IPX severs for native IP see .Fl A option. @@ -65,8 +70,10 @@ parameter. .It Fl C don't convert password to uppercase. .It Fl D -Marks connection as primary. Can be used to modify already established -connection. Only +Marks connection as primary. +Can be used to modify already established +connection. +Only .Nm program accept that option. .It Fl I Ar signature_level @@ -81,7 +88,8 @@ Value Meaning .Ed Please note that only packet headers signing are implemented. .It Fl M Ar mode -Just like files connections can be shared by users. The bits in +Just like files connections can be shared by users. +The bits in .Ar mode argument behaves much like file permissions: .Bd -literal -offset indent @@ -91,50 +99,62 @@ Mask Meaning 1 EXECUTE - user allowed to execute requests. .Ed By default connection created with mode 0700 and only owner can do -anything with it. If you want to share the connection, for example with group -you may specify 0750 value. This means group can do NCP request, but can't -destroy connection. When user doesn't explicitly specify server to use, ncp* +anything with it. +If you want to share the connection, for example with group +you may specify 0750 value. +This means group can do NCP request, but can't +destroy connection. +When user doesn't explicitly specify server to use, ncp* programs try to find suitable connection in the next order: .Pp -1. Try to find connection owned by user. If there is more than one such -connection it try to figure out which is primary. Primary flag controlled +1. Try to find connection owned by user. +If there is more than one such +connection it try to figure out which is primary. +Primary flag controlled by .Fl D option. .Pp 2. If previous fail, first shared connection will be used. .It Fl N -don't ask for a password. While loading +don't ask for a password. +While loading .Nm reads ~/.nwfsrc file to get additional configuration parameters and -password. If no password found for the specified SERVER:USER pair, +password. +If no password found for the specified SERVER:USER pair, .Nm prompts for it. .It Fl O Just like files, connection has .Ar owner and .Ar group -attributes. Newly created connection takes +attributes. +Newly created connection takes .Ar owner parameter from creator's userid and .Ar group paramter from creator's primary group. -This can be overrided with this option. Only superuser can override an +This can be overrided with this option. +Only superuser can override an .Ar owner parameter. .It Fl P Marks connection as permanent. .Nm -always create permanent connection. This option can be used in other ncp* +always create permanent connection. +This option can be used in other ncp* programs. .It Fl R Ar retry_count -specifies number of retries before drop the connection. The default value is 10. +specifies number of retries before drop the connection. +The default value is 10. Note: after connection marked 'BAD' each request will try to restore it. This process restore only NCP connection, but do not reopen any opened files. .It Fl W Ar timeout -This specifies server request timeout in seconds. The default is 5 seconds. +This specifies server request timeout in seconds. +The default is 5 seconds. .It Ar /server:user This syntax provided for the sake of simplicity and mutually exclusive with .Fl S @@ -145,12 +165,14 @@ options. .Sh FILES .Bl -tag -width /var/log/wtmp -compact .It Pa ~/.nwfsrc -keeps static parameters for connections and other information. See +keeps static parameters for connections and other information. +See .Pa /usr/share/examples/nwclient/dot.nwfsrc for details. .Sh NOTES -Low level connection management performed by ncp.ko module. For an IPX +Low level connection management performed by ncp.ko module. +For an IPX protocol it is also necessary to load IPXrouted program. .Sh BUGS diff --git a/usr.bin/ncplogin/ncplogout.1 b/usr.bin/ncplogin/ncplogout.1 index cd83d10..d83cd22 100644 --- a/usr.bin/ncplogin/ncplogout.1 +++ b/usr.bin/ncplogin/ncplogout.1 @@ -18,20 +18,25 @@ The .Nm will shedule connection created by .Xr ncplogin 1 -command to close. If connection is busy (i.e. used by other processes) it will -be closed when last process terminated. This command is similar to DOS +command to close. +If connection is busy (i.e. used by other processes) it will +be closed when last process terminated. +This command is similar to DOS logout.exe command. .Pp The options are: .Bl -tag -width indent .It Fl S Ar server -name of Netware server to identify connection. Can be omitted if there is only +name of Netware server to identify connection. +Can be omitted if there is only one connection active. .It Fl U Ar user -name of user used to identify connection. Can be omitted if there is only +name of user used to identify connection. +Can be omitted if there is only one connection active. .It Fl c Ar handle -close connection by handle. List of available handles can be obtained via +close connection by handle. +List of available handles can be obtained via .Bd -literal -offset indent ncplist c .Ed diff --git a/usr.bin/netstat/netstat.1 b/usr.bin/netstat/netstat.1 index 680a0be..0125772 100644 --- a/usr.bin/netstat/netstat.1 +++ b/usr.bin/netstat/netstat.1 @@ -198,7 +198,8 @@ or .Ar protocol, respectively. .It Fl L -Show the size of the various listen queues. The first count shows the +Show the size of the various listen queues. +The first count shows the number of unaccepted connections. The second count shows the amount of unaccepted incomplete connections. The third count is the maximum number of queued connections. diff --git a/usr.bin/passwd/passwd.1 b/usr.bin/passwd/passwd.1 index 383674b..707d934 100644 --- a/usr.bin/passwd/passwd.1 +++ b/usr.bin/passwd/passwd.1 @@ -110,13 +110,15 @@ The super-user is not required to provide a user's current password if only the local password is modified. .Sh NIS INTERACTION .Nm Passwd -has built-in support for NIS. If a user exists in the NIS password +has built-in support for NIS. +If a user exists in the NIS password database but does not exist locally, .Nm passwd automatically switches into .if t ``yppasswd'' .if n "yppasswd" -mode. If the specified +mode. +If the specified user does not exist in either the local password database of the NIS password maps, .Nm passwd @@ -129,9 +131,11 @@ daemon requires the original password before it will allow any changes to the NIS password maps). This restriction applies even to the super-user, with one important exception: the password authentication is -bypassed for the super-user on the NIS master server. This means that +bypassed for the super-user on the NIS master server. +This means that the super-user on the NIS master server can make unrestricted changes to -anyone's NIS password. The super-user on NIS client systems and NIS slave +anyone's NIS password. +The super-user on NIS client systems and NIS slave servers still needs to provide a password before the update will be processed. .Pp The following additional options are supported for use with NIS: @@ -151,7 +155,8 @@ flag can be used to force into .if t ``local only'' .if n "local only" -mode. This flag can be used to change the entry +mode. +This flag can be used to change the entry for a local user when an NIS user exists with the same login name. For example, you will sometimes find entries for system .if t ``placeholder'' @@ -160,28 +165,35 @@ users such as .Pa bin or .Pa daemon -in both the NIS password maps and the local user database. By +in both the NIS password maps and the local user database. +By default, .Nm passwd -will try to change the NIS password. The +will try to change the NIS password. +The .Fl l flag can be used to change the local password instead. .It Fl d Ar domain -Specify what domain to use when changing an NIS password. By default, +Specify what domain to use when changing an NIS password. +By default, .Nm passwd -assumes that the system default domain should be used. This flag is +assumes that the system default domain should be used. +This flag is primarily for use by the superuser on the NIS master server: a single -NIS server can support multiple domains. It is also possible that the +NIS server can support multiple domains. +It is also possible that the domainname on the NIS master may not be set (it is not necessary for an NIS server to also be a client) in which case the .Nm passwd command needs to be told what domain to operate on. .It Fl s Ar host -Specify the name of an NIS server. This option, in conjunction +Specify the name of an NIS server. +This option, in conjunction with the .Fl d option, can be used to change an NIS password on a non-local NIS -server. When a domain is specified with the +server. +When a domain is specified with the .Fl d option and .Nm passwd @@ -192,14 +204,16 @@ be .if n "localhost". This can be overidden with the .Fl s -flag. The specified hostname need not be the name of an NIS master: the +flag. +The specified hostname need not be the name of an NIS master: the name of the NIS master for a given map can be determined by querying any NIS server (master or slave) in a domain, so specifying the name of a slave server will work equally well. .Pp .It Fl o Do not automatically override the password authentication checks for the -super-user on the NIS master server; assume 'old' mode instead. This +super-user on the NIS master server; assume 'old' mode instead. +This flag is of limited practical use but is useful for testing. .El .Sh FILES diff --git a/usr.bin/pr/pr.1 b/usr.bin/pr/pr.1 index 85d011c..3956227 100644 --- a/usr.bin/pr/pr.1 +++ b/usr.bin/pr/pr.1 @@ -159,7 +159,8 @@ This option requires the use of the .Fl column option. .It Fl d -Produce output that is double spaced. An extra +Produce output that is double spaced. +An extra .Em <newline> character is output following every .Em <newline> @@ -266,7 +267,8 @@ output. If .Ar char (any nondigit character) is given, it is appended to the line number to -separate it from whatever follows. The default for +separate it from whatever follows. +The default for .Ar char is a .Em <tab> . diff --git a/usr.bin/printenv/printenv.1 b/usr.bin/printenv/printenv.1 index 18f76ee..72bacfc 100644 --- a/usr.bin/printenv/printenv.1 +++ b/usr.bin/printenv/printenv.1 @@ -79,7 +79,8 @@ The options are as follows: .It Fl i Execute the .Ar command -with only those environment values specified. The environment inherited +with only those environment values specified. +The environment inherited by .Nm env is ignored completely. diff --git a/usr.bin/rdist/rdist.1 b/usr.bin/rdist/rdist.1 index 9e265b0..f789b1d 100644 --- a/usr.bin/rdist/rdist.1 +++ b/usr.bin/rdist/rdist.1 @@ -90,7 +90,8 @@ If no names are specified on the command line, will update all of the files and directories listed in .Ar distfile . Otherwise, the argument is taken to be the name of a file to be updated -or the label of a command to execute. If label and file names conflict, +or the label of a command to execute. +If label and file names conflict, it is assumed to be a label. These may be used together to update specific files using specific commands. @@ -141,7 +142,8 @@ option is used to define or override variable definitions in the can be the empty string, one name, or a list of names surrounded by parentheses and separated by tabs and/or spaces. .It Fl h -Follow symbolic links. Copy the file that the link points to rather than the +Follow symbolic links. +Copy the file that the link points to rather than the link itself. .It Fl i Ignore unresolved links. @@ -149,42 +151,53 @@ Ignore unresolved links. will normally try to maintain the link structure of files being transferred and warn the user if all the links cannot be found. .It Fl m Ar host -Limit which machines are to be updated. Multiple +Limit which machines are to be updated. +Multiple .Fl m arguments can be given to limit updates to a subset of the hosts listed in the .Ar distfile . .It Fl n -Print the commands without executing them. This option is +Print the commands without executing them. +This option is useful for debugging .Ar distfile . .It Fl q -Quiet mode. Files that are being modified are normally -printed on standard output. The +Quiet mode. +Files that are being modified are normally +printed on standard output. +The .Fl q option suppresses this. .It Fl R -Remove extraneous files. If a directory is being updated, any files that exist +Remove extraneous files. +If a directory is being updated, any files that exist on the remote host that do not exist in the master directory are removed. This is useful for maintaining truly identical copies of directories. .It Fl v -Verify that the files are up to date on all the hosts. Any files +Verify that the files are up to date on all the hosts. +Any files that are out of date will be displayed but no files will be changed nor any mail sent. .It Fl w -Whole mode. The whole file name is appended to the destination directory -name. Normally, only the last component of a name is used when renaming files. +Whole mode. +The whole file name is appended to the destination directory +name. +Normally, only the last component of a name is used when renaming files. This will preserve the directory structure of the files being -copied instead of flattening the directory structure. For example, +copied instead of flattening the directory structure. +For example, renaming a list of files such as ( dir1/f1 dir2/f2 ) to dir3 would create files dir3/dir1/f1 and dir3/dir2/f2 instead of dir3/f1 and dir3/f2. .It Fl y -Younger mode. Files are normally updated if their +Younger mode. +Files are normally updated if their .Ar mtime and .Ar size (see .Xr stat 2 ) -disagree. The +disagree. +The .Fl y option causes .Nm @@ -199,7 +212,8 @@ Debug mode. .Ar Distfile contains a sequence of entries that specify the files to be copied, the destination hosts, and what operations to perform -to do the updating. Each entry has one of the following formats. +to do the updating. +Each entry has one of the following formats. .Pp .Bd -literal -offset indent -compact <variable name> `=' <name list> @@ -223,10 +237,12 @@ copied. Each file in the source list is added to a list of changes if the file is out of date on the host which is being updated (second format) or the file is newer than the time stamp file (third format). .Pp -Labels are optional. They are used to identify a command for partial updates. +Labels are optional. +They are used to identify a command for partial updates. .Pp Newlines, tabs, and blanks are only used as separators and are -otherwise ignored. Comments begin with `#' and end with a newline. +otherwise ignored. +Comments begin with `#' and end with a newline. .Pp Variables to be expanded begin with `$' followed by one character or a name enclosed in curly braces (see the examples at the end). diff --git a/usr.bin/rpcgen/rpcgen.1 b/usr.bin/rpcgen/rpcgen.1 index da53e44..d31648d 100644 --- a/usr.bin/rpcgen/rpcgen.1 +++ b/usr.bin/rpcgen/rpcgen.1 @@ -87,7 +87,8 @@ dispatch table in .Pp .Nm Rpcgen can also generate sample client and server files -that can be customized to suit a particular application. The +that can be customized to suit a particular application. +The .Fl \&Sc , .Fl \&Ss and @@ -95,7 +96,8 @@ and options generate sample client, server and makefile, respectively. The .Fl a -option generates all files, including sample files. If the +option generates all files, including sample files. +If the .Ar infile is .Pa proto.x , @@ -286,7 +288,8 @@ header which supports dispatch tables. .It Fl i Ar size Size at which to start generating inline code. -This option is useful for optimization. The default size is 5. +This option is useful for optimization. +The default size is 5. .Pp Note: in order to provide backwards compatibility with the older .Nm @@ -371,8 +374,10 @@ and for users who need to write their own routine to do initialization. .It Fl M Generate multithread-safe stubs for passing arguments and results between -rpcgen generated code and user written code. This option is useful -for users who want to use threads in their code. However, the +rpcgen generated code and user written code. +This option is useful +for users who want to use threads in their code. +However, the .Xr rpc_svc_calls 3 functions are not yet MT-safe, which means that rpcgen generated server-side code will not be MT-safe. diff --git a/usr.bin/rusers/rusers.1 b/usr.bin/rusers/rusers.1 index 05044f5..733b55e 100644 --- a/usr.bin/rusers/rusers.1 +++ b/usr.bin/rusers/rusers.1 @@ -48,9 +48,11 @@ The command produces output similar to .Xr who , but for the list of hosts or all machines on the local -network. For each host responding to the rusers query, +network. +For each host responding to the rusers query, the hostname with the names of the users currently logged -on is printed on each line. The rusers command will wait for +on is printed on each line. +The rusers command will wait for one minute to catch late responders. .Pp The following options are available: @@ -58,7 +60,8 @@ The following options are available: .It Fl a Print all machines responding even if no one is currently logged in. .It Fl l -Print a long format listing. This includes the user name, host name, +Print a long format listing. +This includes the user name, host name, tty that the user is logged in to, the date and time the user logged in, the amount of time since the user typed on the keyboard, and the remote host they logged in from (if applicable). diff --git a/usr.bin/rwall/rwall.1 b/usr.bin/rwall/rwall.1 index abdcda5..6300502 100644 --- a/usr.bin/rwall/rwall.1 +++ b/usr.bin/rwall/rwall.1 @@ -45,7 +45,8 @@ .Sh DESCRIPTION The .Nm -command sends a message to the users logged into the specified host. The +command sends a message to the users logged into the specified host. +The message to be sent can be typed in and terminated with EOF or it can be in a .Ar file . diff --git a/usr.bin/sasc/sasc.1 b/usr.bin/sasc/sasc.1 index cf5635e..7ace540 100644 --- a/usr.bin/sasc/sasc.1 +++ b/usr.bin/sasc/sasc.1 @@ -49,10 +49,12 @@ The .Nm utility provides shell level access to the ioctl -requests served by the handy scanner device driver asc. Please see +requests served by the handy scanner device driver asc. +Please see .Xr asc 4 for the exact meaning of the requests. Generally they modify -the output and behavior of the asc scanner device. When +the output and behavior of the asc scanner device. +When .Nm is called with no option only the current settings are reported. .Sh OPTIONS @@ -65,9 +67,11 @@ Operate in quiet mode, i.e. do not report any of the current settings. Normally the parameters are shown after the modifications have been performed. .It Fl f Ar file -Operate on a different scanner device node given by filename. Note +Operate on a different scanner device node given by filename. +Note that even though there may exist more than one node of scanner device -several of them will refer the same device unit. The modifications are +several of them will refer the same device unit. +The modifications are performed od the unit regardless of the device node by which it is accessed. .It Fl r Ar resolution Bq ASC_SRES diff --git a/usr.bin/script/script.1 b/usr.bin/script/script.1 index d46ae1a..bf48452 100644 --- a/usr.bin/script/script.1 +++ b/usr.bin/script/script.1 @@ -121,7 +121,8 @@ If the variable .Ev SHELL exists, the shell forked by .Nm -will be that shell. If +will be that shell. +If .Ev SHELL is not set, the Bourne shell is assumed. (Most shells set this variable automatically). diff --git a/usr.bin/showmount/showmount.8 b/usr.bin/showmount/showmount.8 index c2aae04..33d2fb6 100644 --- a/usr.bin/showmount/showmount.8 +++ b/usr.bin/showmount/showmount.8 @@ -54,7 +54,8 @@ server on By default it prints the names of all hosts that have .Tn NFS file systems mounted -on the host. See +on the host. +See .%T "NFS: Network File System Protocol Specification" , RFC 1094, Appendix A, diff --git a/usr.bin/sockstat/sockstat.1 b/usr.bin/sockstat/sockstat.1 index a55909c..96fa406 100644 --- a/usr.bin/sockstat/sockstat.1 +++ b/usr.bin/sockstat/sockstat.1 @@ -37,7 +37,8 @@ .Sh DESCRIPTION The .Nm -command lists open Internet sockets. The information listed for each +command lists open Internet sockets. +The information listed for each socket is: .Bl -tag -width "FOREIGN ADDRESS" .It Li USER diff --git a/usr.bin/su/su.1 b/usr.bin/su/su.1 index c7a0597..54ed870 100644 --- a/usr.bin/su/su.1 +++ b/usr.bin/su/su.1 @@ -131,7 +131,8 @@ non-zero, .Nm will fail. .It Fl c Ar class -Use the settings of the specified login class. Only allowed for the super-user. +Use the settings of the specified login class. +Only allowed for the super-user. .El .Pp The diff --git a/usr.bin/talk/talk.1 b/usr.bin/talk/talk.1 index 64bf639..73d046c 100644 --- a/usr.bin/talk/talk.1 +++ b/usr.bin/talk/talk.1 @@ -80,7 +80,8 @@ talk: connection requested by your_name@your_machine. talk: respond with: talk your_name@your_machine .Ed .Pp -to the user you wish to talk to. At this point, the recipient +to the user you wish to talk to. +At this point, the recipient of the message should reply by typing .Pp .Dl talk \ your_name@your_machine diff --git a/usr.bin/tcopy/tcopy.1 b/usr.bin/tcopy/tcopy.1 index 85a344e..5c65c39 100644 --- a/usr.bin/tcopy/tcopy.1 +++ b/usr.bin/tcopy/tcopy.1 @@ -90,7 +90,8 @@ command appeared in .Bx 4.3 . .Sh BUGS Writting an image of a tape to a file does not preserve much more than -the raw data. Block size(s) and tape EOF marks are lost which would +the raw data. +Block size(s) and tape EOF marks are lost which would otherwise be preserved in a tape-to-tape copy. EOD is determined by two sequential EOF marks with no data between. @@ -101,6 +102,8 @@ will erroneously stop copying early in this case. When using the copy/verify option \-c .Xr tcopy 1 -does not rewind the tapes prior to start. A rewind is performed -after writing prior to the verification stage. If one doesn't start +does not rewind the tapes prior to start. +A rewind is performed +after writing prior to the verification stage. +If one doesn't start at BOT then the comparison may not be of the intended data. diff --git a/usr.bin/tip/tip/tip.1 b/usr.bin/tip/tip/tip.1 index dd9327f..a9c083d 100644 --- a/usr.bin/tip/tip/tip.1 +++ b/usr.bin/tip/tip/tip.1 @@ -312,12 +312,14 @@ writes when receiving files; abbreviated .Ar ho . .It Ar login (str) Pathname of a login shell script to run once connected; standard input -and output are redirected to the remote host. Leading tildes in the pathname +and output are redirected to the remote host. +Leading tildes in the pathname are expanded expansion; abbreviated .Ar li . .It Ar logout (str) Pathname of a shell script to run before disconnecting; standard input -and output are redirected to the remote host. Leading tildes in the pathname +and output are redirected to the remote host. +Leading tildes in the pathname are expanded expansion; abbreviated .Ar lo . .It Ar prompt diff --git a/usr.bin/uuencode/uuencode.1 b/usr.bin/uuencode/uuencode.1 index 9616d66..a01f18b 100644 --- a/usr.bin/uuencode/uuencode.1 +++ b/usr.bin/uuencode/uuencode.1 @@ -93,7 +93,8 @@ Decode .Ar file and write output to standard output. .It Fl s -Do not strip output pathname to base filename. By default +Do not strip output pathname to base filename. +By default .Nm uudecode deletes any prefix ending with the last slash '/' for security purpose. diff --git a/usr.bin/uuencode/uuencode.format.5 b/usr.bin/uuencode/uuencode.format.5 index 10f1699..d256a0b 100644 --- a/usr.bin/uuencode/uuencode.format.5 +++ b/usr.bin/uuencode/uuencode.format.5 @@ -77,7 +77,8 @@ Character 64 represents a count of zero. .Pp Groups of 3 bytes are stored in 4 characters, 6 bits per character. All characters are always in range from 1 to 64 and are offset by a -space (octal 40) to make the characters printing. Character +space (octal 40) to make the characters printing. +Character 64 represents a count of zero. The last line may be shorter than the normal 45 bytes. If the size is not a multiple of 3, this fact can be determined diff --git a/usr.bin/vacation/vacation.1 b/usr.bin/vacation/vacation.1 index 7d2c6ae..b5db139 100644 --- a/usr.bin/vacation/vacation.1 +++ b/usr.bin/vacation/vacation.1 @@ -75,7 +75,8 @@ Handle messages for in the same manner as those received for the user's login name. .It Fl d -Enable debugging mode. See below. +Enable debugging mode. +See below. .It Fl i Initialize the vacation database files. It should be used before you modify your diff --git a/usr.bin/whois/whois.1 b/usr.bin/whois/whois.1 index d9866f5..280e2aa 100644 --- a/usr.bin/whois/whois.1 +++ b/usr.bin/whois/whois.1 @@ -89,17 +89,20 @@ for most of .Tn \&.ORG and .Tn \&.EDU -domains. NOTE! The registration of these domains is now done by a number of +domains. +NOTE! The registration of these domains is now done by a number of independent and competing registrars and this database holds no information on the domains registered by organizations other than Network Solutions, Inc. Also, note that the InterNIC database .Pq Tn whois.internic.net -is no longer handled by Network Solutions, Inc. For details, see: +is no longer handled by Network Solutions, Inc. +For details, see: http://www.internic.net/. .It Fl m Use the Route Arbiter Database .Pq Tn RADB -database. It contains route policy specifications for a large +database. +It contains route policy specifications for a large number of operators' networks. .It Fl p Use the Asia/Pacific Network Information Center diff --git a/usr.bin/xinstall/install.1 b/usr.bin/xinstall/install.1 index a15517a..f9a77baf 100644 --- a/usr.bin/xinstall/install.1 +++ b/usr.bin/xinstall/install.1 @@ -107,7 +107,8 @@ Specify the target's file flags; see .Xr chflags 1 for a list of possible flags and their meanings. .It Fl g -Specify a group. A numeric GID is allowed. +Specify a group. +A numeric GID is allowed. .It Fl M Disable all use of .Xr mmap 2 . @@ -118,7 +119,8 @@ The specified mode may be either an octal or symbolic value; see .Xr chmod 1 for a description of possible mode values. .It Fl o -Specify an owner. A numeric UID is allowed. +Specify an owner. +A numeric UID is allowed. .It Fl p Preserve the modification time. Copy the file, as if the diff --git a/usr.bin/xlint/xlint/lint.1 b/usr.bin/xlint/xlint/lint.1 index d076b36..2136164 100644 --- a/usr.bin/xlint/xlint/lint.1 +++ b/usr.bin/xlint/xlint/lint.1 @@ -61,7 +61,8 @@ .Nm attempts to detect features of the named C program files that are likely to be bugs, to be non-portable, or to be -wasteful. It also performs stricter type checking then does +wasteful. +It also performs stricter type checking then does the C compiler. .Nm runs the C preprocessor as its first phase, with the @@ -77,7 +78,8 @@ word for all code that is to be checked by Among the possible problems that are currently noted are unreachable statements, loops not entered at the top, variables declared and not used, and logical expressions -with constant values. Function calls are checked for +with constant values. +Function calls are checked for inconsistencies, such as calls to functions that return values in some places and not in others, functions called with varying numbers of arguments, function calls that @@ -88,7 +90,8 @@ the non-existent return value of the function. .Pp Filename arguments ending with .Pa \&.c -are taken to be C source files. Filename arguments with +are taken to be C source files. +Filename arguments with names ending with .Pa \&.ln are taken to be the result of an earlier invocation of @@ -98,7 +101,8 @@ with either the .Fl o or .Fl C -option in effect. The +option in effect. +The .Pa \&.ln files are analogous to the .Pa \&.o @@ -123,7 +127,8 @@ By default, .Nm appends the standard C lint library .Pq Pa llib-lc.ln -to the end of the list of files. When the +to the end of the list of files. +When the .Fl i option is used, the .Pa \&.ln @@ -134,13 +139,15 @@ or .Fl i options are used, the .Pa llib-l Ns Ar library Ns Pa \&.ln -files are ignored. When the +files are ignored. +When the .Fl i option is .Em omitted the second pass of .Nm -checks this list of files for mutual compatibility. At this point, +checks this list of files for mutual compatibility. +At this point, if a complaint stems not from a given source file, but from one of its included files, the source filename will be printed followed by a question mark. @@ -162,7 +169,8 @@ cause implicit narrowing conversion. .It Fl b Report .Sy break -statements that cannot be reached. This is not the default +statements that cannot be reached. +This is not the default because, unfortunately, most .Xr lex 1 and many @@ -180,11 +188,13 @@ and .It Fl g Don't print warnings for some extensions of .Xr gcc 1 -to the C language. Currently these are nonconstant initializers in +to the C language. +Currently these are nonconstant initializers in automatic aggregate initializations, arithmetic on pointer to void, zero sized structures, subscripting of non-lvalue arrays, prototypes overriding old style function declarations and long long -integer types. The +integer types. +The .Fl g flag also turns on the keywords .Sy asm @@ -203,7 +213,8 @@ Produce a .Pa \&.ln file for every .Pa \&.c -file on the command line. These +file on the command line. +These .Pa \&.ln files are the product of .Nm lint Ns 's @@ -217,7 +228,8 @@ Attempt to check portability of code to other dialects of C. In case of redeclarations report the position of the previous declaration. .It Fl s -Strict ANSI C mode. Issue warnings and errors required by ANSI C. +Strict ANSI C mode. +Issue warnings and errors required by ANSI C. Also do not produce warnings for constructs which behave differently in traditional C and ANSI C. With the .Fl s @@ -227,14 +239,17 @@ is a predefined preprocessor macro. .It Fl t Traditional C mode. .Li __STDC__ -is not predefined in this mode. Warnings are printed for constructs +is not predefined in this mode. +Warnings are printed for constructs not allowed in traditional C. Warnings for constructs which behave -differently in traditional C and ANSI C are suppressed. Preprocessor +differently in traditional C and ANSI C are suppressed. +Preprocessor macros describing the machine type (e.g. .Li sun3 Ns ) and machine architecture (e.g. .Li m68k Ns ) -are defined without leading and trailing underscores. The keywords +are defined without leading and trailing underscores. +The keywords .Sy const Ns , .Sy volatile and @@ -266,7 +281,8 @@ This library is built from all .Pa \&.c and .Pa \&.ln -input files. After all global definitions of functions and +input files. +After all global definitions of functions and variables in these files are written to the newly created library, .Nm checks all input files, including libraries specified with the @@ -279,7 +295,8 @@ for .Xr cpp 1 , as if by a .Li #define -directive. If no definition is given, +directive. +If no definition is given, .Ar name is defined as 1. .It Fl I Ns Ar directory @@ -309,16 +326,19 @@ Name the output file .Ar outputfile . The output file produced is the input that is given to .Nm lint Ns 's -second pass. The +second pass. +The .Fl o -option simply saves this file in the named output file. If the +option simply saves this file in the named output file. +If the .Fl i option is also used the files are not checked for compatibility. To produce a .Pa llib-l Ns Ar library Ns Pa \&.ln without extraneous messages, use of the .Fl u -option is suggested. The +option is suggested. +The .Fl v option is useful if the source file(s) for the lint library are just external interfaces. @@ -362,7 +382,8 @@ suppress complaints about fall through to a .Sy case or .Sy default -labelled statement. This directive should be placed immediately +labelled statement. +This directive should be placed immediately preceding the label. .It Li /* LINTLIBRARY */ At the beginning of a file, mark all functions and variables defined @@ -377,7 +398,8 @@ Also shut off complaints about unused function arguments. .Li */ .Xc Suppresses any intra-file warning except those dealing with -unused variables or functions. This directive should be placed +unused variables or functions. +This directive should be placed on the line immediately preceding where the lint warning occurred. .It Li /* LONGLONG */ Suppress complaints about use of long long integer types. @@ -391,7 +413,8 @@ makes .Nm check the first .Pq Ar n Ns No -1 -arguments as usual. The +arguments as usual. +The .Ar n Ns No -th argument is interpreted as a .Sy printf @@ -402,10 +425,12 @@ causes to treat function declaration prototypes as function definitions if .Ar n -is non-zero. This directive can only be used in conjunction with +is non-zero. +This directive can only be used in conjunction with the .Li /* LINTLIBRARY */ -directive. If +directive. +If .Ar n is zero, function prototypes will be treated normally. .It Li /* SCANFLIKE Ns Ar n Li */ @@ -413,14 +438,16 @@ makes .Nm check the first .Pq Ar n Ns No -1 -arguments as usual. The +arguments as usual. +The .Ar n Ns No -th argument is interpreted as a .Sy scanf format string that is used to check the remaining arguments. .It Li /* VARARGS Ns Ar n Li */ Suppress the usual checking for variable numbers of arguments in -the following function declaration. The data types of the first +the following function declaration. +The data types of the first .Ar n arguments are checked; a missing .Ar n @@ -433,16 +460,19 @@ and the .Fl o options allows for incremental use of .Nm -on a set of C source files. Generally, one invokes +on a set of C source files. +Generally, one invokes .Nm once for each source file with the .Fl i -option. Each of these invocations produces a +option. +Each of these invocations produces a .Pa \&.ln file that corresponds to the .Pa \&.c file, and prints all messages that are about just that -source file. After all the source files have been separately +source file. +After all the source files have been separately run through .Nm lint , it is invoked once more (without the @@ -451,7 +481,8 @@ option), listing all the .Pa \&.ln files with the needed .Fl l Ns Ar library -options. this will print all the inter-file inconsistencies. This +options. this will print all the inter-file inconsistencies. +This scheme works well with .Xr make 1 ; it allows @@ -466,7 +497,8 @@ time the set of source files were .It Ev LIBDIR the directory where the lint libraries specified by the .Fl l Ns Ar library -option must exist. If this environment variable is undefined, +option must exist. +If this environment variable is undefined, then the default path .Pa /usr/libdata/lint will be used to search for the libraries. @@ -505,7 +537,8 @@ option will, when used in later runs, cause certain errors that were reported when the libraries were created to be reported again, and cause line numbers and file names from the original source used to create those libraries -to be reported in error messages. For these reasons, it is recommended +to be reported in error messages. +For these reasons, it is recommended to use the .Fl C option to create lint libraries. |
