From e6d3cf26485c2f3410273cda3d6e4c1b0d78e2a4 Mon Sep 17 00:00:00 2001 From: Sheldon Hearn Date: Tue, 14 Sep 1999 11:46:04 +0000 Subject: [PATCH] Correct some hard sentence breaks. Only those surrounding the previous commit and those which cause ugly nroff output have been fixed, since the purpose of the style guideline which they contravene is to reduce the sizes of deltas. Reported by: bde --- bin/csh/csh.1 | 17 +++--- bin/echo/echo.1 | 4 +- bin/kill/kill.1 | 4 +- bin/pwd/pwd.1 | 8 +-- bin/sh/sh.1 | 126 ++++++++++++++++++++------------------- share/man/man1/builtin.1 | 7 ++- usr.bin/login/login.1 | 4 +- usr.bin/nice/nice.1 | 8 +-- usr.bin/nohup/nohup.1 | 7 ++- usr.bin/printf/printf.1 | 4 +- usr.bin/time/time.1 | 10 ++-- usr.bin/which/which.1 | 4 +- 12 files changed, 107 insertions(+), 96 deletions(-) diff --git a/bin/csh/csh.1 b/bin/csh/csh.1 index 9ec757d0d97a..14c94c9e0715 100644 --- a/bin/csh/csh.1 +++ b/bin/csh/csh.1 @@ -55,8 +55,9 @@ job control facilities (see interactive file name and user name completion (see .Sx File Name Completion ) , -and a C-like syntax. It is used both as an interactive -login shell and a shell script command processor. +and a C-like syntax. +It is used both as an interactive login shell and +a shell script command processor. .Ss Argument list processing If the first argument (argument 0) to the shell is .Ql Fl \& , @@ -236,8 +237,9 @@ may be a component of a pipeline, etc.). It is also possible to separate pipelines with `\&|\&|' or `&&' showing, as in the C language, that the second is to be executed only if the first fails or succeeds -respectively. (See -.Em Expressions . ) +respectively. +See +.Sx Expressions . .Ss Jobs The shell associates a .Ar job @@ -317,7 +319,8 @@ The job control mechanism requires that the .Xr stty 1 option .Ic new -be set. It is an artifact from a +be set. +It is an artifact from a .Em new implementation of the @@ -568,8 +571,8 @@ Repeat the previous substitution. Apply the change once on each word, prefixing the above, e.g., `g&'. .It a Apply the change as many times as possible on a single word, prefixing -the above. It can be used together with `g' to apply a substitution -globally. +the above. +It can be used together with `g' to apply a substitution globally. .It p Print the new command line but do not execute it. .It q diff --git a/bin/echo/echo.1 b/bin/echo/echo.1 index 515cff0ead52..0f43f9955377 100644 --- a/bin/echo/echo.1 +++ b/bin/echo/echo.1 @@ -62,8 +62,8 @@ by iBCS2 compatible systems. .Pp Some shells may provide a builtin .Nm -command which is similar or identical to this utility. Consult -the +command which is similar or identical to this utility. +Consult the .Xr builtin 1 manual page. .Sh DIAGNOSTICS diff --git a/bin/kill/kill.1 b/bin/kill/kill.1 index 67c2424b3f39..1a6d0f734f3c 100644 --- a/bin/kill/kill.1 +++ b/bin/kill/kill.1 @@ -112,8 +112,8 @@ TERM (software termination signal) .Pp Some shells may provide a builtin .Nm -command which is similar or identical to this utility. Consult -the +command which is similar or identical to this utility. +Consult the .Xr builtin 1 manual page. .Sh SEE ALSO diff --git a/bin/pwd/pwd.1 b/bin/pwd/pwd.1 index 4eaed1d069ce..455f791be0a7 100644 --- a/bin/pwd/pwd.1 +++ b/bin/pwd/pwd.1 @@ -50,8 +50,8 @@ the standard output. .Pp Some shells may provide a builtin .Nm -command which is similar or identical to this utility. Consult -the +command which is similar or identical to this utility. +Consult the .Xr builtin 1 manual page. .Sh DIAGNOSTICS @@ -75,7 +75,7 @@ In .Xr csh 1 the command .Ic dirs -is always faster because it is built into that shell. However, -it can give a different answer in the rare case +is always faster because it is built into that shell. +However, it can give a different answer in the rare case that the current directory or a containing directory was moved after the shell descended into it. diff --git a/bin/sh/sh.1 b/bin/sh/sh.1 index a72b28982c3c..c33eae38f462 100644 --- a/bin/sh/sh.1 +++ b/bin/sh/sh.1 @@ -66,9 +66,9 @@ specification of the shell. .Ss Overview The shell is a command that reads lines from either a file or the terminal, interprets them, and -generally executes other commands. It is the program that is running -when a user logs into the system (although a user can select -a different shell with the +generally executes other commands. +It is the program that is running when a user logs into the system +(although a user can select a different shell with the .Xr chsh 1 command). The shell @@ -106,7 +106,8 @@ at login time in the .Pa .profile file, and commands that are executed for every shell inside the .Ev ENV -file. To set the +file. +To set the .Ev ENV variable to some file, place the following line in your .Pa .profile @@ -211,8 +212,10 @@ running (i.e. when set with the .Ic set command). .It Fl T Li asynctraps -When waiting for a child, execute traps immediately. If this option is -not set, traps are executed after the child exits, as specified in +When waiting for a child, execute traps immediately. +If this option is not set, +traps are executed after the child exits, +as specified in .St -p1003.2 This nonstandard option is useful for putting guarding shells around children that block signals. The surrounding shell may kill the child @@ -302,9 +305,9 @@ An alias is a name and corresponding value set using the .Ic alias builtin command. Whenever a reserved word may occur (see above), and after checking for reserved words, the shell -checks the word to see if it matches an alias. If it does, -it replaces it in the input stream with its value. For example, -if there is an alias called +checks the word to see if it matches an alias. +If it does, it replaces it in the input stream with its value. +For example, if there is an alias called .Dq lf with the value .Dq ls -F , @@ -424,9 +427,10 @@ set to the arguments of the shell function. The variables which are explicitly placed in the environment of the command (by placing assignments to them before the function name) are made local to the function and are set -to the values given. Then the command given in the function -definition is executed. The positional parameters are -restored to their original values when the command completes. +to the values given. +Then the command given in the function definition is executed. +The positional parameters are restored to their original values +when the command completes. This all occurs within the current shell. .Pp Shell builtin commands are executed internally to the shell, without @@ -436,8 +440,8 @@ Otherwise, if the command name does not match a function or builtin command, the command is searched for as a normal program in the filesystem (as described in the next section). When a normal program is executed, the shell runs the program, -passing the arguments and the environment to the -program. If the program is not a normal executable file +passing the arguments and the environment to the program. +If the program is not a normal executable file (i.e. if it does not begin with the .Qq magic number whose @@ -446,11 +450,11 @@ representation is .Qq #! , resulting in an ENOEXEC return value from .Fn execve ) -the shell -will interpret the program in a subshell. The child shell -will reinitialize itself in this case, so that the effect will -be as if a new shell had been invoked to handle the ad-hoc shell -script, except that the location of hashed commands located in +the shell will interpret the program in a subshell. +The child shell will reinitialize itself in this case, +so that the effect will be +as if a new shell had been invoked to handle the ad-hoc shell script, +except that the location of hashed commands located in the parent shell will be remembered by the child. .Pp Note that previous versions of this document @@ -802,9 +806,10 @@ Tilde expansions, parameter expansions, command substitutions, arithmetic expansions, and quote removals that occur within a single word expand to a single field. It is only field splitting or pathname expansion that can create multiple -fields from a single word. The single exception to this -rule is the expansion of the special parameter @ within -double-quotes, as was described above. +fields from a single word. +The single exception to this rule is +the expansion of the special parameter @ within double-quotes, +as was described above. .Pp The order of word expansion is: .Bl -enum @@ -884,7 +889,8 @@ parameter is unset or null, the expansion of word (or a message indicating it is unset if word is omitted) is written to standard error and the shell exits with a nonzero -exit status. Otherwise, the value of +exit status. +Otherwise, the value of parameter is substituted. An interactive shell need not exit. .It Li ${parameter:+word} @@ -958,8 +964,8 @@ splitting, they may be translated into s, depending on the value of IFS and quoting that is in effect.) .Ss Arithmetic Expansion Arithmetic expansion provides a mechanism for evaluating an arithmetic -expression and substituting its value. The format for arithmetic -expansion is as follows: +expression and substituting its value. +The format for arithmetic expansion is as follows: .Bd -literal -offset indent $((expression)) .Ed @@ -1012,11 +1018,11 @@ characters and they are turned into meta-characters. An asterisk .Dq * matches any string of characters. A -question mark matches any single character. A left -bracket +question mark matches any single character. +A left bracket .Dq [ -introduces a character class. The end of -the character class is indicated by a +introduces a character class. +The end of the character class is indicated by a .Dq ] ; if the .Dq ] @@ -1024,21 +1030,19 @@ is missing then the .Dq [ matches a .Dq [ -rather than -introducing a character class. A character class matches -any of the characters between the square brackets. A -range of characters may be specified using a minus sign. -The character class may be complemented by making an -exclamation point the first character of the character -class. +rather than introducing a character class. +A character class matches any of the characters between the square brackets. +A range of characters may be specified using a minus sign. +The character class may be complemented +by making an exclamation point the first character of the character class. .Pp To include a .Dq ] -in a character class, make it the first -character listed (after the +in a character class, make it the first character listed +(after the .Dq ! , -if any). To include a -minus sign, make it the first or last character listed. +if any). +To include a minus sign, make it the first or last character listed. .Ss Builtin Commands This section lists the commands which are builtin because they need to perform some operation @@ -1090,16 +1094,16 @@ and the directory name does not begin with a slash (/), dot (.) or dot-dot (..), then the directories listed in CDPATH will be searched for the specified directory. The format of -CDPATH is the same as that of PATH. In an interactive shell, -the cd command will print out the name of -the directory that it actually switched to if this is -different from the name that the user gave. These -may be different either because the CDPATH mechanism +CDPATH is the same as that of PATH. +In an interactive shell, +the cd command will print out the name of the directory +that it actually switched to +if this is different from the name that the user gave. +These may be different either because the CDPATH mechanism was used or because a symbolic link was crossed. .It eval string ... -Concatenate all the arguments with spaces. Then -re-parse and execute the -command. +Concatenate all the arguments with spaces. +Then re-parse and execute the command. .It exec [ command arg ... ] Unless command is omitted, the shell process is replaced with the specified program (which must be a @@ -1289,11 +1293,10 @@ to executing .El .Pp .It setvar variable value -Assigns value to variable. (In general it is better -to write variable=value rather than using setvar. +Assigns value to variable. +In general it is better to write variable=value rather than using setvar. Setvar is intended to be used in functions that -assign values to variables whose names are passed as -parameters.) +assign values to variables whose names are passed as parameters. .It shift [ n ] Shift the positional parameters n times. A shift sets the value of $1 to the value of $2, the value of @@ -1312,7 +1315,8 @@ default action. The trap command has no effect on signals that were ignored on entry to the shell. .It type [name] ... Interpret each name as a command and print the -resolution of the command search. Possible resolutions are: +resolution of the command search. +Possible resolutions are: shell keyword, alias, shell builtin command, command, tracked alias and not found. For aliases the alias expansion is printed; for commands and tracked aliases the complete pathname of @@ -1374,8 +1378,8 @@ The maximal number of simultaneous processes for this user ID. Set the value of umask (see .Xr umask 2 ) to the specified -octal value. If the argument is omitted, the -umask value is printed. +octal value. +If the argument is omitted, the umask value is printed. .It unalias [-a] [name] If .Dq name @@ -1385,14 +1389,14 @@ If is specified, all aliases are removed. .It unset name ... The specified variables and functions are unset and -unexported. If a given name corresponds to both a -variable and a function, both the variable and the -function are unset. +unexported. +If a given name corresponds to both a variable and a function, +both the variable and the function are unset. .It wait [ job ] Wait for the specified job to complete and return the -exit status of the last process in the job. If the -argument is omitted, wait for all jobs to complete -and the return an exit status of zero. +exit status of the last process in the job. +If the argument is omitted, wait for all jobs to complete +and return an exit status of zero. .El .Ss Commandline Editing When diff --git a/share/man/man1/builtin.1 b/share/man/man1/builtin.1 index 2c60dbdf2f18..a0a14695f8c2 100644 --- a/share/man/man1/builtin.1 +++ b/share/man/man1/builtin.1 @@ -125,8 +125,8 @@ any component of a pipeline except the last. If a command specified to the shell contains a slash .Dq \&/ , the shell will not execute a builtin command, even if the last component -of the specified command matches the name of a builtin command. Thus, -while specifying +of the specified command matches the name of a builtin command. +Thus, while specifying .Dq Ic echo causes a builtin command to be executed under shells that support the builtin echo command, @@ -145,7 +145,8 @@ Only builtin commands for the .Xr csh 1 and .Xr sh 1 -shells are listed here. Consult the appropriate manual page for +shells are listed here. +Consult the appropriate manual page for details on the operation of any given builtin command under those shells. Users of other shells will need to consult the documentation supplied with the other shells. diff --git a/usr.bin/login/login.1 b/usr.bin/login/login.1 index 3d1a9c7ecb59..492b9832da9c 100644 --- a/usr.bin/login/login.1 +++ b/usr.bin/login/login.1 @@ -145,8 +145,8 @@ a user's login environment. .Pp Some shells may provide a builtin .Nm -command which is similar or identical to this utility. Consult -the +command which is similar or identical to this utility. +Consult the .Xr builtin 1 manual page. .Sh FILES diff --git a/usr.bin/nice/nice.1 b/usr.bin/nice/nice.1 index b017179d0f54..9bebdc15cf79 100644 --- a/usr.bin/nice/nice.1 +++ b/usr.bin/nice/nice.1 @@ -54,8 +54,8 @@ If is not given .Nm assumed the value 10. -The priority is a value in the range -20 to 20. The default priority -is 0, priority 20 is the lowest possible. +The priority is a value in the range -20 to 20. +The default priority is 0, priority 20 is the lowest possible. .Nm Nice will execute .Ar command @@ -76,8 +76,8 @@ command executed by .Pp Some shells may provide a builtin .Nm -command which is similar or identical to this utility. Consult -the +command which is similar or identical to this utility. +Consult the .Xr builtin 1 manual page. .Sh EXAMPLES diff --git a/usr.bin/nohup/nohup.1 b/usr.bin/nohup/nohup.1 index 8f137e784b6b..9aa327128352 100644 --- a/usr.bin/nohup/nohup.1 +++ b/usr.bin/nohup/nohup.1 @@ -54,7 +54,8 @@ with its arguments and at this time sets the signal .Dv SIGHUP -to be ignored. The signal +to be ignored. +The signal .Dv SIGQUIT may also be set to be ignored. @@ -71,8 +72,8 @@ exits 1 if an error occurs, otherwise the exit status is that of .Pp Some shells may provide a builtin .Nm -command which is similar or identical to this utility. Consult -the +command which is similar or identical to this utility. +Consult the .Xr builtin 1 manual page. .Sh ENVIRONMENT diff --git a/usr.bin/printf/printf.1 b/usr.bin/printf/printf.1 index 153990bb07a8..9f0d9a986df6 100644 --- a/usr.bin/printf/printf.1 +++ b/usr.bin/printf/printf.1 @@ -253,8 +253,8 @@ the actual width. .Pp Some shells may provide a builtin .Nm -command which is similar or identical to this utility. Consult -the +command which is similar or identical to this utility. +Consult the .Xr builtin 1 manual page. .Sh RETURN VALUES diff --git a/usr.bin/time/time.1 b/usr.bin/time/time.1 index 196042c8a33c..48cd78d1e38a 100644 --- a/usr.bin/time/time.1 +++ b/usr.bin/time/time.1 @@ -71,7 +71,8 @@ Available options: If the .Fl o flag is used, append to the specified file rather than overwriting -it. Otherwise, this option has no effect. +it. +Otherwise, this option has no effect. .It Fl l The contents of the .Em rusage @@ -92,14 +93,15 @@ output POSIX.2 compliant (each time is printed on its own line). .Pp Some shells may provide a builtin .Nm -command which is similar or identical to this utility. Consult -the +command which is similar or identical to this utility. +Consult the .Xr builtin 1 manual page. .Sh DIAGNOSTICS If .Ar command -could be timed successfully, its exit status is returned. In case +could be timed successfully, its exit status is returned. +If .Ar command terminated abnormally, a warning message is output to stderr. If the diff --git a/usr.bin/which/which.1 b/usr.bin/which/which.1 index 97daca54e30d..6b00525b0b40 100644 --- a/usr.bin/which/which.1 +++ b/usr.bin/which/which.1 @@ -55,8 +55,8 @@ none are found. .Pp Some shells may provide a builtin .Nm -command which is similar or identical to this utility. Consult -the +command which is similar or identical to this utility. +Consult the .Xr builtin 1 manual page. .Sh HISTORY