Index: stable/11/bin/pwd/pwd.1 =================================================================== --- stable/11/bin/pwd/pwd.1 (revision 313867) +++ stable/11/bin/pwd/pwd.1 (revision 313868) @@ -1,107 +1,107 @@ .\"- .\" Copyright (c) 1990, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" This code is derived from software contributed to Berkeley by .\" the Institute of Electrical and Electronics Engineers, Inc. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" @(#)pwd.1 8.2 (Berkeley) 4/28/95 .\" $FreeBSD$ .\" .Dd October 5, 2016 .Dt PWD 1 .Os .Sh NAME .Nm pwd .Nd return working directory name .Sh SYNOPSIS .Nm .Op Fl L | P .Sh DESCRIPTION The .Nm utility writes the absolute pathname of the current working directory to the standard output. .Pp Some shells may provide a builtin .Nm command which is similar or identical to this utility. Consult the .Xr builtin 1 manual page. .Pp The options are as follows: .Bl -tag -width indent .It Fl L Display the logical current working directory. .It Fl P Display the physical current working directory (all symbolic links resolved). .El .Pp If no options are specified, the .Fl P option is assumed. .Sh ENVIRONMENT Environment variables used by .Nm : .Bl -tag -width ".Ev PWD" .It Ev PWD Logical current working directory. .El .Sh EXIT STATUS .Ex -std .Sh SEE ALSO .Xr builtin 1 , .Xr cd 1 , .Xr csh 1 , .Xr sh 1 , .Xr getcwd 3 .Sh STANDARDS The .Nm utility conforms to .St -p1003.1-2001 . .Sh HISTORY The -.Nm +.Nm command appeared in .At v5 . .Sh BUGS 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 that the current directory or a containing directory was moved after the shell descended into it. .Pp The .Fl L option does not work unless the .Ev PWD environment variable is exported by the shell. Index: stable/11/bin/sh/sh.1 =================================================================== --- stable/11/bin/sh/sh.1 (revision 313867) +++ stable/11/bin/sh/sh.1 (revision 313868) @@ -1,2874 +1,2874 @@ .\"- .\" Copyright (c) 1991, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" This code is derived from software contributed to Berkeley by .\" Kenneth Almquist. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" from: @(#)sh.1 8.6 (Berkeley) 5/4/95 .\" $FreeBSD$ .\" .Dd May 30, 2016 .Dt SH 1 .Os .Sh NAME .Nm sh .Nd command interpreter (shell) .Sh SYNOPSIS .Nm .Op Fl /+abCEefhIimnPpTuVvx .Op Fl /+o Ar longname .Oo .Ar script .Op Ar arg ... .Oc .Nm .Op Fl /+abCEefhIimnPpTuVvx .Op Fl /+o Ar longname .Fl c Ar string .Oo .Ar name .Op Ar arg ... .Oc .Nm .Op Fl /+abCEefhIimnPpTuVvx .Op Fl /+o Ar longname .Fl s .Op Ar arg ... .Sh DESCRIPTION The .Nm utility is the standard command interpreter for the system. The current version of .Nm is close to the .St -p1003.1 specification for the shell. It only supports features designated by .Tn POSIX , plus a few Berkeley extensions. This man page is not intended to be a tutorial nor a complete 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 started when a user logs into the system, although a user can select a different shell with the .Xr chsh 1 command. The shell implements a language that has flow control constructs, a macro facility that provides a variety of features in addition to data storage, along with built-in history and line editing capabilities. It incorporates many features to aid interactive use and has the advantage that the interpretative language is common to both interactive and non-interactive use (shell scripts). That is, commands can be typed directly to the running shell or can be put into a file, which can be executed directly by the shell. .Ss Invocation .\" .\" XXX This next sentence is incredibly confusing. .\" If no arguments are present and if the standard input of the shell is connected to a terminal (or if the .Fl i option is set), the shell is considered an interactive shell. An interactive shell generally prompts before each command and handles programming and command errors differently (as described below). When first starting, the shell inspects argument 0, and if it begins with a dash .Pq Ql - , the shell is also considered a login shell. This is normally done automatically by the system when the user first logs in. A login shell first reads commands from the files .Pa /etc/profile and then .Pa .profile in a user's home directory, if they exist. If the environment variable .Ev ENV is set on entry to a shell, or is set in the .Pa .profile of a login shell, the shell then subjects its value to parameter expansion and arithmetic expansion and reads commands from the named file. Therefore, a user should place commands that are to be executed only at login time in the .Pa .profile file, and commands that are executed for every shell inside the .Ev ENV file. The user can set the .Ev ENV variable to some file by placing the following line in the file .Pa .profile in the home directory, substituting for .Pa .shrc the filename desired: .Pp .Dl "ENV=$HOME/.shrc; export ENV" .Pp The first non-option argument specified on the command line will be treated as the name of a file from which to read commands (a shell script), and the remaining arguments are set as the positional parameters of the shell .Li ( $1 , $2 , etc.). Otherwise, the shell reads commands from its standard input. .Pp Unlike older versions of .Nm the .Ev ENV script is only sourced on invocation of interactive shells. This closes a well-known, and sometimes easily exploitable security hole related to poorly thought out .Ev ENV scripts. .Ss Argument List Processing All of the single letter options to .Nm have a corresponding long name, with the exception of .Fl c and .Fl /+o . These long names are provided next to the single letter options in the descriptions below. The long name for an option may be specified as an argument to the .Fl /+o option of .Nm . Once the shell is running, the long name for an option may be specified as an argument to the .Fl /+o option of the .Ic set built-in command (described later in the section called .Sx Built-in Commands ) . Introducing an option with a dash .Pq Ql - enables the option, while using a plus .Pq Ql + disables the option. A .Dq Li -- or plain .Ql - will stop option processing and will force the remaining words on the command line to be treated as arguments. The .Fl /+o and .Fl c options do not have long names. They take arguments and are described after the single letter options. .Bl -tag -width indent .It Fl a Li allexport Flag variables for export when assignments are made to them. .It Fl b Li notify Enable asynchronous notification of background job completion. (UNIMPLEMENTED) .It Fl C Li noclobber Do not overwrite existing files with .Ql > . .It Fl E Li emacs Enable the built-in .Xr emacs 1 command line editor (disables the .Fl V option if it has been set; set automatically when interactive on terminals). .It Fl e Li errexit Exit immediately if any untested command fails in non-interactive mode. The exit status of a command is considered to be explicitly tested if the command is part of the list used to control an .Ic if , elif , while , or .Ic until ; if the command is the left hand operand of an .Dq Li && or .Dq Li || operator; or if the command is a pipeline preceded by the .Ic !\& keyword. If a shell function is executed and its exit status is explicitly tested, all commands of the function are considered to be tested as well. .Pp It is recommended to check for failures explicitly instead of relying on .Fl e because it tends to behave in unexpected ways, particularly in larger scripts. .It Fl f Li noglob Disable pathname expansion. .It Fl h Li trackall A do-nothing option for .Tn POSIX compliance. .It Fl I Li ignoreeof Ignore .Dv EOF Ap s from input when in interactive mode. .It Fl i Li interactive Force the shell to behave interactively. .It Fl m Li monitor Turn on job control (set automatically when interactive). A new process group is created for each pipeline (called a job). It is possible to suspend jobs or to have them run in the foreground or in the background. In a non-interactive shell, this option can be set even if no terminal is available and is useful to place processes in separate process groups. .It Fl n Li noexec If not interactive, read commands but do not execute them. This is useful for checking the syntax of shell scripts. .It Fl P Li physical Change the default for the .Ic cd and .Ic pwd commands from .Fl L (logical directory layout) to .Fl P (physical directory layout). .It Fl p Li privileged Turn on privileged mode. This mode is enabled on startup if either the effective user or group ID is not equal to the real user or group ID. Turning this mode off sets the effective user and group IDs to the real user and group IDs. When this mode is enabled for interactive shells, the file .Pa /etc/suid_profile is sourced instead of .Pa ~/.profile after .Pa /etc/profile is sourced, and the contents of the .Ev ENV variable are ignored. .It Fl s Li stdin Read commands from standard input (set automatically if no file arguments are present). This option has no effect when set after the shell has already started running (i.e., when set with the .Ic set command). .It Fl T Li trapsasync 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 or it may just return control to the tty and leave the child alone, like this: .Bd -literal -offset indent sh -T -c "trap 'exit 1' 2 ; some-blocking-program" .Ed .It Fl u Li nounset Write a message to standard error when attempting to expand a variable, a positional parameter or the special parameter .Va \&! that is not set, and if the shell is not interactive, exit immediately. .It Fl V Li vi Enable the built-in .Xr vi 1 command line editor (disables .Fl E if it has been set). .It Fl v Li verbose The shell writes its input to standard error as it is read. Useful for debugging. .It Fl x Li xtrace Write each command (preceded by the value of the .Va PS4 variable subjected to parameter expansion and arithmetic expansion) to standard error before it is executed. Useful for debugging. .It nolog Another do-nothing option for .Tn POSIX compliance. It only has a long name. .El .Pp The .Fl c option causes the commands to be read from the .Ar string operand instead of from the standard input. Keep in mind that this option only accepts a single string as its argument, hence multi-word strings must be quoted. .Pp The .Fl /+o option takes as its only argument the long name of an option to be enabled or disabled. For example, the following two invocations of .Nm both enable the built-in .Xr emacs 1 command line editor: .Bd -literal -offset indent set -E set -o emacs .Ed .Pp If used without an argument, the .Fl o option displays the current option settings in a human-readable format. If .Cm +o is used without an argument, the current option settings are output in a format suitable for re-input into the shell. .Ss Lexical Structure The shell reads input in terms of lines from a file and breaks it up into words at whitespace (blanks and tabs), and at certain sequences of characters called .Dq operators , which are special to the shell. There are two types of operators: control operators and redirection operators (their meaning is discussed later). The following is a list of valid operators: .Bl -tag -width indent .It Control operators: .Bl -column "XXX" "XXX" "XXX" "XXX" "XXX" -offset center -compact .It Li & Ta Li && Ta Li \&( Ta Li \&) Ta Li \en .It Li ;; Ta Li ;& Ta Li \&; Ta Li \&| Ta Li || .El .It Redirection operators: .Bl -column "XXX" "XXX" "XXX" "XXX" "XXX" -offset center -compact .It Li < Ta Li > Ta Li << Ta Li >> Ta Li <> .It Li <& Ta Li >& Ta Li <<- Ta Li >| Ta \& .El .El .Pp The character .Ql # introduces a comment if used at the beginning of a word. The word starting with .Ql # and the rest of the line are ignored. .Pp .Tn ASCII .Dv NUL characters (character code 0) are not allowed in shell input. .Ss Quoting Quoting is used to remove the special meaning of certain characters or words to the shell, such as operators, whitespace, keywords, or alias names. .Pp There are four types of quoting: matched single quotes, dollar-single quotes, matched double quotes, and backslash. .Bl -tag -width indent .It Single Quotes Enclosing characters in single quotes preserves the literal meaning of all the characters (except single quotes, making it impossible to put single-quotes in a single-quoted string). .It Dollar-Single Quotes Enclosing characters between .Li $' and .Li ' preserves the literal meaning of all characters except backslashes and single quotes. A backslash introduces a C-style escape sequence: .Bl -tag -width xUnnnnnnnn .It \ea Alert (ring the terminal bell) .It \eb Backspace .It \ec Ns Ar c The control character denoted by .Li ^ Ns Ar c in .Xr stty 1 . If .Ar c is a backslash, it must be doubled. .It \ee The ESC character .Tn ( ASCII 0x1b) .It \ef Formfeed .It \en Newline .It \er Carriage return .It \et Horizontal tab .It \ev Vertical tab .It \e\e Literal backslash .It \e\&' Literal single-quote .It \e\&" Literal double-quote .It \e Ns Ar nnn The byte whose octal value is .Ar nnn (one to three digits) .It \ex Ns Ar nn The byte whose hexadecimal value is .Ar nn (one or more digits only the last two of which are used) .It \eu Ns Ar nnnn The Unicode code point .Ar nnnn (four hexadecimal digits) .It \eU Ns Ar nnnnnnnn The Unicode code point .Ar nnnnnnnn (eight hexadecimal digits) .El .Pp The sequences for Unicode code points are currently only useful with UTF-8 locales. They reject code point 0 and UTF-16 surrogates. .Pp If an escape sequence would produce a byte with value 0, that byte and the rest of the string until the matching single-quote are ignored. .Pp Any other string starting with a backslash is an error. .It Double Quotes Enclosing characters within double quotes preserves the literal meaning of all characters except dollar sign .Pq Ql $ , backquote .Pq Ql ` , and backslash .Pq Ql \e . The backslash inside double quotes is historically weird. It remains literal unless it precedes the following characters, which it serves to quote: .Pp .Bl -column "XXX" "XXX" "XXX" "XXX" "XXX" -offset center -compact .It Li $ Ta Li ` Ta Li \&" Ta Li \e Ta Li \en .El .It Backslash A backslash preserves the literal meaning of the following character, with the exception of the newline character .Pq Ql \en . A backslash preceding a newline is treated as a line continuation. .El .Ss Keywords Keywords or reserved words are words that have special meaning to the shell and are recognized at the beginning of a line and after a control operator. The following are keywords: .Bl -column "doneXX" "elifXX" "elseXX" "untilXX" "whileX" -offset center .It Li \&! Ta { Ta } Ta Ic case Ta Ic do .It Ic done Ta Ic elif Ta Ic else Ta Ic esac Ta Ic fi .It Ic for Ta Ic if Ta Ic then Ta Ic until Ta Ic while .El .Ss Aliases An alias is a name and corresponding value set using the .Ic alias built-in command. Wherever the command word of a simple command may occur, and after checking for keywords if a keyword may occur, 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 .Dq Li lf with the value .Dq Li "ls -F" , then the input .Pp .Dl "lf foobar" .Pp would become .Pp .Dl "ls -F foobar" .Pp Aliases are also recognized after an alias whose value ends with a space or tab. For example, if there is also an alias called .Dq Li nohup with the value .Dq Li "nohup " , then the input .Pp .Dl "nohup lf foobar" .Pp would become .Pp .Dl "nohup ls -F foobar" .Pp Aliases provide a convenient way for naive users to create shorthands for commands without having to learn how to create functions with arguments. Using aliases in scripts is discouraged because the command that defines them must be executed before the code that uses them is parsed. This is fragile and not portable. .Pp An alias name may be escaped in a command line, so that it is not replaced by its alias value, by using quoting characters within or adjacent to the alias name. This is most often done by prefixing an alias name with a backslash to execute a function, built-in, or normal program with the same name. See the .Sx Quoting subsection. .Ss Commands The shell interprets the words it reads according to a language, the specification of which is outside the scope of this man page (refer to the BNF in the .St -p1003.2 document). Essentially though, a line is read and if the first word of the line (or after a control operator) is not a keyword, then the shell has recognized a simple command. Otherwise, a complex command or some other special construct may have been recognized. .Ss Simple Commands If a simple command has been recognized, the shell performs the following actions: .Bl -enum .It Leading words of the form .Dq Li name=value are stripped off and assigned to the environment of the simple command (they do not affect expansions). Redirection operators and their arguments (as described below) are stripped off and saved for processing. .It The remaining words are expanded as described in the section called .Sx Word Expansions , and the first remaining word is considered the command name and the command is located. The remaining words are considered the arguments of the command. If no command name resulted, then the .Dq Li name=value variable assignments recognized in 1) affect the current shell. .It Redirections are performed as described in the next section. .El .Ss Redirections Redirections are used to change where a command reads its input or sends its output. In general, redirections open, close, or duplicate an existing reference to a file. The overall format used for redirection is: .Pp .D1 Oo Ar n Oc Ar redir-op file .Pp The .Ar redir-op is one of the redirection operators mentioned previously. The following gives some examples of how these operators can be used. Note that stdin and stdout are commonly used abbreviations for standard input and standard output respectively. .Bl -tag -width "1234567890XX" -offset indent .It Oo Ar n Oc Ns Li > Ar file redirect stdout (or file descriptor .Ar n ) to .Ar file .It Oo Ar n Oc Ns Li >| Ar file same as above, but override the .Fl C option .It Oo Ar n Oc Ns Li >> Ar file append stdout (or file descriptor .Ar n ) to .Ar file .It Oo Ar n Oc Ns Li < Ar file redirect stdin (or file descriptor .Ar n ) from .Ar file .It Oo Ar n Oc Ns Li <> Ar file redirect stdin (or file descriptor .Ar n ) to and from .Ar file .It Oo Ar n1 Oc Ns Li <& Ns Ar n2 duplicate stdin (or file descriptor .Ar n1 ) from file descriptor .Ar n2 .It Oo Ar n Oc Ns Li <&- close stdin (or file descriptor .Ar n ) .It Oo Ar n1 Oc Ns Li >& Ns Ar n2 duplicate stdout (or file descriptor .Ar n1 ) to file descriptor .Ar n2 .It Oo Ar n Oc Ns Li >&- close stdout (or file descriptor .Ar n ) .El .Pp The following redirection is often called a .Dq here-document . .Bd -unfilled -offset indent .Oo Ar n Oc Ns Li << Ar delimiter .Ar here-doc-text .Ar ... .Ar delimiter .Ed .Pp All the text on successive lines up to the delimiter is saved away and made available to the command on standard input, or file descriptor .Ar n if it is specified. If the .Ar delimiter as specified on the initial line is quoted, then the .Ar here-doc-text is treated literally, otherwise the text is subjected to parameter expansion, command substitution, and arithmetic expansion (as described in the section on .Sx Word Expansions ) . If the operator is .Dq Li <<- instead of .Dq Li << , then leading tabs in the .Ar here-doc-text are stripped. .Ss Search and Execution There are three types of commands: shell functions, built-in commands, and normal programs. The command is searched for (by name) in that order. The three types of commands are all executed in a different way. .Pp When a shell function is executed, all of the shell positional parameters (except .Li $0 , which remains unchanged) are 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. This all occurs within the current shell. .Pp Shell built-in commands are executed internally to the shell, without spawning a new process. There are two kinds of built-in commands: regular and special. Assignments before special builtins persist after they finish executing and assignment errors, redirection errors and certain operand errors cause a script to be aborted. Special builtins cannot be overridden with a function. Both regular and special builtins can affect the shell in ways normal programs cannot. .Pp Otherwise, if the command name does not match a function or built-in command, the command is searched for as a normal program in the file system (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 (i.e., if it does not begin with the .Dq "magic number" whose .Tn ASCII representation is .Dq Li #! , resulting in an .Er ENOEXEC return value from .Xr execve 2 ) but appears to be a text file, the shell will run a new instance of .Nm to interpret it. .Pp Note that previous versions of this document and the source code itself misleadingly and sporadically refer to a shell script without a magic number as a .Dq "shell procedure" . .Ss Path Search When locating a command, the shell first looks to see if it has a shell function by that name. Then it looks for a built-in command by that name. If a built-in command is not found, one of two things happen: .Bl -enum .It Command names containing a slash are simply executed without performing any searches. .It The shell searches each entry in the .Va PATH variable in turn for the command. The value of the .Va PATH variable should be a series of entries separated by colons. Each entry consists of a directory name. The current directory may be indicated implicitly by an empty directory name, or explicitly by a single period. .El .Ss Command Exit Status Each command has an exit status that can influence the behavior of other shell commands. The paradigm is that a command exits with zero for normal or success, and non-zero for failure, error, or a false indication. The man page for each command should indicate the various exit codes and what they mean. Additionally, the built-in commands return exit codes, as does an executed shell function. .Pp If a command is terminated by a signal, its exit status is greater than 128. The signal name can be found by passing the exit status to .Li kill -l . .Pp If there is no command word, the exit status is the exit status of the last command substitution executed, or zero if the command does not contain any command substitutions. .Ss Complex Commands Complex commands are combinations of simple commands with control operators or keywords, together creating a larger complex command. More generally, a command is one of the following: .Bl -item -offset indent .It simple command .It pipeline .It list or compound-list .It compound command .It function definition .El .Pp Unless otherwise stated, the exit status of a command is that of the last simple command executed by the command, or zero if no simple command was executed. .Ss Pipelines A pipeline is a sequence of one or more commands separated by the control operator .Ql \&| . The standard output of all but the last command is connected to the standard input of the next command. The standard output of the last command is inherited from the shell, as usual. .Pp The format for a pipeline is: .Pp .D1 Oo Li \&! Oc Ar command1 Op Li \&| Ar command2 ... .Pp The standard output of .Ar command1 is connected to the standard input of .Ar command2 . The standard input, standard output, or both of a command is considered to be assigned by the pipeline before any redirection specified by redirection operators that are part of the command. .Pp Note that unlike some other shells, .Nm executes each process in a pipeline with more than one command in a subshell environment and as a child of the .Nm process. .Pp If the pipeline is not in the background (discussed later), the shell waits for all commands to complete. .Pp If the keyword .Ic !\& does not precede the pipeline, the exit status is the exit status of the last command specified in the pipeline. Otherwise, the exit status is the logical NOT of the exit status of the last command. That is, if the last command returns zero, the exit status is 1; if the last command returns greater than zero, the exit status is zero. .Pp Because pipeline assignment of standard input or standard output or both takes place before redirection, it can be modified by redirection. For example: .Pp .Dl "command1 2>&1 | command2" .Pp sends both the standard output and standard error of .Ar command1 to the standard input of .Ar command2 . .Pp A .Ql \&; or newline terminator causes the preceding AND-OR-list (described below in the section called .Sx Short-Circuit List Operators ) to be executed sequentially; an .Ql & causes asynchronous execution of the preceding AND-OR-list. .Ss Background Commands (&) If a command is terminated by the control operator ampersand .Pq Ql & , the shell executes the command in a subshell environment (see .Sx Grouping Commands Together below) and asynchronously; the shell does not wait for the command to finish before executing the next command. .Pp The format for running a command in background is: .Pp .D1 Ar command1 Li & Op Ar command2 Li & Ar ... .Pp If the shell is not interactive, the standard input of an asynchronous command is set to .Pa /dev/null . .Pp The exit status is zero. .Ss Lists (Generally Speaking) A list is a sequence of zero or more commands separated by newlines, semicolons, or ampersands, and optionally terminated by one of these three characters. The commands in a list are executed in the order they are written. If command is followed by an ampersand, the shell starts the command and immediately proceeds onto the next command; otherwise it waits for the command to terminate before proceeding to the next one. .Ss Short-Circuit List Operators .Dq Li && and .Dq Li || are AND-OR list operators. .Dq Li && executes the first command, and then executes the second command if the exit status of the first command is zero. .Dq Li || is similar, but executes the second command if the exit status of the first command is nonzero. .Dq Li && and .Dq Li || both have the same priority. .Ss Flow-Control Constructs (if, while, for, case) The syntax of the .Ic if command is: .Bd -unfilled -offset indent -compact .Ic if Ar list .Ic then Ar list .Oo Ic elif Ar list .Ic then Ar list Oc Ar ... .Op Ic else Ar list .Ic fi .Ed .Pp The exit status is that of selected .Ic then or .Ic else list, or zero if no list was selected. .Pp The syntax of the .Ic while command is: .Bd -unfilled -offset indent -compact .Ic while Ar list .Ic do Ar list .Ic done .Ed .Pp The two lists are executed repeatedly while the exit status of the first list is zero. The .Ic until command is similar, but has the word .Ic until in place of .Ic while , which causes it to repeat until the exit status of the first list is zero. .Pp The exit status is that of the last execution of the second list, or zero if it was never executed. .Pp The syntax of the .Ic for command is: .Bd -unfilled -offset indent -compact .Ic for Ar variable Op Ic in Ar word ... .Ic do Ar list .Ic done .Ed .Pp If .Ic in and the following words are omitted, .Ic in Li \&"$@\&" is used instead. The words are expanded, and then the list is executed repeatedly with the variable set to each word in turn. The .Ic do and .Ic done commands may be replaced with .Ql { and .Ql } . .Pp The syntax of the .Ic break and .Ic continue commands is: .D1 Ic break Op Ar num .D1 Ic continue Op Ar num .Pp The .Ic break command terminates the .Ar num innermost .Ic for or .Ic while loops. The .Ic continue command continues with the next iteration of the innermost loop. These are implemented as special built-in commands. .Pp The syntax of the .Ic case command is: .Bd -unfilled -offset indent -compact .Ic case Ar word Ic in -.Ar pattern Ns Li ) Ar list Li ;; +.Ar pattern Ns ) Ar list Li ;; .Ar ... .Ic esac .Ed .Pp The pattern can actually be one or more patterns (see .Sx Shell Patterns described later), separated by .Ql \&| characters. Tilde expansion, parameter expansion, command substitution, arithmetic expansion and quote removal are applied to the word. Then, each pattern is expanded in turn using tilde expansion, parameter expansion, command substitution and arithmetic expansion and the expanded form of the word is checked against it. If a match is found, the corresponding list is executed. If the selected list is terminated by the control operator .Ql ;& instead of .Ql ;; , execution continues with the next list, continuing until a list terminated with .Ql ;; or the end of the .Ic case command. .Ss Grouping Commands Together Commands may be grouped by writing either .Pp .D1 Li \&( Ns Ar list Ns Li \%) .Pp or .Pp .D1 Li { Ar list Ns Li \&; } .Pp The first form executes the commands in a subshell environment. A subshell environment has its own copy of: .Bl -enum .It The current working directory as set by .Ic cd . .It The file creation mask as set by .Ic umask . .It Resource limits as set by .Ic ulimit . .It References to open files. .It Traps as set by .Ic trap . .It Known jobs. .It Positional parameters and variables. .It Shell options. .It Shell functions. .It Shell aliases. .El .Pp These are copied from the parent shell environment, except that trapped (but not ignored) signals are reset to the default action and known jobs are cleared. Any changes do not affect the parent shell environment. .Pp A subshell environment may be implemented as a child process or differently. If job control is enabled in an interactive shell, commands grouped in parentheses can be suspended and continued as a unit. .Pp For compatibility with other shells, two open parentheses in sequence should be separated by whitespace. .Pp The second form never forks another shell, so it is slightly more efficient. Grouping commands together this way allows the user to redirect their output as though they were one program: .Bd -literal -offset indent { echo -n "hello"; echo " world"; } > greeting .Ed .Ss Functions The syntax of a function definition is .Pp .D1 Ar name Li \&( \&) Ar command .Pp A function definition is an executable statement; when executed it installs a function named .Ar name and returns an exit status of zero. The .Ar command is normally a list enclosed between .Ql { and .Ql } . .Pp Variables may be declared to be local to a function by using the .Ic local command. This should appear as the first statement of a function, and the syntax is: .Pp .D1 Ic local Oo Ar variable ... Oc Op Fl .Pp The .Ic local command is implemented as a built-in command. The exit status is zero unless the command is not in a function or a variable name is invalid. .Pp When a variable is made local, it inherits the initial value and exported and readonly flags from the variable with the same name in the surrounding scope, if there is one. Otherwise, the variable is initially unset. The shell uses dynamic scoping, so that if the variable .Va x is made local to function .Em f , which then calls function .Em g , references to the variable .Va x made inside .Em g will refer to the variable .Va x declared inside .Em f , not to the global variable named .Va x . .Pp The only special parameter that can be made local is .Ql - . Making .Ql - local causes any shell options (including those that only have long names) that are changed via the .Ic set command inside the function to be restored to their original values when the function returns. .Pp The syntax of the .Ic return command is .Pp .D1 Ic return Op Ar exitstatus .Pp It terminates the current executional scope, returning from the closest nested function or sourced script; if no function or sourced script is being executed, it exits the shell instance. The .Ic return command is implemented as a special built-in command. .Ss Variables and Parameters The shell maintains a set of parameters. A parameter denoted by a name (consisting solely of alphabetics, numerics, and underscores, and starting with an alphabetic or an underscore) is called a variable. When starting up, the shell turns all environment variables with valid names into shell variables. New variables can be set using the form .Pp .D1 Ar name Ns = Ns Ar value .Pp A parameter can also be denoted by a number or a special character as explained below. .Pp Assignments are expanded differently from other words: tilde expansion is also performed after the equals sign and after any colon and usernames are also terminated by colons, and field splitting and pathname expansion are not performed. .Pp This special expansion applies not only to assignments that form a simple command by themselves or precede a command word, but also to words passed to the .Ic export , .Ic local or .Ic readonly built-in commands that have this form. For this, the builtin's name must be literal (not the result of an expansion) and may optionally be preceded by one or more literal instances of .Ic command without options. .Ss Positional Parameters A positional parameter is a parameter denoted by a number greater than zero. The shell sets these initially to the values of its command line arguments that follow the name of the shell script. The .Ic set built-in command can also be used to set or reset them. .Ss Special Parameters Special parameters are parameters denoted by a single special character or the digit zero. They are shown in the following list, exactly as they would appear in input typed by the user or in the source of a shell script. .Bl -hang .It Li $* Expands to the positional parameters, starting from one. When the expansion occurs within a double-quoted string it expands to a single field with the value of each parameter separated by the first character of the .Va IFS variable, or by a space if .Va IFS is unset. .It Li $@ Expands to the positional parameters, starting from one. When the expansion occurs within double-quotes, each positional parameter expands as a separate argument. If there are no positional parameters, the expansion of .Li @ generates zero arguments, even when .Li @ is double-quoted. What this basically means, for example, is if .Li $1 is .Dq Li abc and .Li $2 is .Dq Li "def ghi" , then .Li \&"$@\&" expands to the two arguments: .Bd -literal -offset indent "abc" "def ghi" .Ed .It Li $# Expands to the number of positional parameters. .It Li $? Expands to the exit status of the most recent pipeline. .It Li $- (hyphen) Expands to the current option flags (the single-letter option names concatenated into a string) as specified on invocation, by the .Ic set built-in command, or implicitly by the shell. .It Li $$ Expands to the process ID of the invoked shell. A subshell retains the same value of .Va $ as its parent. .It Li $! Expands to the process ID of the most recent background command executed from the current shell. For a pipeline, the process ID is that of the last command in the pipeline. If this parameter is referenced, the shell will remember the process ID and its exit status until the .Ic wait built-in command reports completion of the process. .It Li $0 (zero) Expands to the name of the shell script if passed on the command line, the .Ar name operand if given (with .Fl c ) or otherwise argument 0 passed to the shell. .El .Ss Special Variables The following variables are set by the shell or have special meaning to it: .Bl -tag -width ".Va HISTSIZE" .It Va CDPATH The search path used with the .Ic cd built-in. .It Va EDITOR The fallback editor used with the .Ic fc built-in. If not set, the default editor is .Xr ed 1 . .It Va FCEDIT The default editor used with the .Ic fc built-in. .It Va HISTSIZE The number of previous commands that are accessible. .It Va HOME The user's home directory, used in tilde expansion and as a default directory for the .Ic cd built-in. .It Va IFS Input Field Separators. The default value is .Aq space , .Aq tab , and .Aq newline in that order. This default also applies if .Va IFS is unset, but not if it is set to the empty string. See the .Sx White Space Splitting section for more details. .It Va LINENO The current line number in the script or function. .It Va MAIL The name of a mail file, that will be checked for the arrival of new mail. Overridden by .Va MAILPATH . .It Va MAILPATH A colon .Pq Ql \&: separated list of file names, for the shell to check for incoming mail. This variable overrides the .Va MAIL setting. There is a maximum of 10 mailboxes that can be monitored at once. .It Va OPTIND The index of the next argument to be processed by .Ic getopts . This is initialized to 1 at startup. .It Va PATH The default search path for executables. See the .Sx Path Search section for details. .It Va PPID The parent process ID of the invoked shell. This is set at startup unless this variable is in the environment. A later change of parent process ID is not reflected. A subshell retains the same value of .Va PPID . .It Va PS1 The primary prompt string, which defaults to .Dq Li "$ " , unless you are the superuser, in which case it defaults to .Dq Li "# " . .Va PS1 may include any of the following formatting sequences, which are replaced by the given information: .Bl -tag -width indent .It Li \eH This system's fully-qualified hostname (FQDN). .It Li \eh This system's hostname. .It Li \eW The final component of the current working directory. .It Li \ew The entire path of the current working directory. .It Li \e$ Superuser status. .Dq Li "$ " for normal users and .Dq Li "# " for superusers. .It Li \e\e A literal backslash. .El .It Va PS2 The secondary prompt string, which defaults to .Dq Li "> " . .Va PS2 may include any of the formatting sequences from .Va PS1 . .It Va PS4 The prefix for the trace output (if .Fl x is active). The default is .Dq Li "+ " . .El .Ss Word Expansions This clause describes the various expansions that are performed on words. Not all expansions are performed on every word, as explained later. .Pp 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 .Va @ within double-quotes, as was described above. .Pp The order of word expansion is: .Bl -enum .It Tilde Expansion, Parameter Expansion, Command Substitution, Arithmetic Expansion (these all occur at the same time). .It Field Splitting is performed on fields generated by step (1) unless the .Va IFS variable is null. .It Pathname Expansion (unless the .Fl f option is in effect). .It Quote Removal. .El .Pp The .Ql $ character is used to introduce parameter expansion, command substitution, or arithmetic expansion. .Ss Tilde Expansion (substituting a user's home directory) A word beginning with an unquoted tilde character .Pq Ql ~ is subjected to tilde expansion. All the characters up to a slash .Pq Ql / or the end of the word are treated as a username and are replaced with the user's home directory. If the username is missing (as in .Pa ~/foobar ) , the tilde is replaced with the value of the .Va HOME variable (the current user's home directory). .Ss Parameter Expansion The format for parameter expansion is as follows: .Pp .D1 Li ${ Ns Ar expression Ns Li } .Pp where .Ar expression consists of all characters until the matching .Ql } . Any .Ql } escaped by a backslash or within a single-quoted or double-quoted string, and characters in embedded arithmetic expansions, command substitutions, and variable expansions, are not examined in determining the matching .Ql } . If the variants with .Ql + , .Ql - , .Ql = or .Ql ?\& occur within a double-quoted string, as an extension there may be unquoted parts (via double-quotes inside the expansion); .Ql } within such parts are also not examined in determining the matching .Ql } . .Pp The simplest form for parameter expansion is: .Pp .D1 Li ${ Ns Ar parameter Ns Li } .Pp The value, if any, of .Ar parameter is substituted. .Pp The parameter name or symbol can be enclosed in braces, which are optional except for positional parameters with more than one digit or when parameter is followed by a character that could be interpreted as part of the name. If a parameter expansion occurs inside double-quotes: .Bl -enum .It Field splitting is not performed on the results of the expansion, with the exception of the special parameter .Va @ . .It Pathname expansion is not performed on the results of the expansion. .El .Pp In addition, a parameter expansion can be modified by using one of the following formats. .Bl -tag -width indent .It Li ${ Ns Ar parameter Ns Li :- Ns Ar word Ns Li } Use Default Values. If .Ar parameter is unset or null, the expansion of .Ar word is substituted; otherwise, the value of .Ar parameter is substituted. .It Li ${ Ns Ar parameter Ns Li := Ns Ar word Ns Li } Assign Default Values. If .Ar parameter is unset or null, the expansion of .Ar word is assigned to .Ar parameter . In all cases, the final value of .Ar parameter is substituted. Quoting inside .Ar word does not prevent field splitting or pathname expansion. Only variables, not positional parameters or special parameters, can be assigned in this way. .It Li ${ Ns Ar parameter Ns Li :? Ns Oo Ar word Oc Ns Li } Indicate Error if Null or Unset. If .Ar parameter is unset or null, the expansion of .Ar word (or a message indicating it is unset if .Ar word is omitted) is written to standard error and the shell exits with a nonzero exit status. Otherwise, the value of .Ar parameter is substituted. An interactive shell need not exit. .It Li ${ Ns Ar parameter Ns Li :+ Ns Ar word Ns Li } Use Alternate Value. If .Ar parameter is unset or null, null is substituted; otherwise, the expansion of .Ar word is substituted. .El .Pp In the parameter expansions shown previously, use of the colon in the format results in a test for a parameter that is unset or null; omission of the colon results in a test for a parameter that is only unset. .Pp The .Ar word inherits the type of quoting (unquoted, double-quoted or here-document) from the surroundings, with the exception that a backslash that quotes a closing brace is removed during quote removal. .Bl -tag -width indent .It Li ${# Ns Ar parameter Ns Li } String Length. The length in characters of the value of .Ar parameter . .El .Pp The following four varieties of parameter expansion provide for substring processing. In each case, pattern matching notation (see .Sx Shell Patterns ) , rather than regular expression notation, is used to evaluate the patterns. If parameter is one of the special parameters .Va * or .Va @ , the result of the expansion is unspecified. Enclosing the full parameter expansion string in double-quotes does not cause the following four varieties of pattern characters to be quoted, whereas quoting characters within the braces has this effect. .Bl -tag -width indent .It Li ${ Ns Ar parameter Ns Li % Ns Ar word Ns Li } Remove Smallest Suffix Pattern. The .Ar word is expanded to produce a pattern. The parameter expansion then results in .Ar parameter , with the smallest portion of the suffix matched by the pattern deleted. .It Li ${ Ns Ar parameter Ns Li %% Ns Ar word Ns Li } Remove Largest Suffix Pattern. The .Ar word is expanded to produce a pattern. The parameter expansion then results in .Ar parameter , with the largest portion of the suffix matched by the pattern deleted. .It Li ${ Ns Ar parameter Ns Li # Ns Ar word Ns Li } Remove Smallest Prefix Pattern. The .Ar word is expanded to produce a pattern. The parameter expansion then results in .Ar parameter , with the smallest portion of the prefix matched by the pattern deleted. .It Li ${ Ns Ar parameter Ns Li ## Ns Ar word Ns Li } Remove Largest Prefix Pattern. The .Ar word is expanded to produce a pattern. The parameter expansion then results in .Ar parameter , with the largest portion of the prefix matched by the pattern deleted. .El .Ss Command Substitution Command substitution allows the output of a command to be substituted in place of the command name itself. Command substitution occurs when the command is enclosed as follows: .Pp .D1 Li $( Ns Ar command Ns Li )\& .Pp or the backquoted version: .Pp .D1 Li ` Ns Ar command Ns Li ` .Pp The shell expands the command substitution by executing command and replacing the command substitution with the standard output of the command, removing sequences of one or more newlines at the end of the substitution. Embedded newlines before the end of the output are not removed; however, during field splitting, they may be translated into spaces depending on the value of .Va IFS and the quoting that is in effect. The command is executed in a subshell environment, except that the built-in commands .Ic jobid , .Ic jobs , and .Ic trap return information about the parent shell environment and .Ic times returns information about the same process if they are the only command in a command substitution. .Pp If a command substitution of the .Li $( form begins with a subshell, the .Li $( and .Li (\& must be separated by whitespace to avoid ambiguity with arithmetic expansion. .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: .Pp .D1 Li $(( Ns Ar expression Ns Li )) .Pp The .Ar expression is treated as if it were in double-quotes, except that a double-quote inside the expression is not treated specially. The shell expands all tokens in the .Ar expression for parameter expansion, command substitution, arithmetic expansion and quote removal. .Pp The allowed expressions are a subset of C expressions, summarized below. .Bl -tag -width "Variables" -offset indent .It Values All values are of type .Ft intmax_t . .It Constants Decimal, octal (starting with .Li 0 ) and hexadecimal (starting with .Li 0x ) integer constants. .It Variables Shell variables can be read and written and contain integer constants. .It Unary operators .Li "! ~ + -" .It Binary operators .Li "* / % + - << >> < <= > >= == != & ^ | && ||" .It Assignment operators .Li "= += -= *= /= %= <<= >>= &= ^= |=" .It Conditional operator .Li "? :" .El .Pp The result of the expression is substituted in decimal. .Ss White Space Splitting (Field Splitting) In certain contexts, after parameter expansion, command substitution, and arithmetic expansion the shell scans the results of expansions and substitutions that did not occur in double-quotes for field splitting and multiple fields can result. .Pp Characters in .Va IFS that are whitespace .Po .Aq space , .Aq tab , and .Aq newline .Pc are treated differently from other characters in .Va IFS . .Pp Whitespace in .Va IFS at the beginning or end of a word is discarded. .Pp Subsequently, a field is delimited by either .Bl -enum .It a non-whitespace character in .Va IFS with any whitespace in .Va IFS surrounding it, or .It one or more whitespace characters in .Va IFS . .El .Pp If a word ends with a non-whitespace character in .Va IFS , there is no empty field after this character. .Pp If no field is delimited, the word is discarded. In particular, if a word consists solely of an unquoted substitution and the result of the substitution is null, it is removed by field splitting even if .Va IFS is null. .Ss Pathname Expansion (File Name Generation) Unless the .Fl f option is set, file name generation is performed after word splitting is complete. Each word is viewed as a series of patterns, separated by slashes. The process of expansion replaces the word with the names of all existing files whose names can be formed by replacing each pattern with a string that matches the specified pattern. There are two restrictions on this: first, a pattern cannot match a string containing a slash, and second, a pattern cannot match a string starting with a period unless the first character of the pattern is a period. The next section describes the patterns used for Pathname Expansion, the four varieties of parameter expansion for substring processing and the .Ic case command. .Ss Shell Patterns A pattern consists of normal characters, which match themselves, and meta-characters. The meta-characters are .Ql * , .Ql \&? , and .Ql \&[ . These characters lose their special meanings if they are quoted. When command or variable substitution is performed and the dollar sign or back quotes are not double-quoted, the value of the variable or the output of the command is scanned for these characters and they are turned into meta-characters. .Pp An asterisk .Pq Ql * matches any string of characters. A question mark .Pq Ql \&? matches any single character. A left bracket .Pq Ql \&[ introduces a character class. The end of the character class is indicated by a .Ql \&] ; if the .Ql \&] is missing then the .Ql \&[ matches a .Ql \&[ rather than introducing a character class. A character class matches any of the characters between the square brackets. A locale-dependent range of characters may be specified using a minus sign. A named class of characters (see .Xr wctype 3 ) may be specified by surrounding the name with .Ql \&[: and .Ql :\&] . For example, .Ql \&[\&[:alpha:\&]\&] is a shell pattern that matches a single letter. The character class may be complemented by making an exclamation point .Pq Ql !\& the first character of the character class. A caret .Pq Ql ^ has the same effect but is non-standard. .Pp To include a .Ql \&] in a character class, make it the first character listed (after the .Ql \&! or .Ql ^ , if any). To include a .Ql - , make it the first or last character listed. .Ss Built-in Commands This section lists the built-in commands. .Bl -tag -width indent .It Ic \&: A null command that returns a 0 (true) exit value. .It Ic \&. Ar file The commands in the specified file are read and executed by the shell. The .Ic return command may be used to return to the .Ic \&. command's caller. If .Ar file contains any .Ql / characters, it is used as is. Otherwise, the shell searches the .Va PATH for the file. If it is not found in the .Va PATH , it is sought in the current working directory. .It Ic \&[ A built-in equivalent of .Xr test 1 . .It Ic alias Oo Ar name Ns Oo = Ns Ar string Oc ... Oc If .Ar name Ns = Ns Ar string is specified, the shell defines the alias .Ar name with value .Ar string . If just .Ar name is specified, the value of the alias .Ar name is printed. With no arguments, the .Ic alias built-in command prints the names and values of all defined aliases (see .Ic unalias ) . Alias values are written with appropriate quoting so that they are suitable for re-input to the shell. Also see the .Sx Aliases subsection. .It Ic bg Op Ar job ... Continue the specified jobs (or the current job if no jobs are given) in the background. .It Ic bind Oo Fl aeklrsv Oc Oo Ar key Oo Ar command Oc Oc List or alter key bindings for the line editor. This command is documented in .Xr editrc 5 . .It Ic break Op Ar num See the .Sx Flow-Control Constructs subsection. .It Ic builtin Ar cmd Op Ar arg ... Execute the specified built-in command, .Ar cmd . This is useful when the user wishes to override a shell function with the same name as a built-in command. .It Ic cd Oo Fl L | P Oc Oo Fl e Oc Op Ar directory .It Ic cd Fl Switch to the specified .Ar directory , to the directory specified in the .Va HOME environment variable if no .Ar directory is specified or to the directory specified in the .Va OLDPWD environment variable if .Ar directory is .Fl . If .Ar directory does not begin with .Pa / , \&. , or .Pa .. , then the directories listed in the .Va CDPATH variable will be searched for the specified .Ar directory . If .Va CDPATH is unset, the current directory is searched. The format of .Va CDPATH is the same as that of .Va PATH . In an interactive shell, the .Ic cd command will print out the name of the directory that it actually switched to if the .Va CDPATH mechanism was used or if .Ar directory was .Fl . .Pp If the .Fl P option is specified, .Pa .. is handled physically and symbolic links are resolved before .Pa .. components are processed. If the .Fl L option is specified, .Pa .. is handled logically. This is the default. .Pp The .Fl e option causes .Ic cd to return exit status 1 if the full pathname of the new directory cannot be determined reliably or at all. Normally this is not considered an error, although a warning is printed. .It Ic chdir A synonym for the .Ic cd built-in command. .It Ic command Oo Fl p Oc Op Ar utility Op Ar argument ... .It Ic command Oo Fl p Oc Fl v Ar utility .It Ic command Oo Fl p Oc Fl V Ar utility The first form of invocation executes the specified .Ar utility , ignoring shell functions in the search. If .Ar utility is a special builtin, it is executed as if it were a regular builtin. .Pp If the .Fl p option is specified, the command search is performed using a default value of .Va PATH that is guaranteed to find all of the standard utilities. .Pp If the .Fl v option is specified, .Ar utility is not executed but a description of its interpretation by the shell is printed. For ordinary commands the output is the path name; for shell built-in commands, shell functions and keywords only the name is written. Aliases are printed as .Dq Ic alias Ar name Ns = Ns Ar value . .Pp The .Fl V option is identical to .Fl v except for the output. It prints .Dq Ar utility Ic is Ar description where .Ar description is either the path name to .Ar utility , a special shell builtin, a shell builtin, a shell function, a shell keyword or an alias for .Ar value . .It Ic continue Op Ar num See the .Sx Flow-Control Constructs subsection. .It Ic echo Oo Fl e | n Oc Op Ar string ... Print a space-separated list of the arguments to the standard output and append a newline character. .Bl -tag -width indent .It Fl n Suppress the output of the trailing newline. .It Fl e Process C-style backslash escape sequences. The .Ic echo command understands the following character escapes: .Bl -tag -width indent .It \ea Alert (ring the terminal bell) .It \eb Backspace .It \ec Suppress the trailing newline (this has the side-effect of truncating the line if it is not the last character) .It \ee The ESC character .Tn ( ASCII 0x1b) .It \ef Formfeed .It \en Newline .It \er Carriage return .It \et Horizontal tab .It \ev Vertical tab .It \e\e Literal backslash .It \e0nnn (Zero) The character whose octal value is .Ar nnn .El .Pp If .Ar string is not enclosed in quotes then the backslash itself must be escaped with a backslash to protect it from the shell. For example .Bd -literal -offset indent $ echo -e "a\evb" a b $ echo -e a\e\evb a b $ echo -e "a\e\eb" a\eb $ echo -e a\e\e\e\eb a\eb .Ed .El .Pp Only one of the .Fl e and .Fl n options may be specified. .It Ic eval Ar string ... Concatenate all the arguments with spaces. Then re-parse and execute the command. .It Ic exec Op Ar command Op arg ... Unless .Ar command is omitted, the shell process is replaced with the specified program (which must be a real program, not a shell built-in command or function). Any redirections on the .Ic exec command are marked as permanent, so that they are not undone when the .Ic exec command finishes. .It Ic exit Op Ar exitstatus Terminate the shell process. If .Ar exitstatus is given it is used as the exit status of the shell. Otherwise, if the shell is executing an .Cm EXIT trap, the exit status of the last command before the trap is used; if the shell is executing a trap for a signal, the shell exits by resending the signal to itself. Otherwise, the exit status of the preceding command is used. The exit status should be an integer between 0 and 255. .It Ic export Ar name ... .It Ic export Op Fl p The specified names are exported so that they will appear in the environment of subsequent commands. The only way to un-export a variable is to .Ic unset it. The shell allows the value of a variable to be set at the same time as it is exported by writing .Pp .D1 Ic export Ar name Ns = Ns Ar value .Pp With no arguments the .Ic export command lists the names of all exported variables. If the .Fl p option is specified, the exported variables are printed as .Dq Ic export Ar name Ns = Ns Ar value lines, suitable for re-input to the shell. .It Ic false A null command that returns a non-zero (false) exit value. .It Ic fc Oo Fl e Ar editor Oc Op Ar first Op Ar last .It Ic fc Fl l Oo Fl nr Oc Op Ar first Op Ar last .It Ic fc Fl s Oo Ar old Ns = Ns Ar new Oc Op Ar first The .Ic fc built-in command lists, or edits and re-executes, commands previously entered to an interactive shell. .Bl -tag -width indent .It Fl e Ar editor Use the editor named by .Ar editor to edit the commands. The .Ar editor string is a command name, subject to search via the .Va PATH variable. The value in the .Va FCEDIT variable is used as a default when .Fl e is not specified. If .Va FCEDIT is null or unset, the value of the .Va EDITOR variable is used. If .Va EDITOR is null or unset, .Xr ed 1 is used as the editor. .It Fl l No (ell) List the commands rather than invoking an editor on them. The commands are written in the sequence indicated by the .Ar first and .Ar last operands, as affected by .Fl r , with each command preceded by the command number. .It Fl n Suppress command numbers when listing with .Fl l . .It Fl r Reverse the order of the commands listed (with .Fl l ) or edited (with neither .Fl l nor .Fl s ) . .It Fl s Re-execute the command without invoking an editor. .It Ar first .It Ar last Select the commands to list or edit. The number of previous commands that can be accessed are determined by the value of the .Va HISTSIZE variable. The value of .Ar first or .Ar last or both are one of the following: .Bl -tag -width indent .It Oo Cm + Oc Ns Ar num A positive number representing a command number; command numbers can be displayed with the .Fl l option. .It Fl Ar num A negative decimal number representing the command that was executed .Ar num of commands previously. For example, \-1 is the immediately previous command. .It Ar string A string indicating the most recently entered command that begins with that string. If the .Ar old Ns = Ns Ar new operand is not also specified with .Fl s , the string form of the first operand cannot contain an embedded equal sign. .El .El .Pp The following variables affect the execution of .Ic fc : .Bl -tag -width ".Va HISTSIZE" .It Va FCEDIT Name of the editor to use for history editing. .It Va HISTSIZE The number of previous commands that are accessible. .El .It Ic fg Op Ar job Move the specified .Ar job or the current job to the foreground. .It Ic getopts Ar optstring var The .Tn POSIX .Ic getopts command. The .Ic getopts command deprecates the older .Xr getopt 1 command. The first argument should be a series of letters, each possibly followed by a colon which indicates that the option takes an argument. The specified variable is set to the parsed option. The index of the next argument is placed into the shell variable .Va OPTIND . If an option takes an argument, it is placed into the shell variable .Va OPTARG . If an invalid option is encountered, .Ar var is set to .Ql \&? . It returns a false value (1) when it encounters the end of the options. A new set of arguments may be parsed by assigning .Li OPTIND=1 . .It Ic hash Oo Fl rv Oc Op Ar command ... The shell maintains a hash table which remembers the locations of commands. With no arguments whatsoever, the .Ic hash command prints out the contents of this table. .Pp With arguments, the .Ic hash command removes each specified .Ar command from the hash table (unless they are functions) and then locates it. With the .Fl v option, .Ic hash prints the locations of the commands as it finds them. The .Fl r option causes the .Ic hash command to delete all the entries in the hash table except for functions. .It Ic jobid Op Ar job Print the process IDs of the processes in the specified .Ar job . If the .Ar job argument is omitted, use the current job. .It Ic jobs Oo Fl lps Oc Op Ar job ... Print information about the specified jobs, or all jobs if no .Ar job argument is given. The information printed includes job ID, status and command name. .Pp If the .Fl l option is specified, the PID of each job is also printed. If the .Fl p option is specified, only the process IDs for the process group leaders are printed, one per line. If the .Fl s option is specified, only the PIDs of the job commands are printed, one per line. .It Ic kill A built-in equivalent of .Xr kill 1 that additionally supports sending signals to jobs. .It Ic local Oo Ar variable ... Oc Op Fl See the .Sx Functions subsection. .It Ic printf A built-in equivalent of .Xr printf 1 . .It Ic pwd Op Fl L | P Print the path of the current directory. The built-in command may differ from the program of the same name because the built-in command remembers what the current directory is rather than recomputing it each time. This makes it faster. However, if the current directory is renamed, the built-in version of .Xr pwd 1 will continue to print the old name for the directory. .Pp If the .Fl P option is specified, symbolic links are resolved. If the .Fl L option is specified, the shell's notion of the current directory is printed (symbolic links are not resolved). This is the default. .It Ic read Oo Fl p Ar prompt Oc Oo .Fl t Ar timeout Oc Oo Fl er Oc Ar variable ... The .Ar prompt is printed if the .Fl p option is specified and the standard input is a terminal. Then a line is read from the standard input. The trailing newline is deleted from the line and the line is split as described in the section on .Sx White Space Splitting (Field Splitting) above, and the pieces are assigned to the variables in order. If there are more pieces than variables, the remaining pieces (along with the characters in .Va IFS that separated them) are assigned to the last variable. If there are more variables than pieces, the remaining variables are assigned the null string. .Pp Backslashes are treated specially, unless the .Fl r option is specified. If a backslash is followed by a newline, the backslash and the newline will be deleted. If a backslash is followed by any other character, the backslash will be deleted and the following character will be treated as though it were not in .Va IFS , even if it is. .Pp If the .Fl t option is specified and the .Ar timeout elapses before a complete line of input is supplied, the .Ic read command will return an exit status as if terminated by .Dv SIGALRM without assigning any values. The .Ar timeout value may optionally be followed by one of .Ql s , .Ql m or .Ql h to explicitly specify seconds, minutes or hours. If none is supplied, .Ql s is assumed. .Pp The .Fl e option exists only for backward compatibility with older scripts. .Pp The exit status is 0 on success, 1 on end of file, between 2 and 128 if an error occurs and greater than 128 if a trapped signal interrupts .Ic read . .It Ic readonly Oo Fl p Oc Op Ar name ... Each specified .Ar name is marked as read only, so that it cannot be subsequently modified or unset. The shell allows the value of a variable to be set at the same time as it is marked read only by using the following form: .Pp .D1 Ic readonly Ar name Ns = Ns Ar value .Pp With no arguments the .Ic readonly command lists the names of all read only variables. If the .Fl p option is specified, the read-only variables are printed as .Dq Ic readonly Ar name Ns = Ns Ar value lines, suitable for re-input to the shell. .It Ic return Op Ar exitstatus See the .Sx Functions subsection. .It Ic set Oo Fl /+abCEefIimnpTuVvx Oc Oo Fl /+o Ar longname Oc Oo .Fl c Ar string Oc Op Fl - Ar arg ... The .Ic set command performs three different functions: .Bl -item .It With no arguments, it lists the values of all shell variables. .It If options are given, either in short form or using the long .Dq Fl /+o Ar longname form, it sets or clears the specified options as described in the section called .Sx Argument List Processing . .It If the .Dq Fl - option is specified, .Ic set will replace the shell's positional parameters with the subsequent arguments. If no arguments follow the .Dq Fl - option, all the positional parameters will be cleared, which is equivalent to executing the command .Dq Li "shift $#" . The .Dq Fl - flag may be omitted when specifying arguments to be used as positional replacement parameters. This is not recommended, because the first argument may begin with a dash .Pq Ql - or a plus .Pq Ql + , which the .Ic set command will interpret as a request to enable or disable options. .El .It Ic setvar Ar variable value Assigns the specified .Ar value to the specified .Ar variable . The .Ic setvar command is intended to be used in functions that assign values to variables whose names are passed as parameters. In general it is better to write .Dq Ar variable Ns = Ns Ar value rather than using .Ic setvar . .It Ic shift Op Ar n Shift the positional parameters .Ar n times, or once if .Ar n is not specified. A shift sets the value of .Li $1 to the value of .Li $2 , the value of .Li $2 to the value of .Li $3 , and so on, decreasing the value of .Li $# by one. For portability, shifting if there are zero positional parameters should be avoided, since the shell may abort. .It Ic test A built-in equivalent of .Xr test 1 . .It Ic times Print the amount of time spent executing the shell process and its children. The first output line shows the user and system times for the shell process itself, the second one contains the user and system times for the children. .It Ic trap Oo Ar action Oc Ar signal ... .It Ic trap Fl l Cause the shell to parse and execute .Ar action when any specified .Ar signal is received. The signals are specified by name or number. In addition, the pseudo-signal .Cm EXIT may be used to specify an .Ar action that is performed when the shell terminates. The .Ar action may be an empty string or a dash .Pq Ql - ; the former causes the specified signal to be ignored and the latter causes the default action to be taken. Omitting the .Ar action and using only signal numbers is another way to request the default action. In a subshell or utility environment, the shell resets trapped (but not ignored) signals to the default action. The .Ic trap command has no effect on signals that were ignored on entry to the shell. .Pp Option .Fl l causes the .Ic trap command to display a list of valid signal names. .It Ic true A null command that returns a 0 (true) exit value. .It Ic type Op Ar name ... Interpret each .Ar name as a command and print the resolution of the command search. Possible resolutions are: shell keyword, alias, special shell builtin, shell builtin, command, tracked alias and not found. For aliases the alias expansion is printed; for commands and tracked aliases the complete pathname of the command is printed. .It Ic ulimit Oo Fl HSabcdfklmnopstuvw Oc Op Ar limit Set or display resource limits (see .Xr getrlimit 2 ) . If .Ar limit is specified, the named resource will be set; otherwise the current resource value will be displayed. .Pp If .Fl H is specified, the hard limits will be set or displayed. While everybody is allowed to reduce a hard limit, only the superuser can increase it. The .Fl S option specifies the soft limits instead. When displaying limits, only one of .Fl S or .Fl H can be given. The default is to display the soft limits, and to set both the hard and the soft limits. .Pp Option .Fl a causes the .Ic ulimit command to display all resources. The parameter .Ar limit is not acceptable in this mode. .Pp The remaining options specify which resource value is to be displayed or modified. They are mutually exclusive. .Bl -tag -width indent .It Fl b Ar sbsize The maximum size of socket buffer usage, in bytes. .It Fl c Ar coredumpsize The maximal size of core dump files, in 512-byte blocks. .It Fl d Ar datasize The maximal size of the data segment of a process, in kilobytes. .It Fl f Ar filesize The maximal size of a file, in 512-byte blocks. .It Fl k Ar kqueues The maximal number of kqueues (see .Xr kqueue 2 ) for this user ID. .It Fl l Ar lockedmem The maximal size of memory that can be locked by a process, in kilobytes. .It Fl m Ar memoryuse The maximal resident set size of a process, in kilobytes. .It Fl n Ar nofiles The maximal number of descriptors that could be opened by a process. .It Fl o Ar umtxp The maximal number of process-shared locks (see .Xr pthread 3 ) for this user ID. .It Fl p Ar pseudoterminals The maximal number of pseudo-terminals for this user ID. .It Fl s Ar stacksize The maximal size of the stack segment, in kilobytes. .It Fl t Ar time The maximal amount of CPU time to be used by each process, in seconds. .It Fl u Ar userproc The maximal number of simultaneous processes for this user ID. .It Fl v Ar virtualmem The maximal virtual size of a process, in kilobytes. .It Fl w Ar swapuse The maximum amount of swap space reserved or used for this user ID, in kilobytes. .El .It Ic umask Oo Fl S Oc Op Ar mask Set the file creation mask (see .Xr umask 2 ) to the octal or symbolic (see .Xr chmod 1 ) value specified by .Ar mask . If the argument is omitted, the current mask value is printed. If the .Fl S option is specified, the output is symbolic, otherwise the output is octal. .It Ic unalias Oo Fl a Oc Op Ar name ... The specified alias names are removed. If .Fl a is specified, all aliases are removed. .It Ic unset Oo Fl fv Oc Ar name ... The specified variables or functions are unset and unexported. If the .Fl v option is specified or no options are given, the .Ar name arguments are treated as variable names. If the .Fl f option is specified, the .Ar name arguments are treated as function names. .It Ic wait Op Ar job ... Wait for each specified .Ar job to complete and return the exit status of the last process in the last specified .Ar job . If any .Ar job specified is unknown to the shell, it is treated as if it were a known job that exited with exit status 127. If no operands are given, wait for all jobs to complete and return an exit status of zero. .El .Ss Commandline Editing When .Nm is being used interactively from a terminal, the current command and the command history (see .Ic fc in .Sx Built-in Commands ) can be edited using .Nm vi Ns -mode command line editing. This mode uses commands similar to a subset of those described in the .Xr vi 1 man page. The command .Dq Li "set -o vi" (or .Dq Li "set -V" ) enables .Nm vi Ns -mode editing and places .Nm into .Nm vi insert mode. With .Nm vi Ns -mode enabled, .Nm can be switched between insert mode and command mode by typing .Aq ESC . Hitting .Aq return while in command mode will pass the line to the shell. .Pp Similarly, the .Dq Li "set -o emacs" (or .Dq Li "set -E" ) command can be used to enable a subset of .Nm emacs Ns -style command line editing features. .Sh ENVIRONMENT The following environment variables affect the execution of .Nm : .Bl -tag -width ".Ev LANGXXXXXX" .It Ev ENV Initialization file for interactive shells. .It Ev LANG , Ev LC_* Locale settings. These are inherited by children of the shell, and is used in a limited manner by the shell itself. .It Ev OLDPWD The previous current directory. This is used and updated by .Ic cd . .It Ev PWD An absolute pathname for the current directory, possibly containing symbolic links. This is used and updated by the shell. .It Ev TERM The default terminal setting for the shell. This is inherited by children of the shell, and is used in the history editing modes. .El .Pp Additionally, environment variables are turned into shell variables at startup, which may affect the shell as described under .Sx Special Variables . .Sh FILES .Bl -tag -width "/etc/suid_profileXX" -compact .It Pa ~/.profile User's login profile. .It Pa /etc/profile System login profile. .It Pa /etc/shells Shell database. .It Pa /etc/suid_profile Privileged shell profile. .El .Sh EXIT STATUS Errors that are detected by the shell, such as a syntax error, will cause the shell to exit with a non-zero exit status. If the shell is not an interactive shell, the execution of the shell file will be aborted. Otherwise the shell will return the exit status of the last command executed, or if the .Ic exit builtin is used with a numeric argument, it will return the argument. .Sh SEE ALSO .Xr builtin 1 , .Xr chsh 1 , .Xr echo 1 , .Xr ed 1 , .Xr emacs 1 , .Xr kill 1 , .Xr printf 1 , .Xr pwd 1 , .Xr test 1 , .Xr vi 1 , .Xr execve 2 , .Xr getrlimit 2 , .Xr umask 2 , .Xr wctype 3 , .Xr editrc 5 , .Xr shells 5 .Sh HISTORY A .Nm command, the Thompson shell, appeared in .At v1 . It was superseded in .At v7 by the Bourne shell, which inherited the name .Nm . .Pp This version of .Nm was rewritten in 1989 under the .Bx license after the Bourne shell from .At V.4 . .Sh AUTHORS This version of .Nm was originally written by .An Kenneth Almquist . .Sh BUGS The .Nm utility does not recognize multibyte characters other than UTF-8. Splitting using .Va IFS does not recognize multibyte characters. Index: stable/11/usr.bin/bc/bc.1 =================================================================== --- stable/11/usr.bin/bc/bc.1 (revision 313867) +++ stable/11/usr.bin/bc/bc.1 (revision 313868) @@ -1,416 +1,416 @@ .\" $FreeBSD$ .\" $OpenBSD: bc.1,v 1.32 2015/11/17 05:45:35 mmcc Exp $ .\" .\" Copyright (C) Caldera International Inc. 2001-2002. .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code and documentation must retain the above .\" copyright notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 3. All advertising materials mentioning features or use of this software .\" must display the following acknowledgement: .\" This product includes software developed or owned by Caldera .\" International, Inc. .\" 4. Neither the name of Caldera International, Inc. nor the names of other .\" contributors may be used to endorse or promote products derived from .\" this software without specific prior written permission. .\" .\" USE OF THE SOFTWARE PROVIDED FOR UNDER THIS LICENSE BY CALDERA .\" INTERNATIONAL, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. .\" IN NO EVENT SHALL CALDERA INTERNATIONAL, INC. BE LIABLE FOR ANY DIRECT, .\" INDIRECT INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING .\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" .\" @(#)bc.1 6.8 (Berkeley) 8/8/91 .\" -.Dd November 21 2015 +.Dd November 21, 2015 .Dt BC 1 .Os .Sh NAME .Nm bc .Nd arbitrary-precision arithmetic language and calculator .Sh SYNOPSIS .Nm bc .Op Fl chlv .Op Fl e Ar expression .Op Ar file ... .Sh DESCRIPTION .Nm is an interactive processor for a language which resembles C but provides unlimited precision arithmetic. It takes input from any expressions on the command line and any files given, then reads the standard input. .Pp Options available: .Bl -tag -width Ds .It Fl c .Nm is actually a preprocessor for .Xr dc 1 , which it invokes automatically, unless the .Fl c .Pq compile only option is present. In this case the generated .Xr dc 1 instructions are sent to the standard output, instead of being interpreted by a running .Xr dc 1 process. .It Fl e Ar expression , Fl Fl expression Ar expression Evaluate .Ar expression . If multiple .Fl e options are specified, they are processed in the order given, separated by newlines. .It Fl h , Fl Fl help Prints usage information. .It Fl l , Fl Fl mathlib Allow specification of an arbitrary precision math library. The definitions in the library are available to command line expressions. .It Fl v , Fl Fl version Prints version information. .El .Pp The syntax for .Nm programs is as follows: .Sq L means letter a-z; .Sq E means expression; .Sq S means statement. As a non-portable extension, it is possible to use long names in addition to single letter names. A long name is a sequence starting with a lowercase letter followed by any number of lowercase letters and digits. The underscore character .Pq Sq _ counts as a letter. .Pp Comments .Bd -unfilled -offset indent -compact are enclosed in /* and */ are enclosed in # and the next newline .Ed .Pp The newline is not part of the line comment, which in itself is a non-portable extension. .Pp Names .Bd -unfilled -offset indent -compact simple variables: L array elements: L [ E ] The words `ibase', `obase', and `scale' The word `last' or a single dot .Ed .Pp Other operands .Bd -unfilled -offset indent -compact arbitrarily long numbers with optional sign and decimal point ( E ) sqrt ( E ) length ( E ) number of significant decimal digits scale ( E ) number of digits right of decimal point L ( E , ... , E ) .Ed .Pp The sequence .Sq \e is ignored within numbers. .Pp Operators .Pp The following arithmetic and logical operators can be used. The semantics of the operators is the same as in the C language. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. .Bl -column "= += \-= *= /= %= ^=" "Associativity" "multiply, divide, modulus" -offset indent .It Sy "Operator" Ta Sy "Associativity" Ta Sy "Description" .It "++ \-\-" Ta "none" Ta "increment, decrement" .It "\-" Ta "none" Ta "unary minus" .It "^" Ta "right" Ta "power" .It "* / %" Ta "left" Ta "multiply, divide, modulus" .It "+ \-" Ta "left" Ta "plus, minus" .It "= += -= *= /= %= ^=" Ta "right" Ta "assignment" .It "== <= >= != < >" Ta "none" Ta "relational" .It "!" Ta "none" Ta "boolean not" .It "&&" Ta "left" Ta "boolean and" .It "||" Ta "left" Ta "boolean or" .El .Pp Note the following: .Bl -bullet -offset indent .It The relational operators may appear in any expression. The .St -p1003.1-2008 standard only allows them in the conditional expression of an .Sq if , .Sq while or .Sq for statement. .It The relational operators have a lower precedence than the assignment operators. This has the consequence that the expression .Sy a = b < c is interpreted as .Sy (a = b) < c , which is probably not what the programmer intended. .It In contrast with the C language, the relational operators all have the same precedence, and are non-associative. The expression .Sy a < b < c will produce a syntax error. .It The boolean operators (!, && and ||) are non-portable extensions. .It The boolean not (!) operator has much lower precedence than the same operator in the C language. This has the consequence that the expression .Sy !a < b is interpreted as .Sy !(a < b) . Prudent programmers use parentheses when writing expressions involving boolean operators. .El .Pp Statements .Bd -unfilled -offset indent -compact E { S ; ... ; S } if ( E ) S if ( E ) S else S while ( E ) S for ( E ; E ; E ) S null statement break continue quit a string of characters, enclosed in double quotes print E ,..., E .Ed .Pp A string may contain any character, except double quote. The if statement with an else branch is a non-portable extension. All three E's in a for statement may be empty. This is a non-portable extension. The continue and print statements are also non-portable extensions. .Pp The print statement takes a list of comma-separated expressions. Each expression in the list is evaluated and the computed value is printed and assigned to the variable `last'. No trailing newline is printed. The expression may also be a string enclosed in double quotes. Within these strings the following escape sequences may be used: .Sq \ea for bell (alert), .Sq \eb for backspace, .Sq \ef for formfeed, .Sq \en for newline, .Sq \er for carriage return, .Sq \et for tab, .Sq \eq for double quote and .Sq \e\e for backslash. Any other character following a backslash will be ignored. Strings will not be assigned to `last'. .Pp Function definitions .Bd -unfilled -offset indent define L ( L ,..., L ) { auto L, ... , L S; ... S return ( E ) } .Ed .Pp As a non-portable extension, the opening brace of the define statement may appear on the next line. The return statement may also appear in the following forms: .Bd -unfilled -offset indent return return () return E .Ed .Pp The first two are equivalent to the statement .Dq return 0 . The last form is a non-portable extension. Not specifying a return statement is equivalent to writing .Dq return (0) . .Pp Functions available in the math library, which is loaded by specifying the .Fl l flag on the command line .Pp .Bl -tag -width j(n,x) -offset indent -compact .It s(x) sine .It c(x) cosine .It e(x) exponential .It l(x) log .It a(x) arctangent .It j(n,x) Bessel function .El .Pp All function arguments are passed by value. .Pp The value of a statement that is an expression is printed unless the main operator is an assignment. The value printed is assigned to the special variable `last'. This is a non-portable extension. A single dot may be used as a synonym for `last'. Either semicolons or newlines may separate statements. Assignment to .Ar scale influences the number of digits to be retained on arithmetic operations in the manner of .Xr dc 1 . Assignments to .Ar ibase or .Ar obase set the input and output number radix respectively. .Pp The same letter may be used as an array, a function, and a simple variable simultaneously. All variables are global to the program. `Auto' variables are pushed down during function calls. When using arrays as function arguments or defining them as automatic variables, empty square brackets must follow the array name. .Pp For example .Bd -literal -offset indent scale = 20 define e(x){ auto a, b, c, i, s a = 1 b = 1 s = 1 for(i=1; 1==1; i++){ a = a*x b = b*i c = a/b if(c == 0) return(s) s = s+c } } .Ed .Pp defines a function to compute an approximate value of the exponential function and .Pp .Dl for(i=1; i<=10; i++) e(i) .Pp prints approximate values of the exponential function of the first ten integers. .Bd -literal -offset indent $ bc -l -e 'scale = 500; 2 * a(2^10000)' -e quit .Ed .Pp prints an approximation of pi. .Sh COMMAND LINE EDITING .Nm supports interactive command line editing, via the .Xr editline 3 library. It is enabled by default if input is from a tty. Previous lines can be recalled and edited with the arrow keys, and other GNU Emacs-style editing keys may be used as well. .Pp The .Xr editline 3 library is configured with a .Pa .editrc file \- refer to .Xr editrc 5 for more information. .Sh FILES .Bl -tag -width /usr/share/misc/bc.library -compact .It Pa /usr/share/misc/bc.library math library, read when the .Fl l option is specified on the command line. .El .Sh COMPATIBILITY The .Fl q and .Fl Fl quiet options are no-ops for compatibility with some other implementations of .Nm and their use is discouraged. .Sh SEE ALSO .Xr dc 1 .Sh STANDARDS The .Nm utility is compliant with the .St -p1003.1-2008 specification. .Pp The flags .Op Fl ce , as well as the parts noted above, are extensions to that specification. .Sh HISTORY The .Nm command first appeared in .At v6 . A complete rewrite of the .Nm command first appeared in .Ox 3.5 . .Sh AUTHORS .An -nosplit The original version of the .Nm command was written by .An Robert Morris and .An Lorinda Cherry . The current version of the .Nm utility was written by .An Otto Moerbeek . .Sh BUGS The .Ql quit statement is interpreted when read, not when executed. .Pp Some non-portable extensions, as found in the GNU version of the .Nm utility are not implemented (yet). Index: stable/11/usr.bin/ctlstat/ctlstat.8 =================================================================== --- stable/11/usr.bin/ctlstat/ctlstat.8 (revision 313867) +++ stable/11/usr.bin/ctlstat/ctlstat.8 (revision 313868) @@ -1,123 +1,123 @@ -.\" +.\" .\" Copyright (c) 2010 Silicon Graphics International Corp. .\" All rights reserved. -.\" +.\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions, and the following disclaimer, .\" without modification. .\" 2. Redistributions in binary form must reproduce at minimum a disclaimer .\" substantially similar to the "NO WARRANTY" disclaimer below .\" ("Disclaimer") and any redistribution must be conditioned upon .\" including a substantially similar Disclaimer requirement for further .\" binary redistribution. -.\" +.\" .\" NO WARRANTY .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS .\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR .\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT .\" HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING .\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGES. -.\" +.\" .\" ctlstat utility man page. .\" .\" Author: Ken Merry .\" .\" $Id: //depot/users/kenm/FreeBSD-test2/usr.bin/ctlstat/ctlstat.8#2 $ .\" $FreeBSD$ .\" .Dd January 9, 2017 .Dt CTLSTAT 8 .Os .Sh NAME .Nm ctlstat .Nd CAM Target Layer statistics utility .Sh SYNOPSIS .Nm .Op Fl t .Op Fl c Ar count .Op Fl C .Op Fl d .Op Fl D .Op Fl j .Op Fl l Ar lun .Op Fl n Ar numdevs .Op Fl p Ar port .Op Fl w Ar wait .Sh DESCRIPTION The .Nm utility provides statistics information for the CAM Target Layer. The first display (except for dump and JSON modes) shows average statistics since system startup. Subsequent displays show average statistics during the measurement interval. .Pp The options are as follows: .Bl -tag -width 10n .It Fl t Total mode. This displays separate columns with the total read and write output, and a combined total column that also includes non I/O operations. .It Fl c Ar count Display statistics this many times. .It Fl C Disable CPU statistics display. .It Fl d Display DMA operation time (latency) instead of overall I/O time (latency). .It Fl D Text dump mode. Dump statistics every 30 seconds in a text format suitable for parsing. No statistics are computed in this mode, only raw numbers are displayed. .It Fl h Suppress display of the header. .It Fl j JSON dump mode. Dump statistics every 30 seconds in JavaScript Object Notation (JSON) format. No statistics are computed in this mode, only raw numbers are displayed. .It Fl l Ar lun Request statistics for the specified LUN. .It Fl n Ar numdevs Display statistics for this many devices. .It Fl p Ar port Request statistics for the specified port. .It Fl w Ar wait Wait this many seconds in between displays. If this option is not specified, .Nm defaults to a 1 second interval. .El .Sh EXAMPLES .Dl ctlstat -t .Pp Display total statistics for the system with a one second interval. .Pp .Dl ctlstat -d -l 5 -C .Pp Display average DMA time for LUN 5 and omit CPU utilization. .Pp .Dl ctlstat -n 7 -w 10 .Pp Display statistics for the first 7 LUNs, and display average statistics every 10 seconds. .Sh SEE ALSO .Xr cam 3 , .Xr cam 4 , .Xr ctl 4 , .Xr xpt 4 , .Xr camcontrol 8 , .Xr ctladm 8 , .Xr ctld 8 , .Xr iostat 8 .Sh AUTHORS .An Ken Merry Aq Mt ken@FreeBSD.org .An Will Andrews Aq Mt will@FreeBSD.org .An Alexander Motin Aq Mt mav@FreeBSD.org Index: stable/11/usr.bin/env/env.1 =================================================================== --- stable/11/usr.bin/env/env.1 (revision 313867) +++ stable/11/usr.bin/env/env.1 (revision 313868) @@ -1,482 +1,482 @@ .\" Copyright (c) 1980, 1990, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" This code is derived from software contributed to Berkeley by .\" the Institute of Electrical and Electronics Engineers, Inc. .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" From @(#)printenv.1 8.1 (Berkeley) 6/6/93 .\" From FreeBSD: src/usr.bin/printenv/printenv.1,v 1.17 2002/11/26 17:33:35 ru Exp .\" $FreeBSD$ .\" .Dd April 17, 2008 .Dt ENV 1 .Os .Sh NAME .Nm env .Nd set environment and execute command, or print environment .Sh SYNOPSIS .Nm .Op Fl iv .Op Fl P Ar altpath .Op Fl S Ar string .Op Fl u Ar name .Op Ar name Ns = Ns Ar value ... .Op Ar utility Op Ar argument ... .Sh DESCRIPTION The .Nm utility executes another .Ar utility after modifying the environment as specified on the command line. Each .Ar name Ns = Ns Ar value option specifies the setting of an environment variable, .Ar name , with a value of .Ar value . All such environment variables are set before the .Ar utility is executed. .Pp The options are as follows: .Bl -tag -width indent .It Fl i Execute the .Ar utility with only those environment variables specified by .Ar name Ns = Ns Ar value options. The environment inherited by .Nm is ignored completely. .\" -P .It Fl P Ar altpath Search the set of directories as specified by .Ar altpath to locate the specified .Ar utility program, instead of using the value of the .Ev PATH environment variable. .\" -S .It Fl S Ar string Split apart the given .Ar string into multiple strings, and process each of the resulting strings as separate arguments to the .Nm utility. The .Fl S option recognizes some special character escape sequences and also supports environment-variable substitution, as described below. .\" -u .It Fl u Ar name If the environment variable .Ar name is in the environment, then remove it before processing the remaining options. This is similar to the .Ic unset command in .Xr sh 1 . The value for .Ar name must not include the .Ql = character. .\" -v .It Fl v Print verbose information for each step of processing done by the .Nm utility. Additional information will be printed if .Fl v is specified multiple times. .El .Pp The above options are only recognized when they are specified before any .Ar name Ns = Ns Ar value options. .Pp If no .Ar utility is specified, .Nm prints out the names and values of the variables in the environment, with one name/value pair per line. .\" -.Ss Details of Fl S Ss (split-string) processing +.Ss Details of Fl S \&Ss (split-string) processing The processing of the .Fl S option will split the given .Ar string into separate arguments based on any space or characters found in the .Ar string . Each of those new arguments will then be treated as if it had been specified as a separate argument on the original .Nm command. .Pp Spaces and tabs may be embedded in one of those new arguments by using single .Pq Dq Li ' or double .Pq Ql \&" quotes, or backslashes .Pq Ql \e . Single quotes will escape all non-single quote characters, up to the matching single quote. Double quotes will escape all non-double quote characters, up to the matching double quote. It is an error if the end of the .Ar string is reached before the matching quote character. .Pp If .Fl S would create a new argument that starts with the .Ql # character, then that argument and the remainder of the .Ar string will be ignored. The .Ql \e# sequence can be used when you want a new argument to start with a .Ql # character, without causing the remainder of the .Ar string to be skipped. .Pp While processing the .Ar string value, .Fl S processing will treat certain character combinations as escape sequences which represent some action to take. The character escape sequences are in backslash notation. The characters and their meanings are as follows: .Pp .Bl -tag -width indent -offset indent -compact .It Cm \ec Ignore the remaining characters in the .Ar string . This must not appear inside a double-quoted string. .It Cm \ef Replace with a character. .It Cm \en Replace with a character. .It Cm \er Replace with a character. .It Cm \et Replace with a character. .It Cm \ev Replace with a character. .It Cm \e# Replace with a .Ql # character. This would be useful when you need a .Ql # as the first character in one of the arguments created by splitting apart the given .Ar string . .It Cm \e$ Replace with a .Ql $ character. .It Cm \e_ If this is found inside of a double-quoted string, then replace it with a single blank. If this is found outside of a quoted string, then treat this as the separator character between new arguments in the original .Ar string . .It Cm \e" Replace with a character. .It Cm \e\' Replace with a character. .It Cm \e\e Replace with a backslash character. .El .Pp The sequences for and backslash are the only sequences which are recognized inside of a single-quoted string. The other sequences have no special meaning inside a single-quoted string. All escape sequences are recognized inside of a double-quoted string. It is an error if a single .Ql \e character is followed by a character other than the ones listed above. .Pp The processing of .Fl S also supports substitution of values from environment variables. To do this, the name of the environment variable must be inside of .Ql ${} , such as: .Li ${SOMEVAR} . The common shell syntax of .Li $SOMEVAR is not supported. All values substituted will be the values of the environment variables as they were when the .Nm utility was originally invoked. Those values will not be checked for any of the escape sequences as described above. And any settings of .Ar name Ns = Ns Ar value will not effect the values used for substitution in .Fl S processing. .Pp Also, .Fl S processing can not reference the value of the special parameters which are defined by most shells. For instance, .Fl S can not recognize special parameters such as: .Ql $* , .Ql $@ , .Ql $# , .Ql $? or .Ql $$ if they appear inside the given .Ar string . .\" .Ss Use in shell-scripts The .Nm utility is often used as the .Ar interpreter on the first line of interpreted scripts, as described in .Xr execve 2 . .Pp Note that the way the kernel parses the .Ql #! (first line) of an interpreted script has changed as of .Fx 6.0 . Prior to that, the .Fx kernel would split that first line into separate arguments based on any whitespace (space or characters) found in the line. So, if a script named .Pa /usr/local/bin/someport had a first line of: .Pp .Dl "#!/usr/local/bin/php -n -q -dsafe_mode=0" .Pp then the .Pa /usr/local/bin/php program would have been started with the arguments of: .Bd -literal -offset indent arg[0] = '/usr/local/bin/php' arg[1] = '-n' arg[2] = '-q' arg[3] = '-dsafe_mode=0' arg[4] = '/usr/local/bin/someport' .Ed .Pp plus any arguments the user specified when executing .Pa someport . However, this processing of multiple options on the .Ql #! line is not the way any other operating system parses the first line of an interpreted script. So after a change which was made for .Fx 6.0 release, that script will result in .Pa /usr/local/bin/php being started with the arguments of: .Bd -literal -offset indent arg[0] = '/usr/local/bin/php' arg[1] = '-n -q -dsafe_mode=0' arg[2] = '/usr/local/bin/someport' .Ed .Pp plus any arguments the user specified. This caused a significant change in the behavior of a few scripts. In the case of above script, to have it behave the same way under .Fx 6.0 as it did under earlier releases, the first line should be changed to: .Pp .Dl "#!/usr/bin/env -S /usr/local/bin/php -n -q -dsafe_mode=0" .Pp The .Nm utility will be started with the entire line as a single argument: .Pp .Dl "arg[1] = '-S /usr/local/bin/php -n -q -dsafe_mode=0'" .Pp and then .Fl S processing will split that line into separate arguments before executing .Pa /usr/local/bin/php . .\" .Sh ENVIRONMENT The .Nm utility uses the .Ev PATH environment variable to locate the requested .Ar utility if the name contains no .Ql / characters, unless the .Fl P option has been specified. .Sh EXIT STATUS .Ex -std An exit status of 126 indicates that .Ar utility was found, but could not be executed. An exit status of 127 indicates that .Ar utility could not be found. .Sh EXAMPLES Since the .Nm utility is often used as part of the first line of an interpreted script, the following examples show a number of ways that the .Nm utility can be useful in scripts. .Pp The kernel processing of an interpreted script does not allow a script to directly reference some other script as its own interpreter. As a way around this, the main difference between .Pp .Dl #!/usr/local/bin/foo and .Dl "#!/usr/bin/env /usr/local/bin/foo" .Pp is that the latter works even if .Pa /usr/local/bin/foo is itself an interpreted script. .Pp Probably the most common use of .Nm is to find the correct interpreter for a script, when the interpreter may be in different directories on different systems. The following example will find the .Ql perl interpreter by searching through the directories specified by .Ev PATH . .Pp .Dl "#!/usr/bin/env perl" .Pp One limitation of that example is that it assumes the user's value for .Ev PATH is set to a value which will find the interpreter you want to execute. The .Fl P option can be used to make sure a specific list of directories is used in the search for .Ar utility . Note that the .Fl S option is also required for this example to work correctly. .Pp .Dl "#!/usr/bin/env -S -P/usr/local/bin:/usr/bin perl" .Pp The above finds .Ql perl only if it is in .Pa /usr/local/bin or .Pa /usr/bin . That could be combined with the present value of .Ev PATH , to provide more flexibility. Note that spaces are not required between the .Fl S and .Fl P options: .Pp .Dl "#!/usr/bin/env -S-P/usr/local/bin:/usr/bin:${PATH} perl" .Sh COMPATIBILITY The .Nm utility accepts the .Fl option as a synonym for .Fl i . .Sh SEE ALSO .Xr printenv 1 , .Xr sh 1 , .Xr execvp 3 , .Xr environ 7 .Sh STANDARDS The .Nm utility conforms to .St -p1003.1-2001 . The .Fl P , S , u and .Fl v options are non-standard extensions supported by .Fx , but which may not be available on other operating systems. .Sh HISTORY The .Nm command appeared in .Bx 4.4 . The .Fl P , S and .Fl v options were added in .Fx 6.0 . .Sh BUGS The .Nm utility does not handle values of .Ar utility which have an equals sign .Pq Ql = in their name, for obvious reasons. .Pp The .Nm utility does not take multibyte characters into account when processing the .Fl S option, which may lead to incorrect results in some locales. Index: stable/11/usr.bin/expand/expand.1 =================================================================== --- stable/11/usr.bin/expand/expand.1 (revision 313867) +++ stable/11/usr.bin/expand/expand.1 (revision 313868) @@ -1,114 +1,114 @@ .\" Copyright (c) 1980, 1990, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" @(#)expand.1 8.1 (Berkeley) 6/9/93 .\" $FreeBSD$ .\" .Dd June 6, 2015 .Dt EXPAND 1 .Os .Sh NAME .Nm expand , .Nm unexpand .Nd expand tabs to spaces, and vice versa .Sh SYNOPSIS .Nm .Oo .Fl t .Sm off .Ar tab1 , tab2 , ... , tabn .Sm on .Oc .Op Ar .Nm unexpand .Oo .Fl a | t .Sm off .Ar tab1 , tab2 , ... , tabn .Sm on .Oc .Op Ar .Sh DESCRIPTION The .Nm utility processes the named files or the standard input writing the standard output with tabs changed into blanks. Backspace characters are preserved into the output and decrement the column count for tab calculations. The .Nm utility is useful for pre-processing character files (before sorting, looking at specific columns, etc.) that contain tabs. .Pp The .Nm unexpand utility puts tabs back into the data from the standard input or the named files and writes the result on the standard output. .Pp The following options are available: .Bl -tag -width indent .It Fl a .Nm ( unexpand only.) By default, only leading blanks and tabs are reconverted to maximal strings of tabs. If the .Fl a option is given, then tabs are inserted whenever they would compress the resultant file by replacing two or more characters. -.It Fl t Sm Ar tab1 , tab2 , ... , tabn Sm +.It Fl t \&Sm Ar tab1 , tab2 , ... , tabn \&Sm Set tab stops at column positions .Ar tab1 , tab2 , ... , tabn . If only a single number is given, tab stops are set that number of column positions apart instead of the default number of 8. .El .Sh ENVIRONMENT The .Ev LANG , LC_ALL and .Ev LC_CTYPE environment variables affect the execution of .Nm and .Nm unexpand as described in .Xr environ 7 . .Sh EXIT STATUS .Ex -std expand unexpand .Sh STANDARDS The .Nm and .Nm unexpand utilities conform to .St -p1003.1-2001 . .Sh HISTORY The .Nm utility first appeared in .Bx 1 . Index: stable/11/usr.bin/ipcrm/ipcrm.1 =================================================================== --- stable/11/usr.bin/ipcrm/ipcrm.1 (revision 313867) +++ stable/11/usr.bin/ipcrm/ipcrm.1 (revision 313868) @@ -1,119 +1,122 @@ .\" Copyright (c) 1994 Adam Glass .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. The name of the Author may not be used to endorse or promote products .\" derived from this software without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY Adam Glass ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL Adam Glass BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\"" .Dd December 12, 2007 .Dt IPCRM 1 .Os .Sh NAME .Nm ipcrm .Nd "remove the specified message queues, semaphore sets, and shared segments" .Sh SYNOPSIS .Nm .Op Fl W .Op Fl v .Op Fl q Ar msqid .Op Fl m Ar shmid .Op Fl s Ar semid .Op Fl Q Ar msgkey .Op Fl M Ar shmkey .Op Fl S Ar semkey .Ar ... .Sh DESCRIPTION The .Nm utility removes the specified message queues, semaphores and shared memory segments. These System V IPC objects can be specified by their creation ID or any associated key. .Pp The following options are generic: .Bl -tag -width indent .It Fl v If specified once with -W or with -1 for an object, it will show all removed objects. If specified twice with -W or with -1 for an objects, it will show all removed objects and all failed removals. .It Fl W Try to wipe all specified message queues, semaphores and shared memory segments. .It Fl y Use the .Xr kvm 3 interface instead of the .Xr sysctl 3 interface to extract the required information. If .Nm is to operate on the running system, using .Xr kvm 3 will require read privileges to .Pa /dev/kmem . .El .Pp The following options are used to specify which IPC objects will be removed. Any number and combination of these options can be used: .Bl -tag -width indent .It Fl q Ar msqid Remove the message queue associated with the ID .Ar msqid from the system. .It Fl m Ar shmid Mark the shared memory segment associated with ID .Ar shmid for removal. This marked segment will be destroyed after the last detach. .It Fl s Ar semid Remove the semaphore set associated with ID .Ar semid from the system. .It Fl Q Ar msgkey Remove the message queue associated with key .Ar msgkey from the system. .It Fl M Ar shmkey Mark the shared memory segment associated with key .Ar shmkey for removal. This marked segment will be destroyed after the last detach. .It Fl S Ar semkey Remove the semaphore set associated with key .Ar semkey from the system. .El .Pp The identifiers and keys associated with these System V IPC objects can be determined by using .Xr ipcs 1 . If the identifier or the key is -1, it will remove all these objects. .Sh SEE ALSO .Xr ipcs 1 .Sh HISTORY The wiping of all System V IPC objects was first implemented in .Fx 6.4 No and 7.1. .Sh AUTHORS -The original author was Adam Glass. -The wiping of all System V IPC objects was thought up by Callum -Gibson and extended and implemented by Edwin Groothuis. +The original author was +.An Adam Glass . +The wiping of all System V IPC objects was thought up by +.An Callum Gibson +and extended and implemented by +.An Edwin Groothuis . Index: stable/11/usr.bin/mail/mail.1 =================================================================== --- stable/11/usr.bin/mail/mail.1 (revision 313867) +++ stable/11/usr.bin/mail/mail.1 (revision 313868) @@ -1,1280 +1,1280 @@ .\" Copyright (c) 1980, 1990, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" @(#)mail.1 8.8 (Berkeley) 4/28/95 .\" $FreeBSD$ .\" .Dd January 5, 2006 .Dt MAIL 1 .Os .Sh NAME .Nm mail , .Nm Mail , .Nm mailx .Nd send and receive mail .Sh SYNOPSIS .Nm .Op Fl dEiInv .Op Fl s Ar subject .Op Fl c Ar cc-addr .Op Fl b Ar bcc-addr .Op Fl F .Ar to-addr ... .Op Fl Ar sendmail-option ... .Nm .Op Fl dEHiInNv .Op Fl F .Fl f .Op Ar name .Nm .Op Fl dEHiInNv .Op Fl F .Op Fl u Ar user .Nm .Op Fl d .Fl e .Op Fl f Ar name .Sh INTRODUCTION The .Nm utility is an intelligent mail processing system, which has a command syntax reminiscent of .Xr ed 1 with lines replaced by messages. .Pp The following options are available: .Bl -tag -width indent .It Fl v Verbose mode. The details of delivery are displayed on the user's terminal. .It Fl d Debugging mode. See the .Va debug mail option for details. .It Fl e Test for the presence of mail in the (by default, system) mailbox. An exit status of 0 is returned if it has mail; otherwise, an exit status of 1 is returned. .It Fl H Write a header summary only, then exit. .It Fl E Do not send messages with an empty body. This is useful for piping errors from .Xr cron 8 scripts. .It Fl i Ignore tty interrupt signals. This is particularly useful when using .Nm on noisy phone lines. .It Fl I Force .Nm to run in interactive mode even when input is not a terminal. In particular, the .Ql ~ special character when sending mail is only active in interactive mode. .It Fl n Inhibit reading the system-wide .Pa mail.rc files upon startup. .It Fl N Inhibit the initial display of message headers when reading mail or editing a mail folder. .It Fl s Ar subject Specify .Ar subject on command line. (Only the first argument after the .Fl s flag is used as a subject; be careful to quote subjects containing spaces.) .It Fl c Ar cc-addr Send carbon copies to .Ar cc-addr list of users. The .Ar cc-addr argument should be a comma-separated list of names. .It Fl b Ar bcc-addr Send blind carbon copies to .Ar bcc-addr list of users. The .Ar bcc-addr argument should be a comma-separated list of names. .It Fl f Op Ar mbox Read in the contents of your .Pa mbox (or the specified file) for processing; when you .Ic quit , .Nm writes undeleted messages back to this file. .It Fl F Record the message in a file named after the first recipient. The name is the login-name portion of the address found first on the .Dq Li To: line in the mail header. Overrides the .Va record variable, if set. .It Fl u Ar user Is equivalent to: .Pp .Dl "mail -f /var/mail/user" .El .Ss "Startup Actions" At startup time .Nm will execute commands in the system command files .Pa /usr/share/misc/mail.rc , .Pa /usr/local/etc/mail.rc and .Pa /etc/mail.rc in order, unless explicitly told not to by the use of the .Fl n option. Next, the commands in the user's personal command file .Pa ~/.mailrc are executed. The .Nm utility then examines its command line options to determine whether a new message is to be sent, or whether an existing mailbox is to be read. .Ss "Sending Mail" To send a message to one or more people, .Nm can be invoked with arguments which are the names of people to whom the mail will be sent. You are then expected to type in your message, followed by a .Aq Li control-D at the beginning of a line. The section below .Sx "Replying To or Originating Mail" , describes some features of .Nm available to help you compose your letter. .Ss "Reading Mail" In normal usage .Nm is given no arguments and checks your mail out of the post office, then prints out a one line header of each message found. The current message is initially the first message (numbered 1) and can be printed using the .Ic print command (which can be abbreviated .Ic p ) . You can move among the messages much as you move between lines in .Xr ed 1 , with the commands .Ic + and .Ic \- moving backwards and forwards, and simple numbers. .Ss "Disposing of Mail" After examining a message you can .Ic delete .Pq Ic d the message or .Ic reply .Pq Ic r to it. Deletion causes the .Nm program to forget about the message. This is not irreversible; the message can be .Ic undeleted .Pq Ic u by giving its number, or the .Nm session can be aborted by giving the .Ic exit .Pq Ic x command. Deleted messages will, however, usually disappear never to be seen again. .Ss "Specifying Messages" Commands such as .Ic print and .Ic delete can be given a list of message numbers as arguments to apply to a number of messages at once. Thus .Dq Li "delete 1 2" deletes messages 1 and 2, while .Dq Li "delete 1\-5" deletes messages 1 through 5. The special name .Ql * addresses all messages, and .Ql $ addresses the last message; thus the command .Ic top which prints the first few lines of a message could be used in .Dq Li "top *" to print the first few lines of all messages. .Ss "Replying To or Originating Mail" You can use the .Ic reply command to set up a response to a message, sending it back to the person who it was from. Text you then type in, up to an end-of-file, defines the contents of the message. While you are composing a message, .Nm treats lines beginning with the character .Ql ~ specially. For instance, typing .Ic ~m (alone on a line) will place a copy of the current message into the response right shifting it by a tabstop (see .Va indentprefix variable, below). Other escapes will set up subject fields, add and delete recipients to the message and allow you to escape to an editor to revise the message or to a shell to run some commands. (These options are given in the summary below.) .Ss "Ending a Mail Processing Session" You can end a .Nm session with the .Ic quit .Pq Ic q command. Messages which have been examined go to your .Pa mbox file unless they have been deleted in which case they are discarded. Unexamined messages go back to the post office. (See the .Fl f option above). .Ss "Personal and System Wide Distribution Lists" It is also possible to create a personal distribution lists so that, for instance, you can send mail to .Dq Li cohorts and have it go to a group of people. Such lists can be defined by placing a line like .Pp .Dl "alias cohorts bill ozalp jkf mark kridle@ucbcory" .Pp in the file .Pa .mailrc in your home directory. The current list of such aliases can be displayed with the .Ic alias command in .Nm . System wide distribution lists can be created by editing .Pa /etc/mail/aliases , see .Xr aliases 5 and .Xr sendmail 8 ; these are kept in a different syntax. In mail you send, personal aliases will be expanded in mail sent to others so that they will be able to .Ic reply to the recipients. System wide aliases are not expanded when the mail is sent, but any reply returned to the machine will have the system wide alias expanded as all mail goes through .Xr sendmail 8 . .Ss "Network Mail (ARPA, UUCP, Berknet)" See .Xr mailaddr 7 for a description of network addresses. .Pp The .Nm utility has a number of options which can be set in the .Pa .mailrc file to alter its behavior; thus .Dq Li "set askcc" enables the .Va askcc feature. (These options are summarized below.) .Sh SUMMARY (Adapted from the .%T "Mail Reference Manual" . ) .Pp Each command is typed on a line by itself, and may take arguments following the command word. The command need not be typed in its entirety \(em the first command which matches the typed prefix is used. For commands which take message lists as arguments, if no message list is given, then the next message forward which satisfies the command's requirements is used. If there are no messages forward of the current message, the search proceeds backwards, and if there are no good messages at all, .Nm types .Dq Li "No applicable messages" and aborts the command. .Bl -tag -width indent .It Ic \- Print out the preceding message. If given a numeric argument .Ar n , goes to the .Ar n Ns 'th previous message and prints it. .It Ic # ignore the remainder of the line as a comment. .It Ic \&? Prints a brief summary of commands. .It Ic \&! Executes the shell (see .Xr sh 1 and .Xr csh 1 ) command which follows. .It Ic Print .Pq Ic P Like .Ic print but also prints out ignored header fields. See also .Ic print , ignore and .Ic retain . .It Ic Reply .Pq Ic R Reply to originator. Does not reply to other recipients of the original message. .It Ic Type .Pq Ic T Identical to the .Ic Print command. .It Ic alias .Pq Ic a With no arguments, prints out all currently-defined aliases. With one argument, prints out that alias. With more than one argument, creates a new alias or changes an old one. .It Ic alternates .Pq Ic alt The .Ic alternates command is useful if you have accounts on several machines. It can be used to inform .Nm that the listed addresses are really you. When you .Ic reply to messages, .Nm will not send a copy of the message to any of the addresses listed on the .Ic alternates list. If the .Ic alternates command is given with no argument, the current set of alternative names is displayed. .It Ic chdir .Pq Ic c Changes the user's working directory to that specified, if given. If no directory is given, then changes to the user's login directory. .It Ic copy .Pq Ic co The .Ic copy command does the same thing that .Ic save does, except that it does not mark the messages it is used on for deletion when you .Ic quit . .It Ic delete .Pq Ic d Takes a list of messages as argument and marks them all as deleted. Deleted messages will not be saved in .Pa mbox , nor will they be available for most other commands. .It Ic dp (also .Ic dt ) Deletes the current message and prints the next message. If there is no next message, .Nm says .Dq Li "at EOF" . .It Ic edit .Pq Ic e Takes a list of messages and points the text editor at each one in turn. On return from the editor, the message is read back in. .It Ic exit .Ic ( ex or .Ic x ) Effects an immediate return to the shell without modifying the user's system mailbox, his .Pa mbox file, or his edit file in .Fl f . .It Ic file .Pq Ic fi The same as .Ic folder . .It Ic folders List the names of the folders in your folder directory. .It Ic folder .Pq Ic fo The .Ic folder command switches to a new mail file or folder. With no arguments, it tells you which file you are currently reading. If you give it an argument, it will write out changes (such as deletions) you have made in the current file and read in the new file. Some special conventions are recognized for the name. .Ql # means the previous file, .Ql % means your system mailbox, .Dq Li % Ns Ar user means user's system mailbox, .Ql & means your .Pa mbox file, and .Dq Li + Ns Ar folder means a file in your folder directory. .It Ic from .Pq Ic f Takes a list of messages and prints their message headers. .It Ic headers .Pq Ic h Lists the current range of headers, which is an 18-message group. If a .Ql + argument is given, then the next 18-message group is printed, and if a .Ql \- argument is given, the previous 18-message group is printed. .It Ic help A synonym for .Ic \&? . .It Ic hold .Ic ( ho , also .Ic preserve ) Takes a message list and marks each message therein to be saved in the user's system mailbox instead of in .Pa mbox . Does not override the .Ic delete command. .It Ic ignore Add the list of header fields named to the .Ar ignored list . Header fields in the ignore list are not printed on your terminal when you print a message. This command is very handy for suppression of certain machine-generated header fields. The .Ic Type and .Ic Print commands can be used to print a message in its entirety, including ignored fields. If .Ic ignore is executed with no arguments, it lists the current set of ignored fields. .It Ic inc Incorporate any new messages that have arrived while mail is being read. The new messages are added to the end of the message list, and the current message is reset to be the first new mail message. This does not renumber the existing message list, nor does it cause any changes made so far to be saved. .It Ic mail .Pq Ic m Takes as argument login names and distribution group names and sends mail to those people. .It Ic mbox Indicate that a list of messages be sent to .Pa mbox in your home directory when you quit. This is the default action for messages if you do .Em not have the .Ic hold option set. .It Ic more .Pq Ic mo Takes a list of messages and invokes the pager on that list. .It Ic next .Ic ( n , like .Ic + or .Tn CR ) Goes to the next message in sequence and types it. With an argument list, types the next matching message. .It Ic preserve .Pq Ic pre A synonym for .Ic hold . .It Ic print .Pq Ic p Takes a message list and types out each message on the user's terminal. .It Ic quit .Pq Ic q Terminates the session, saving all undeleted, unsaved messages in the user's .Pa mbox file in his login directory, preserving all messages marked with .Ic hold or .Ic preserve or never referenced in his system mailbox, and removing all other messages from his system mailbox. If new mail has arrived during the session, the message .Dq Li "You have new mail" is given. If given while editing a mailbox file with the .Fl f flag, then the edit file is rewritten. A return to the shell is effected, unless the rewrite of edit file fails, in which case the user can escape with the .Ic exit command. .It Ic reply .Pq Ic r Takes a message list and sends mail to the sender and all recipients of the specified message. The default message must not be deleted. .It Ic respond A synonym for .Ic reply . .It Ic retain Add the list of header fields named to the .Em "retained list" . Only the header fields in the retained list are shown on your terminal when you print a message. All other header fields are suppressed. The .Ic type and .Ic print commands can be used to print a message in its entirety. If .Ic retain is executed with no arguments, it lists the current set of retained fields. .It Ic save .Pq Ic s Takes a message list and a filename and appends each message in turn to the end of the file. The filename in quotes, followed by the line count and character count is echoed on the user's terminal. .It Ic set .Pq Ic se With no arguments, prints all variable values. Otherwise, sets option. Arguments are of the form .Ar option Ns Li = Ns Ar value (no space before or after .Ql = ) or .Ar option . Quotation marks may be placed around any part of the assignment statement to quote blanks or tabs, i.e.\& .Dq Li "set indentprefix=\*q->\*q" .It Ic saveignore .Ic Saveignore is to .Ic save what .Ic ignore is to .Ic print and .Ic type . Header fields thus marked are filtered out when saving a message by .Ic save or when automatically saving to .Pa mbox . .It Ic saveretain .Ic Saveretain is to .Ic save what .Ic retain is to .Ic print and .Ic type . Header fields thus marked are the only ones saved with a message when saving by .Ic save or when automatically saving to .Pa mbox . .Ic Saveretain overrides .Ic saveignore . .It Ic shell .Pq Ic sh Invokes an interactive version of the shell. .It Ic size Takes a message list and prints out the size in characters of each message. .It Ic source The .Ic source command reads commands from a file. .It Ic top Takes a message list and prints the top few lines of each. The number of lines printed is controlled by the variable .Va toplines and defaults to 5. .It Ic type .Pq Ic t A synonym for .Ic print . .It Ic unalias Takes a list of names defined by .Ic alias commands and discards the remembered groups of users. The group names no longer have any significance. .It Ic undelete .Pq Ic u Takes a message list and marks each message as .Em not being deleted. .It Ic unread .Pq Ic U Takes a message list and marks each message as .Em not having been read. .It Ic unset Takes a list of option names and discards their remembered values; the inverse of .Ic set . .It Ic visual .Pq Ic v Takes a message list and invokes the display editor on each message. .It Ic write .Pq Ic w Similar to .Ic save , except that .Em only the message body .Em ( without the header) is saved. Extremely useful for such tasks as sending and receiving source program text over the message system. .It Ic xit .Pq Ic x A synonym for .Ic exit . .It Ic z The .Nm utility presents message headers in windowfuls as described under the .Ic headers command. You can move .Nm Ns 's attention forward to the next window with the .Ic z command. Also, you can move to the previous window by using .Ic z\- . .El .Ss Tilde/Escapes Here is a summary of the tilde escapes, which are used when composing messages to perform special functions. Tilde escapes are only recognized at the beginning of lines. The name .Dq "tilde escape" is somewhat of a misnomer since the actual escape character can be set by the option .Va escape . .Bl -tag -width indent .It Ic ~a Inserts the autograph string from the sign= option into the message. .It Ic ~A Inserts the autograph string from the Sign= option into the message. .It Ic ~b Ar name ... Add the given names to the list of carbon copy recipients but do not make the names visible in the Cc: line .Dq ( blind carbon copy). .It Ic ~c Ar name ... Add the given names to the list of carbon copy recipients. .It Ic ~d Read the file .Pa dead.letter from your home directory into the message. .It Ic ~e Invoke the text editor on the message collected so far. After the editing session is finished, you may continue appending text to the message. .It Ic ~f Ar messages Read the named messages into the message being sent. If no messages are specified, read in the current message. Message headers currently being ignored (by the .Ic ignore or .Ic retain command) are not included. .It Ic ~F Ar messages Identical to .Ic ~f , except all message headers are included. .It Ic ~h Edit the message header fields by typing each one in turn and allowing the user to append text to the end or modify the field by using the current terminal erase and kill characters. .It Ic ~i Ar string Inserts the value of the named option into the text of the message. .It Ic ~m Ar messages Read the named messages into the message being sent, indented by a tab or by the value of .Va indentprefix . If no messages are specified, read the current message. Message headers currently being ignored (by the .Ic ignore or .Ic retain command) are not included. .It Ic ~M Ar messages Identical to .Ic ~m , except all message headers are included. .It Ic ~p Print out the message collected so far, prefaced by the message header fields. .It Ic ~q Abort the message being sent, copying the message to .Pa dead.letter in your home directory if .Va save is set. .It Ic ~r Ar filename , Ic ~r Li \&! Ns Ar command .It Ic ~< Ar filename , Ic ~< Li \&! Ns Ar command Read the named file into the message. If the argument begins with a .Ql \&! , the rest of the string is taken as an arbitrary system command and is executed, with the standard output inserted into the message. .It Ic ~R Ar string Use .Ar string as the Reply-To field. .It Ic ~s Ar string Cause the named string to become the current subject field. .It Ic ~t Ar name ... Add the given names to the direct recipient list. .It Ic ~v Invoke an alternative editor (defined by the .Ev VISUAL environment variable) on the message collected so far. Usually, the alternative editor will be a screen editor. After you quit the editor, you may resume appending text to the end of your message. .It Ic ~w Ar filename Write the message onto the named file. .It Ic ~x Exits as with .Ic ~q , except the message is not saved in .Pa dead.letter . .It Ic ~! Ar command Execute the indicated shell command, then return to the message. .It Ic ~| Ar command , Ic ~^ Ar command Pipe the message through the command as a filter. If the command gives no output or terminates abnormally, retain the original text of the message. The command .Xr fmt 1 is often used as .Ar command to rejustify the message. .It Ic ~: Ar mail-command , Ic ~_ Ar mail-command Execute the given .Nm command. Not all commands, however, are allowed. .It Ic ~. Simulate end-of-file on input. .It Ic ~? Print a summary of the available command escapes. .It Ic ~~ Ar string Insert the string of text in the message prefaced by a single .Ql ~ . If you have changed the escape character, then you should double that character in order to send it. .El .Ss "Mail Options" Options can be set with the .Ic set command and can be disabled with the .Ic unset or .Ic set Cm no Ns Ar name commands. Options may be either binary, in which case it is only significant to see whether they are set or not; or string, in which case the actual value is of interest. If an option is not set, .Nm will look for an environment variable of the same name. The available options include the following: .Bl -tag -width indent .It Va append Causes messages saved in .Pa mbox to be appended to the end rather than prepended. This should always be set (preferably in one of the system-wide .Pa mail.rc files). Default is .Va noappend . .It Va ask , asksub Causes .Nm to prompt you for the subject of each message you send. If you respond with simply a newline, no subject field will be sent. Default is .Va asksub . .It Va askbcc Causes you to be prompted for additional blind carbon copy recipients at the end of each message. Responding with a newline indicates your satisfaction with the current list. Default is .Va noaskbcc . .It Va askcc Causes you to be prompted for additional carbon copy recipients at the end of each message. Responding with a newline indicates your satisfaction with the current list. Default is .Va noaskcc . .It Va autoinc Causes new mail to be automatically incorporated when it arrives. Setting this is similar to issuing the .Ic inc command at each prompt, except that the current message is not reset when new mail arrives. Default is .Va noautoinc . .It Va autoprint Causes the .Ic delete command to behave like .Ic dp ; thus, after deleting a message, the next one will be typed automatically. Default is .Va noautoprint . .It Va crt The valued option .Va crt is used as a threshold to determine how long a message must be before .Ev PAGER is used to read it. If .Va crt is set without a value, then the height of the terminal screen stored in the system is used to compute the threshold (see .Xr stty 1 ) . Default is .Va nocrt . .It Va debug Setting the binary option .Va debug is the same as specifying .Fl d on the command line and causes .Nm to output all sorts of information useful for debugging .Nm . In case .Nm is invoked in this mode to send mail, all preparations will be performed and reported about, but the mail will not be actually sent. Default is .Va nodebug . .It Va dot The binary option .Va dot causes .Nm to interpret a period alone on a line as the terminator of a message you are sending. Default is .Va nodot . .It Va escape If defined, the first character of this option gives the character to use in place of .Ql ~ to denote escapes. .It Va flipr Reverses the sense of .Ic reply and .Ic Reply commands. Default is .Va noflipr . .It Va folder The name of the directory to use for storing folders of messages. If this name begins with a .Ql / , .Nm considers it to be an absolute pathname; otherwise, the folder directory is found relative to your home directory. .It Va header If defined, initially display message headers when reading mail or editing a mail folder. Default is .Va header . This option can be disabled by giving the .Fl N flag on the command line. .It Va hold This option is used to hold messages in the system mailbox by default. Default is .Va nohold . .It Va ignore Causes interrupt signals from your terminal to be ignored and echoed as .Li @ Ns 's. Default is .Va noignore . .It Va ignoreeof An option related to .Va dot is .Va ignoreeof which makes .Nm refuse to accept a .Aq Li control-D as the end of a message. .Ar Ignoreeof also applies to .Nm command mode. Default is .Va noignoreeof . .It Va indentprefix String used by the .Ic ~m tilde escape for indenting messages, in place of the normal tab character .Pq Li ^I . Be sure to quote the value if it contains spaces or tabs. .It Va metoo Usually, when a group is expanded that contains the sender, the sender is removed from the expansion. Setting this option causes the sender to be included in the group. Default is .Va nometoo . .It Va quiet Suppresses the printing of the version when first invoked. Default is .Va noquiet . .It Va record If defined, gives the pathname of the file used to record all outgoing mail. If not defined, outgoing mail is not saved. Default is .Va norecord . .It Va Replyall Reverses the sense of .Ic reply and .Ic Reply commands. Default is .Va noReplyall . .It Va save If this option is set, and you abort a message with two .Tn RUBOUT (erase or delete), .Nm will copy the partial letter to the file .Pa dead.letter in your home directory. Default is .Va save . .It Va searchheaders If this option is set, then a message-list specifier in the form -.Dq Li / Ns Ar x Ns Li : Ns Ar y +.Dq Li / Ns Ar x Ns : Ns Ar y will expand to all messages containing the substring .Ar y in the header field .Ar x . The string search is case insensitive. If .Ar x is omitted, it will default to the .Dq Li Subject header field. The form .Dq Li /to: Ns Ar y is a special case, and will expand to all messages containing the substring .Ar y in the .Dq Li To , .Dq Li Cc or .Dq Li Bcc header fields. The check for .Qq Li "to" is case sensitive, so that .Dq Li /To: Ns Ar y can be used to limit the search for .Ar y to just the .Dq Li To: field. Default is .Va nosearchheaders . .It Va toplines If defined, gives the number of lines of a message to be printed out with the .Ic top command; normally, the first five lines are printed. .It Va verbose Setting the option .Va verbose is the same as using the .Fl v flag on the command line. When .Nm runs in verbose mode, the actual delivery of messages is displayed on the user's terminal. Default is .Va noverbose . .El .Sh ENVIRONMENT .Bl -tag -width ".Ev REPLYTO" .It Ev DEAD Pathname of the file to save partial messages to in case of interrupts or delivery errors. Default is .Pa ~/dead.letter . .It Ev EDITOR Pathname of the text editor to use in the .Ic edit command and .Ic ~e escape. If not defined, then a default editor is used. .It Ev HOME Pathname of the user's home directory. .It Ev LISTER Pathname of the directory lister to use in the .Ic folders command. Default is .Pa /bin/ls . .It Ev MAIL Location of the user's mailbox. Default is .Pa /var/mail . .It Ev MAILRC Pathname of file containing initial .Nm commands. Default is .Pa ~/.mailrc . .It Ev MBOX The name of the mailbox file. It can be the name of a folder. The default is .Pa mbox in the user's home directory. .It Ev PAGER Pathname of the program to use in the .Ic more command or when .Va crt variable is set. The default paginator .Xr more 1 is used if this option is not defined. .It Ev REPLYTO If set, will be used to initialize the Reply-To field for outgoing messages. .It Ev SHELL Pathname of the shell to use in the .Ic \&! command and the .Ic ~! escape. A default shell is used if this option is not defined. .It Ev TMPDIR Pathname of the directory used for creating temporary files. .It Ev VISUAL Pathname of the text editor to use in the .Ic visual command and .Ic ~v escape. .It Ev USER Login name of the user executing mail. .El .Sh FILES .Bl -tag -width ".Pa /usr/share/misc/mail.*help" -compact .It Pa /var/mail/* Post office. .It Pa ~/mbox User's old mail. .It Pa ~/.mailrc File giving initial .Nm commands. This can be overridden by setting the .Ev MAILRC environment variable. .It Pa /tmp/R* Temporary files. .It Pa /usr/share/misc/mail.*help Help files. .Pp .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, if it exists. .El .Sh SEE ALSO .Xr fmt 1 , .Xr newaliases 1 , .Xr vacation 1 , .Xr aliases 5 , .Xr mailaddr 7 , .Xr sendmail 8 .Rs .%T "The Mail Reference Manual" .Re .Sh HISTORY A .Nm command appeared in .At v1 . This man page is derived from .%T "The Mail Reference Manual" originally written by .An Kurt Shoens . .Sh BUGS There are some flags that are not documented here. Most are not useful to the general user. .Pp Usually, .Nm is just a link to .Nm Mail and .Nm mailx , which can be confusing. .Pp The name of the .Ic alternates list is incorrect English (it should be .Dq alternatives ) , but is retained for compatibility. Index: stable/11/usr.bin/mkimg/mkimg.1 =================================================================== --- stable/11/usr.bin/mkimg/mkimg.1 (revision 313867) +++ stable/11/usr.bin/mkimg/mkimg.1 (revision 313868) @@ -1,331 +1,331 @@ .\" Copyright (c) 2013, 2014 Juniper Networks, Inc. .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" .\" $FreeBSD$ .\" .Dd August 7, 2015 .Dt MKIMG 1 .Os .Sh NAME .Nm mkimg .Nd "utility to make disk images" .Sh SYNOPSIS .Nm .Op Fl H Ar heads .Op Fl P Ar blksz .Op Fl S Ar secsz .Op Fl T Ar tracksz .Op Fl b Ar bootcode .Op Fl c Ar capacity .Op Fl f Ar format .Op Fl o Ar outfile .Op Fl v .Op Fl y .Op Fl s Ar scheme Op Fl p Ar partition ... .Nm .Ar --formats | --schemes | --version .Sh DESCRIPTION The .Nm utility creates a disk image from the raw partition contents specified with the .Ar partition argument(s) and using the partitioning scheme specified with the .Ar scheme argument. The disk image is written to .Ar stdout by default or the file specified with the .Ar outfile argument. The image file is a raw disk image by default, but the format of the image file can be specified with the .Ar format argument. .Pp The disk image can be made bootable by specifying the scheme-specific boot block contents with the .Ar bootcode argument and, depending on the scheme, with a boot partition. The contents of such a boot partition is provided like any other partition and the .Nm utility does not treat it any differently from other partitions. .Pp Some partitioning schemes need a disk geometry and for those the .Nm utility accepts the .Ar tracksz and .Ar heads arguments, specifying the number of sectors per track and the number of heads per cylinder (resp.) .Pp Both the logical and physical sector size can be specified and for that the .Nm utility accepts the .Ar secsz and .Ar blksz arguments. The .Ar secsz argument is used to specify the logical sector size. This is the sector size reported by a disk when queried for its capacity. Modern disks use a larger sector size internally, referred to as block size by the .Nm utility and this can be specified by the .Ar blksz argument. The .Nm utility will use the (physical) block size to determine the start of partitions and to round the size of the disk image. .Pp The .Fl c option can be used to specify a minimal capacity for the disk image. Use this option without the .Fl s and .Fl p options to create an empty disk image with the given (virtual) size. An empty partition table can be written to the disk when specifying a partitioning scheme with the .Fl s option, but without specifying any partitions. When the size required to for all the partitions is larger than the given capacity, then the disk image will be larger than the capacity given. .Pp The .Fl v option increases the level of output that the .Nm utility prints. .Pp The .Fl y option is used for testing purposes only and is not to be used in production. When present, the .Nm utility will generate predictable values for Universally Unique Identifiers (UUIDs) and time stamps so that consecutive runs of the .Nm utility will create images that are identical. .Pp A set of long options exist to query about the .Nm utility itself. Options in this set should be given by themselves because the .Nm utility exits immediately after providing the requested information. The version of the .Nm utility is printed when the .Ar --version option is given. The list of supported output formats is printed when the .Ar --formats option is given and the list of supported partitioning schemes is printed when the .Ar --schemes option is given. Both the format and scheme lists a space-separated lists for easy handling in scripts. .Pp For a more descriptive list of supported partitioning schemes or supported output format, or for a detailed description of how to specify partitions, run the .Nm utility without any arguments. This will print a usage message with all the necessary details. .Sh DISK FORMATS The .Nm utility supports a number of output file formats. A short description of these is given below. .Ss QCOW and QCOW2 QCOW stands for "QEMU Copy On Write". It's a sparse file format akin to VHD and VMDK and QCOW represents the first version. QCOW2 represents version 2 of the file format. Version 2 is not backward compatible with version 1 and adds support for snapshots among other things. The QCOW file formats are natively supported by QEMU and Xen. To write QCOW, specify .Fl f Ar qcow on the command line. To write version 2 QCOW, specify .Fl f Ar qcow2 on the command line. The preferred file extension is ".qcow" and ".qcow2" for QCOW and QCOW2 (resp.), but ".qcow" is sometimes used for version 2 files as well. .Ss RAW file format This file format is a sector by sector representation of an actual disk. There is no extra information that describes or relates to the format itself. The size of the file is the size of the (virtual) disk. This file format is suitable for being copyied onto a disk with utilities like .Nm dd . To write a raw disk file, either omit the .Fl f option, or specify .Fl f Ar raw on the command line. The preferred file extension is one of ".img" or ".raw", but there's no real convention for it. .Ss Dynamic VHD and Fixed VHD Microsoft's "Virtual Hard Disk" file formats. The dynamic format is a sparse format akin to QCOW and VMDK. The fixed format is effectively a raw format with a footer appended to the file and as such it's often indistinguishable from the raw format. The fixed file format has been added to support Microsoft's Azure platform and due to inconsistencies in interpretation of the footer is not compatible with utilities like .Nm qemu when it is specifically instructed to interpreted the file as a VHD file. By default .Nm qemu will treat the file as a raw disk file, which mostly works fine. To have .Nm create a dynamic VHD file, specify .Fl f Ar vhd on the command line. To create a fixed VHD file for use by Azure, specify .Fl f Ar vhdf on the command line. The preferred file extension is ".vhd". .Ss VMDK VMware's "Virtual Machine Disk" file format. It's a sparse file format akin to QCOW and VHD and supported by many virtualization solutions. To create a VMDK file, specify .Fl f Ar vmdk on the command line. The preferred file extension is ".vmdk". .Pp Not all virtualization solutions support all file formats, but often those virtualization environments have utilities to convert from one format to another. Note however that conversion may require that the virtual disk size is changed to match the constraints of the output format and this may invalidate the contents of the disk image. For example, the GUID Partition Table (GPT) scheme has a header in the last sector on the disk. When changing the disk size, the GPT must be changed so that the last header is moved accordingly. This is typically not part of the conversion process. If possible, use an output format specifically for the environment in which the file is intended to be used. .Sh ENVIRONMENT .Bl -tag -width "TMPDIR" -compact .It Ev TMPDIR Directory to put temporary files in; default is .Pa /tmp . .El .Sh EXAMPLES To create a bootable disk image that is partitioned using the GPT scheme and containing a root file system that was previously created using -.Xr makefs +.Xr makefs 8 and also containing a swap partition, run the .Nm utility as follows: .Dl % mkimg -s gpt -b /boot/pmbr -p freebsd-boot:=/boot/gptboot \ -p freebsd-ufs:=root-file-system.ufs -p freebsd-swap::1G \ -o gpt.img .Pp The command line given above results in a raw image file. This is because no output format was given. To create a VMDK image for example, add the .Fl f Ar vmdk argument to the .Nm utility and name the output file accordingly. .Pp A nested partitioning scheme is created by running the .Nm utility twice. The output of the first will be fed as the contents of a partition to the second. This can be done using a temporary file, like so: .Dl % mkimg -s bsd -b /boot/boot -p freebsd-ufs:=root-file-system.ufs \ -p freebsd-swap::1G -o /tmp/bsd.img .Dl % mkimg -s mbr -b /boot/mbr -p freebsd:=/tmp/bsd.img -o mbr-bsd.img .Pp Alternatively, the .Nm utility can be run in a cascaded fashion, whereby the output of the first is fed directly into the second. To do this, run the .Nm utility as follows: .Dl % mkimg -s mbr -b /boot/mbr -p freebsd:-'mkimg -s bsd -b /boot/boot \ -p freebsd-ufs:=root-file-system.ufs -p freebsd-swap::1G' -o mbr-bsd.img .Pp To accommodate the need to have partitions named or numbered in a certain way, the .Nm utility allows for the specification of empty partitions. For example, to create an image that is compatible with partition layouts found in .Pa /etc/disktab , the 'd' partition often needs to be skipped. This is accomplished by inserting an unused partition after the first 2 partition specifications. It is worth noting at this time that the BSD scheme will automatically skip the 'c' partition by virtue of it referring to the entire disk. To create an image that is compatible with the qp120at disk, use the .Nm utility as follows: .Dl % mkimg -s bsd -b /boot/boot -p freebsd-ufs:=root-file-system.ufs \ -p freebsd-swap::20M -p- -p- -p- -p- -p freebsd-ufs:=usr-file-system.ufs \ -o bsd.img .Pp For partitioning schemes that feature partition labels, the .Nm utility supports assigning labels to the partitions specified. In the following example the file system partition is labeled as 'backup': .Dl % mkimg -s gpt -p freebsd-ufs/backup:=file-system.ufs -o gpt.img .Sh SEE ALSO .Xr dd 1 , .Xr gpart 8 , .Xr makefs 8 , .Xr mdconfig 8 , .Xr newfs 8 .Sh HISTORY The .Nm utility first appeared in .Fx 10.1 . .Sh AUTHORS The .Nm utility and manpage were written by .An Marcel Moolenaar Aq Mt marcel@FreeBSD.org . Index: stable/11/usr.bin/mkuzip/mkuzip.8 =================================================================== --- stable/11/usr.bin/mkuzip/mkuzip.8 (revision 313867) +++ stable/11/usr.bin/mkuzip/mkuzip.8 (revision 313868) @@ -1,185 +1,185 @@ .\"- .\" Copyright (c) 2004-2016 Maxim Sobolev .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" .Dd March 17, 2006 .Dt MKUZIP 8 .Os .Sh NAME .Nm mkuzip .Nd compress disk image for use with .Xr geom_uzip 4 class .Sh SYNOPSIS .Nm .Op Fl v .Op Fl o Ar outfile .Op Fl s Ar cluster_size .Op Fl j Ar compression_jobs .Ar infile .Sh DESCRIPTION The .Nm utility compresses a disk image file so that the .Xr geom_uzip 4 class will be able to decompress the resulting image at run-time. This allows for a significant reduction of size of disk image at the expense of some CPU time required to decompress the data each time it is read. The .Nm utility works in two phases: .Bl -enum .It An .Ar infile image is split into clusters; each cluster is compressed using -.Xr zlib 3 +.Xr zlib 3 or .Xr lzma 3 . .It The resulting set of compressed clusters along with headers that allow locating each individual cluster is written to the output file. .El .Pp The options are: .Bl -tag -width indent .It Fl o Ar outfile Name of the output file .Ar outfile . The default is to use the input name with the suffix -.Pa .uzip +.Pa .uzip for the .Xr zlib 3 compression or .Pa .ulzma for the .Xr lzma 3 . .It Fl L Use .Xr lzma 3 compression algorithm instead of the default .Xr zlib 3 . The .Xr lzma 3 provides noticeable better compression levels on the same data set at the expense of much slower compression speed (10-20x) and somewhat slower decompression (2-3x). .It Fl s Ar cluster_size Split the image into clusters of .Ar cluster_size bytes, 16384 bytes by default. The .Ar cluster_size should be a multiple of 512 bytes. .It Fl v Display verbose messages. .It Fl Z Disable zero-blocks detection and elimination. When this option is set, the .Nm would compress empty blocks (i.e. clusters that consist of only zero bytes) just as it would any other block. When the option is not set, the .Nm detects such blocks and skips them from the output. Setting .Fl Z results is slight increase of compressed image size, typically less than 0.1% of a final size of the compressed image. .It Fl d Enable de-duplication. When the option is enabled the .Nm detects identical blocks in the input and replaces each subsequent occurence of such block with pointer to the very first one in the output. Setting this option results is moderate decrease of compressed image size, typically around 3-5% of a final size of the compressed image. .It Fl S Print summary about the compression ratio as well as output file size after file has been processed. .It Fl j Ar compression_jobs Specify the number of compression jobs that .Nm runs in parallel to speed up compression. When option is not specified the number of jobs set to be equal to the value of .Va hw.ncpu .Xr sysctl 8 variable. .El .Sh NOTES The compression ratio largely depends on the cluster size used. .\" The following two sentences are unclear: how can gzip(1) be .\" used in a comparable fashion, and wouldn't a gzip-compressed .\" image suffer from larger cluster sizes as well? For large cluster sizes (16K and higher), typical compression ratios are only 1-2% less than those achieved with .Xr gzip 1 . However, it should be kept in mind that larger cluster sizes lead to higher overhead in the .Xr geom_uzip 4 class, as the class has to decompress the whole cluster even if only a few bytes from that cluster have to be read. .Pp The .Nm utility inserts a short shell script at the beginning of the generated image, which makes it possible to .Dq run the image just like any other shell script. The script tries to load the .Xr geom_uzip 4 class if it is not loaded, configure the image as an .Xr md 4 disk device using .Xr mdconfig 8 , and automatically mount it using .Xr mount_cd9660 8 on the mount point provided as the first argument to the script. .Pp The de-duplication is a .Fx specific feature and while it does not require any changes to on-disk compressed image format, however it did require some matching changes to the .Xr geom_uzip 4 to handle resulting images correctly. .Sh EXIT STATUS .Ex -std .Sh SEE ALSO .Xr gzip 1 , .Xr xz 1 , -.Xr zlib 3 , .Xr lzma 3 , +.Xr zlib 3 , .Xr geom 4 , .Xr geom_uzip 4 , .Xr md 4 , .Xr mdconfig 8 , .Xr mount_cd9660 8 .Sh AUTHORS .An Maxim Sobolev Aq Mt sobomax@FreeBSD.org Index: stable/11/usr.bin/mt/mt.1 =================================================================== --- stable/11/usr.bin/mt/mt.1 (revision 313867) +++ stable/11/usr.bin/mt/mt.1 (revision 313868) @@ -1,626 +1,626 @@ .\" Copyright (c) 1981, 1990, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" @(#)mt.1 8.1 (Berkeley) 6/6/93 .\" $FreeBSD$ .\" .Dd May 20, 2016 .Dt MT 1 .Os .Sh NAME .Nm mt .Nd magnetic tape manipulating program .Sh SYNOPSIS .Nm .Op Fl f Ar tapename .Ar command .Op Ar count .Nm .Op Fl f Ar tapename .Ar command .Ar argument .Sh DESCRIPTION The .Nm utility is used to command a magnetic tape drive for operations other than reading or writing data. .Pp The .Fl f option's .Ar tapename overrides the .Ev TAPE environment variable described below. .Pp The available commands are listed below. Only as many characters as are required to uniquely identify a command need be specified. .Pp The following commands optionally take a .Ar count , which defaults to 1. .Bl -tag -width ".Cm erase" .It Cm weof Write .Ar count end-of-file (EOF) marks at the current position. This returns when the file mark has been written to the media. .It Cm weofi Write .Ar count end-of-file (EOF) marks at the current position. This returns as soon as the command has been validated by the tape drive. .It Cm smk Write .Ar count setmarks at the current position (DDS drives only). .It Cm fsf Forward space .Ar count files. .It Cm fsr Forward space .Ar count records. .It Cm fss Forward space .Ar count setmarks (DDS drives only). .It Cm bsf Backward space .Ar count files. .It Cm bsr Backward space .Ar count records. .It Cm bss Backward space .Ar count setmarks (DDS drives only). .It Cm erase Erase the tape using a long (often very long) method. With a .Ar count of 0, it will erase the tape using a quick method. Operation is not guaranteed if the tape is not at its beginning. The tape will be at its beginning upon completion. .El .Pp The following commands ignore .Ar count . .Bl -tag -width ".Cm geteotmodel" .It Cm rdhpos Read the hardware block position. The block number reported is specific for that hardware only. With drive data compression especially, this position may have more to do with the amount of data sent to the drive than the amount of data written to tape. Some drives do not support this. .It Cm rdspos Read the SCSI logical block position. This typically is greater than the hardware position by the number of end-of-file marks. Some drives do not support this. .It Cm rewind Rewind the tape. .It Cm offline , rewoffl Rewind the tape and place the drive off line. Some drives are never off line. .It Cm load Load the tape into the drive. .It Cm retension Re-tension the tape. This winds the tape from the current position to the end and then to the beginning. This sometimes improves subsequent reading and writing, particularly for streaming drives. Some drives do not support this. .It Cm ostatus Output status information about the drive. 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 outputs 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). .Pp Also note that this is the old status command, and will be eliminated in favor of the new status command (see below) in a future release. .It Cm errstat Output (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 is associated status and any residual counts (if any). This command retrieves and outputs this information. If possible, this also clears any latched error information. .It Cm geteotmodel Output the current EOT filemark model. The model states how many filemarks will be written at close if a tape was being written. .It Cm eod , eom Wind the tape to the end of the recorded data, typically after an EOF mark where another file may be written. .It Cm rblim Report the block limits of the tape drive, including the minimum and maximum block size, and the block granularity if any. .El .Pp The following commands may require an .Ar argument . .Bl -tag -width ".Cm seteotmodel" .It Cm sethpos Set the hardware block position. The .Ar argument is a hardware block number to which to position the tape. Some drives do not support this. .It Cm setspos Set the SCSI logical block position. The .Ar argument is a SCSI logical block number to which to position the tape. Some drives do not support this. .It Cm blocksize Set the block size for the drive. The .Ar argument is the number of bytes per block, except 0 commands the drive to use variable-length blocks. .It Cm seteotmodel Set the EOT filemark model to .Ar argument and output the old and new models. Typically this will be 2 filemarks, but some devices (typically QIC cartridge drives) can only write 1 filemark. You may only choose a value of .Ar 1 or .Ar 2 . .It Cm status Output status information about the drive. 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. .Pp If the driver knows the relative position from BOT (in terms of filemarks and records), it outputs that. If the tape drive supports the long form report of the .Tn SCSI READ POSITION command, the Reported File Number and Reported Record Number will be numbers other than -1, and there may be Flags reported as well. .Pp The BOP flag means that the logical position of the drive is at the beginning of the partition. .Pp The EOP flag means that the logical position of the drive is between Early Warning and End of Partition. .Pp The BPEW flag means that the logical position of the drive is in a Programmable Early Warning Zone or on the EOP side of Early Warning. .Pp Note that the Reported Record Number is the tape block or object number relative to the beginning of the partition. The Calculated Record Number is the tape block or object number relative to the previous file mark. .Pp Note that the Calculated File and Record Numbers are not definitive. The Reported File and Record Numbers are definitive, if they are numbers other than -1. .Bl -tag -width 6n .It Fl v Print additional status information, such as the maximum supported I/O size. .It Fl x Print all available status data to stdout in XML format. .El .It Cm getdensity Report density support information for the tape drive and any media that is loaded. Most drives will report at least basic density information similar to that reported by .Nm status command. Newer tape drives that conform to the T-10 SSC and newer tape specifications may report more detailed information about the types of tapes they support and the tape currently in the drive. .Bl -tag -width 6n .It Fl x Print all available density data to stdout in XML format. Because density information is currently included in the general status XML report used for .Nm status command, this will be the same XML output via .Do .Nm status -.Fl x +.Fl x .Dc .El .It Cm param Display or set parameters. -One of +One of .Fl l , .Fl s , or .Fl x must be specified to indicate which operation to perform. .Bl -tag -width 8n .It Fl l List parameters, values and descriptions. By default all parameters will be displayed. To display a specific parameter, specify the parameter with .Fl p . .It Fl p Ar name Specify the parameter name to list (with .Fl l ) -or set (with +or set (with .Fl s ) . .It Fl q Enable quiet mode for parameter listing. This will suppress printing of parameter descriptions. .It Fl s Ar value Specify the parameter value to set. The general type of this argument (integer, unsigned integer, string) is determined by the type of the variable indicated by the .Xr sa 4 driver. More detailed argument checking is done by the .Xr sa 4 driver. .It Fl x Print out all parameter information in XML format. .El .It Cm protect Display or set drive protection parameters. This is used to control checking and reporting a per-block checksum for tape drives that support it. Some drives may only support some parameters. .Bl -tag -width 8n .It Fl b Ar 0|1 Set the Recover Buffered Data Protected bit. If set, this indicates that checksums are transferred with the logical blocks transferred by the RECOVERED BUFFERED DATA .Tn SCSI command. .It Fl d Disable all protection information settings. .It Fl e Enable all protection information settings. The default protection method used is Reed-Solomon CRC (protection method 1), as specified in ECMA-319. The default protection information length used with Reed-Solomon CRC is 4 bytes. To enable all settings except one more more settings, specify the .Fl e argument and then explicitly disable settings that you do not wish to enable. For example, specifying .Fl e .Fl w Ar 0 will enable all settings except for LBP_W. .It Fl l List available protection parmeters and their current settings. .It Fl L Ar len Set the length of the protection information in bytes. For Reed-Solomon CRC, the protection information length should be 4 bytes. .It Fl m Ar num Specify the numeric value for the protection method. The numeric value for Reed-Solomon CRC is 1. .It Fl r Ar 0|1 Set the LBP_R parameter. When set, this indicates that each block read from the tape drive will have a checksum at the end. .It Fl v Enable verbose mode for parameter listing. This will include descriptions of each parameter. .It Fl w Ar 0|1 Set the LBP_W parameter. When set, this indicates that each block written to the tape drive will have a checksum at the end. The drive will verify the checksum before writing the block to tape. .El .It Cm locate Set the tape drive's logical position. -One of +One of .Fl b , .Fl e , .Fl f , -or +or .Fl s must be specified to indicate the type of position. If the partition number is specified, the drive will first relocate to the given partition (if it exists) and then to the position indicated within that partition. If the partition number is not specified, the drive will relocate to the given position within the current partition. .Bl -tag -width 14n .It Fl b Ar block_addr Relocate to the given tape block or logical object identifier. Note that the block number is the Reported Record Number that is relative to the beginning of the partition (or beginning of tape). .It Fl e Relocate to the end of data. .It Fl f Ar fileno Relocate to the given file number. .It Fl p Ar partition Specify the partition to change to. .It Fl s Ar setmark Relocate to the given set mark. .El .It Cm comp Set the drive's compression mode. The non-numeric values of .Ar argument are: .Pp .Bl -tag -width 9n -compact .It off Turn compression off. .It on Turn compression on. .It none Same as .Ar off . .It enable Same as .Ar on . .It IDRC IBM Improved Data Recording Capability compression (0x10). .It DCLZ DCLZ compression algorithm (0x20). .El .Pp In addition to the above recognized compression keywords, the user can supply a numeric compression algorithm for the drive to use. In most cases, simply turning the compression .Sq on will have the desired effect of enabling the default compression algorithm supported by the drive. If this is not the case (see the .Cm status display to see which compression algorithm is currently in use), the user can manually specify one of the supported compression keywords (above), or supply a numeric compression value from the drive's specifications. .Pp Note that for some older tape drives (for example the Exabyte 8200 and 8500 series drives) it is necessary to switch to a different density to tell the drive to record data in its compressed format. If the user attempts to turn compression on while the uncompressed density is selected, the drive will return an error. This is generally not an issue for modern tape drives. .It Cm density Set the density for the drive. For the density codes, see below. The density value could be given either numerically, or as a string, corresponding to the .Dq Reference field. If the string is abbreviated, it will be resolved in the order shown in the table, and the first matching entry will be used. If the given string and the resulting canonical density name do not match exactly, an informational message is output about what the given string has been taken for. .El .Pp The initial version of the density table below was taken from the .Sq Historical sequential access density codes table (A-1) in Revision 11 of the SCSI-3 Stream Device Commands (SSC) working draft, dated November 11, 1997. Subsequent additions have come from a number of sources. .Pp The density codes are: .Bd -literal -offset 2n 0x0 default for device 0xE reserved for ECMA Value Width Tracks Density Code Type Reference Note mm in bpmm bpi 0x01 12.7 (0.5) 9 32 (800) NRZI R X3.22-1983 2 0x02 12.7 (0.5) 9 63 (1,600) PE R X3.39-1986 2 0x03 12.7 (0.5) 9 246 (6,250) GCR R X3.54-1986 2 0x05 6.3 (0.25) 4/9 315 (8,000) GCR C X3.136-1986 1 0x06 12.7 (0.5) 9 126 (3,200) PE R X3.157-1987 2 0x07 6.3 (0.25) 4 252 (6,400) IMFM C X3.116-1986 1 0x08 3.81 (0.15) 4 315 (8,000) GCR CS X3.158-1987 1 0x09 12.7 (0.5) 18 1,491 (37,871) GCR C X3.180 2 0x0A 12.7 (0.5) 22 262 (6,667) MFM C X3B5/86-199 1 0x0B 6.3 (0.25) 4 63 (1,600) PE C X3.56-1986 1 0x0C 12.7 (0.5) 24 500 (12,690) GCR C HI-TC1 1,6 0x0D 12.7 (0.5) 24 999 (25,380) GCR C HI-TC2 1,6 0x0F 6.3 (0.25) 15 394 (10,000) GCR C QIC-120 1,6 0x10 6.3 (0.25) 18 394 (10,000) GCR C QIC-150 1,6 0x11 6.3 (0.25) 26 630 (16,000) GCR C QIC-320 1,6 0x12 6.3 (0.25) 30 2,034 (51,667) RLL C QIC-1350 1,6 0x13 3.81 (0.15) 1 2,400 (61,000) DDS CS X3B5/88-185A 5 0x14 8.0 (0.315) 1 1,703 (43,245) RLL CS X3.202-1991 5,11 0x15 8.0 (0.315) 1 1,789 (45,434) RLL CS ECMA TC17 5,12 0x16 12.7 (0.5) 48 394 (10,000) MFM C X3.193-1990 1 0x17 12.7 (0.5) 48 1,673 (42,500) MFM C X3B5/91-174 1 0x18 12.7 (0.5) 112 1,673 (42,500) MFM C X3B5/92-50 1 0x19 12.7 (0.5) 128 2,460 (62,500) RLL C DLTapeIII 6,7 0x1A 12.7 (0.5) 128 3,214 (81,633) RLL C DLTapeIV(20) 6,7 0x1B 12.7 (0.5) 208 3,383 (85,937) RLL C DLTapeIV(35) 6,7 0x1C 6.3 (0.25) 34 1,654 (42,000) MFM C QIC-385M 1,6 0x1D 6.3 (0.25) 32 1,512 (38,400) GCR C QIC-410M 1,6 0x1E 6.3 (0.25) 30 1,385 (36,000) GCR C QIC-1000C 1,6 0x1F 6.3 (0.25) 30 2,666 (67,733) RLL C QIC-2100C 1,6 0x20 6.3 (0.25) 144 2,666 (67,733) RLL C QIC-6GB(M) 1,6 0x21 6.3 (0.25) 144 2,666 (67,733) RLL C QIC-20GB(C) 1,6 0x22 6.3 (0.25) 42 1,600 (40,640) GCR C QIC-2GB(C) ? 0x23 6.3 (0.25) 38 2,666 (67,733) RLL C QIC-875M ? 0x24 3.81 (0.15) 1 2,400 (61,000) CS DDS-2 5 0x25 3.81 (0.15) 1 3,816 (97,000) CS DDS-3 5 0x26 3.81 (0.15) 1 3,816 (97,000) CS DDS-4 5 0x27 8.0 (0.315) 1 3,056 (77,611) RLL CS Mammoth 5 0x28 12.7 (0.5) 36 1,491 (37,871) GCR C X3.224 1 0x29 12.7 (0.5) 0x2A 0x2B 12.7 (0.5) 3 ? ? ? C X3.267 5 0x40 12.7 (0.5) 384 4,800 (123,952) C LTO-1 0x41 12.7 (0.5) 208 3,868 (98,250) RLL C DLTapeIV(40) 6,7 0x42 12.7 (0.5) 512 7,398 (187,909) C LTO-2 0x44 12.7 (0.5) 704 9,638 (244,805) C LTO-3 0x46 12.7 (0.5) 896 12,725 (323,215) C LTO-4 0x47 3.81 (0.25) ? 6,417 (163,000) CS DAT-72 0x48 12.7 (0.5) 448 5,236 (133,000) PRML C SDLTapeI(110) 6,8,13 0x49 12.7 (0.5) 448 7,598 (193,000) PRML C SDLTapeI(160) 6,8 0x4A 12.7 (0.5) 768 ? C T10000A 10 0x4B 12.7 (0.5) 1152 ? C T10000B 10 0x4C 12.7 (0.5) 3584 ? C T10000C 10 0x4D 12.7 (0.5) 4608 ? C T10000D 10 0x51 12.7 (0.5) 512 11,800 (299,720) C 3592A1 (unencrypted) 0x52 12.7 (0.5) 896 11,800 (299,720) C 3592A2 (unencrypted) 0x53 12.7 (0.5) 1152 13,452 (341,681) C 3592A3 (unencrypted) 0x54 12.7 (0.5) 2560 19,686 (500,024) C 3592A4 (unencrypted) 0x55 12.7 (0.5) 5120 20,670 (525,018) C 3592A5 (unencrypted) 0x58 12.7 (0.5) 1280 15,142 (384,607) C LTO-5 0x5A 12.7 (0.5) 2176 15,142 (384,607) C LTO-6 0x5C 12.7 (0.5) 3584 19,107 (485,318) C LTO-7 0x71 12.7 (0.5) 512 11,800 (299,720) C 3592A1 (encrypted) 0x72 12.7 (0.5) 896 11,800 (299,720) C 3592A2 (encrypted) 0x73 12.7 (0.5) 1152 13,452 (341,681) C 3592A3 (encrypted) 0x74 12.7 (0.5) 2560 19,686 (500,024) C 3592A4 (encrypted) 0x75 12.7 (0.5) 5120 20,670 (525,018) C 3592A5 (encrypted) 0x8c 8.0 (0.315) 1 1,789 (45,434) RLL CS EXB-8500c 5,9 0x90 8.0 (0.315) 1 1,703 (43,245) RLL CS EXB-8200c 5,9 .Ed .Bd -literal -offset 2n Code Description Type Description ---- -------------------------------------- ---- ----------- NRZI Non return to zero, change on ones R Reel-to-reel GCR Group code recording C Cartridge PE Phase encoded CS Cassette IMFM Inverted modified frequency modulation MFM Modified frequency modulation DDS DAT data storage RLL Run length limited PRML Partial Response Maximum Likelihood .Ed .Bd -literal -offset 2n NOTES 1. Serial recorded. 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 an industry standard definition of the media format. 7. DLT recording: serially recorded track pairs (DLTapeIII and DLTapeIV(20)), or track quads (DLTapeIV(35) and DLTapeIV(40)). 8. Super DLT (SDLT) recording: 56 serially recorded logical tracks with 8 physical tracks each. 9. Vendor-specific Exabyte density code for compressed format. 10. bpi/bpmm values for the Oracle/StorageTek T10000 tape drives are not listed in the manual. Someone with access to a drive can supply the necessary values by running 'mt getdensity'. 11. This is Exabyte 8200 uncompressed format. The compressed format density code is 0x90. 12. This is Exabyte 8500 uncompressed format. The compressed format density code is 0x8c. 13. This density code (0x48) was also used for DAT-160. .Ed .Sh ENVIRONMENT .Bl -tag -width ".Ev TAPE" .It Ev TAPE This is the pathname of the tape drive. The default (if the variable is unset, but not if it is null) is .Pa /dev/nsa0 . It may be overridden with the .Fl f option. .El .Sh FILES .Bl -tag -width ".Pa /dev/*sa[0-9]*" -compact .It Pa /dev/*sa[0-9]* SCSI magnetic tape interface .El .Sh DIAGNOSTICS The exit status will be 0 when the drive operations were successful, 2 when the drive operations were unsuccessful, and 1 for other problems like an unrecognized command or a missing drive device. .Sh COMPATIBILITY Some undocumented commands support old software. .Sh SEE ALSO .Xr dd 1 , .Xr ioctl 2 , .Xr mtio 4 , .Xr sa 4 , .Xr environ 7 .Sh HISTORY The .Nm command appeared in .Bx 4.3 . .Pp Extensions regarding the .Xr st 4 driver appeared in .Bx 386 0.1 as a separate .Nm st command, and have been merged into the .Nm command in .Fx 2.1 . .Pp The former .Cm eof command that used to be a synonym for .Cm weof has been abandoned in .Fx 2.1 since it was often confused with .Cm eom , which is fairly dangerous. .Sh BUGS The utility cannot be interrupted or killed during a long erase (which can be longer than an hour), and it is easy to forget that the default erase is long. .Pp Hardware block numbers do not always correspond to blocks on the tape when the drive uses internal compression. .Pp Erasure is not guaranteed if the tape is not at its beginning. .Pp Tape-related documentation is poor, here and elsewhere. Index: stable/11/usr.bin/perror/perror.1 =================================================================== --- stable/11/usr.bin/perror/perror.1 (revision 313867) +++ stable/11/usr.bin/perror/perror.1 (revision 313868) @@ -1,50 +1,50 @@ -.\" +.\" .\" Copyright (c) 2009 Hudson River Trading LLC .\" Written by: George V. Neville-Neil .\" All rights reserved. -.\" +.\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. -.\" +.\" .\" $FreeBSD$ .\" .Dd May 12, 2009 .Dt PERROR 1 .Os .Sh NAME .Nm perror .Nd "print an error number as a string" .Sh SYNOPSIS .Nm .Ar number .Sh DESCRIPTION The .Nm program takes a raw errno value and prints it as a string. .Sh SEE ALSO .Xr perror 3 .Sh HISTORY The .Nm program first appeared in .Fx 8.0 . .Sh AUTHORS .An George V. Neville-Neil Index: stable/11/usr.bin/revoke/revoke.1 =================================================================== --- stable/11/usr.bin/revoke/revoke.1 (revision 313867) +++ stable/11/usr.bin/revoke/revoke.1 (revision 313868) @@ -1,56 +1,56 @@ .\" Copyright (c) 2009 Ed Schouten .\" All rights reserved. -.\" +.\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. -.\" +.\" .\" $FreeBSD$ .\" .Dd June 15, 2009 .Dt REVOKE 1 .Os .Sh NAME .Nm revoke .Nd "revoke a character device" .Sh SYNOPSIS .Nm .Ar .Sh DESCRIPTION The .Nm program revokes the character devices using .Xr revoke 2 . When used on a TTY, calls like .Xr read 2 , .Xr write 2 and .Xr ioctl 2 , will be aborted immediately, effectively causing login sessions to be terminated. .Sh SEE ALSO .Xr revoke 2 .Sh HISTORY The .Nm program first appeared in .Fx 8.0 . .Sh AUTHORS -.An Ed Schouten Aq Mt ed@FreeBSD.org +.An \&Ed Schouten Aq Mt ed@FreeBSD.org Index: stable/11/usr.bin/sdiff/sdiff.1 =================================================================== --- stable/11/usr.bin/sdiff/sdiff.1 (revision 313867) +++ stable/11/usr.bin/sdiff/sdiff.1 (revision 313868) @@ -1,174 +1,172 @@ .\" $FreeBSD$ .\" $OpenBSD: sdiff.1,v 1.15 2007/06/29 14:48:07 jmc Exp $ .\" .\" Written by Raymond Lai . .\" Public domain. .\" .Dd $Mdocdate: July 5 2012 $ .Dt SDIFF 1 .Os .Sh NAME .Nm sdiff .Nd side-by-side diff .Sh SYNOPSIS .Nm .Op Fl abdilstW .Op Fl I Ar regexp .Op Fl o Ar outfile .Op Fl w Ar width .Ar file1 .Ar file2 .Sh DESCRIPTION .Nm displays two files side by side, with any differences between the two highlighted as follows: new lines are marked with .Sq \*(Gt ; deleted lines are marked with .Sq \*(Lt ; and changed lines are marked with .Sq \*(Ba . .Pp .Nm can also be used to interactively merge two files, prompting at each set of differences. See the .Fl o option for an explanation. .Pp The options are: .Bl -tag -width Ds .It Fl l -left-column Only print the left column for identical lines. .It Fl o -output Ar outfile Interactively merge .Ar file1 and .Ar file2 into .Ar outfile . In this mode, the user is prompted for each set of differences. See .Ev EDITOR and .Ev VISUAL , below, for details of which editor, if any, is invoked. .Pp The commands are as follows: .Bl -tag -width Ds .It Cm l | 1 Choose left set of diffs. .It Cm r | 2 Choose right set of diffs. .It Cm s Silent mode \(en identical lines are not printed. .It Cm v Verbose mode \(en identical lines are printed. .It Cm e Start editing an empty file, which will be merged into .Ar outfile upon exiting the editor. .It Cm e Cm l Start editing file with left set of diffs. .It Cm e Cm r Start editing file with right set of diffs. .It Cm e Cm b Start editing file with both sets of diffs. .It Cm q Quit .Nm . .El .It Fl s -suppress-common-lines Skip identical lines. .It Fl w -width Ar width Print a maximum of .Ar width characters on each line. The default is 130 characters. .El .Pp Options passed to .Xr diff 1 are: .Bl -tag -width Ds .It Fl a -text Treat .Ar file1 and .Ar file2 as text files. .It Fl b -ignore-space-change Ignore trailing blank spaces. .It Fl d -minimal Minimize diff size. .It Fl I -ignore-matching-lines Ar regexp Ignore line changes matching .Ar regexp . All lines in the change must match .Ar regexp for the change to be ignored. .It Fl i -ignore-case Do a case-insensitive comparison. .It Fl t -expand-tabs Expand tabs to spaces. .It Fl W -ignore-all-space Ignore all spaces. .It Fl B -ignore-blank-lines Ignore blank lines. .It Fl E -ignore-tab-expansion Treat tabs and eight spaces as the same. .It Fl t -ignore-tabs Ignore tabs. .It Fl H -speed-large-files Assume scattered small changes in a large file. .It Fl -ignore-file-name-case Ignore the case of file names. .It Fl -no-ignore-file-name-case Do not ignore file name case. .It Fl -strip-trailing-cr Skip identical lines. .It Fl -tabsize Ar NUM Change the size of tabs (default is 8.) .El .Sh ENVIRONMENT .Bl -tag -width Ds .It Ev EDITOR , VISUAL Specifies an editor to use with the .Fl o option. If both .Ev EDITOR and .Ev VISUAL are set, .Ev VISUAL takes precedence. If neither .Ev EDITOR nor .Ev VISUAL are set, the default is .Xr vi 1 . .It Ev TMPDIR Specifies a directory for temporary files to be created. The default is .Pa /tmp . .El .Sh SEE ALSO .Xr cmp 1 , .Xr diff 1 , .Xr diff3 1 , .Xr vi 1 , .Xr re_format 7 .Sh AUTHORS .Nm was written from scratch for the public domain by .An Ray Lai Aq ray@cyth.net . .Sh CAVEATS -.Pp Tabs are treated as anywhere from one to eight characters wide, depending on the current column. Terminals that treat tabs as eight characters wide will look best. - Index: stable/11/usr.bin/units/units.1 =================================================================== --- stable/11/usr.bin/units/units.1 (revision 313867) +++ stable/11/usr.bin/units/units.1 (revision 313868) @@ -1,205 +1,205 @@ .\" $FreeBSD$ .Dd July 4, 2014 .Dt UNITS 1 .Os .Sh NAME .Nm units .Nd conversion program .Sh SYNOPSIS .Nm .Op Fl f Ar filename .Op Fl H Ar filename .Op Fl qvUV .Op Ar from-unit to-unit .Sh OPTIONS The following options are available: .Bl -tag -width indent -.It Fl h No , Fl -help +.It Fl h \&No , Fl -help Show an overview of options -.It Fl f Ar filename No , Fl -file Ar filename +.It Fl f Ar filename \&No , Fl -file Ar filename Specify the name of the units data file to load. -.It Fl H Ar filename No , Fl -historyfile Ar filename +.It Fl H Ar filename \&No , Fl -historyfile Ar filename Ignored, for compatibility with GNU units. .It Fl e , Fl -exponential Behave as if -o '%6e' was typed. -.It Fl q No , Fl -quiet +.It Fl q \&No , Fl -quiet Suppress prompting of the user for units and the display of statistics about the number of units loaded. -.It Fl U No , Fl -unitsfile +.It Fl U \&No , Fl -unitsfile If the default unit file exists prints its location. If not, print .Qo Units data file not found .Qc -.It Fl t No , Fl -terse +.It Fl t \&No , Fl -terse Only print the result. This is used when calling .Nm from other programs for easy to parse results. -.It Fl v No , Fl -verbose +.It Fl v \&No , Fl -verbose Print the units in the conversion output. Be more verbose in general. -.It Fl o Ar format No , Fl -output-format Ar format +.It Fl o Ar format \&No , Fl -output-format Ar format Select the output format string by which numbers are printed. -.It Fl V No , Fl -version +.It Fl V \&No , Fl -version Print the version number, usage, and then exit. .It Ar from-unit to-unit Allow a single unit conversion to be done directly from the command line. The program will not print prompts. It will print out the result of the single specified conversion. .El .Sh DESCRIPTION The .Nm program converts quantities expressed in various scales to their equivalents in other scales. The .Nm program can only handle multiplicative or affine scale changes. It works interactively by prompting the user for input: .Bd -literal You have: meters You want: feet * 3.2808399 / 0.3048 You have: cm^3 You want: gallons * 0.00026417205 / 3785.4118 You have: meters/s You want: furlongs/fortnight * 6012.8848 / 0.00016630952 You have: 1|2 inch You want: cm * 1.27 / 0.78740157 You have: 85 degF You want: degC 29.444444 .Ed .Pp Powers of units can be specified using the '^' character as shown in the example, or by simple concatenation: 'cm3' is equivalent to 'cm^3'. Multiplication of units can be specified by using spaces, a dash or an asterisk. Division of units is indicated by the slash ('/'). Note that multiplication has a higher precedence than division, so 'm/s/s' is the same as 'm/s^2' or 'm/s s'. Division of numbers must be indicated using the vertical bar ('|'). To convert half a meter, you would write '1|2 meter'. If you write '1/2 meter' then the units program would interpret that as equivalent to '0.5/meter'. If you enter incompatible unit types, the units program will print a message indicating that the units are not conformable and it will display the reduced form for each unit: .Bd -literal You have: ergs/hour You want: fathoms kg^2 / day conformability error 2.7777778e-11 kg m^2 / sec^3 2.1166667e-05 kg^2 m / sec .Ed .Pp The conversion information is read from a units data file. The default file includes definitions for most familiar units, abbreviations and metric prefixes. Some constants of nature included are: .Pp .Bl -column -offset indent -compact "mercury" .It "pi ratio of circumference to diameter" .It "c speed of light" .It "e charge on an electron" .It "g acceleration of gravity" .It "force same as g" .It "mole Avogadro's number" .It "water pressure per unit height of water" .It "mercury pressure per unit height of mercury" .It "au astronomical unit" .El .Pp The unit 'pound' is a unit of mass. Compound names are run together so 'pound force' is a unit of force. The unit 'ounce' is also a unit of mass. The fluid ounce is 'floz'. British units that differ from their US counterparts are prefixed with 'br', and currency is prefixed with its country name: 'belgiumfranc', 'britainpound'. When searching for a unit, if the specified string does not appear exactly as a unit name, then .Nm will try to remove a trailing 's' or a trailing 'es' and check again for a match. .Pp To find out what units are available read the standard units file. If you want to add your own units you can supply your own file. A unit is specified on a single line by giving its name and an equivalence. Be careful to define new units in terms of old ones so that a reduction leads to the primitive units which are marked with '!' characters. The .Nm program will not detect infinite loops that could be caused by careless unit definitions. Comments in the unit definition file begin with a '#' or '/' character at the beginning of a line. .Pp Prefixes are defined in the same was as standard units, but with a trailing dash at the end of the prefix name. If a unit is not found even after removing trailing 's' or 'es', then it will be checked against the list of prefixes. Prefixes will be removed until a legal base unit is identified. .Pp Here is an example of a short units file that defines some basic units. .Pp .Bl -column -offset indent -compact "minute" .It "m !a!" .It "sec !b!" .It "micro- 1e-6" .It "minute 60 sec" .It "hour 60 min" .It "inch 0.0254 m" .It "ft 12 inches" .It "mile 5280 ft" .El .Sh FILES .Bl -tag -width /usr/share/misc/definitions.units -compact .It Pa /usr/share/misc/definitions.units the standard units library .El .Sh AUTHORS .An Adrian Mariano Aq Mt adrian@cam.cornell.edu .Sh BUGS The effect of including a '/' in a prefix is surprising. .Pp Exponents entered by the user can be only one digit. You can work around this by multiplying several terms. .Pp The user must use | to indicate division of numbers and / to indicate division of symbols. This distinction should not be necessary. .Pp The program contains various arbitrary limits on the length of the units converted and on the length of the data file. .Pp The program should use a hash table to store units so that it does not take so long to load the units list and check for duplication. Index: stable/11/usr.bin/unzip/unzip.1 =================================================================== --- stable/11/usr.bin/unzip/unzip.1 (revision 313867) +++ stable/11/usr.bin/unzip/unzip.1 (revision 313868) @@ -1,191 +1,191 @@ .\"- .\" Copyright (c) 2007-2008 Dag-Erling Smørgrav .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" .Dd December 12, 2015 .Dt UNZIP 1 .Os .Sh NAME .Nm unzip .Nd extract files from a ZIP archive .Sh SYNOPSIS .Nm .Op Fl aCcfjLlnopqtuvy .Op Fl d Ar dir .Ar zipfile .Sh DESCRIPTION .\" ... The following options are available: .Bl -tag -width Fl .It Fl a When extracting a text file, convert DOS-style line endings to Unix-style line endings. .It Fl C Match file names case-insensitively. .It Fl c Extract to stdout/screen. When extracting files from the zipfile, they are written to stdout. This is similar to .Fl p , but does not suppress normal output. .It Fl d Ar dir Extract files into the specified directory rather than the current directory. .It Fl f Update existing. Extract only files from the zipfile if a file with the same name already exists on disk and is older than the former. Otherwise, the file is silently skipped. .It Fl j Ignore directories stored in the zipfile; instead, extract all files directly into the extraction directory. .It Fl L Convert the names of the extracted files and directories to lowercase. .It Fl l List, rather than extract, the contents of the zipfile. .It Fl n No overwrite. When extracting a file from the zipfile, if a file with the same name already exists on disk, the file is silently skipped. .It Fl o Overwrite. When extracting a file from the zipfile, if a file with the same name already exists on disk, the existing file is replaced with the file from the zipfile. .It Fl p Extract to stdout. When extracting files from the zipfile, they are written to stdout. The normal output is suppressed as if .Fl q was specified. .It Fl q Quiet: print less information while extracting. .It Fl t Test: do not extract anything, but verify the checksum of every file in the archive. .It Fl u Update. When extracting a file from the zipfile, if a file with the same name already exists on disk, the existing file is replaced with the file from the zipfile if and only if the latter is newer than the former. Otherwise, the file is silently skipped. .It Fl v List verbosely, rather than extract, the contents of the zipfile. This differs from .Fl l by using the long listing. Note that most of the data is currently fake and does not reflect the content of the archive. .It Fl x Ar pattern Exclude files matching the pattern .Ar pattern . .It Fl y Print four digit years in listings instead of two. .It Fl Z Ar mode Emulate .Xr zipinfo 1L mode. Enabling .Xr zipinfo 1L mode changes the way in which additional arguments are parsed. Currently only .Xr zipinfo 1L mode 1 is supported, which lists the file names one per line. .El .Pp Note that only one of .Fl n , .Fl o , and .Fl u may be specified. If specified filename is .Qq - , then data is read from .Va stdin . .Sh ENVIRONMENT If the .Ev UNZIP_DEBUG environment variable is defined, the .Fl q command-line option has no effect, and additional debugging information will be printed to .Va stderr . .Sh COMPATIBILITY The .Nm utility aims to be sufficiently compatible with other implementations to serve as a drop-in replacement in the context of the .Xr ports 7 system. No attempt has been made to replicate functionality which is not required for that purpose. .Pp For compatibility reasons, command-line options will be recognized if they are listed not only before but also after the name of the zipfile. .Pp Normally, the .Fl a option should only affect files which are marked as text files in the zipfile's central directory. Since the .Xr archive 3 library does not provide access to that information, it is not available to the .Nm utility. Instead, the .Nm utility will assume that a file is a text file if no non-ASCII characters are present within the first block of data decompressed for that file. If non-ASCII characters appear in subsequent blocks of data, a warning will be issued. .Pp The .Nm utility is only able to process ZIP archives handled by .Xr libarchive 3 . Depending on the installed version of -.Xr libarchive , +.Xr libarchive 3 , this may or may not include self-extracting archives. .Sh SEE ALSO .Xr libarchive 3 .Sh HISTORY The .Nm utility appeared in .Fx 8.0 . .Sh AUTHORS The .Nm utility and this manual page were written by .An Dag-Erling Sm\(/orgrav Aq Mt des@FreeBSD.org . It uses the .Xr archive 3 library developed by .An Tim Kientzle Aq Mt kientzle@FreeBSD.org . Index: stable/11/usr.bin/uuencode/uuencode.1 =================================================================== --- stable/11/usr.bin/uuencode/uuencode.1 (revision 313867) +++ stable/11/usr.bin/uuencode/uuencode.1 (revision 313868) @@ -1,221 +1,221 @@ .\" Copyright (c) 1980, 1990, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" @(#)uuencode.1 8.1 (Berkeley) 6/6/93 .\" $FreeBSD$ .\" .Dd January 27, 2002 .Dt UUENCODE 1 .Os .Sh NAME .Nm uuencode , .Nm uudecode , .Nm b64encode , .Nm b64decode .Nd encode/decode a binary file .Sh SYNOPSIS .Nm .Op Fl m -.Op Fl r +.Op Fl r .Op Fl o Ar output_file .Op Ar file .Ar name .Nm uudecode .Op Fl cimprs .Op Ar .Nm uudecode .Op Fl i .Fl o Ar output_file .Nm b64encode .Op Fl r .Op Fl o Ar output_file .Op Ar file .Ar name .Nm b64decode .Op Fl cimprs .Op Ar .Nm b64decode .Op Fl i .Fl o Ar output_file .Op Ar file .Sh DESCRIPTION The .Nm and .Nm uudecode utilities are used to transmit binary files over transmission mediums that do not support other than simple .Tn ASCII data. The .Nm b64encode utility is synonymous with .Nm with the .Fl m flag specified. The .Nm b64decode utility is synonymous with .Nm uudecode with the .Fl m flag specified. .Pp The .Nm utility reads .Ar file (or by default the standard input) and writes an encoded version to the standard output, or .Ar output_file if one has been specified. The encoding uses only printing .Tn ASCII characters and includes the mode of the file and the operand .Ar name for use by .Nm uudecode . .Pp The .Nm uudecode utility transforms .Em uuencoded files (or by default, the standard input) into the original form. The resulting file is named either .Ar name or (depending on options passed to .Nm uudecode ) .Ar output_file and will have the mode of the original file except that setuid and execute bits are not retained. The .Nm uudecode utility ignores any leading and trailing lines. .Pp The following options are available for .Nm : .Bl -tag -width ident .It Fl m Use the Base64 method of encoding, rather than the traditional .Nm algorithm. .It Fl r Produce raw output by excluding the initial and final framing lines. .It Fl o Ar output_file Output to .Ar output_file instead of standard output. .El .Pp The following options are available for .Nm uudecode : .Bl -tag -width ident .It Fl c Decode more than one uuencoded file from .Ar file if possible. .It Fl i Do not overwrite files. .It Fl m When used with the .Fl r flag, decode Base64 input instead of traditional .Nm input. Without .Fl r it has no effect. .It Fl o Ar output_file Output to .Ar output_file instead of any pathname contained in the input data. .It Fl p Decode .Ar file and write output to standard output. .It Fl r Decode raw (or broken) input, which is missing the initial and possibly the final framing lines. The input is assumed to be in the traditional .Nm encoding, but if the .Fl m flag is used, or if the utility is invoked as .Nm b64decode , then the input is assumed to be in Base64 format. .It Fl s Do not strip output pathname to base filename. By default .Nm uudecode deletes any prefix ending with the last slash '/' for security reasons. .El .Sh EXAMPLES The following example packages up a source tree, compresses it, uuencodes it and mails it to a user on another system. When .Nm uudecode is run on the target system, the file ``src_tree.tar.Z'' will be created which may then be uncompressed and extracted into the original tree. .Pp .Bd -literal -offset indent -compact tar cf \- src_tree \&| compress \&| uuencode src_tree.tar.Z \&| mail user@example.com .Ed .Pp The following example unpacks all uuencoded files from your mailbox into your current working directory. .Pp .Bd -literal -offset indent -compact uudecode -c < $MAIL .Ed .Pp The following example extracts a compressed tar archive from your mailbox .Pp .Bd -literal -offset indent -compact uudecode -o /dev/stdout < $MAIL | zcat | tar xfv - .Ed .Sh SEE ALSO .Xr basename 1 , .Xr compress 1 , .Xr mail 1 , .Xr uucp 1 Pq Pa ports/net/freebsd-uucp , .Xr uuencode 5 .Sh HISTORY The .Nm uudecode and .Nm utilities appeared in .Bx 4.0 . .Sh BUGS Files encoded using the traditional algorithm are expanded by 35% (3 bytes become 4 plus control information). Index: stable/11/usr.bin/whois/whois.1 =================================================================== --- stable/11/usr.bin/whois/whois.1 (revision 313867) +++ stable/11/usr.bin/whois/whois.1 (revision 313868) @@ -1,287 +1,287 @@ .\" Copyright (c) 1985, 1990, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" From: @(#)whois.1 8.1 (Berkeley) 6/6/93 .\" $FreeBSD$ .\" .Dd April 25, 2016 .Dt WHOIS 1 .Os .Sh NAME .Nm whois .Nd "Internet domain name and network number directory service" .Sh SYNOPSIS .Nm .Op Fl aAbfgiIklmPQrRS .Op Fl c Ar TLD | Fl h Ar host .Op Fl p Ar port .Op Fl - .Ar name ... .Sh DESCRIPTION The .Nm utility looks up records in the databases maintained by several Network Information Centers .Pq Tn NICs . .Pp By default .Nm starts by querying the Internet Assigned Numbers Authority (IANA) whois server, and follows referrals to whois servers that have more specific details about the query .Ar name . The IANA whois server knows about IP address and AS numbers as well as domain names. .Pp There are a few special cases where referrals do not work, so .Nm goes directly to the appropriate server. These include point-of-contact handles for ARIN, .Pa nic.at , NORID, and RIPE, and domain names under .Pa ac.uk . .Pp The options are as follows: .Bl -tag -width indent .It Fl a Use the American Registry for Internet Numbers .Pq Tn ARIN database. It contains network numbers used in those parts of the world covered neither by .Tn APNIC , AfriNIC , LACNIC , nor by .Tn RIPE . The query syntax is documented at .Pa https://www.arin.net/resources/whoisrws/whois_api.html#nicname .It Fl A Use the Asia/Pacific Network Information Center .Pq Tn APNIC database. It contains network numbers used in East Asia, Australia, New Zealand, and the Pacific islands. Get query syntax documentation using .Ic whois -A help .It Fl b Use the Network Abuse Clearinghouse database. It contains addresses to which network abuse should be reported, indexed by domain name. .It Fl c Ar TLD This is the equivalent of using the .Fl h option with an argument of .Qq Ar TLD Ns Li .whois-servers.net . This can be helpful for locating country-class TLD whois servers. .It Fl f Use the African Network Information Centre .Pq Tn AfriNIC database. It contains network numbers used in Africa and the islands of the western Indian Ocean. Get query syntax documentation using .Ic whois -f help .It Fl g Use the US non-military federal government database, which contains points of contact for subdomains of .Pa .GOV . .It Fl h Ar host Use the specified host instead of the default. Either a host name or an IP address may be specified. .It Fl i Use the traditional Network Information Center (InterNIC) .Pq Pa whois.internic.net database. This now contains only registrations for domain names under .Pa .COM , .Pa .NET , .Pa .EDU . You can specify the type of object to search for like .Ic whois -i ' Ns Ar type Ar name Ns Ic ' where .Ar type can be .Nm domain , nameserver , registrar . The .Ar name can contain .Li * wildcards. .It Fl I Use the Internet Assigned Numbers Authority .Pq Tn IANA database. .It Fl k Use the National Internet Development Agency of Korea's .Pq Tn KRNIC database. It contains network numbers and domain contact information for Korea. .It Fl l Use the Latin American and Caribbean IP address Regional Registry .Pq Tn LACNIC database. It contains network numbers used in much of Latin America and the Caribbean. .It Fl m Use the Route Arbiter Database .Pq Tn RADB database. It contains route policy specifications for a large number of operators' networks. .It Fl p Ar port Connect to the whois server on .Ar port . If this option is not specified, .Nm defaults to port 43. .It Fl P Use the PeeringDB database of AS numbers. It contains details about presence at internet peering points for many network operators. .It Fl Q Do a quick lookup; .Nm will not attempt to follow referrals to other whois servers. This is the default if a server is explicitly specified using one of the other options or in an environment variable. See also the .Fl R option. .It Fl r Use the R\(aaeseaux IP Europ\(aaeens .Pq Tn RIPE database. It contains network numbers and domain contact information for Europe. Get query syntax documentation using .Ic whois -r help .It Fl R Do a recursive lookup; .Nm will attempt to follow referrals to other whois servers. This is the default if no server is explicitly specified. See also the .Fl Q option. .It Fl S By default .Nm adjusts simple queries (without spaces) to produce more useful output from certain whois servers, and it suppresses some uninformative output. With the .Fl S option, .Nm sends the query and prints the output verbatim. .El .Pp The operands specified to .Nm are treated independently and may be used as queries on different whois servers. .Sh ENVIRONMENT -.Bl -tag +.Bl -tag -width WHOIS_SERVER .It Ev WHOIS_SERVER The primary default whois server. If this is unset, .Nm uses the .Ev RA_SERVER environment variable. .It Ev RA_SERVER The secondary default whois server. If this is unset, .Nm will use .Pa whois.iana.org . .El .Sh EXIT STATUS .Ex -std .Sh EXAMPLES To obtain contact information about an administrator located in the Russian .Tn TLD domain .Qq Li RU , use the .Fl c option as shown in the following example, where .Ar CONTACT-ID is substituted with the actual contact identifier. .Pp .Dl Ic whois -c RU CONTACT-ID .Pp (Note: This example is specific to the .Tn TLD .Qq Li RU , but other .Tn TLDs can be queried by using a similar syntax.) .Pp The following example demonstrates how to query a whois server using a non-standard port, where .Dq Li query-data is the query to be sent to .Dq Li whois.example.com on port .Dq Li rwhois (written numerically as 4321). .Pp .Dl Ic whois -h whois.example.com -p rwhois query-data .Pp Some whois servers support complex queries with dash-letter options. You can use the .Fl - option to separate .Nm command options from whois server query options. A query containing spaces must be quoted as one argument to the .Nm command. The following example asks the RIPE whois server to return a brief description of its .Dq Li domain object type: .Pp .Dl Ic whois -r -- '-t domain' .Sh SEE ALSO .Rs .%A Ken Harrenstien .%A Vic White .%T NICNAME/WHOIS .%D 1 March 1982 .%O RFC 812 .Re .Sh HISTORY The .Nm command appeared in .Bx 4.3 . Index: stable/11 =================================================================== --- stable/11 (revision 313867) +++ stable/11 (revision 313868) Property changes on: stable/11 ___________________________________________________________________ Modified: svn:mergeinfo ## -0,0 +0,1 ## Merged /head:r313659-313673