diff --git a/share/man/man7/environ.7 b/share/man/man7/environ.7 index 9a77100ff6d3..7d188a795883 100644 --- a/share/man/man7/environ.7 +++ b/share/man/man7/environ.7 @@ -1,314 +1,314 @@ .\" Copyright (c) 1983, 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. .\" 3. 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. .\" .\" @(#)environ.7 8.3 (Berkeley) 4/19/94 .\" $FreeBSD$ .\" .Dd August 5, 2020 .Dt ENVIRON 7 .Os .Sh NAME .Nm environ .Nd user environment .Sh SYNOPSIS .Ar extern char **environ ; .Sh DESCRIPTION An array of strings, called the .Ar environment is made available to each process by .Xr execve 2 when a process begins. By convention these strings have the form .Va name Ns No = Ns Ar value , and are referred to as .Dq environment variables . A process can query, update, and delete these strings using the .Xr getenv 3 , .Xr setenv 3 , and .Xr unsetenv 3 functions, respectively. The shells also provide commands to manipulate the environment; they are described in the respective shell manual pages. .Pp What follows is a list of environment variables typically seen on a .Ux system. It includes only those variables that a user can expect to see during their day-to-day use of the system, and is far from complete. Environment variables specific to a particular program or library function are documented in the .Sx ENVIRONMENT section of the appropriate manual page. .Sh ENVIRONMENT .Bl -tag -width LD_LIBRARY_PATH .It Ev BLOCKSIZE The size of the block units used by several disk-related commands, most notably .Xr df 1 , .Xr du 1 and .Xr ls 1 . .Ev BLOCKSIZE may be specified in units of a byte by specifying a number, in units of a kilobyte by specifying a number followed by .Ql K or .Ql k , in units of a megabyte by specifying a number followed by .Ql M or .Ql m , and in units of a gigabyte by specifying a number followed by .Ql G or .Ql g . Sizes less than 512 bytes or greater than a gigabyte are ignored. This variable is processed by the .Xr getbsize 3 function. .It Ev COLUMNS The user's preferred width in column positions for the terminal. Utilities such as .Xr ls 1 and .Xr who 1 use this to format output into columns. If unset or empty, utilities will use an .Xr ioctl 2 call to ask the terminal driver for the width. .It Ev EDITOR Default editor name. .It Ev EXINIT A startup list of commands read by .Xr ex 1 and .Xr vi 1 . .It Ev HOME A user's login directory, set by .Xr login 1 from the password file .Xr passwd 5 . .It Ev LANG This variable configures all programs which use .Xr setlocale 3 to use the specified locale unless the .Ev LC_* variables are set. .It Ev LC_ALL Overrides the values of .Ev LC_COLLATE , .Ev LC_CTYPE , .Ev LC_MESSAGES , .Ev LC_MONETARY , .Ev LC_NUMERIC , .Ev LC_TIME and .Ev LANG . .It Ev LC_COLLATE Locale to be used for ordering of strings. .It Ev LC_CTYPE Locale to be used for character classification (letter, space, digit, etc.) and for interpreting byte sequences as multibyte characters. .It Ev LC_MESSAGES Locale to be used for diagnostic messages. .It Ev LC_MONETARY Locale to be used for interpreting monetary input and formatting output. .It Ev LC_NUMERIC Locale to be used for interpreting numeric input and formatting output. .It Ev LC_TIME Locale to be used for interpreting dates input and for formatting output. .It Ev MAIL The location of the user's mailbox instead of the default in /var/mail, used by .Xr mail 1 , .Xr sh 1 , and many other mail clients. .It Ev MANPATH The sequence of directories, separated by colons, searched by .Xr man 1 when looking for manual pages. .It Ev NLSPATH List of directories to be searched for the message catalog referred to by .Ev LC_MESSAGES . See .Xr catopen 3 . .It Ev PAGER Default paginator program. The program specified by this variable is used by .Xr mail 1 , .Xr man 1 , .Xr ftp 1 , etc, to display information which is longer than the current display. .It Ev PATH The sequence of directories, separated by colons, searched by .Xr csh 1 , .Xr sh 1 , .Xr system 3 , .Xr execvp 3 , etc, when looking for an executable file. .Ev PATH is set to ``/usr/bin:/bin'' initially by .Xr login 1 . .It Ev POSIXLY_CORRECT When set to any value, this environment variable modifies the behaviour of certain commands to (mostly) execute in a strictly POSIX-compliant manner. .It Ev PRINTER The name of the default printer to be used by .Xr lpr 1 , .Xr lpq 1 , and .Xr lprm 1 . .It Ev PWD The current directory pathname. .It Ev SHELL The full pathname of the user's login shell. .It Ev TERM The kind of terminal for which output is to be prepared. This information is used by commands, such as -.Xr nroff 1 +.Xr nroff 1 Pq Pa ports/textproc/groff or .Xr plot 1 which may exploit special terminal capabilities. See .Pa /usr/share/misc/termcap .Pq Xr termcap 5 for a list of terminal types. .It Ev TERMCAP The string describing the terminal in .Ev TERM , or, if it begins with a '/', the name of the termcap file. See .Ev TERMPATH below, and .Xr termcap 5 . .It Ev TERMPATH A sequence of pathnames of termcap files, separated by colons or spaces, which are searched for terminal descriptions in the order listed. Having no .Ev TERMPATH is equivalent to a .Ev TERMPATH of .Pa $HOME/.termcap:/etc/termcap . .Ev TERMPATH is ignored if .Ev TERMCAP contains a full pathname. .It Ev TMPDIR The directory in which to store temporary files. Most applications use either .Pa /tmp or .Pa /var/tmp . Setting this variable will make them use another directory. .It Ev TZ The timezone to use when displaying dates. The normal format is a pathname relative to .Pa /usr/share/zoneinfo . For example, the command .Pp .Dl env TZ=America/Los_Angeles date .Pp displays the current time in California. See .Xr tzset 3 for more information. .It Ev USER The login name of the user. It is recommended that portable applications use .Ev LOGNAME instead. .El .Pp Further names may be placed in the environment by the .Ic export command and .Ar name=value arguments in .Xr sh 1 , or by the .Ic setenv command if you use .Xr csh 1 . It is unwise to change certain .Xr sh 1 variables that are frequently exported by .Pa .profile files, such as .Ev MAIL , .Ev PS1 , .Ev PS2 , and .Ev IFS , unless you know what you are doing. .Pp The current environment variables can be printed with .Xr env 1 , .Xr set 1 or .Xr printenv 1 in .Xr sh 1 and .Xr env 1 , .Xr printenv 1 or the .Cm printenv built-in command in .Xr csh 1 . .Sh SEE ALSO .Xr cd 1 , .Xr csh 1 , .Xr env 1 , .Xr ex 1 , .Xr login 1 , .Xr printenv 1 , .Xr sh 1 , .Xr execve 2 , .Xr execle 3 , .Xr getbsize 3 , .Xr getenv 3 , .Xr setenv 3 , .Xr setlocale 3 , .Xr system 3 , .Xr termcap 3 , .Xr termcap 5 .Sh HISTORY The .Nm manual page appeared in .At v7 . diff --git a/usr.bin/man/man.1 b/usr.bin/man/man.1 index 9a611eff3005..0a3c96741ef8 100644 --- a/usr.bin/man/man.1 +++ b/usr.bin/man/man.1 @@ -1,428 +1,428 @@ .\"- .\" Copyright (c) 2010 Gordon Tetlow .\" 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 January 26, 2022 .Dt MAN 1 .Os .Sh NAME .Nm man .Nd display online manual documentation pages .Sh SYNOPSIS .Nm .Op Fl adho .Op Fl t | w .Op Fl M Ar manpath .Op Fl P Ar pager .Op Fl S Ar mansect .Op Fl m Ar arch Ns Op : Ns Ar machine .Op Fl p Op Ar eprtv .Op Ar mansect .Ar page ... .Nm .Fl K .Ar regexp ... .Nm .Fl f .Ar keyword ... .Nm .Fl k .Ar keyword ... .Sh DESCRIPTION The .Nm utility finds and displays online manual documentation pages. If .Ar mansect is provided, .Nm restricts the search to the specific section of the manual. .Pp The sections of the manual are: .Bl -enum -offset indent -compact .It .Fx General Commands Manual .It .Fx System Calls Manual .It .Fx Library Functions Manual .It .Fx Kernel Interfaces Manual .It .Fx File Formats Manual .It .Fx Games Manual .It .Fx Miscellaneous Information Manual .It .Fx System Manager's Manual .It .Fx Kernel Developer's Manual .El .Pp Options that .Nm understands: .Bl -tag -width indent .It Fl K Ar regexp Does a full text search in all manual pages. .Ar regexp is a regular expression as understood by .Dq Li "grep -E" . This option requires .Xr mandoc 1 . This is a slow operation. .It Fl M Ar manpath Forces a specific colon separated manual path instead of the default search path. See .Xr manpath 1 . Overrides the .Ev MANPATH environment variable. .It Fl P Ar pager Use specified pager. Defaults to .Dq Li "less -sR" if color support is enabled, or .Dq Li "less -s" . Overrides the .Ev MANPAGER environment variable, which in turn overrides the .Ev PAGER environment variable. .It Fl S Ar mansect Restricts manual sections searched to the specified colon delimited list. Defaults to .Dq Li 1:8:2:3:3lua:n:4:5:6:7:9:l . Overrides the .Ev MANSECT environment variable. .It Fl a Display all manual pages instead of just the first found for each .Ar page argument. .It Fl d Print extra debugging information. Repeat for increased verbosity. Does not display the manual page. .It Fl f Emulate .Xr whatis 1 . .It Fl h Display short help message and exit. .It Fl k Emulate .Xr apropos 1 . .It Fl m Ar arch Ns Op : Ns Ar machine Override the default architecture and machine settings allowing lookup of other platform specific manual pages. See .Sx IMPLEMENTATION NOTES for how this option changes the default behavior. Overrides the .Ev MACHINE_ARCH and .Ev MACHINE environment variables. .It Fl o Force use of non-localized manual pages. See .Sx IMPLEMENTATION NOTES for how locale specific searches work. Overrides the .Ev LC_ALL , LC_CTYPE , and .Ev LANG environment variables. .It Fl p Op Cm eprtv Use the list of given preprocessors before running -.Xr nroff 1 +.Xr nroff 1 Pq Pa ports/textproc/groff or -.Xr troff 1 . +.Xr troff 1 Pq Pa ports/textproc/groff . Valid preprocessors arguments: .Pp .Bl -tag -width indent -compact .It Cm e -.Xr eqn 1 +.Xr eqn 1 Pq Pa ports/textproc/groff .It Cm p -.Xr pic 1 +.Xr pic 1 Pq Pa ports/textproc/groff .It Cm r -.Xr refer 1 +.Xr refer 1 Pq Pa ports/textproc/groff .It Cm t -.Xr tbl 1 +.Xr tbl 1 Pq Pa ports/textproc/groff .It Cm v .Xr vgrind 1 .El .Pp Overrides the .Ev MANROFFSEQ environment variable. .It Fl t Send manual page source through -.Xr troff 1 +.Xr troff 1 Pq Pa ports/textproc/groff allowing transformation of the manual pages to other formats. .It Fl w Display the location of the manual page instead of the contents of the manual page. .El .Sh IMPLEMENTATION NOTES .Ss Locale Specific Searches The .Nm utility supports manual pages in different locales. The search behavior is dictated by the first of three environment variables with a nonempty string: .Ev LC_ALL , LC_CTYPE , or .Ev LANG . If set, .Nm will search for locale specific manual pages using the following logic: .Pp .Bl -item -offset indent -compact .It .Va lang Ns _ Ns Va country Ns . Ns Va charset .It .Va lang Ns . Ns Va charset .It .Li en Ns . Ns Va charset .El .Pp For example, if .Ev LC_ALL is set to .Dq Li ja_JP.eucJP , .Nm will search the following paths when considering section 1 manual pages in .Pa /usr/share/man : .Pp .Bl -item -offset indent -compact .It .Pa /usr/share/man/ja_JP.eucJP/man1 .It .Pa /usr/share/man/ja.eucJP/man1 .It .Pa /usr/share/man/en.eucJP/man1 .It .Pa /usr/share/man/man1 .El .Ss Platform Specific Searches The .Nm utility supports platform specific manual pages. The search behavior is dictated by the .Fl m option or the .Ev MACHINE_ARCH and .Ev MACHINE environment variables. For example, if .Ev MACHINE_ARCH is set to .Dq Li aarch64 and .Ev MACHINE is set to .Dq Li arm64 , .Nm will search the following paths when considering section 4 manual pages in .Pa /usr/share/man : .Pp .Bl -item -offset indent -compact .It .Pa /usr/share/man/man4/aarch64 .It .Pa /usr/share/man/man4/arm64 .It .Pa /usr/share/man/man4 .El .Ss Displaying Specific Manual Files The .Nm utility also supports displaying a specific manual page if passed a path to the file as long as it contains a .Ql / character. .Sh ENVIRONMENT The following environment variables affect the execution of .Nm : .Bl -tag -width ".Ev MANROFFSEQ" .It Ev LC_ALL , LC_CTYPE , LANG Used to find locale specific manual pages. Valid values can be found by running the .Xr locale 1 command. See .Sx IMPLEMENTATION NOTES for details. Influenced by the .Fl o option. .It Ev MACHINE_ARCH , MACHINE Used to find platform specific manual pages. If unset, the output of .Dq Li "sysctl hw.machine_arch" and .Dq Li "sysctl hw.machine" is used respectively. See .Sx IMPLEMENTATION NOTES for details. Corresponds to the .Fl m option. .It Ev MANPATH The standard search path used by .Xr man 1 may be changed by specifying a path in the .Ev MANPATH environment variable. Invalid paths, or paths without manual databases, are ignored. Overridden by .Fl M . If .Ev MANPATH begins with a colon, it is appended to the default list; if it ends with a colon, it is prepended to the default list; or if it contains two adjacent colons, the standard search path is inserted between the colons. If none of these conditions are met, it overrides the standard search path. .It Ev MANROFFSEQ Used to determine the preprocessors for the manual source before running -.Xr nroff 1 +.Xr nroff 1 Pq Pa ports/textproc/groff or -.Xr troff 1 . +.Xr troff 1 Pq Pa ports/textproc/groff . If unset, defaults to -.Xr tbl 1 . +.Xr tbl 1 Pq Pa ports/textproc/groff . Corresponds to the .Fl p option. .It Ev MANSECT Restricts manual sections searched to the specified colon delimited list. Corresponds to the .Fl S option. .It Ev MANWIDTH If set to a numeric value, used as the width manpages should be displayed. Otherwise, if set to a special value .Dq Li tty , and output is to a terminal, the pages may be displayed over the whole width of the screen. .It Ev MANCOLOR If set, enables color support. .It Ev MANPAGER Program used to display files. .Pp If unset, and color support is enabled, .Dq Li "less -sR" is used. .Pp If unset, and color support is disabled, then .Ev PAGER is used. If that has no value either, .Dq Li "less -s" is used. .El .Sh FILES .Bl -tag -width indent -compact .It Pa /etc/man.conf System configuration file. .It Pa /usr/local/etc/man.d/*.conf Local configuration files. .El .Sh EXIT STATUS .Ex -std .Sh EXAMPLES Show the manual page for .Xr stat 2 : .Bd -literal -offset indent $ man 2 stat .Ed .Pp Show all manual pages for .Ql stat . .Bd -literal -offset indent $ man -a stat .Ed .Pp List manual pages which match the regular expression either in the title or in the body: .Bd -literal -offset indent $ man -k '\e.*archive' .Ed .Pp Show the manual page for .Xr ls 1 and use .Xr cat 1 as pager: .Bd -literal -offset indent $ man -P cat ls .Ed .Pp Show the location of the .Xr ls 1 manual page: .Bd -literal -offset indent $ man -w ls .Ed .Pp Show the location of manual pages in sections 1 and 8 which contain the word .Ql arm : .Bd -literal -offset indent $ ./man -w -K '\e' -S 1:8 .Ed .Sh SEE ALSO .Xr apropos 1 , .Xr egrep 1 , .Xr intro 1 , .Xr mandoc 1 , .Xr manpath 1 , .Xr whatis 1 , .Xr intro 2 , .Xr intro 3 , .Xr intro 3lua , .Xr intro 4 , .Xr intro 5 , .Xr man.conf 5 , .Xr intro 6 , .Xr intro 7 , .Xr mdoc 7 , .Xr intro 8 , .Xr intro 9 diff --git a/usr.bin/soelim/soelim.1 b/usr.bin/soelim/soelim.1 index 1f4e5a833516..fb210534f3f7 100644 --- a/usr.bin/soelim/soelim.1 +++ b/usr.bin/soelim/soelim.1 @@ -1,91 +1,91 @@ .\" Copyright (c) 2014 Baptiste Daroussin .\" 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 November 7, 2015 .Dt SOELIM 1 .Os .Sh NAME .Nm soelim .Nd interpret .so requests in manpages .Sh SYNOPSIS .Nm .Op Fl Crtv .Op Fl I Ar dir .Op Ar .Sh DESCRIPTION The .Nm utility reads the specified files or the standard input and performs the textual inclusion implied by the -.Xr nroff 1 +.Xr nroff 1 Pq Pa ports/textproc/groff directives of the form: .Pp .Dl \&.so anotherfile .Pp If a line starts with: .Dq .so anotherfile it replaces the line by processing .Dq anotherfile . Otherwise the line is printed to stdout. .Bl -tag -width "-I dir" .It Fl C Recognise .Em .so when it is not followed by a space character. .It Fl r Compatibility with groff's .Xr soelim 1 (does nothing). .It Fl t Compatibility with groff's .Xr soelim 1 (does nothing). .It Fl v Compatibility with groff's .Xr soelim 1 (does nothing). .It Fl I Ar dir This option specifies directories where .Nm searches for files (both those on the command line and those named in .Dq .so directive.) This option may be specified multiple times. The directories will be searched in the order specified. .El .Pp The files are always searched first in the current directory. .Pp A file specified with an absolute path will be opened directly without performing a search. .Sh SEE ALSO .Xr mandoc 1 .Sh AUTHORS This version of the .Nm utility was written by .An Baptiste Daroussin Aq Mt bapt@freebsd.org . diff --git a/usr.bin/vgrind/vgrind.1 b/usr.bin/vgrind/vgrind.1 index ed2bb9647f8b..64d6d8accc9b 100644 --- a/usr.bin/vgrind/vgrind.1 +++ b/usr.bin/vgrind/vgrind.1 @@ -1,242 +1,242 @@ .\" 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. .\" 3. 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. .\" .\" @(#)vgrind.1 8.1 (Berkeley) 6/6/93 .\" $FreeBSD$ .\" .Dd August 29, 2006 .Dt VGRIND 1 .Os .Sh NAME .Nm vgrind .Nd grind nice listings of programs .Sh SYNOPSIS .Nm .Op Fl .Op Fl W .Op Fl d Ar file .Op Fl f .Op Fl h Ar header .Op Fl l Ns Ar language .Op Fl n .Op Fl p Ar postproc .Op Fl s Ar pointsize .Op Fl t .Op Fl x .Ar name Ar ... .Sh DESCRIPTION The .Nm utility formats the program sources specified as arguments on the command line in a nice style using -.Xr troff 1 . +.Xr troff 1 Pq Pa ports/textproc/groff . Comments are placed in italics, keywords in bold face, and the name of the current function is listed down the margin of each page as it is encountered. .Pp The .Nm utility runs in two basic modes, filter mode (see the .Fl f option) or regular mode. In filter mode .Nm acts as a filter in a manner similar to .Xr tbl 1 . The standard input is passed directly to the standard output except for lines bracketed by the .Em troff-like macros: .Bl -tag -width Ds .It \&.vS starts processing .It \&.vE ends processing .El .Pp These lines are formatted as described above. The output from this filter can be passed to -.Xr troff 1 +.Xr troff 1 Pq Pa ports/textproc/groff for output. There need be no particular ordering with -.Xr eqn 1 +.Xr eqn 1 Pq Pa ports/textproc/groff or -.Xr tbl 1 . +.Xr tbl 1 Pq Pa ports/textproc/groff . .Pp In regular mode .Nm accepts input files, processes them, and passes them to the postprocessor for output, .Xr psroff 1 by default. .Pp In both modes .Nm passes any lines beginning with a decimal point without conversion. .Pp The options are: .Bl -tag -width Ar .It Fl forces input to be taken from standard input (default if .Fl f is specified) .It Fl W forces output to the (wide) Versatec printer rather than the (narrow) Varian .It Fl d Ar file specifies an alternate language definitions file (default is .Pa /usr/share/misc/vgrindefs ) .It Fl f forces filter mode .It Fl h Ar header specifies a particular header to put on every output page (default is the file name) .It Fl l specifies the language to use. Currently known are .Tn PASCAL .Pq Fl l Ns Ar p , .Tn MODEL .Pq Fl l Ns Ar m , C .Pf ( Fl l Ns Ar c or the default), .Tn C++ .Pq Fl l Ns Ar c++ , .Tn CSH .Pq Fl l Ns Ar csh , .Tn SHELL .Pq Fl l Ns Ar sh , .Tn RATFOR .Pq Fl l Ns Ar r , .Tn MODULA2 .Pq Fl l Ns Ar mod2 , .Tn YACC .Pq Fl l Ns Ar yacc , .Tn LISP .Pq Fl l Ns Ar isp , .Tn ICON .Pq Fl l Ns Ar I , and .Tn PERL .Pq Fl l Ns Ar perl . .It Fl n forces no keyword bolding .It Fl p Ar postproc use .Ar postproc to post-process the output, .Xr psroff 1 by default. .It Fl s Ar pointsize specifies a point size to use on output (exactly the same as the argument of a .ps) .It Fl t similar to the same option in -.Xr troff 1 +.Xr troff 1 Pq Pa ports/textproc/groff causing formatted text to go to the standard output .It Fl x outputs the index file in a ``pretty'' format. The index file itself is produced whenever .Nm is run with a file called .Pa index in the current directory. The index of function definitions can then be run off by giving .Nm the .Fl x option and the file .Pa index as argument. .El .Sh FILES .Bl -tag -width /usr/share/misc/vgrindefsxx -compact .It Pa index file where source for index is created .It Pa /usr/share/tmac/tmac.vgrind macro package .It Pa /usr/libexec/vfontedpr preprocessor .It Pa /usr/share/misc/vgrindefs language descriptions .El .Sh SEE ALSO .Xr getcap 3 , .Xr vgrindefs 5 .Sh HISTORY The .Nm command appeared in .Bx 3.0 . .Sh BUGS The vfontedpr preprocessor assumes that a certain programming style is followed: .Pp For .Tn C \- function names can be preceded on a line only by spaces, tabs, or an asterisk. The parenthesized arguments must also be on the same line. .Pp For .Tn PASCAL \- function names need to appear on the same line as the keywords .Em function or .Em procedure . .Pp For .Tn MODEL \- function names need to appear on the same line as the keywords .Em is beginproc . .Pp If these conventions are not followed, the indexing and marginal function name comment mechanisms will fail. .Pp More generally, arbitrary formatting styles for programs mostly look bad. The use of spaces to align source code fails miserably; if you plan to .Nm your program you should use tabs. This is somewhat inevitable since the font used by .Nm is variable width. .Pp The mechanism of .Xr ctags 1 in recognizing functions should be used here. .Pp Filter mode does not work in documents using the .Fl me or .Fl ms macros. (So what use is it anyway?) diff --git a/usr.bin/vgrind/vgrindefs.5 b/usr.bin/vgrind/vgrindefs.5 index 280ffd7534e2..7489411a634c 100644 --- a/usr.bin/vgrind/vgrindefs.5 +++ b/usr.bin/vgrind/vgrindefs.5 @@ -1,170 +1,170 @@ .\" Copyright (c) 1989, 1991, 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. .\" 3. 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. .\" .\" @(#)vgrindefs.5 8.1 (Berkeley) 6/6/93 .\" $FreeBSD$ .\" .Dd June 6, 1993 .Dt VGRINDEFS 5 .Os .Sh NAME .Nm vgrindefs .Nd language definition data base for .Xr vgrind 1 .Sh SYNOPSIS .Nm .Sh DESCRIPTION The .Nm file contains all language definitions for .Xr vgrind 1 . The data base is very similar to .Xr termcap 5 . .Sh FIELDS The following table names and describes each field. .Bl -column Namexxx Tpexxx .It Sy "Name Type Description" .It "ab str regular expression for the start of an alternate comment" .It "ae str regular expression for the end of an alternate comment" .It "pb str regular expression for start of a procedure" .It "bb str regular expression for start of a lexical block" .It "be str regular expression for the end of a lexical block" .It "cb str regular expression for the start of a comment" .It "ce str regular expression for the end of a comment" .It "sb str regular expression for the start of a string" .It "se str regular expression for the end of a string" .It "lb str regular expression for the start of a character constant" .It "le str regular expression for the end of a character constant" .It "nc str regular expression for a non-comment (see below)" .It "tl bool present means procedures are only defined at the top lexical level" .It "oc bool present means upper and lower case are equivalent" .It "kw str a list of keywords separated by spaces" .El .Pp Non-comments are required to describe a certain context where a sequence that would normally start a comment loses its special meaning. A typical example for this can be found in Perl, where comments are normally starting with .Ql # , while the string .Ql $# is an operator on an array. .Sh REGULAR EXPRESSIONS .Nm Vgrindefs uses regular expression which are very similar to those of .Xr ex 1 and .Xr lex 1 . The characters `^', `$', `:' and `\e' are reserved characters and must be "quoted" with a preceding .Ql \e if they are to be included as normal characters. The metasymbols and their meanings are: .Bl -tag -width indent .It $ the end of a line .It \&^ the beginning of a line .It \ed a delimiter (space, tab, newline, start of line) .It \ea matches any string of symbols (like .* in lex) .It \ep matches any alphanumeric name. In a procedure definition (pb) the string that matches this symbol is used as the procedure name. .It () grouping .It \&| alternation .It ? last item is optional .It \ee preceding any string means that the string will not match an input string if the input string is preceded by an escape character (\e). This is typically used for languages (like C) which can include the string delimiter in a string by escaping it. .El .Pp Unlike other regular expressions in the system, these match words and not characters. Hence something like "(tramp|steamer)flies?" would match "tramp", "steamer", "trampflies", or "steamerflies". .Sh KEYWORD LIST The keyword list is just a list of keywords in the language separated by spaces. If the "oc" boolean is specified, indicating that upper and lower case are equivalent, then all the keywords should be specified in lower case. .Sh FILES .Bl -tag -width /usr/share/misc/vgrindefs -compact .It Pa /usr/share/misc/vgrindefs File containing terminal descriptions. .El .Sh EXAMPLES The following entry, which describes the C language, is typical of a language entry. .Bd -literal C|c:\ :pb=^\ed?*?\ed?\ep\ed?\e(\ea?\e):bb={:be=}:cb=/*:ce=*/:sb=":se=\ee":\e :lb=':le=\ee':tl:\e :kw=asm auto break case char continue default do double else enum\e extern float for fortran goto if int long register return short\e sizeof static struct switch typedef union unsigned while #define\e #else #endif #if #ifdef #ifndef #include #undef # define else endif\e if ifdef ifndef include undef: .Ed .Pp Note that the first field is just the language name (and any variants of it). Thus the C language could be specified to .Xr vgrind 1 as "c" or "C". .Pp Entries may continue onto multiple lines by giving a \e as the last character of a line. Capabilities in .Nm are of two types: Boolean capabilities which indicate that the language has some particular feature and string capabilities which give a regular expression or keyword list. .Sh SEE ALSO -.Xr troff 1 , +.Xr troff 1 Pq Pa ports/textproc/groff , .Xr vgrind 1 .Sh HISTORY The .Nm file format appeared in .Bx 4.2 . diff --git a/usr.sbin/lpr/lpd/lpd.8 b/usr.sbin/lpr/lpd/lpd.8 index 23c839086571..7e79ab0a0c19 100644 --- a/usr.sbin/lpr/lpd/lpd.8 +++ b/usr.sbin/lpr/lpd/lpd.8 @@ -1,354 +1,354 @@ .\" Copyright (c) 1983, 1991, 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. .\" 3. 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. .\" .\" @(#)lpd.8 8.3 (Berkeley) 4/19/94 .\" $FreeBSD$ .\" .Dd April 15, 2021 .Dt LPD 8 .Os .Sh NAME .Nm lpd .Nd line printer spooler daemon .Sh SYNOPSIS .Nm .Op Fl cdlpsFW46 .Op Ar port# .Sh DESCRIPTION The .Nm utility is the line printer daemon (spool area handler) and is normally invoked at boot time from the .Xr rc 8 file. It makes a single pass through the .Xr printcap 5 file to find out about the existing printers and prints any files left after a crash. It then uses the system calls .Xr listen 2 and .Xr accept 2 to receive requests to print files in the queue, transfer files to the spooling area, display the queue, or remove jobs from the queue. In each case, it forks a child to handle the request so the parent can continue to listen for more requests. .Pp Available options: .Bl -tag -width Ds .It Fl c By default, if some remote host has a connection error while trying to send a print request to .Nm on a local host, .Nm will only send error message to that remote host. The .Fl c flag causes .Nm to also log all of those connection errors via .Xr syslog 3 . .It Fl d Turn on .Dv SO_DEBUG on the Internet listening socket (see .Xr setsockopt 2 ) . .It Fl l The .Fl l flag causes .Nm to log valid requests received from the network. This can be useful for debugging purposes. .It Fl p The .Fl p flag is a synonym for the .Fl s flag. It is being deprecated, and may be removed in a future version of .Nm . .It Fl s The .Fl s (secure) flag causes .Nm not to open an Internet listening socket. This means that .Nm will not accept any connections from any remote hosts, although it will still accept print requests from all local users. .It Fl F By default, .Nm will daemonize into the background. The .Fl F flag causes .Nm to remain in the foreground. Logging is still performed with .Xr syslog 3 . .It Fl W By default, the .Nm daemon will only accept connections which originate from a reserved-port (<1024) on the remote host. The .Fl W flag causes .Nm to accept connections coming from any port. This is can be useful when you want to accept print jobs from certain implementations of lpr written for Windows. .It Fl 4 Inet only. .It Fl 6 Inet6 only. .It Fl 46 Inet and inet6 (default). .It Ar "port#" The Internet port number used to rendezvous with other processes is normally obtained with .Xr getservbyname 3 but can be changed with the .Ar port# argument. .El .Pp Access control is provided by two means. First, all requests must come from one of the machines listed in the file .Pa /etc/hosts.equiv or .Pa /etc/hosts.lpd . Second, if the .Li rs capability is specified in the .Xr printcap 5 entry for the printer being accessed, .Em lpr requests will only be honored for those users with accounts on the machine with the printer. .Pp The file .Em minfree in each spool directory contains the number of kilobytes to leave free so that the line printer queue will not completely fill the disk. The .Em minfree file can be edited with your favorite text editor. .Pp The daemon begins processing files after it has successfully set the lock for exclusive access (described a bit later), and scans the spool directory for files beginning with .Em cf . Lines in each .Em cf file specify files to be printed or non-printing actions to be performed. Each such line begins with a key character to specify what to do with the remainder of the line. .Bl -tag -width Ds .It J Job Name. String to be used for the job name on the burst page. .It C Classification. String to be used for the classification line on the burst page. .It L Literal. The line contains identification info from the password file and causes the banner page to be printed. .It T Title. String to be used as the title for .Xr pr 1 . .It H Host Name. Name of the machine where .Xr lpr 1 was invoked. .It P Person. Login name of the person who invoked .Xr lpr 1 . This is used to verify ownership by .Xr lprm 1 . .It M Send mail to the specified user when the current print job completes. .It f Formatted File. Name of a file to print which is already formatted. .It l Like ``f'' but passes control characters and does not make page breaks. .It p Name of a file to print using .Xr pr 1 as a filter. .It t Troff File. The file contains -.Xr troff 1 +.Xr troff 1 Pq Pa ports/textproc/groff output (cat phototypesetter commands). .It n Ditroff File. The file contains device independent troff output. .It r DVI File. The file contains .Tn Tex l output DVI format from Stanford. .It g Graph File. The file contains data produced by .Xr plot 3 . .It c Cifplot File. The file contains data produced by .Em cifplot . .It v The file contains a raster image. .It r The file contains text data with FORTRAN carriage control characters. .It \&1 Troff Font R. Name of the font file to use instead of the default. .It \&2 Troff Font I. Name of the font file to use instead of the default. .It \&3 Troff Font B. Name of the font file to use instead of the default. .It \&4 Troff Font S. Name of the font file to use instead of the default. .It W Width. Changes the page width (in characters) used by .Xr pr 1 and the text filters. .It I Indent. The number of characters to indent the output by (in ASCII). .It U Unlink. Name of file to remove upon completion of printing. .It N File name. The name of the file which is being printed, or a blank for the standard input (when .Xr lpr 1 is invoked in a pipeline). .It Z Locale. String to be used as the locale for .Xr pr 1 . .El .Pp If a file cannot be opened, a message will be logged via .Xr syslog 3 using the .Em LOG_LPR facility. The .Nm utility will try up to 20 times to reopen a file it expects to be there, after which it will skip the file to be printed. .Pp The .Nm utility uses .Xr flock 2 to provide exclusive access to the lock file and to prevent multiple daemons from becoming active simultaneously. If the daemon should be killed or die unexpectedly, the lock file need not be removed. The lock file is kept in a readable .Tn ASCII form and contains two lines. The first is the process id of the daemon and the second is the control file name of the current job being printed. The second line is updated to reflect the current status of .Nm for the programs .Xr lpq 1 and .Xr lprm 1 . .Sh FILES .Bl -tag -width "/var/spool/*/minfree" -compact .It Pa /etc/printcap printer description file .It Pa /var/spool/* spool directories .It Pa /var/spool/*/minfree minimum free space to leave .It Pa /dev/lp* line printer devices .It Pa /var/run/printer socket for local requests .It Pa /etc/hosts.equiv lists machine names allowed printer access .It Pa /etc/hosts.lpd lists machine names allowed printer access, but not under same administrative control. .El .Sh SEE ALSO .Xr lpq 1 , .Xr lpr 1 , .Xr lprm 1 , .Xr setsockopt 2 , .Xr syslog 3 , .Xr hosts.lpd 5 , .Xr printcap 5 , .Xr chkprintcap 8 , .Xr lpc 8 , .Xr pac 8 .Rs .\" 4.4BSD SMM:7 .%A Ralph Campbell .%T "4.2 BSD Line Printer Spooler Manual" .Re .Sh HISTORY An .Nm daemon appeared in Version 6 AT&T UNIX. diff --git a/usr.sbin/lpr/lpr/lpr.1 b/usr.sbin/lpr/lpr/lpr.1 index b63d480d6e0b..a1a71cf2bb5f 100644 --- a/usr.sbin/lpr/lpr/lpr.1 +++ b/usr.sbin/lpr/lpr/lpr.1 @@ -1,321 +1,321 @@ .\" 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. .\" 3. 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 @(#)lpr.1 8.1 (Berkeley) 6/6/93 .\" $FreeBSD$ .\" " .Dd June 6, 1993 .Dt LPR 1 .Os .Sh NAME .Nm lpr .Nd off line print .Sh SYNOPSIS .Nm .Op Fl P Ns Ar printer .Op Fl \&# Ns Ar num .Op Fl C Ar class .Op Fl J Ar job .Op Fl L Ar locale .Op Fl T Ar title .Op Fl U Ar user .Op Fl Z Ar daemon-options .Op Fl i Ar numcols .Op Fl 1234 Ar font .Op Fl w Ar num .Op Fl cdfghlnmprstv .Op Ar name ... .Sh DESCRIPTION The .Nm utility uses a spooling daemon to print the named files when facilities become available. If no names appear, the standard input is assumed. .Pp The following single letter options are used to notify the line printer spooler that the files are not standard text files. The spooling daemon will use the appropriate filters to print the data accordingly. Note that not all spoolers implement filters for all data types, and some sites may use these types for other purposes than the ones described here. .Bl -tag -width indent .It Fl d The files are assumed to contain data in .Tn DVI format from the .Tn TeX typesetting system. .It Fl f Use a filter which interprets the first character of each line as a standard .Tn FORTRAN carriage control character. .It Fl l Use a filter which allows control characters to be printed and suppresses page breaks. .It Fl p Use .Xr pr 1 to format the files. .El .Pp The following options are historical and not directly supported by any software included in .Fx . .Bl -tag -width indent .It Fl c The files are assumed to contain data produced by .Xr cifplot 1 . .It Fl g The files are assumed to contain standard plot data as produced by the .Ux .Xr plot 3 routines. .It Fl n The files are assumed to contain data from .Em ditroff (device independent troff). .It Fl t The files are assumed to contain .Tn C/A/T phototypesetter commands from ancient versions of .Ux -.Xr troff 1 . +.Xr troff 1 Pq Pa ports/textproc/groff . .It Fl v The files are assumed to contain a raster image for devices like the Benson Varian. .El .Pp These options apply to the handling of the print job: .Bl -tag -width indent .It Fl P Force output to a specific printer. Normally, the default printer is used (site dependent), or the value of the environment variable .Ev PRINTER is used. .It Fl h Suppress the printing of the burst page. .It Fl m Send mail upon completion. .It Fl r Remove the file upon completion of spooling or upon completion of printing (with the .Fl s option). .It Fl s Use symbolic links. Usually files are copied to the spool directory. The .Fl s option will use .Xr symlink 2 to link data files rather than trying to copy them so large files can be printed. This means the files should not be modified or removed until they have been printed. .El .Pp The remaining options apply to copies, the page display, and headers: .Bl -tag -width indent .It Fl \&# Ns Ar num The quantity .Ar num is the number of copies desired of each file named. For example, .Bd -literal -offset indent lpr \-#3 foo.c bar.c more.c .Ed would result in 3 copies of the file foo.c, followed by 3 copies of the file bar.c, etc. On the other hand, .Bd -literal -offset indent cat foo.c bar.c more.c \&| lpr \-#3 .Ed .Pp will give three copies of the concatenation of the files. Often a site will disable this feature to encourage use of a photocopier instead. .It Xo .Fl Ns Op Cm 1234 .Ar font .Xc Specifies a .Ar font to be mounted on font position .Ar i . The daemon will construct a .Li .railmag file referencing the font pathname. .It Fl C Ar class Job classification to use on the burst page. For example, .Bd -literal -offset indent lpr \-C EECS foo.c .Ed .Pp causes the system name (the name returned by .Xr hostname 1 ) to be replaced on the burst page by .Tn EECS , and the file foo.c to be printed. .It Fl J Ar job Job name to print on the burst page. Normally, the first file's name is used. .It Fl L Ar locale Use .Ar locale specified as argument instead of one found in environment. (Only effective when filtering through .Xr pr 1 is requested using the .Fl p option.) .It Fl T Ar title Title name for .Xr pr 1 , instead of the file name. .It Fl U Ar user User name to print on the burst page, also for accounting purposes. This option is only honored if the real user-id is daemon (or that specified in the printcap file instead of daemon), and is intended for those instances where print filters wish to requeue jobs. .It Fl Z Ar daemon-options Some spoolers, such as .Tn LPRng , accept additional per-job options using a .Ql Z control line. When .Fl Z is specified, and .Fl p .Pq Xr pr 1 is not requested, the specified .Ar daemon-options will be passed to the remote .Tn LPRng spooler. .It Fl i Ar numcols The output is indented by .Pq Ar numcols . .It Fl w Ar num Uses .Ar num as the page width for .Xr pr 1 . .El .Sh ENVIRONMENT If the following environment variable exists, it is used by .Nm : .Bl -tag -width PRINTER .It Ev PRINTER Specifies an alternate default printer. .El .Sh FILES .Bl -tag -width /var/spool/output/*/tf* -compact .It Pa /etc/passwd Personal identification. .It Pa /etc/printcap Printer capabilities data base. .It Pa /usr/sbin/lpd Line printer daemons. .It Pa /var/spool/output/* Directories used for spooling. .It Pa /var/spool/output/*/cf* Daemon control files. .It Pa /var/spool/output/*/df* Data files specified in "cf" files. .It Pa /var/spool/output/*/tf* Temporary copies of "cf" files. .El .Sh DIAGNOSTICS If you try to spool too large a file, it will be truncated. The .Nm utility will object to printing binary files. If a user other than root prints a file and spooling is disabled, .Nm will print a message saying so and will not put jobs in the queue. If a connection to .Xr lpd 8 on the local machine cannot be made, .Nm will say that the daemon cannot be started. Diagnostics may be printed in the daemon's log file regarding missing spool files by .Xr lpd 8 . .Sh SEE ALSO .Xr lpq 1 , .Xr lprm 1 , .Xr pr 1 , .Xr symlink 2 , .Xr printcap 5 , .Xr lpc 8 , .Xr lpd 8 .Sh HISTORY The .Nm command appeared in .Bx 3 . .Sh BUGS Fonts for -.Xr troff 1 +.Xr troff 1 Pq Pa ports/textproc/groff and .Tn TeX reside on the host with the printer. It is currently not possible to use local font libraries. .Pp The .Ql Z control file line is used for two different purposes; for standard .Fx .Xr lpd 8 , it specifies a locale to be passed to .Xr pr 1 . For .Tn LPRng .Xr lpd 8 , it specifies additional options to be interpreted by the spooler's input and output filters. When submitting jobs via .Nm , .Fl p .Fl L Ar locale is used in the former context, and .Fl Z Ar daemon-options is used in the latter.