From: Akihiro MOTOKI Date: Fri, 15 Jun 2012 17:26:34 +0000 (+0900) Subject: cups: Add non-posted source lang files. X-Git-Tag: util-linux-2.12r~409 X-Git-Url: http://git.osdn.net/view?a=commitdiff_plain;h=efa29e3667b56f48dc27c8d2ca94b8f93b083094;p=linuxjm%2Fjm.git cups: Add non-posted source lang files. --- diff --git a/manual/cups/original/man1/cups-config.1 b/manual/cups/original/man1/cups-config.1 new file mode 100644 index 00000000..577dd44f --- /dev/null +++ b/manual/cups/original/man1/cups-config.1 @@ -0,0 +1,117 @@ +.\" +.\" "$Id: cups-config.man 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" cups-config man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2006 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH cups-config 1 "CUPS" "23 October 2008" "Apple Inc." +.SH NAME +cups-config \- get cups api, compiler, directory, and link information. +.SH SYNOPSIS +.B cups-config +--api-version +.br +.B cups-config +--build +.br +.B cups-config +--cflags +.br +.B cups-config +--datadir +.br +.B cups-config +--help +.br +.B cups-config +--ldflags +.br +.B cups-config +[ +.I --image +] [ +.I --static +] --libs +.br +.B cups-config +--serverbin +.br +.B cups-config +--serverroot +.br +.B cups-config +--version +.br +.SH DESCRIPTION +\fBcups-config\fR is the CUPS program configuration utility. It should be +used by application developers to determine the necessary command-line +options for the compiler and linker, as well as determining installation +directories for filters, configuration files, and drivers. +.SH OPTIONS +.TP 5 +--api-version +.br +Displays the current API version (major.minor). +.TP 5 +--build +.br +Displays a system-specific build number. +.TP 5 +--cflags +.br +Displays the necessary compiler options. +.TP 5 +--datadir +.br +Displays the default CUPS data directory. +.TP 5 +--help +.br +Displays the program usage message. +.TP 5 +--image +.br +When used with \fI--libs\fR, adds the CUPS imaging library to the +list of displayed libraries. +.TP 5 +--ldflags +.br +Displays the necessary linker options. +.TP 5 +--libs +.br +Displays the necessary librarys to link to. +.TP 5 +--serverbin +.br +Displays the default CUPS binary directory, +where filters and backends are stored. +.TP 5 +--serverroot +.br +Displays the default CUPS configuration file directory. +.TP 5 +--static +.br +When used with \fI--libs\fR, shows the static libraries instead +of the default (shared) libraries. +.TP 5 +--version +.br +Displays the full version number of the CUPS installation +(major.minor.patch). +.SH SEE ALSO +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: cups-config.man 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man1/cupstestdsc.1 b/manual/cups/original/man1/cupstestdsc.1 new file mode 100644 index 00000000..781c5efe --- /dev/null +++ b/manual/cups/original/man1/cupstestdsc.1 @@ -0,0 +1,50 @@ +.\" +.\" "$Id: cupstestdsc.man 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" cupstestdsc man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 2006 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH cupstestdsc 1 "CUPS" "20 March 2006" "Apple Inc." +.SH NAME +cupstestdsc \- test conformance of postscript files +.SH SYNOPSIS +.B cupstestdsc +[ -h ] filename.ps [ ... +.I filenameN.ps +] +.br +.B cupstestdsc +[ -h ] - +.SH DESCRIPTION +\fIcupstestdsc\fR tests the conformance of PostScript files to +the Adobe PostScript Language Document Structuring Conventions +Specification version 3.0. The results of testing and any other +output are sent to the standard output. The second form of the +command reads PostScript from the standard input. +.SH LIMITATIONS +\fIcupstestdsc\fR only validates the DSC comments in a PostScript +file and does not attempt to validate the PostScript code itself. +Developers must ensure that the PostScript they generate follows +the rules defined by Adobe. Specifically, all pages must be +independent of each other, code outside page descriptions may not +affect the graphics state (current font, color, transform matrix, +etc.), and device-specific commands such as setpagedevice should +not be used. +.SH SEE ALSO +http://localhost:631/help +.br +Adobe PostScript Language Document Structuring Conventions +Specification, Version 3.0. +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: cupstestdsc.man 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man1/cupstestppd.1 b/manual/cups/original/man1/cupstestppd.1 new file mode 100644 index 00000000..042f4c29 --- /dev/null +++ b/manual/cups/original/man1/cupstestppd.1 @@ -0,0 +1,165 @@ +.\" +.\" "$Id: cupstestppd.man 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" cupstestppd man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2006 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH cupstestppd 1 "CUPS" "19 November 2009" "Apple Inc." +.SH NAME +cupstestppd \- test conformance of ppd files +.SH SYNOPSIS +.B cupstestppd +[ -I +.I category +] [ -R +.I rootdir +] [ -W +.I category +] [ -q ] [-r] [ -v[v] ] filename.ppd[.gz] [ ... filenameN.ppd[.gz] ] +.br +.B cupstestppd +[ -R +.I rootdir +] [ -W +.I category +] [ -q ] [-r] [ -v[v] ] - +.SH DESCRIPTION +\fIcupstestppd\fR tests the conformance of PPD files to the +Adobe PostScript Printer Description file format specification +version 4.3. It can also be used to list the supported options +and available fonts in a PPD file. The results of testing and +any other output are sent to the standard output. +.LP +The first form of \fIcupstestppd\fR tests one or more PPD files +on the command-line. The second form tests the PPD file provided +on the standard input. +.SH OPTIONS +\fIcupstestppd\fR supports the following options: +.TP 5 +-I filename +.br +Ignores all PCFileName warnings. +.TP 5 +-I filters +.br +Ignores all filter errors. +.TP 5 +-I profiles +.br +Ignores all profile errors. +.TP 5 +-R rootdir +.br +Specifies an alternate root directory for the filter, pre-filter, +and other support file checks. +.TP 5 +-W constraints +.br +Report all UIConstraint errors as warnings. +.TP 5 +-W defaults +.br +Except for size-related options, report all default option errors as warnings. +.TP 5 +-W filters +.br +Report all filter errors as warnings. +.TP 5 +-W profiles +.br +Report all profile errors as warnings. +.TP 5 +-W sizes +.br +Report all media size errors as warnings. +.TP 5 +-W translations +.br +Report all translation errors as warnings. +.TP 5 +-W all +.br +Report all of the previous errors as warnings. +.TP 5 +-W none +.br +Report all of the previous errors as errors. +.TP 5 +-q +.br +Specifies that no information should be displayed. +.TP 5 +-r +.br +Relaxes the PPD conformance requirements so that common +whitespace, control character, and formatting problems are not +treated as hard errors. +.TP 5 +-v +.br +Specifies that detailed conformance testing results should be +displayed rather than the concise PASS/FAIL/ERROR status. +.TP 5 +-vv +.br +Specifies that all information in the PPD file should be +displayed in addition to the detailed conformance testing +results. +.LP +The \fI-q\fR, \fI-v\fR, and \fI-vv\fR options are mutually exclusive. +.SH EXIT STATUS +\fIcupstestppd\fR returns zero on success and non-zero on error. The +error codes are as follows: +.TP 5 +1 +.br +Bad command-line arguments or missing PPD filename. +.TP 5 +2 +.br +Unable to open or read PPD file. +.TP 5 +3 +.br +The PPD file contains format errors that cannot be skipped. +.TP 5 +4 +.br +The PPD file does not conform to the Adobe PPD specification. +.SH EXAMPLES +The following command will test all PPD files under the current +directory and print the names of each file that does not +conform: +.nf + + find . -name \\*.ppd \\! -exec cupstestppd -q '{}' \\; -print + +.fi +The next command tests all PPD files under the current directory +and print detailed conformance testing results for the files +that do not conform: +.nf + + find . -name \\*.ppd \\! -exec cupstestppd -q '{}' \\; \\ + -exec cupstestppd -v '{}' \\; + +.fi +.SH SEE ALSO +\fIlpadmin(8)\fR, +.br +http://localhost:631/help +.br +Adobe PostScript Printer Description File Format Specification, Version 4.3. +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: cupstestppd.man 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man1/ipptool.1 b/manual/cups/original/man1/ipptool.1 new file mode 100644 index 00000000..6cf84509 --- /dev/null +++ b/manual/cups/original/man1/ipptool.1 @@ -0,0 +1,130 @@ +.\" +.\" "$Id: ipptool.man 9354 2010-11-10 06:48:19Z mike $" +.\" +.\" ipptool man page for CUPS. +.\" +.\" Copyright 2010 by Apple Inc. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH ipptool 1 "CUPS" "9 November 2010" "Apple Inc." +.SH NAME +ipptool - perform internet printing protocol requests +.SH SYNOPSIS +.B ipptool +[ -4 ] [ -6 ] [ -C ] [ -E ] [ -I ] [ -L ] [ -S ] [ -T +.I seconds +] [ -V +.I version +] [ -X ] [ -c ] [ -d +.I name=value +] [ -f +.I filename +] [ -i +.I seconds +] [ -n +.I repeat-count +] [ -q ] [ -t ] [ -v ] +.I URI +.I filename +[ +.I ... filenameN +] +.SH DESCRIPTION +\fIipptool\fR sends IPP requests to the specified URI and tests and/or displays the results. Each named file defines one or more requests, including the expected response status, attributes, and values. Output is either a plain text, formatted text, CSV, or XML report on the standard output, with a non-zero exit status indicating that one or more tests have failed. The file format is described in \fIipptoolfile(5)\fR. +.SH OPTIONS +The following options are recognized by \fIipptool\fR: +.TP 5 +-4 +Specifies that \fIipptool\fR must connect to the printer or server using IPv4. +.TP 5 +-6 +Specifies that \fIipptool\fR must connect to the printer or server using IPv6. +.TP 5 +-C +Specifies that requests should be sent using the HTTP/1.1 "Transfer-Encoding: chunked" header, which is required for conformance by all versions of IPP. The default is to use "Transfer-Encoding: chunked" for requests with attached files and "Content-Length:" for requests without attached files. +.TP 5 +-E +Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header. +.TP 5 +-I +Specifies that \fIipptool\fR will continue past errors. +.TP 5 +-L +Specifies that requests should be sent using the HTTP/1.0 "Content-Length:" header, which is required for conformance by all versions of IPP. The default is to use "Transfer-Encoding: chunked" for requests with attached files and "Content-Length:" for requests without attached files. +.TP 5 +-S +Forces (dedicated) SSL encryption when connecting to the server. +.TP 5 +-T seconds +Specifies a timeout for IPP requests in seconds. +.TP 5 +-V version +Specifies the default IPP version to use: 1.0, 1.1, 2.0, 2.1, or 2.2. If not specified, version 1.1 is used. +.TP 5 +-X +Specifies that XML (Apple plist) output is desired instead of the plain text report. This option is incompatible with the \fI-i\fR (interval) and \fI-n\fR (repeat-count) options. +.TP 5 +-c +Specifies that CSV (comma-separated values) output is desired instead of the plain text output. +.TP 5 +-d name=value +Defines the named variable. +.TP 5 +-f filename +Defines the default request filename for tests. +.TP 5 +-i seconds +Specifies that the (last) file should be repeated at the specified interval. This option is incompatible with the \fI-X\fR (XML plist output) option. +.TP 5 +-l +Specifies that plain text output is desired. +.TP 5 +-n repeat-count +Specifies that the (last) file should be repeated the specified number of times. This option is incompatible with the \fI-X\fR (XML plist output) option. +.TP 5 +-t +Specifies that CUPS test report output is desired instead of the plain text output. +.TP 5 +-v +Specifies that all request and response attributes should be output in CUPS test mode (\fI-t\fR). This is the default for XML output. +.SH COMPATIBILITY +The \fIipptool\fR program is unique to CUPS. +.SH EXAMPLES +Get a list of completed jobs for "myprinter": +.nf + ipptool ipp://localhost/printers/myprinter get-completed-jobs.test +.fi +.LP +Send email notifications to "user@example.com" when "myprinter" changes: +.nf + ipptool -d recipient=mailto:user@example.com \ + ipp://localhost/printers/myprinter create-printer-subscription.test +.fi +.SH STANDARD FILES +The following standard files are available: +.nf + create-printer-subscription.test + get-completed-jobs.test + get-jobs.test + ipp-1.1.test + ipp-2.0.test + ipp-2.1.test + testfile.jpg + testfile.pdf + testfile.ps + testfile.txt +.fi +.SH SEE ALSO +\fIipptoolfile(5)\fR, +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2010 by Apple Inc. +.\" +.\" End of "$Id: ipptool.man 9354 2010-11-10 06:48:19Z mike $". +.\" diff --git a/manual/cups/original/man1/lpoptions.1 b/manual/cups/original/man1/lpoptions.1 new file mode 100644 index 00000000..1bf56d62 --- /dev/null +++ b/manual/cups/original/man1/lpoptions.1 @@ -0,0 +1,135 @@ +.\" +.\" "$Id: lpoptions.man.in 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" lpoptions man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2006 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH lpoptions 1 "CUPS" "29 August 2008" "Apple Inc." +.SH NAME +lpoptions \- display or set printer options and defaults +.SH SYNOPSIS +.B lpoptions +[ -E ] [ -U +.I username +] [ -h +.I server[:port] +] -d +.I destination[/instance] +[ -o +.I option[=value] +] ... [ -o +.I option[=value] +] +.br +.B lpoptions +[ -E ] [ -U +.I username +] [ -h +.I server[:port] +] [ -p +.I destination[/instance] +] -l +.br +.B lpoptions +[ -E ] [ -U +.I username +] [ -h +.I server[:port] +] [ -o +.I option[=value] +] ... [ -o +.I option[=value] +] [ -p +.I destination[/instance] +] -r +.I option +.br +.B lpoptions +[ -E ] [ -U +.I username +] [ -h +.I server[:port] +] -x +.I destination[/instance] +.SH DESCRIPTION +\fIlpoptions\fR displays or sets printer options and defaults. +\fIlpoptions\fR shows the default printer options when run with no +arguments. Other options include: +.TP 5 +-E +.br +Enables encryption when communicating with the CUPS server. +.TP 5 +-U username +.br +Uses an alternate username. +.TP 5 +-d destination[/instance] +.br +Sets the user default printer to \fIdestination\fR. If \fIinstance\fR +is supplied then that particular instance is used. This option +overrides the system default printer for the current user. +.TP 5 +-h server[:port] +.br +Uses an alternate server. +.TP 5 +-l +.br +Lists the printer specific options and their current settings. +.TP 5 +-o option[=value] +.br +Specifies a new option for the named destination. +.TP 5 +-p destination[/instance] +.br +Sets the destination and instance, if specified, for any options +that follow. If the named instance does not exist then it is +created. +.TP 5 +-r option +.br +Removes the specified option for the named destination. +.TP 5 +-x destination[/instance] +.br +Removes the options for the named destination and instance, if +specified. If the named instance does not exist then this does +nothing. +.LP +If no options are specified using the \fI-o\fR option, then the +current options for the named printer are reported on the +standard output. +.LP +Options set with the \fIlpoptions\fR command are used by the +\fIlp(1)\fR and \fIlpr(1)\fR commands when submitting jobs. +.SH ROOT ACCOUNT OPTIONS +When run by the root user, \fIlpoptions\fR gets and sets default +options and instances for \fIall users\fR in the +/etc/cups/lpoptions file. +.SH COMPATIBILITY +The \fIlpoptions\fR command is unique to CUPS. +.SH FILES +~/.cups/lpoptions - user defaults and instances created by non-root +users. +.br +/etc/cups/lpoptions - system-wide defaults and instances +created by the root user. +.SH SEE ALSO +\fIcancel(1)\fR, \fIlp(1)\fR, \fIlpadmin(8)\fR, \fIlpr(1)\fR, +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: lpoptions.man.in 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man1/lppasswd.1 b/manual/cups/original/man1/lppasswd.1 new file mode 100644 index 00000000..87ade67b --- /dev/null +++ b/manual/cups/original/man1/lppasswd.1 @@ -0,0 +1,68 @@ +.\" +.\" "$Id: lppasswd.man 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" lpadmin man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2006 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH lppasswd 1 "CUPS" "22 February 2008" "Apple Inc." +.SH NAME +lppasswd \- add, change, or delete digest passwords. +.SH SYNOPSIS +.B lppasswd +[ +.I username +] +.br +.B lppasswd +-a [ -g +.I groupname +] +.I username +.br +.B lppasswd +-x +.I username +.SH DESCRIPTION +\fIlppasswd\fR adds, changes, or deletes passwords in the CUPS +digest password file, \fIpasswd.md5\fR. When run by a normal +user, \fIlppasswd\fR will prompt for the old and new passwords. +When run by the super-user, \fIlppasswd\fR can add new accounts +(\fI-a username\fR), change existing accounts (\fIusername\fR), +or delete accounts (\fI-x username\fR) in the digest password +file. Digest usernames do not have to match local UNIX usernames. +.SH OPTIONS +\fIlppasswd\fR supports the following options: +.TP 5 +-g groupname +.br +Specifies a group other than the default system group. +.SH SECURITY ISSUES +By default, the \fIlppasswd\fR program is not installed to allow ordinary +users to change their passwords. To enable this, the \fIlppasswd\fR command +must be made setuid to root with the command: +.br +.nf +chmod u+s lppasswd +.fi +.PP +While every attempt has been made to make \fIlppasswd\fR secure against +exploits that could grant super-user privileges to unprivileged users, +paranoid system administrators may wish to use Basic authentication with +accounts managed by PAM instead. +.SH SEE ALSO +\fIlp(1)\fR, \fIlpr(1)\fR, +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: lppasswd.man 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man1/ppdc.1 b/manual/cups/original/man1/ppdc.1 new file mode 100644 index 00000000..b613d429 --- /dev/null +++ b/manual/cups/original/man1/ppdc.1 @@ -0,0 +1,80 @@ +.\" +.\" "$Id: ppdc.man 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" ppdc man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2007 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH ppdc 1 "CUPS" "10 October 2008" "Apple Inc." +.SH NAME +ppdc \- cups ppd compiler +.SH SYNOPSIS +.B ppdc +[ -D +.I name[=value] +] [ -I +.I include-directory +] [ -c +.I message-catalog +] [ -d +.I output-directory +] [ -l +.I language(s) +] [-m] [-t] [ -v ] [ -z ] [ --cr ] [ --crlf ] [ --lf ] +.I source-file +.SH DESCRIPTION +\fIppdc\fR compiles PPDC source files into one or more PPD +files. +.PP +The \fI-D\fR option sets the named variable for use in the +source file. It is equivalent to using the #define directive +in the source file. +.PP +The \fI-I\fR option specifies an alternate include directory; +multiple \fI-I\fR options can be supplied to add additional +directories. +.PP +The \fI-c\fR option specifies a single message catalog file in GNU +gettext source format (filename.po) to be used for localization. +.PP +The \fI-d\fR option specifies the output directory for PPD +files. The default output directory is "ppd". +.PP +The \fI-l\fR option specifies one or more languages to use when +localizing the PPD file(s). The default language is "en" +(English). Separate multiple languages with commas, for example +"de_DE,en_UK,es_ES,es_MX,es_US,fr_CA,fr_FR,it_IT" will create PPD +files with German, UK English, Spanish (Spain, Mexico, and US), +French (France and Canada), and Italian languages in each file. +.PP +The \fI-m\fR option specifies that the output filename should be +based on the ModelName value instead of FileName or PCFilenName. +.PP +The \fI-t\fR option specifies that PPD files should be tested instead +of generated. +.PP +The \fI-v\fR option provides more verbose output, basically a +running status of which files are being loaded or written. +.PP +The \fI-z\fR option generates compressed PPD files (filename.ppd.gz). +The default is to generate uncompressed PPD files. +.PP +The \fI--cr\fR, \fI--crlf\fR, and \fI--lf\fR options specify the +line ending to use - carriage return, carriage return and line feed, +or line feed. The default is to use the line feed character alone. +.SH SEE ALSO +ppdhtml(1), ppdi(1), ppdmerge(1), ppdpo(1), ppdcfile(5) +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: ppdc.man 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man1/ppdhtml.1 b/manual/cups/original/man1/ppdhtml.1 new file mode 100644 index 00000000..bebf4e1e --- /dev/null +++ b/manual/cups/original/man1/ppdhtml.1 @@ -0,0 +1,46 @@ +.\" +.\" "$Id: ppdhtml.man 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" ppdhtml man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2007 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH ppdhtml 1 "CUPS" "10 October 2008" "Apple Inc." +.SH NAME +ppdhtml \- cups html summary generator +.SH SYNOPSIS +.B ppdhtml +[ -D +.I name[=value] +] [ -I +.I include-directory +] +.I source-file +.SH DESCRIPTION +\fIppdhtml\fR reads a driver information file and produces a +HTML summary page that lists all of the drivers in a file and +the supported options. +.PP +The \fI-D\fR option sets the named variable for use in the +source file. It is equivalent to using the #define directive +in the source file. +.PP +The \fI-I\fR option specifies an alternate include directory; +multiple \fI-I\fR options can be supplied to add additional +directories. +.SH SEE ALSO +ppdc(1), ppdcfile(5), ppdi(1), ppdmerge(1), ppdpo(1) +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: ppdhtml.man 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man1/ppdi.1 b/manual/cups/original/man1/ppdi.1 new file mode 100644 index 00000000..610d91cd --- /dev/null +++ b/manual/cups/original/man1/ppdi.1 @@ -0,0 +1,46 @@ +.\" +.\" "$Id: ppdi.man 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" ppdi man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2007 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH ppdi 1 "CUPS" "20 May 2008" "Apple Inc." +.SH NAME +ppdi \- import ppd files +.SH SYNOPSIS +.B ppdi +[ \-I +.I include-directory +] [ \-o +.I source-file +] +.I ppd-file +[ +.I ppd-file2 ... ppd-fileN +] +.SH DESCRIPTION +\fIppdi\fR imports one or more PPD files into a PPD compiler source file. +Multiple languages of the same PPD file are merged into a single printer +definition to facilitate accurate changes for all localizations. +.PP +The \fI-o\fR option specifies the PPD source file to update. If the source +file does not exist, a new source file is created. Otherwise the existing +file is merged with the new PPD file(s) on the command-line. If no source +file is specified, the filename "ppdi.drv" is used. +.SH SEE ALSO +ppdc(1), ppdhtml(1), ppdmerge(1), ppdpo(1), ppdcfile(5) +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: ppdi.man 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man1/ppdmerge.1 b/manual/cups/original/man1/ppdmerge.1 new file mode 100644 index 00000000..90fee820 --- /dev/null +++ b/manual/cups/original/man1/ppdmerge.1 @@ -0,0 +1,47 @@ +.\" +.\" "$Id: ppdmerge.man 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" ppdmerge man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2007 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH ppdmerge 1 "CUPS" "20 May 2008" "Apple Inc." +.SH NAME +ppdmerge \- merge ppd files +.SH SYNOPSIS +.B ppdmerge +[ \-o +.I output-ppd-file +] +.I ppd-file +.I ppd-file2 +[ +.I ... ppd-fileN +] +.SH DESCRIPTION +\fIppdmerge\fR merges two or more PPD files into a single, multi-language +PPD file. +.PP +The \fI-o\fR option specifies the PPD file to create. If not specified, +the merged PPD file is written to the standard output. If the output file +already exists, the new +.SH NOTES +\fIppdmerge\fR does not check whether the merged PPD files are for the +same device. Merging of different device PPDs will yield unpredictable +results. +.SH SEE ALSO +cupsprofile(1), ppdc(1), ppdhtml(1), ppdi(1), ppdpo(1), ppdcfile(5) +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: ppdmerge.man 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man1/ppdpo.1 b/manual/cups/original/man1/ppdpo.1 new file mode 100644 index 00000000..a3f9ac9b --- /dev/null +++ b/manual/cups/original/man1/ppdpo.1 @@ -0,0 +1,52 @@ +.\" +.\" "$Id: ppdpo.man 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" ppdpo man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2007 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH ppdpo 1 "CUPS" "10 October 2008" "Apple Inc." +.SH NAME +ppdpo \- ppd message catalog generator +.SH SYNOPSIS +.B ppdpo +[ -D +.I name[=value] +] [ -I +.I include-directory +] [ -o +.I output-file +] +.I source-file +.SH DESCRIPTION +\fIppdpo\fR extracts UI strings from PPDC source files and updates either +a GNU gettext or Mac OS X strings format message catalog source file for +translation. +.PP +The \fI-D\fR option sets the named variable for use in the +source file. It is equivalent to using the #define directive +in the source file. +.PP +The \fI-I\fR option specifies an alternate include directory; +multiple \fI-I\fR options can be supplied to add additional +directories. +.PP +The \fI-o\fR option specifies the output file. The supported extensions are +".po" or ".po.gz" for GNU gettext format message catalogs and ".strings" for +Mac OS X strings files. +.SH SEE ALSO +ppdc(1), ppdhtml(1), ppdi(1), ppdmerge(1), ppdcfile(5) +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: ppdpo.man 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man5/classes.conf.5 b/manual/cups/original/man5/classes.conf.5 new file mode 100644 index 00000000..0664442d --- /dev/null +++ b/manual/cups/original/man5/classes.conf.5 @@ -0,0 +1,110 @@ +.\" +.\" "$Id: classes.conf.man 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" classes.conf man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2006 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH classes.conf 5 "CUPS" "29 April 2009" "Apple Inc." +.SH NAME +classes.conf \- class configuration file for cups +.SH DESCRIPTION +The \fIclasses.conf\fR file defines the local printer classes that are +available. It is normally located in the \fI/etc/cups\fR directory and +is generated automatically by the \fIcupsd(8)\fR program when printer +classes are added or deleted. +.LP +Each line in the file can be a configuration directive, a blank line, +or a comment. Comment lines start with the # character. +.SH DIRECTIVES +.TP 5 + ... +.br +Defines a specific printer class. +.TP 5 + ... +.br +Defines a default printer class. +.TP 5 +Accepting Yes +.TP 5 +Accepting No +.br +Specifies whether the printer is accepting new jobs. +.TP 5 +AllowUser [ user @group ... ] +.br +Allows specific users and groups to print to the printer. +.TP 5 +DenyUser [ user @group ... ] +.br +Prevents specific users and groups from printing to the printer. +.TP 5 +Info text +.br +Specifies human-readable text describing the printer. +.TP 5 +JobSheets banner banner +.br +Specifies the banner pages to use for the printer. +.TP 5 +KLimit number +.br +Specifies the job-k-limit value for the printer. +.TP 5 +Location text +.br +Specifies human-readable text describing the location of the printer. +.TP 5 +OpPolicy name +.br +Specifies the operation policy for the printer. +.TP 5 +PageLimit number +.br +Specifies the job-page-limit value for the printer. +.TP 5 +Printer +.br +Specifies a printer that is a member of the printer class. +.TP 5 +QuotaPeriod seconds +.br +Specifies the job-quota-period value for the printer. +.TP 5 +Shared Yes +.TP 5 +Shared No +.br +Specifies whether the printer is shared. +.TP 5 +State idle +.TP 5 +State stopped +.br +Specifies the initial state of the printer (Idle or Stopped) +.TP 5 +StateMessage text +.br +Specifies the message associated with the state. +.TP 5 +StateTime seconds +.br +Specifies the date/time associated with the state. +.SH SEE ALSO +\fIcupsd(8)\fR, \fIcupsd.conf(5)\fR, \fImime.convs(5)\fR, +\fImime.types(5)\fR, \fIprinters.conf(5)\fR, +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: classes.conf.man 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man5/client.conf.5 b/manual/cups/original/man5/client.conf.5 new file mode 100644 index 00000000..2e41aedb --- /dev/null +++ b/manual/cups/original/man5/client.conf.5 @@ -0,0 +1,55 @@ +.\" +.\" "$Id: client.conf.man.in 9960 2011-09-02 22:37:14Z mike $" +.\" +.\" client.conf man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 2006 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH client.conf 5 "CUPS" "2 September 2011" "Apple Inc." +.SH NAME +client.conf \- client configuration file for cups +.SH DESCRIPTION +The \fIclient.conf\fR file configures the CUPS client and is +normally located in the \fI/etc/cups\fR or \fI~/.cups\fR +directory. Each line in the file can be a configuration +directive, a blank line, or a comment. Comment lines start with +the # character. +.SH DIRECTIVES +The following directives are understood by the client. Consult the +on-line help for detailed descriptions: +.TP 5 +Encryption IfRequested +.TP 5 +Encryption Never +.TP 5 +Encryption Required +.br +Specifies the level of encryption that is required for a particular +location. +.TP 5 +GSSServiceName name +Specifies the Kerberos service name that is used for authentication, typically +"host", "http", or "ipp". CUPS adds the remote hostname +("name@server.example.com") for you. The default name is +"@CUPS_DEFAULT_GSSSERVICENAME@". +.TP 5 +ServerName hostname-or-ip-address[:port] +.TP 5 +ServerName /domain/socket +.br +Specifies the address and optionally the port to use when connecting to the +server. \fBNote: Not supported on Mac OS X 10.7 or later.\fR +.SH SEE ALSO +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: client.conf.man.in 9960 2011-09-02 22:37:14Z mike $". +.\" diff --git a/manual/cups/original/man5/cups-snmp.conf.5 b/manual/cups/original/man5/cups-snmp.conf.5 new file mode 100644 index 00000000..1c778bc8 --- /dev/null +++ b/manual/cups/original/man5/cups-snmp.conf.5 @@ -0,0 +1,73 @@ +.\" +.\" "$Id: cups-snmp.conf.man 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" snmp.conf man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 2006 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH snmp.conf 5 "CUPS" "31 July 2006" "Apple Inc." +.SH NAME +snmp.conf \- snmp configuration file for cups +.SH DESCRIPTION +The \fIsnmp.conf\fR file configures the CUPS SNMP printer +discovery backend and is normally located in the \fI/etc/cups\fR +directory. Each line in the file can be a configuration +directive, a blank line, or a comment. Comment lines start with +the # character. +.LP +The SNMP backend uses the SNMPv1 protocol to discover network +printers, collecting information from the Host MIB along with +intelligent port probes to determine the correct device URI and +make and model for each printer. Future versions of CUPS will +likely support the new Port Monitor MIB as well. +.SH DIRECTIVES +The following directives are understood by the SNMP backend. +Consult the on-line help for detailed descriptions: +.TP 5 +Address @IF(\fIname\fR) +.TP 5 +Address @LOCAL +.TP 5 +Address \fIaddress\fR +.br +Sends SNMP broadcast queries to the specified address(es). The +default address is "@LOCAL" which broadcasts to all LAN +interfaces. +.TP 5 +Community \fIname\fR +.br +Specifies a SNMP community to query. The default community is +"public". +.TP 5 +DebugLevel \fIN\fR +.br +Sets the debug logging level to \fIN\fR; 0 disables debug +logging, 1 enables basic logging, 2 displays SNMP values, and 3 +displays raw hex data. +.TP 5 +HostNameLookups on +.TP 5 +HostNameLookups off +.br +Specifies whether the addresses of printers should be converted +to hostnames or left as numeric IP addresses. The default is +"off". +.TP 5 +MaxRunTime \fIseconds\fR +.br +Specifies the maximum number of seconds that the SNMP backend +will scan the network for printers. +.SH SEE ALSO +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: cups-snmp.conf.man 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man5/cupsd.conf.5 b/manual/cups/original/man5/cupsd.conf.5 new file mode 100644 index 00000000..2d2051d7 --- /dev/null +++ b/manual/cups/original/man5/cupsd.conf.5 @@ -0,0 +1,762 @@ +.\" +.\" "$Id: cupsd.conf.man.in 9784 2011-05-18 21:33:35Z mike $" +.\" +.\" cupsd.conf man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2006 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH cupsd.conf 5 "CUPS" "18 May 2011" "Apple Inc." +.SH NAME +cupsd.conf \- server configuration file for cups +.SH DESCRIPTION +The \fIcupsd.conf\fR file configures the CUPS scheduler, \fIcupsd(8)\fR. It +is normally located in the \fI/etc/cups\fR directory. +.LP +Each line in the file can be a configuration directive, a blank line, +or a comment. Comment lines start with the # character. The +configuration directives are intentionally similar to those used by the +popular Apache web server software and are described below. +.SH DIRECTIVES +The following directives are understood by \fIcupsd(8)\fR. Consult the +on-line help for detailed descriptions: +.TP 5 +AccessLog filename +.TP 5 +AccessLog syslog +.br +Defines the access log filename. +.TP 5 +AccessLogLevel config +.TP 5 +AccessLogLevel actions +.TP 5 +AccessLogLevel all +.br +Specifies the logging level for the AccessLog file. +.TP 5 +Allow all +.TP 5 +Allow none +.TP 5 +Allow host.domain.com +.TP 5 +Allow *.domain.com +.TP 5 +Allow ip-address +.TP 5 +Allow ip-address/netmask +.TP 5 +Allow ip-address/mm +.TP 5 +Allow @IF(name) +.TP 5 +Allow @LOCAL +.br +Allows access from the named hosts or addresses. +.TP 5 +AuthClass User +.TP 5 +AuthClass Group +.TP 5 +AuthClass System +.br +Specifies the authentication class (User, Group, System) - +\fBthis directive is deprecated\fR. +.TP 5 +AuthGroupName group-name +.br +Specifies the authentication group - \fBthis directive is +deprecated\fR. +.TP 5 +AuthType None +.TP 5 +AuthType Basic +.TP 5 +AuthType BasicDigest +.TP 5 +AuthType Digest +.TP 5 +AuthType Negotiate +.br +Specifies the authentication type (None, Basic, BasicDigest, Digest, Negotiate) +.TP 5 +AutoPurgeJobs Yes +.TP 5 +AutoPurgeJobs No +.br +Specifies whether to purge job history data automatically when +it is no longer required for quotas. +.TP 5 +BrowseAddress ip-address +.TP 5 +BrowseAddress @IF(name) +.TP 5 +BrowseAddress @LOCAL +.br +Specifies a broadcast address for outgoing printer information packets. +.TP 5 +BrowseAllow all +.TP 5 +BrowseAllow none +.TP 5 +BrowseAllow host.domain.com +.TP 5 +BrowseAllow *.domain.com +.TP 5 +BrowseAllow ip-address +.TP 5 +BrowseAllow ip-address/netmask +.TP 5 +BrowseAllow ip-address/mm +.TP 5 +BrowseAllow @IF(name) +.TP 5 +BrowseAllow @LOCAL +.br +Allows incoming printer information packets from the named host or address. +.TP 5 +BrowseDeny all +.TP 5 +BrowseDeny none +.TP 5 +BrowseDeny host.domain.com +.TP 5 +BrowseDeny *.domain.com +.TP 5 +BrowseDeny ip-address +.TP 5 +BrowseDeny ip-address/netmask +.TP 5 +BrowseDeny ip-address/mm +.TP 5 +BrowseDeny @IF(name) +.TP 5 +BrowseDeny @LOCAL +.br +Denies incoming printer information packets from the named host or address. +.TP 5 +BrowseInterval seconds +.br +Specifies the maximum interval between printer information broadcasts. +.TP 5 +BrowseLDAPBindDN +.br +Specifies the LDAP domain name to use when registering printers. +.TP 5 +BrowseLDAPCACertFile +.br +Specifies the SSL certificate authority file to use. +.TP 5 +BrowseLDAPDN +.br +Specifies the LDAP domain name to use when discovering printers. +.TP 5 +BrowseLDAPPassword +.br +Specifies the password to use when accessing the LDAP server. +.TP 5 +BrowseLDAPServer +.br +Specifies the LDAP server to use. +.TP 5 +BrowseOrder allow,deny +.TP 5 +BrowseOrder deny,allow +.br +Specifies the order of printer information access control (allow,deny or deny,allow) +.TP 5 +BrowsePoll host-or-ip-address +.br +Specifies a server to poll for printer information. +.TP 5 +BrowsePort port +.br +Specifies the port to listen to for printer information packets. +.TP 5 +BrowseProtocols [All] [CUPS] [DNSSD] [LDAP] [SLP] +.br +Specifies the protocols to use for printer browsing. +.TP 5 +BrowseLocalProtocols [All] [CUPS] [DNSSD] [LDAP] [SLP] +.br +Specifies the protocols to use for local printer browsing. +.TP 5 +BrowseRemoteProtocols [All] [CUPS] [DNSSD] [LDAP] [SLP] +.br +Specifies the protocols to use for remote printer browsing. +.TP 5 +BrowseRelay from-address to-address +.br +Specifies that printer information packets should be relayed from one host or +network to another. +.TP 5 +BrowseShortNames Yes +.TP 5 +BrowseShortNames No +.br +Specifies whether remote printers will use short names ("printer") or not +("printer@server"). This option is ignored if more than one remote printer +exists with the same name. +.TP 5 +BrowseTimeout seconds +.br +Specifies the maximum interval between printer information updates before +remote printers will be removed from the list of available printers. +.TP 5 +BrowseWebIF Yes +.TP 5 +BrowseWebIF No +.br +Specifies whether the CUPS web interface is advertised via DNS-SD. +.TP 5 +Browsing Yes +.TP 5 +Browsing No +.br +Specifies whether or not remote printer browsing should be enabled. +.TP 5 +Classification banner +.br +Specifies the security classification of the server. +.TP 5 +ClassifyOverride Yes +.TP 5 +ClassifyOverride No +.br +Specifies whether to allow users to override the classification +of individual print jobs. +.TP 5 +ConfigFilePerm mode +.br +Specifies the permissions for all configuration files that the scheduler +writes. +.TP 5 +DataDir path +.br +Specified the directory where data files can be found. +.TP 5 +DefaultAuthType Basic +.TP 5 +DefaultAuthType BasicDigest +.TP 5 +DefaultAuthType Digest +.TP 5 +DefaultAuthType Negotiate +.br +Specifies the default type of authentication to use. +.TP 5 +DefaultEncryption Never +.TP 5 +DefaultEncryption IfRequested +.TP 5 +DefaultEncryption Required +.br +Specifies the type of encryption to use for authenticated requests. +.TP 5 +DefaultLanguage locale +.br +Specifies the default language to use for text and web content. +.TP 5 +DefaultPaperSize Auto +.TP 5 +DefaultPaperSize None +.TP 5 +DefaultPaperSize sizename +.br +Specifies the default paper size for new print queues. "Auto" uses a locale- +specific default, while "None" specifies there is no default paper size. +.TP 5 +DefaultPolicy policy-name +.br +Specifies the default access policy to use. +.TP 5 +DefaultShared Yes +.TP 5 +DefaultShared No +.br +Specifies whether local printers are shared by default. +.TP 5 +Deny all +.TP 5 +Deny none +.TP 5 +Deny host.domain.com +.TP 5 +Deny *.domain.com +.TP 5 +Deny ip-address +.TP 5 +Deny ip-address/netmask +.TP 5 +Deny ip-address/mm +.TP 5 +Deny @IF(name) +.TP 5 +Deny @LOCAL +.br +Denies access to the named host or address. +.TP 5 +DirtyCleanInterval seconds +.br +Specifies the delay for updating of configuration and state files. A value of 0 +causes the update to happen as soon as possible, typically within a few +milliseconds. +.TP 5 +DocumentRoot directory +.br +Specifies the root directory for the internal web server documents. +.TP 5 +Encryption IfRequested +.TP 5 +Encryption Never +.TP 5 +Encryption Required +.br +Specifies the level of encryption that is required for a particular +location. +.TP 5 +ErrorLog filename +.TP 5 +ErrorLog syslog +.br +Specifies the error log filename. +.TP 5 +FatalErrors none +.TP 5 +FatalErrors all -kind [... -kind] +.TP 5 +FatalErrors kind [... kind] +.br +Specifies which errors are fatal, causing the scheduler to exit. "Kind" is +"browse", "config", "listen", "log", or "permissions". +.TP 5 +FileDevice Yes +.TP 5 +FileDevice No +.br +Specifies whether the file pseudo-device can be used for new +printer queues. +.TP 5 +FilterLimit limit +.br +Specifies the maximum cost of filters that are run concurrently. +.TP 5 +FilterNice nice-value +.br +Specifies the scheduling priority ("nice" value) of filters that +are run to print a job. +.TP 5 +FontPath directory[:directory:...] +.br +Specifies the search path for fonts. +.TP 5 +Group group-name-or-number +.br +Specifies the group name or ID that will be used when executing +external programs. +.TP 5 +HideImplicitMembers Yes +.TP 5 +HideImplicitMembers No +.br +Specifies whether to hide members of implicit classes. +.TP 5 +HostNameLookups On +.TP 5 +HostNameLookups Off +.TP 5 +HostNameLookups Double +.br +Specifies whether or not to do reverse lookups on client addresses. +.TP 5 +ImplicitAnyClasses Yes +.TP 5 +ImplicitAnyClasses No +.br +Specifies whether or not to create implicit classes for local and +remote printers, e.g. "AnyPrinter" from "Printer", "Printer@server1", +and "Printer@server2". +.TP 5 +ImplicitClasses Yes +.TP 5 +ImplicitClasses No +.br +Specifies whether or not to create implicit classes from identical +remote printers. +.TP 5 +Include filename +.br +Includes the named file. +.TP 5 +JobKillDelay seconds +.br +Specifies the number of seconds to wait before killing the filters and backend +associated with a canceled or held job. +.TP 5 +JobPrivateAccess all +.TP 5 +JobPrivateAccess default +.TP 5 +JobPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+ +.br +Specifies an access list for a job's private values. The "default" access list +is "@OWNER @SYSTEM". "@ACL" maps to the printer's requesting-user-name-allowed +or requesting-user-name-denied values. +.TP 5 +JobPrivateValues all +.TP 5 +JobPrivateValues default +.TP 5 +JobPrivateValues none +.TP 5 +JobPrivateValues attribute-name-1 [ ... attribute-name-N ] +Specifies the list of job values to make private. The "default" values are +"job-name", "job-originating-host-name", and "job-originating-user-name". +.TP 5 +JobRetryInterval seconds +.br +Specifies the interval between retries of jobs in seconds. +.TP 5 +JobRetryLimit count +.br +Specifies the number of retries that are done for jobs. +.TP 5 +KeepAlive Yes +.TP 5 +KeepAlive No +.br +Specifies whether to support HTTP keep-alive connections. +.TP 5 +KeepAliveTimeout seconds +.br +Specifies the amount of time that connections are kept alive. +.TP 5 + ... +.br +Specifies the IPP operations that are being limited inside a policy. +.TP 5 + ... +.TP 5 + ... +.br +Specifies the HTTP methods that are being limited inside a location. +.TP 5 +LimitRequestBody +.br +Specifies the maximum size of any print job request. +.TP 5 +Listen ip-address:port +.TP 5 +Listen *:port +.TP 5 +Listen /path/to/domain/socket +.br +Listens to the specified address and port or domain socket path. +.TP 5 + ... +.br +Specifies access control for the named location. +.TP 5 +LogDebugHistory #-messages +.br +Specifies the number of debugging messages that are logged when an error +occurs in a print job. +.TP 5 +LogFilePerm mode +.br +Specifies the permissions for all log files that the scheduler writes. +.TP 5 +LogLevel alert +.TP 5 +LogLevel crit +.TP 5 +LogLevel debug2 +.TP 5 +LogLevel debug +.TP 5 +LogLevel emerg +.TP 5 +LogLevel error +.TP 5 +LogLevel info +.TP 5 +LogLevel none +.TP 5 +LogLevel notice +.TP 5 +LogLevel warn +.br +Specifies the logging level for the ErrorLog file. +.TP 5 +LogTimeFormat standard +.TP 5 +LogTimeFormat usecs +.br +Specifies the format of the date and time in the log files. +.TP 5 +MaxClients number +.br +Specifies the maximum number of simultaneous clients to support. +.TP 5 +MaxClientsPerHost number +.br +Specifies the maximum number of simultaneous clients to support from a +single address. +.TP 5 +MaxCopies number +.br +Specifies the maximum number of copies that a user can print of each job. +.TP 5 +MaxJobs number +.br +Specifies the maximum number of simultaneous jobs to support. +.TP 5 +MaxJobsPerPrinter number +.br +Specifies the maximum number of simultaneous jobs per printer to support. +.TP 5 +MaxJobsPerUser number +.br +Specifies the maximum number of simultaneous jobs per user to support. +.TP 5 +MaxLogSize number-bytes +.br +Specifies the maximum size of the log files before they are +rotated (0 to disable rotation) +.TP 5 +MaxRequestSize number-bytes +.br +Specifies the maximum request/file size in bytes (0 for no limit) +.TP 5 +MultipleOperationTimeout seconds +.br +Specifies the maximum amount of time to allow between files in a multiple file +print job. +.TP 5 +Order allow,deny +.TP 5 +Order deny,allow +.br +Specifies the order of HTTP access control (allow,deny or deny,allow) +.TP 5 +PageLog filename +.TP 5 +PageLog syslog +.br +Specifies the page log filename. +.TP 5 +PageLogFormat format string +.br +Specifies the format of page log lines. +.TP 5 +PassEnv variable [... variable] +.br +Passes the specified environment variable(s) to child processes. +.TP 5 + ... +.br +Specifies access control for the named policy. +.TP 5 +Port number +.br +Specifies a port number to listen to for HTTP requests. +.TP 5 +PreserveJobFiles Yes +.TP 5 +PreserveJobFiles No +.br +Specifies whether or not to preserve job files after they are printed. +.TP 5 +PreserveJobHistory Yes +.TP 5 +PreserveJobHistory No +.br +Specifies whether or not to preserve the job history after they are +printed. +.TP 5 +Printcap +.TP 5 +Printcap filename +.br +Specifies the filename for a printcap file that is updated +automatically with a list of available printers (needed for +legacy applications); specifying Printcap with no filename +disables printcap generation. +.TP 5 +PrintcapFormat bsd +.TP 5 +PrintcapFormat plist +.TP 5 +PrintcapFormat solaris +.br +Specifies the format of the printcap file. +.TP 5 +PrintcapGUI +.TP 5 +PrintcapGUI gui-program-filename +.br +Specifies whether to generate option panel definition files on +some operating systems. When provided with no program filename, +disables option panel definition files. +.TP 5 +ReloadTimeout seconds +.br +Specifies the amount of time to wait for job completion before +restarting the scheduler. +.TP 5 +RemoteRoot user-name +.br +Specifies the username that is associated with unauthenticated root +accesses. +.TP 5 +RequestRoot directory +.br +Specifies the directory to store print jobs and other HTTP request +data. +.TP 5 +Require group group-name-list +.TP 5 +Require user user-name-list +.TP 5 +Require valid-user +.br +Specifies that user or group authentication is required. +.TP 5 +RIPCache bytes +.br +Specifies the maximum amount of memory to use when converting images +and PostScript files to bitmaps for a printer. +.TP 5 +Satisfy all +.TP 5 +Satisfy any +.br +Specifies whether all or any limits set for a Location must be +satisfied to allow access. +.TP 5 +ServerAdmin user@domain.com +.br +Specifies the email address of the server administrator. +.TP 5 +ServerAlias hostname [... hostname] +.TP 5 +ServerAlias * +.br +Specifies an alternate name that the server is known by. The special name "*" +allows any name to be used. +.TP 5 +ServerBin directory +.br +Specifies the directory where backends, CGIs, daemons, and filters may +be found. +.TP 5 +ServerCertificate filename +.br +Specifies the encryption certificate to use. +.TP 5 +ServerKey filename +.br +Specifies the encryption key to use. +.TP 5 +ServerName hostname-or-ip-address +.br +Specifies the fully-qualified hostname of the server. +.TP 5 +ServerRoot directory +.br +Specifies the directory where the server configuration files can be found. +.TP 5 +ServerTokens Full +.TP 5 +ServerTokens Major +.TP 5 +ServerTokens Minimal +.TP 5 +ServerTokens Minor +.TP 5 +ServerTokens None +.TP 5 +ServerTokens OS +.TP 5 +ServerTokens ProductOnly +.br +Specifies what information is included in the Server header of HTTP +responses. +.TP 5 +SetEnv variable value +.br +Set the specified environment variable to be passed to child processes. +.TP 5 +SSLListen +.br +Listens on the specified address and port for encrypted connections. +.TP 5 +SSLOptions None +.TP 5 +SSLOptions NoEmptyFragments +.br +Sets SSL/TLS protocol options for encrypted connections. +.TP 5 +SSLPort +.br +Listens on the specified port for encrypted connections. +.TP 5 +SubscriptionPrivateAccess all +.TP 5 +SubscriptionPrivateAccess default +.TP 5 +SubscriptionPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+ +.br +Specifies an access list for a subscription's private values. The "default" +access list is "@OWNER @SYSTEM". "@ACL" maps to the printer's +requesting-user-name-allowed or requesting-user-name-denied values. +.TP 5 +SubscriptionPrivateValues all +.TP 5 +SubscriptionPrivateValues default +.TP 5 +SubscriptionPrivateValues none +.TP 5 +SubscriptionPrivateValues attribute-name-1 [ ... attribute-name-N ] +Specifies the list of job values to make private. The "default" values are +"notify-events", "notify-pull-method", "notify-recipient-uri", +"notify-subscriber-user-name", and "notify-user-data". +.TP 5 +SystemGroup group-name [group-name ...] +.br +Specifies the group(s) to use for System class authentication. +.TP 5 +TempDir directory +.br +Specifies the directory where temporary files are stored. +.TP 5 +Timeout seconds +.br +Specifies the HTTP request timeout in seconds. +.TP 5 +User user-name +.br +Specifies the user name or ID that is used when running external programs. +.TP 5 +WebInterface yes +.TP 5 +WebInterface no +Specifies whether the web interface is enabled. +.SH SEE ALSO +\fIclasses.conf(5)\fR, \fIcupsd(8)\fR, \fImime.convs(5)\fR, +\fImime.types(5)\fR, \fIprinters.conf(5)\fR, +\fIsubscriptions.conf(5)\fR, +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: cupsd.conf.man.in 9784 2011-05-18 21:33:35Z mike $". +.\" diff --git a/manual/cups/original/man5/ipptoolfile.5 b/manual/cups/original/man5/ipptoolfile.5 new file mode 100644 index 00000000..8a5d58e2 --- /dev/null +++ b/manual/cups/original/man5/ipptoolfile.5 @@ -0,0 +1,523 @@ +.\" +.\" "$Id: ipptoolfile.man 10023 2011-09-28 16:21:15Z mike $" +.\" +.\" ipptoolfile man page for CUPS. +.\" +.\" Copyright 2010-2011 by Apple Inc. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH ipptoolfile 5 "CUPS" "28 September 2011" "Apple Inc." +.SH NAME +ipptoolfile \- ipptool file format + +.SH DESCRIPTION +The \fIipptool(1)\fR program accepts free-form plain text files that describe one or more IPP requests. Comments start with the "#" character and continue to the end of the line. Each request is enclosed by curley braces, for example: +.nf + + # This is a comment + { + # The name of the test + NAME "Print PostScript Job" + + # The request to send + OPERATION Print-Job + GROUP operation-attributes-tag + ATTR charset attributes-charset utf-8 + ATTR language attributes-natural-language en + ATTR uri printer-uri $uri + ATTR name requesting-user-name $user + FILE testfile.ps + + # The response to expect + STATUS successful-ok + EXPECT attributes-charset OF-TYPE charset + EXPECT attributes-natural-language OF-TYPE naturalLanguage + EXPECT job-id OF-TYPE integer + EXPECT job-uri OF-TYPE uri + } + { + # The name of the test + NAME "Get Attributes of PostScript Job" + + # The request to send + OPERATION Get-Job-Attributes + GROUP operation-attributes-tag + ATTR charset attributes-charset utf-8 + ATTR language attributes-natural-language en + ATTR uri printer-uri $uri + ATTR integer job-id $job-id + ATTR name requesting-user-name $user + + # The response to expect + STATUS successful-ok + EXPECT attributes-charset OF-TYPE charset + EXPECT attributes-natural-language OF-TYPE naturalLanguage + EXPECT job-id OF-TYPE integer + EXPECT job-uri OF-TYPE uri + EXPECT job-state OF-TYPE enum + EXPECT job-originating-user-name OF-TYPE name WITH-VALUE "$user" + } +.fi + +.SH TOP-LEVEL DIRECTIVES +The following directives can be used outside of a test: +.TP 5 +{ test } +Defines a test. +.TP 5 +DEFINE variable-name value +Defines the named variable to the given value. This is equivalent to specifying +"-d variable-name=value" on the \fIipptool\fR command-line. +.TP 5 +DEFINE-DEFAULT variable-name value +Defines the named variable to the given value if it does not already have a +value. +.TP 5 +IGNORE-ERRORS yes +.TP 5 +IGNORE-ERRORS no +Specifies whether, by default, \fIipptool\fR will ignore errors and continue with +subsequent tests. +.TP 5 +INCLUDE "filename" +.TP 5 +INCLUDE +Includes another test file. The first form includes a file relative to the +current test file, while the second form includes a file from the \fIipptool\fR +include directory. +.TP 5 +INCLUDE-IF-DEFINED name "filename" +.TP 5 +INCLUDE-IF-DEFINED name +Includes another test file if the named variable is defined. The first form +includes a file relative to the current test file, while the second form +includes a file from the \fIipptool\fR include directory. +.TP 5 +INCLUDE-IF-NOT-DEFINED name "filename" +.TP 5 +INCLUDE-IF-NOT-DEFINED name +Includes another test file if the named variable is not defined. The first form +includes a file relative to the current test file, while the second form +includes a file from the \fIipptool\fR include directory. +.TP 5 +SKIP-IF-DEFINED variable-name +.TP 5 +SKIP-IF-NOT-DEFINED variable-name +Specifies that the remainder of the test file should be skipped when the +variable is or is not defined. +.TP 5 +TRANSFER auto +Specifies that tests will, by default, use "Transfer-Encoding: chunked" for +requests with attached files and "Content-Length:" for requests without attached +files. +.TP 5 +TRANSFER chunked +Specifies that tests will, by default, use the HTTP/1.1 "Transfer-Encoding: +chunked" header. This is the default and is equivalent to specifying "-c" on the +\fIipptool\fR command-line. Support for chunked requests is required for +conformance with all versions of IPP. +.TP 5 +TRANSFER length +Specifies that tests will, by default, use the HTTP/1.0 "Content-Length:" +header. This is equivalent to specifying "-l" on the \fIipptool\fR command-line. +Support for content length requests is required for conformance with all +versions of IPP. +.TP 5 +VERSION 1.0 +.TP 5 +VERSION 1.1 +.TP 5 +VERSION 2.0 +.TP 5 +VERSION 2.1 +.TP 5 +VERSION 2.2 +Specifies the default IPP version number to use for the tests that follow. + +.SH TEST DIRECTIVES +The following directives are understood in a test: +.TP 5 +ATTR tag attribute-name value(s) +Adds an attribute to the test request. Values are separated by the comma (",") +character - escape commas using the "\" character. +.TP 5 +ATTR collection attribute-name { MEMBER tag member-name value(s) ... } [ ... { ... } ] +Adds a collection attribute to the test request. Member attributes follow the +same syntax as regular attributes and can themselves be nested collections. +Multiple collection values can be supplied as needed. +.TP 5 +DELAY seconds +Specifies a delay before this test will be run. +.TP 5 +DISPLAY attribute-name +Specifies that value of the named attribute should be output as part of the +test report. +.TP 5 +EXPECT attribute-name [ predicate(s) ] +.TP 5 +EXPECT ?attribute-name predicate(s) +.TP 5 +EXPECT !attribute-name +Specifies that the response must/may/must not include the named attribute. +Additional requirements can be added as predicates - see the "EXPECT PREDICATES" +section for more information on predicates. +.TP 5 +FILE filename +Specifies a file to include at the end of the request. This is typically used +when sending a test print file. +.TP 5 +GROUP tag +Specifies the group tag for subsequent attributes in the request. +.TP 5 +IGNORE-ERRORS yes +.TP 5 +IGNORE-ERRORS no +Specifies whether \fIipptool\fR will ignore errors and continue with subsequent +tests. +.TP 5 +NAME "literal string" +Specifies the human-readable name of the test. +.TP 5 +OPERATION operation-code +Specifies the operation to be performed. +.TP 5 +REQUEST-ID number +.TP 5 +REQUEST-ID random +Specifies the request-id value to use in the request, either an integer or the +word "random" to use a randomly generated value (the default). +.TP 5 +RESOURCE path +Specifies an alternate resource path that is used for the HTTP POST request. +The default is the resource from the URI provided to the \fIipptool\fR program. +.TP 5 +SKIP-IF-DEFINED variable-name +.TP 5 +SKIP-IF-NOT-DEFINED variable-name +Specifies that the current test should be skipped when the variable is or is not +defined. +.TP 5 +SKIP-PREVIOUS-ERROR yes +.TP 5 +SKIP-PREVIOUS-ERROR no +Specifies whether \fIipptool\fR will skip the current test if the previous test +resulted in an error/failure. +.TP 5 +STATUS status-code [ predicate ] +Specifies an expected response status-code value. Additional requirements can be +added as predicates - see the "STATUS PREDICATES" section for more information +on predicates. +.TP 5 +TRANSFER auto +Specifies that this test will use "Transfer-Encoding: chunked" if it has an +attached file or "Content-Length:" otherwise. +.TP 5 +TRANSFER chunked +Specifies that this test will use the HTTP/1.1 "Transfer-Encoding: chunked" +header. +.TP 5 +TRANSFER length +Specifies that this test will use the HTTP/1.0 "Content-Length:" header. +.TP 5 +VERSION 1.0 +.TP 5 +VERSION 1.1 +.TP 5 +VERSION 2.0 +.TP 5 +VERSION 2.1 +.TP 5 +VERSION 2.2 +Specifies the IPP version number to use for this test. + +.SH EXPECT PREDICATES +The following predicates are understood following the EXPECT test directive: +.TP 5 +COUNT number +Requires the EXPECT attribute to have the specified number of values. +.TP 5 +DEFINE-MATCH variable-name +Defines the variable to "1" when the EXPECT condition matches. A side-effect of +this predicate is that this EXPECT will never fail a test. +.TP 5 +DEFINE-NO-MATCH variable-name +Defines the variable to "1" when the EXPECT condition does not match. A side- +effect of this predicate is that this EXPECT will never fail a test. +.TP 5 +DEFINE-VALUE variable-name +Defines the variable to the value of the attribute when the EXPECT condition +matches. A side-effect of this predicate is that this EXPECT will never fail a test. +.TP 5 +IF-DEFINED variable-name +Makes the EXPECT conditions apply only if the specified variable is defined. +.TP 5 +IF-NOT-DEFINED variable-name +Makes the EXPECT conditions apply only if the specified variable is not +defined. +.TP 5 +IN-GROUP tag +Requires the EXPECT attribute to be in the specified group tag. +.TP 5 +OF-TYPE tag[,tag,...] +Requires the EXPECT attribute to use the specified value tag(s). +.TP 5 +REPEAT-MATCH +.TP 5 +REPEAT-NO-MATCH +Specifies that the current test should be repeated when the EXPECT condition +matches or does not match. +.TP 5 +SAME-COUNT-AS attribute-name +Requires the EXPECT attribute to have the same number of values as the specified +parallel attribute. +.TP 5 +WITH-VALUE "literal string" +Requires at least one value of the EXPECT attribute to match the literal string. +Comparisons are case-sensitive. +.TP 5 +WITH-VALUE "/regular expression/" +Requires that all values of the EXPECT attribute match the regular expression, +which must conform to the POSIX regular expression syntax. +Comparisons are case-sensitive. + +.SH STATUS PREDICATES +The following predicates are understood following the STATUS test directive: +.TP 5 +IF-DEFINED variable-name +Makes the STATUS apply only if the specified variable is defined. +.TP 5 +IF-NOT-DEFINED variable-name +Makes the STATUS apply only if the specified variable is not defined. +.TP 5 +REPEAT-MATCH +.TP 5 +REPEAT-NO-MATCH +Specifies that the current test should be repeated when the response status-code +matches or does not match the value specified by the STATUS directive. + +.SH OPERATION CODES +Operation codes correspond to the hexadecimal numbers (0xHHHH) and names from +RFC 2911 and other IPP extension specifications. Here is a complete list: +.nf + Activate-Printer + CUPS-Accept-Jobs + CUPS-Add-Modify-Class + CUPS-Add-Modify-Printer + CUPS-Authenticate-Job + CUPS-Delete-Class + CUPS-Delete-Printer + CUPS-Get-Classes + CUPS-Get-Default + CUPS-Get-Devices + CUPS-Get-Document + CUPS-Get-PPD + CUPS-Get-PPDs + CUPS-Get-Printers + CUPS-Move-Job + CUPS-Reject-Jobs + CUPS-Set-Default + Cancel-Current-Job + Cancel-Job + Cancel-Jobs + Cancel-My-Jobs + Cancel-Subscription + Close-Job + Create-Job + Create-Job-Subscription + Create-Printer-Subscription + Deactivate-Printer + Disable-Printer + Enable-Printer + Get-Job-Attributes + Get-Jobs + Get-Notifications + Get-Printer-Attributes + Get-Printer-Support-Files + Get-Printer-Supported-Values + Get-Subscription-Attributes + Get-Subscriptions + Hold-Job + Hold-New-Jobs + Pause-Printer + Pause-Printer-After-Current-Job + Print-Job + Print-URI + Promote-Job + Purge-Jobs + Release-Held-New-Jobs + Release-Job + Renew-Subscription + Reprocess-Job + Restart-Job + Restart-Printer + Resubmit-Job + Resume-Job + Resume-Printer + Schedule-Job-After + Send-Document + Send-Notifications + Send-URI + Set-Job-Attributes + Set-Printer-Attributes + Shutdown-Printer + Startup-Printer + Suspend-Current-Job + Validate-Job +.fi + +.SH STATUS CODES +Status codes correspond to the hexadecimal numbers (0xHHHH) and names from RFC +2911 and other IPP extension specifications. Here is a complete list: +.nf + client-error-attributes-not-settable + client-error-attributes-or-values-not-supported + client-error-bad-request + client-error-charset-not-supported + client-error-compression-error + client-error-compression-not-supported + client-error-conflicting-attributes + client-error-document-access-error + client-error-document-format-error + client-error-document-format-not-supported + client-error-forbidden + client-error-gone + client-error-ignored-all-notifications + client-error-ignored-all-subscriptions + client-error-not-authenticated + client-error-not-authorized + client-error-not-found + client-error-not-possible + client-error-print-support-file-not-found + client-error-request-entity-too-large + client-error-request-value-too-long + client-error-timeout + client-error-too-many-subscriptions + client-error-uri-scheme-not-supported + cups-see-other + redirection-other-site + server-error-busy + server-error-device-error + server-error-internal-error + server-error-job-canceled + server-error-multiple-document-jobs-not-supported + server-error-not-accepting-jobs + server-error-operation-not-supported + server-error-printer-is-deactivated + server-error-service-unavailable + server-error-temporary-error + server-error-version-not-supported + successful-ok + successful-ok-but-cancel-subscription + successful-ok-conflicting-attributes + successful-ok-events-complete + successful-ok-ignored-notifications + successful-ok-ignored-or-substituted-attributes + successful-ok-ignored-subscriptions + successful-ok-too-many-events +.fi + +.SH TAGS +Value and group tags correspond to the names from RFC 2911 and other IPP +extension specifications. Here are the group tags: +.nf + event-notification-attributes-tag + job-attributes-tag + operation-attributes-tag + printer-attributes-tag + subscription-attributes-tag + unsupported-attributes-tag +.fi +.LP +Here are the value tags: +.nf + admin-define + boolean + charset + collection + dateTime + default + delete-attribute + enum + integer + keyword + mimeMediaType + nameWithLanguage + nameWithoutLanguage + naturalLanguage + no-value + not-settable + octetString + rangeOfInteger + resolution + textWithLanguage + textWithoutLanguage + unknown + unsupported + uri + uriScheme +.fi + +.SH VARIABLES +The \fIipptool\fR program maintains a list of variables that can be used in any +literal string or attribute value by specifying "$variable-name". Aside from +variables defined using the "-d" option or "DEFINE" directive, the following +pre-defined variables are available: +.TP 5 +$$ +Inserts a single "$" character. +.TP 5 +$ENV[name] +Inserts the value of the named environment variable, or an empty string if the +environment variable is not defined. +.TP 5 +$filename +Inserts the filename provided to \fIipptool\fR with the "-f" option. +.TP 5 +$hostname +Inserts the hostname from the URI provided to \fIipptool\fR. +.TP 5 +$job-id +Inserts the last job-id value returned in a test response or 0 if no job-id has +been seen. +.TP 5 +$job-uri +Inserts the last job-uri value returned in a test response or an empty string if +no job-uri has been seen. +.TP 5 +$scheme +Inserts the scheme from the URI provided to \fIipptool\fR. +.TP 5 +$notify-subscription-id +Inserts the last notify-subscription-id value returnd in a test response or 0 if +no notify-subscription-id has been seen. +.TP 5 +$port +Inserts the port number from the URI provided to \fIipptool\fR. +.TP 5 +$resource +Inserts the resource path from the URI provided to \fIipptool\fR. +.TP 5 +$uri +Inserts the URI provided to \fIipptool\fR. +.TP 5 +$user +Inserts the current user's login name. +.TP 5 +$username +Inserts the username from the URI provided to \fIipptool\fR, if any. + +.SH SEE ALSO +\fIipptool(1)\fR, +.br +http://localhost:631/help + +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: ipptoolfile.man 10023 2011-09-28 16:21:15Z mike $". +.\" diff --git a/manual/cups/original/man5/mailto.conf.5 b/manual/cups/original/man5/mailto.conf.5 new file mode 100644 index 00000000..7f9e30d5 --- /dev/null +++ b/manual/cups/original/man5/mailto.conf.5 @@ -0,0 +1,60 @@ +.\" +.\" "$Id: mailto.conf.man 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" mailto.conf man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2006 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH mailto.conf 5 "CUPS" "12 July 2006" "Apple Inc." +.SH NAME +mailto.conf \- configuration file for cups email notifier +.SH DESCRIPTION +The \fImailto.conf\fR file defines the local mail server and +email notification preferences for CUPS. +.LP +Each line in the file can be a configuration directive, a blank line, +or a comment. Comment lines start with the # character. +.SH DIRECTIVES +.TP 5 +Cc \fIcc-address@domain.com\fR +.br +Specifies an additional recipient for all email notifications. +.TP 5 +From \fIfrom-address@domain.com\fR +.br +Specifies the sender of email notifications. +.TP 5 +Sendmail \fIsendmail command and options\fR +.br +Specifies the sendmail command to use when sending email +notifications. Only one \fISendmail\fR or \fISMTPServer\fR line +may be present in the \fImailto.conf\fR file. If multiple lines +are present, only the last one is used. +.TP 5 +SMTPServer \fIservername\fR +.br +Specifies a SMTP server to send email notifications to. Only one +\fISendmail\fR or \fISMTPServer\fR line may be present in the +\fImailto.conf\fR file. If multiple lines are present, only the +last one is used. +.TP 5 +Subject \fIsubject-prefix\fR +.br +Specifies a prefix string for the subject line of an email notification. +.SH SEE ALSO +\fIclasses.conf(5)\fR, \fIcupsd(8)\fR, \fIcupsd.conf(5)\fR, +\fImime.convs(5)\fR, \fImime.types(5)\fR, \fIprinters.conf(5)\fR, +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: mailto.conf.man 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man5/mime.convs.5 b/manual/cups/original/man5/mime.convs.5 new file mode 100644 index 00000000..d55cad47 --- /dev/null +++ b/manual/cups/original/man5/mime.convs.5 @@ -0,0 +1,46 @@ +.\" +.\" "$Id: mime.convs.man 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" mime.convs man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2006 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH mime.convs 5 "CUPS" "20 March 2006" "Apple Inc." +.SH NAME +mime.convs \- mime type conversion file for cups +.SH DESCRIPTION +The \fImime.convs\fR file defines the filters that are available +for converting files from one format to another. The standard +filters support text, PDF, PostScript, HP-GL/2, and many types of +image files. +.LP +Additional filters can be added to the \fImime.convs\fR file or +(preferably) to other files in the CUPS configuration directory. +.LP +Each line in the \fImime.convs\fR file is a comment, blank, or filter +line. Comment lines start with the # character. Filter lines specify +the source and destination MIME types along with a relative cost +associated with the filter and the filter to run: +.br +.nf + +super/type super/type cost filter +application/postscript application/vnd.cups-raster 50 pstoraster +.fi +.SH SEE ALSO +\fIclasses.conf(5)\fR, \fIcupsd(8)\fR, \fIcupsd.conf(5)\fR, +\fImime.types(5)\fR, \fIprinters.conf(5)\fR, +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: mime.convs.man 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man5/mime.types.5 b/manual/cups/original/man5/mime.types.5 new file mode 100644 index 00000000..9c695660 --- /dev/null +++ b/manual/cups/original/man5/mime.types.5 @@ -0,0 +1,115 @@ +.\" +.\" "$Id: mime.types.man 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" mime.types man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2006 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH mime.types 5 "CUPS" "16 May 2009" "Apple Inc." +.SH NAME +mime.types \- mime type description file for cups +.SH DESCRIPTION +The \fImime.types\fR file defines the recognized file types. +.LP +Additional file types can be added to \fImime.types\fR or +(preferably) in additional files in the CUPS configuration +directory with the extension ".types". +.LP +Each line in the \fImime.types\fR file is a comment, blank, or +rule line. Comment lines start with the # character. Rule lines +start with the MIME type name and are optionally followed by a +series of file recognition rules that are used to automatically +identify print and web files: +.br +.nf + + super/type rule [ ... ruleN] +.fi +MIME type names are case-insensitive and are sorted in ascending alphanumeric +order for the purposes of matching. See the "TYPE MATCHING AND PRIORITY" +section for more information. +.LP +The rules may be grouped using parenthesis, joined using "+" for a +logical AND and "," or whitespace for a logical OR, and negated using +"!". +.SH RULES +Rules take two forms - a filename extension by itself and functions with test +values inside parenthesis. The following functions are available: +.TP 5 +match("pattern") +.br +Pattern match on filename +.TP 5 +ascii(offset,length) +.br +True if bytes are valid printable ASCII (CR, NL, TAB, BS, 32-126) +.TP 5 +printable(offset,length) +.br +True if bytes are printable 8-bit chars (CR, NL, TAB, BS, 32-126, 128-254) +.TP 5 +priority(number) +.br +Specifies the relative priority of this MIME type. The default priority is 100. +Larger values have higher priority while smaller values have lower priority. +.TP 5 +string(offset,"string") +.br +True if bytes are identical to string +.TP 5 +istring(offset,"string") +.br +True if a case-insensitive comparison of the bytes is identical +.TP 5 +char(offset,value) +.br +True if byte is identical +.TP 5 +short(offset,value) +.br +True if 16-bit integer is identical +.TP 5 +int(offset,value) +.br +True if 32-bit integer is identical +.TP 5 +locale("string") +.br +True if current locale matches string +.TP 5 +contains(offset,range,"string") +.br +True if the range contains the string +.SH STRING CONSTANTS +String constants can be specified inside quotes ("") for strings +containing whitespace and angle brackets (<>) for hexadecimal +strings. +.SH TYPE MATCHING AND PRIORITY +When CUPS needs to determine the MIME type of a given file, it checks every +MIME type defined in the .types files. When two types have the same matching +rules, the type chosen will depend on the type name and priority, with higher- +priority types being used over lower-priority ones. If the types have the same +priority, the type names are sorted alphanumerically in ascending order and the +first type is chosen. +.LP +For example, if two types "text/bar" and "text/foo" are defined as matching the +extension "doc", normally the type "text/bar" will be chosen since its name is +alphanumerically smaller than "text/foo". However, if "text/foo" also defines a +higher priority than "text/bar", "text/foo" will be chosen instead. +.SH SEE ALSO +\fIclasses.conf(5)\fR, \fIcupsd(8)\fR, \fIcupsd.conf(5)\fR, +\fImime.convs(5)\fR, \fIprinters.conf(5)\fR, +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: mime.types.man 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man5/ppdcfile.5 b/manual/cups/original/man5/ppdcfile.5 new file mode 100644 index 00000000..fbd63586 --- /dev/null +++ b/manual/cups/original/man5/ppdcfile.5 @@ -0,0 +1,171 @@ +.\" +.\" "$Id: ppdcfile.man 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" ppdcfile man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2007 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH ppdcfile 5 "CUPS" "20 May 2008" "Apple Inc." +.SH NAME +ppdcfile \- cups ppd compiler source file format +.SH DESCRIPTION +The CUPS PPD compiler reads meta files that contain descriptions +of one or more PPD files to be generated by \fIppdc\fR. This man +page provides a quick reference to the supported keywords and +should be used in conjuction with the Common UNIX Printing System +Developers Manual. +.PP +The source file format is plain ASCII text that can be edited +using your favorite text editor. Comments are supported using +the C (/* ... */) and C++ (// ...) comment mechanisms. +.PP +Printer driver information can be grouped and shared using +curley braces ({ ... }); PPD files are written when a close +brace or end-of-file is seen and a PCFileName directive has been +defined. +.PP +Directives may be placed anywhere on a line and are followed by +one or more values. The following is a list of the available +directives and the values they accept: +.TP 5 +\fB#define\fR name value +.TP 5 +\fB#elif\fR {name | value} +.TP 5 +\fB#else\fR +.TP 5 +\fB#endif\fR +.TP 5 +\fB#font\fR name encoding "version" charset status +.TP 5 +\fB#if\fR {name | value} +.TP 5 +\fB#include\fR +.TP 5 +\fB#include\fR "filename" +.TP 5 +\fB#media\fR name width length +.TP 5 +\fB#media\fR "name/text" width length +.TP 5 +\fB#po\fR locale "filename.po" +.TP 5 +\fBAttribute\fR name "" value +.TP 5 +\fBAttribute\fR name keyword value +.TP 5 +\fBAttribute\fR name "keyword/text" value +.TP 5 +\fBChoice\fR name "code" +.TP 5 +\fBChoice\fR "name/text" "code" +.TP 5 +\fBColorDevice\fR boolean-value +.TP 5 +\fBColorModel\fR name colorspace colororder compression +.TP 5 +\fBColorModel\fR "name/text" colorspace colororder compression +.TP 5 +\fBColorProfile\fR resolution/mediatype gamma density matrix +.TP 5 +\fBCopyright\fR "text" +.TP 5 +\fBCustomMedia\fR name width length left bottom right top "size-code" "region-code" +.TP 5 +\fBCustomMedia\fR "name/text" width length left bottom right top "size-code" "region-code" +.TP 5 +\fBCutter\fR boolean-value +.TP 5 +\fBDarkness\fR temperature name +.TP 5 +\fBDarkness\fR temperature "name/text" +.TP 5 +\fBDriverType\fR type +.TP 5 +\fBDuplex\fR type +.TP 5 +\fBFilter\fR mime-type cost program +.TP 5 +\fBFinishing\fR name +.TP 5 +\fBFinishing\fR "name/text" +.TP 5 +\fBFont\fR * +.TP 5 +\fBFont\fR name encoding "version" charset status +.TP 5 +\fBGroup\fR name +.TP 5 +\fBGroup\fR "name/text" +.TP 5 +\fBHWMargins\fR left bottom right top +.TP 5 +\fBInputSlot\fR position name +.TP 5 +\fBInputSlot\fR position "name/text" +.TP 5 +\fBInstallable\fR name +.TP 5 +\fBInstallable\fR "name/text" +.TP 5 +\fBLocAttribute\fR name "keyword/text" value +.TP 5 +\fBManualCopies\fR boolean-value +.TP 5 +\fBManufacturer\fR "name" +.TP 5 +\fBMaxSize\fR width length +.TP 5 +\fBMediaSize\fR name +.TP 5 +\fBMediaType\fR type name +.TP 5 +\fBMediaType\fR type "name/text" +.TP 5 +\fBMinSize\fR width length +.TP 5 +\fBModelName\fR "name" +.TP 5 +\fBModelNumber\fR number +.TP 5 +\fBOption\fR name type section order +.TP 5 +\fBOption\fR "name/text" type section order +.TP 5 +\fBPCFileName\fR "filename.ppd" +.TP 5 +\fBResolution\fR colorspace bits-per-color row-count row-feed row-step name +.TP 5 +\fBResolution\fR colorspace bits-per-color row-count row-feed row-step "name/text" +.TP 5 +\fBSimpleColorProfile\fR resolution/mediatype density yellow-density red-density gamma red-adjust green-adjust blue-adjust +.TP 5 +\fBThroughput\fR pages-per-minute +.TP 5 +\fBUIConstraints\fR "*Option1 *Option2" +.TP 5 +\fBUIConstraints\fR "*Option1 Choice1 *Option2" +.TP 5 +\fBUIConstraints\fR "*Option1 *Option2 Choice2" +.TP 5 +\fBUIConstraints\fR "*Option1 Choice1 *Option2 Choice2" +.TP 5 +\fBVariablePaperSize\fR boolean-value +.TP 5 +\fBVersion\fR number +.SH SEE ALSO +ppdc(1), ppdhtml(1), ppdi(1), ppdmerge(1), ppdpo(1) +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: ppdcfile.man 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man5/printers.conf.5 b/manual/cups/original/man5/printers.conf.5 new file mode 100644 index 00000000..abda49b2 --- /dev/null +++ b/manual/cups/original/man5/printers.conf.5 @@ -0,0 +1,124 @@ +.\" +.\" "$Id: printers.conf.man 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" printers.conf man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2006 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH printers.conf 5 "CUPS" "29 April 2009" "Apple Inc." +.SH NAME +printers.conf \- printer configuration file for cups +.SH DESCRIPTION +The \fIprinters.conf\fR file defines the local printers that are +available. It is normally located in the \fI/etc/cups\fR directory and +is generated automatically by the \fIcupsd(8)\fR program when printers +are added or deleted. +.LP +Each line in the file can be a configuration directive, a blank line, +or a comment. Comment lines start with the # character. +.SH DIRECTIVES +.TP 5 + ... +.br +Defines a specific printer. +.TP 5 + ... +.br +Defines a default printer. +.TP 5 +Accepting Yes +.TP 5 +Accepting No +.br +Specifies whether the printer is accepting new jobs. +.TP 5 +AllowUser [ user @group ... ] +.br +Allows specific users and groups to print to the printer. +.TP 5 +DenyUser [ user @group ... ] +.br +Prevents specific users and groups from printing to the printer. +.TP 5 +DeviceURI uri +.br +Specifies the device URI for a printer. +.TP 5 +ErrorPolicy abort-job +.TP 5 +ErrorPolicy retry-current-job +.TP 5 +ErrorPolicy retry-job +.TP 5 +ErrorPolicy stop-printer +.br +Specifies the error policy for the printer. +.TP 5 +Info text +.br +Specifies human-readable text describing the printer. +.TP 5 +JobSheets banner banner +.br +Specifies the banner pages to use for the printer. +.TP 5 +KLimit number +.br +Specifies the job-k-limit value for the printer. +.TP 5 +Location text +.br +Specifies human-readable text describing the location of the printer. +.TP 5 +OpPolicy name +.br +Specifies the operation policy for the printer. +.TP 5 +PageLimit number +.br +Specifies the job-page-limit value for the printer. +.TP 5 +PortMonitor monitor +.br +Specifies the port monitor for a printer. +.TP 5 +QuotaPeriod seconds +.br +Specifies the job-quota-period value for the printer. +.TP 5 +Shared Yes +.TP 5 +Shared No +.br +Specifies whether the printer is shared. +.TP 5 +State idle +.TP 5 +State stopped +.br +Specifies the initial state of the printer (Idle or Stopped) +.TP 5 +StateMessage text +.br +Specifies the message associated with the state. +.TP 5 +StateTime seconds +.br +Specifies the date/time associated with the state. +.SH SEE ALSO +\fIclasses.conf(5)\fR, \fIcupsd(8)\fR, \fIcupsd.conf(5)\fR, +\fImime.convs(5)\fR, \fImime.types(5)\fR, +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: printers.conf.man 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man5/subscriptions.conf.5 b/manual/cups/original/man5/subscriptions.conf.5 new file mode 100644 index 00000000..4ff851cb --- /dev/null +++ b/manual/cups/original/man5/subscriptions.conf.5 @@ -0,0 +1,89 @@ +.\" +.\" "$Id: subscriptions.conf.man 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" subscriptions.conf man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 2006 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH subscriptions.conf 5 "CUPS" "30 April 2006" "Apple Inc." +.SH NAME +subscriptions.conf \- subscriptions file for cups +.SH DESCRIPTION +The \fIsubscriptions.conf\fR file defines the local subscriptions +that are active. It is normally located in the \fI/etc/cups\fR +directory and is generated automatically by the \fIcupsd(8)\fR +program when subscriptions are created, renewed, or cancelled. +.LP +Each line in the file can be a configuration directive, a blank line, +or a comment. Comment lines start with the # character. +.SH DIRECTIVES +.TP 5 + ... +.br +Defines a subscription. +.TP 5 +Events name [ ... name ] +.br +Specifies the events that are subscribed. +.TP 5 +ExpirationTime unix-time +.br +Specifies the expiration time of a subscription as a UNIX time +value in seconds since January 1st, 1970. +.TP 5 +Interval seconds +.br +Specifies the preferred time interval for event notifications in +seconds. +.TP 5 +JobId job-id +.br +Specifies the job ID associated with the subscription. +.TP 5 +LeaseDuration seconds +.br +Specifies the number of seconds that the subscription is valid +for. If 0, the subscription does not expire. +.TP 5 +NextEventId number +.br +Specifies the next notify-sequence-number to use for the +subscription. +.TP 5 +NextSubscriptionId number +.br +Specifies the next subscription-id to use. +.TP 5 +Owner username +.br +Specifies the user that owns the subscription. +.TP 5 +PrinterName printername +.br +Specifies the printer or class associated with the subscription. +.TP 5 +Recipient uri +.br +Specifies the notify-recipient-uri value for push-type notifications. +.TP 5 +UserData hex-escaped-data +.br +Specifies user data to be included in event notifications. This +is typically the "from" address in mailto: notifications. +.SH SEE ALSO +\fIclasses.conf(5)\fR, \fIcupsd(8)\fR, \fIcupsd.conf(5)\fR, +\fImime.convs(5)\fR, \fImime.types(5)\fR, \fRprinters.conf(5)\fR +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: subscriptions.conf.man 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man7/backend.7 b/manual/cups/original/man7/backend.7 new file mode 100644 index 00000000..644d85dd --- /dev/null +++ b/manual/cups/original/man7/backend.7 @@ -0,0 +1,196 @@ +.\" +.\" "$Id: backend.man 9693 2011-04-16 02:51:22Z mike $" +.\" +.\" Backend man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2006 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH backend 7 "CUPS" "15 April 2011" "Apple Inc." + +.SH NAME +backend \- cups backend transmission interfaces + +.SH SYNOPSIS +.B backend +.br +.B backend +job user title num-copies options [ +.I filename +] + +.SH DESCRIPTION +Backends are a special type of \fIfilter(7)\fR which is used to +send print data to and discover different devices on the system. + +.LP +Like filters, backends must be capable of reading from a filename +on the command-line or from the standard input, copying the +standard input to a temporary file as required by the physical +interface. + +.LP +The command name (argv[0]) is set to the device URI of the destination printer. +Starting with CUPS 1.1.22, any authentication information in argv[0] is removed, +so backend developers are urged to use the DEVICE_URI environment variable +whenever authentication information is required. The CUPS API includes a +\fIcupsBackendDeviceURI\fR function for retrieving the correct device URI. + +.LP +Back-channel data from the device should be relayed to the job +filters by writing to file descriptor 3. The CUPS API includes +the \fIcupsBackChannelWrite\fR function for this purpose. + +.SH DEVICE DISCOVERY +When run with no arguments, the backend should list the devices +and schemes it supports or is advertising to stdout. The output +consists of zero or more lines consisting of any of the following +forms: + +.nf + device-class scheme "Unknown" "device-info" + device-class device-uri "device-make-and-model" "device-info" + device-class device-uri "device-make-and-model" "device-info" "device-id" + device-class device-uri "device-make-and-model" "device-info" "device-id" "device-location" +.fi + +.LP +The \fIdevice-class\fR field is one of the following values: + +.TP 5 +direct +.br +The device-uri refers to a specific direct-access device with no +options, such as a parallel, USB, or SCSI device. + +.TP 5 +file +.br +The device-uri refers to a file on disk. + +.TP 5 +network +.br +The device-uri refers to a networked device and conforms to the +general form for network URIs. + +.TP 5 +serial +.br +The device-uri refers to a serial device with configurable baud +rate and other options. If the device-uri contains a baud value, +it represents the maximum baud rate supported by the device. + +.LP +The \fIscheme\fR field provides the URI scheme that is supported +by the backend. Backends should use this form only when the +backend supports any URI using that scheme. The \fIdevice-uri\fR +field specifies the full URI to use when communicating with the +device. + +.LP +The \fIdevice-make-and-model\fR field specifies the make and +model of the device, e.g. "Acme Foojet 2000". If the make and +model is not known, you must report "Unknown". + +.LP +The \fIdevice-info\fR field specifies additional information +about the device. Typically this includes the make and model +along with the port number or network address, e.g. "Acme Foojet +2000 USB #1". + +.LP +The optional \fIdevice-id\fR field specifies the IEEE-1284 device +ID string for the device, which is used to select a matching +driver. + +.LP +The optional \fIdevice-location\fR field specifies the physical location of +the device, which is often used to pre-populate the printer-location attribute +when adding a printer. + +.SH PERMISSIONS +Backends without world execute permissions are run as the root +user. Otherwise, the backend is run using the unprivileged user +account, typically "lp". + +.SH EXIT CODES +The following exit codes are defined for backends; C API +constants defined in the header file are defined +in parenthesis: + +.TP 5 +0 (CUPS_BACKEND_OK) +.br +The print file was successfully transmitted to the device or +remote server. + +.TP 5 +1 (CUPS_BACKEND_FAILED) +.br +The print file was not successfully transmitted to the device or +remote server. The scheduler will respond to this by canceling +the job, retrying the job, or stopping the queue depending on the +state of the error-policy attribute. + +.TP 5 +2 (CUPS_BACKEND_AUTH_REQUIRED) +.br +The print file was not successfully transmitted because valid +authentication information is required. The scheduler will +respond to this by holding the job and adding the +authentication-required job-reasons keyword. + +.TP 5 +3 (CUPS_BACKEND_HOLD) +.br +The print file was not successfully transmitted because it cannot +be printed at this time. The scheduler will respond to this by +holding the job. + +.TP 5 +4 (CUPS_BACKEND_STOP) +.br +The print file was not successfully transmitted because it cannot +be printed at this time. The scheduler will respond to this by +stopping the queue. + +.TP 5 +5 (CUPS_BACKEND_CANCEL) +.br +The print file was not successfully transmitted because one or +more attributes are not supported. The scheduler will respond to +this by canceling the job. + +.TP 5 +6 (CUPS_BACKEND_RETRY) +.br +The print file was not successfully transmitted because of a temporary issue. +The scheduler will retry the job at a future time - other jobs may print before +this one. + +.TP 5 +7 (CUPS_BACKEND_RETRY_CURRENT) +.br +The print file was not successfully transmitted because of a temporary issue. +The scheduler will retry the job immediately without allowing intervening jobs. + +.PP +All other exit code values are reserved. + +.SH SEE ALSO +\fIcupsd(8)\fR, \fIcupsd.conf(5)\fR, \fIfilter(7)\fR, +.br +http://localhost:631/help + +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: backend.man 9693 2011-04-16 02:51:22Z mike $". +.\" diff --git a/manual/cups/original/man7/filter.7 b/manual/cups/original/man7/filter.7 new file mode 100644 index 00000000..eef66bab --- /dev/null +++ b/manual/cups/original/man7/filter.7 @@ -0,0 +1,256 @@ +.\" +.\" "$Id: filter.man 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" filter man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2007 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH filter 7 "CUPS" "13 May 2009" "Apple Inc." +.SH NAME +filter \- cups file conversion filter interface +.SH SYNOPSIS +.B filter +job user title num-copies options [ +.I filename +] +.SH DESCRIPTION +The CUPS filter interface provides a standard method for adding support for +new document types to CUPS. Each filter is capable of converting from one +or more input formats to another format that can either be printed directly +or piped into another filter to get it to a printable format. +.LP +Filters \fBmust\fR be capable of reading from a filename on the command-line +or from the standard input, copying the standard input to a temporary +file as required by the file format. All output \fBmust\fR be sent to the +standard output. +.LP +The command name (argv[0]) is set to the name of the destination printer but is +also available in the PRINTER environment variable. + +.SH OPTIONS +Options passed on the command-line typically do not include the default choices +the printer's PPD file. In addition, some options may be specified in multiple +ways - "landscape" is a synonym for "orientation-requested=4", "media" is a +synonym for "PageSize", "PageRegion", "InputSlot", and "MediaType", and "sides" +is a synonym for the various "Duplex" options. Non-raster filters \fBmust\fR +support both explicit and implicit specification of PPD options - use the +ppdMarkDefaults and cupsMarkOptions functions in the CUPS library to use the +correct mapping, and ppdFindMarkedChoice to get the user-selected choice. +.LP +Raster filters should use option choices set through the raster page header, as +those reflect the options in effect for a given page. Options specified on the +command-line determine the default values for the entire job, which can be +overridden on a per-page basis. + +.SH LOG MESSAGES +Messages sent to stderr are generally logged to +printer-state-message attribute and the current \fIErrorLog\fR. +Each line begins with a standard prefix: + +.TP 5 +ALERT: message +.br +Sets the printer-state-message attribute and adds the specified +message to the current \fIErrorLog\fR using the "alert" log level. + +.TP 5 +ATTR: attribute=value [attribute=value] +.br +Sets the named job attribute(s). Typically this will be used to +set the job-remote-id attribute. + +.TP 5 +CRIT: message +.br +Sets the printer-state-message attribute and adds the specified +message to the current \fIErrorLog\fR using the "critical" log level. + +.TP 5 +DEBUG: message +.br +Sets the printer-state-message attribute and adds the specified +message to the current \fIErrorLog\fR using the "debug" log level. + +.TP 5 +DEBUG2: message +.br +Sets the printer-state-message attribute and adds the specified +message to the current \fIErrorLog\fR using the "debug2" log level. + +.TP 5 +EMERG: message +.br +Sets the printer-state-message attribute and adds the specified +message to the current \fIErrorLog\fR using the "emergency" log level. + +.TP 5 +ERROR: message +.br +Sets the printer-state-message attribute and adds the specified +message to the current \fIErrorLog\fR using the "error" log level. + +.TP 5 +INFO: message +.br +Sets the printer-state-message attribute. If the current \fILogLevel\fR +is set to "debug2", also adds the specified message to the +current \fIErrorLog\fR using the "info" log level. + +.TP 5 +NOTICE: message +.br +Sets the printer-state-message attribute and adds the specified +message to the current \fIErrorLog\fR using the "notice" log level. + +.TP 5 +PAGE: page-number #-copies +.TP 5 +PAGE: total #-pages +.br +Adds an entry to the current \fIPageLog\fR. The first form adds +#-copies to the job-media-sheets-completed attribute. The second +form sets the job-media-sheets-completed attribute to #-pages. + +.TP 5 +PPD: Keyword=Value ... KeywordN=Value +.br +Sets the named keywords in the printer's PPD file. This is typically +used to update default option keywords such as DefaultPageSize and +the various installable options in the PPD file. + +.TP 5 +STATE: printer-state-reason [printer-state-reason ...] +.TP 5 +STATE: + printer-state-reason [printer-state-reason ...] +.TP 5 +STATE: - printer-state-reason [printer-state-reason ...] +.br +Sets, adds, or removes printer-state-reason keywords to the +current queue. Typically this is used to indicate media, ink, and +toner conditions on a printer. + +.TP 5 +WARNING: message +.br +Sets the printer-state-message attribute and adds the specified +message to the current \fIErrorLog\fR using the "warning" log level. + +.SH ENVIRONMENT VARIABLES +The following environment variables are defined by the CUPS +server when executing the filter: + +.TP 5 +CHARSET +.br +The default text character set, typically utf-8. + +.TP 5 +CLASS +.br +When a job is submitted to a printer class, contains the name of +the destination printer class. Otherwise this environment +variable will not be set. + +.TP 5 +CONTENT_TYPE +.br +The MIME type associated with the file (e.g. +application/postscript). + +.TP 5 +CUPS_CACHEDIR +.br +The directory for semi-persistent cache files can be found. + +.TP 5 +CUPS_DATADIR +.br +The directory where data files can be found. + +.TP 5 +CUPS_FILETYPE +.br +The type of file being printed: "job-sheet" for a banner page and "document" +for a regular print file. + +.TP 5 +CUPS_SERVERROOT +.br +The root directory of the server. + +.TP 5 +DEVICE_URI +.br +The device-uri associated with the printer. + +.TP 5 +FINAL_CONTENT_TYPE +.br +The MIME type associated with the printer (e.g. +application/vnd.cups-postscript). + +.TP 5 +LANG +.br +The default language locale (typically C or en). + +.TP 5 +PATH +.br +The standard execution path for external programs that may be run by +the filter. + +.TP 5 +PPD +.br +The full pathname of the PostScript Printer Description (PPD) +file for this printer. + +.TP 5 +PRINTER +.br +The name of the printer. + +.TP 5 +RIP_CACHE +.br +The recommended amount of memory to use for Raster Image +Processors (RIPs). + +.TP 5 +SOFTWARE +.br +The name and version number of the server (typically CUPS/1.2). + +.TP 5 +TZ +.br +The timezone of the server. + +.TP 5 +USER +.br +The user executing the filter, typically "lp" or "root"; consult the +\fIcupsd.conf(5)\fR file for the current setting. + +.SH COMPATIBILITY +While the filter interface is compatible with System V interface +scripts, it will only work with the System V interface script as the +only filter. Typically the interface script will be provided via the +\fIlpadmin(8)\fR command using the \fI-i\fR option. +.SH SEE ALSO +\fIbackend(7)\fR, \fIcupsd(8)\fR, +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: filter.man 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man7/notifier.7 b/manual/cups/original/man7/notifier.7 new file mode 100644 index 00000000..498dfd59 --- /dev/null +++ b/manual/cups/original/man7/notifier.7 @@ -0,0 +1,157 @@ +.\" +.\" "$Id: notifier.man 8999 2010-02-24 01:01:04Z mike $" +.\" +.\" notifier man page for CUPS. +.\" +.\" Copyright 2007-2009 by Apple Inc. +.\" Copyright 1997-2007 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH notifier 7 "CUPS" "12 May 2009" "Apple Inc." +.SH NAME +notifier \- cups notification interface +.SH SYNOPSIS +.B notifier +.I recipient +[ +.I user-data +] +.SH DESCRIPTION +The CUPS notifier interface provides a standard method for adding support for +new event notification methods to CUPS. Each notifier delivers one or more IPP +events from the standard input to the specified recipient. +.LP +Notifiers \fBmust\fR read IPP messages from the standard input using the +ippNew and ippReadFile functions and exit on error. Notifiers are encouraged to +exit after a suitable period of inactivity, however they may exit after reading +the first message or stay running until an error is seen. +.SH LOG MESSAGES +Messages sent to stderr are generally logged to the current \fIErrorLog\fR. +Each line begins with a standard prefix: + +.TP 5 +ALERT: message +.br +Sets the printer-state-message attribute and adds the specified +message to the current \fIErrorLog\fR using the "alert" log level. + +.TP 5 +CRIT: message +.br +Sets the printer-state-message attribute and adds the specified +message to the current \fIErrorLog\fR using the "critical" log level. + +.TP 5 +DEBUG: message +.br +Sets the printer-state-message attribute and adds the specified +message to the current \fIErrorLog\fR using the "debug" log level. + +.TP 5 +DEBUG2: message +.br +Sets the printer-state-message attribute and adds the specified +message to the current \fIErrorLog\fR using the "debug2" log level. + +.TP 5 +EMERG: message +.br +Sets the printer-state-message attribute and adds the specified +message to the current \fIErrorLog\fR using the "emergency" log level. + +.TP 5 +ERROR: message +.br +Sets the printer-state-message attribute and adds the specified +message to the current \fIErrorLog\fR using the "error" log level. + +.TP 5 +INFO: message +.br +Sets the printer-state-message attribute. If the current \fILogLevel\fR +is set to "debug2", also adds the specified message to the +current \fIErrorLog\fR using the "info" log level. + +.TP 5 +NOTICE: message +.br +Sets the printer-state-message attribute and adds the specified +message to the current \fIErrorLog\fR using the "notice" log level. + +.TP 5 +WARNING: message +.br +Sets the printer-state-message attribute and adds the specified +message to the current \fIErrorLog\fR using the "warning" log level. + +.SH ENVIRONMENT VARIABLES +The following environment variables are defined by the CUPS server when +executing the notifier: + +.TP 5 +CHARSET +.br +The default text character set, typically utf-8. + +.TP 5 +CUPS_CACHEDIR +.br +The directory for semi-persistent cache files can be found. + +.TP 5 +CUPS_DATADIR +.br +The directory where data files can be found. + +.TP 5 +CUPS_FILETYPE +.br +The type of file being printed: "job-sheet" for a banner page and "document" +for a regular print file. + +.TP 5 +CUPS_SERVERROOT +.br +The root directory of the server. + +.TP 5 +LANG +.br +The default language locale (typically C or en). + +.TP 5 +PATH +.br +The standard execution path for external programs that may be run by +the filter. + +.TP 5 +SOFTWARE +.br +The name and version number of the server (typically CUPS/1.2). + +.TP 5 +TZ +.br +The timezone of the server. + +.TP 5 +USER +.br +The user executing the filter, typically "lp"; consult the \fIcupsd.conf(5)\fR +file for the current setting. + +.SH SEE ALSO +\fIbackend(7)\fR, \fIcupsd(8)\fR, \fIfilter(7)\fR, +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2009 by Apple Inc. +.\" +.\" End of "$Id: notifier.man 8999 2010-02-24 01:01:04Z mike $". +.\" diff --git a/manual/cups/original/man8/cups-deviced.8 b/manual/cups/original/man8/cups-deviced.8 new file mode 100644 index 00000000..7d004465 --- /dev/null +++ b/manual/cups/original/man8/cups-deviced.8 @@ -0,0 +1,44 @@ +.\" +.\" "$Id: cups-deviced.man.in 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" cups-deviced man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2006 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH cups-deviced 8 "CUPS" "16 June 2008" "Apple Inc." +.SH NAME +cups-deviced \- cups device daemon +.SH SYNOPSIS +.B cups-deviced +.I request-id limit user-id options +.SH DESCRIPTION +\fIcups-deviced\fR polls the backends in +\fI/usr/lib/cups/backend\fR for a list of available devices. +It is run by \fIcupsd(8)\fR in response to a +\fICUPS-Get-Devices\fR request. The output format is an IPP +response message. The \fIrequest-id\fR argument is the request ID +from the original IPP request, typically 1. The \fIlimit\fR +argument is the limit value from the original IPP request - 0 +means no limit. The \fIuser-id\fR argument is the +requesting-user-name value from the original IPP request. +Finally, the \fIoptions\fR argument is a space-delimited list of +attributes ("name=value name=value \...") that were passed in +with the request. Currently \fIcups-deviced\fR looks for the +\fIrequested-attributes\fR attribute and tailors the output +accordingly. +.SH SEE ALSO +backend(7), cupsd(8), cupsd.conf(5), +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: cups-deviced.man.in 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man8/cups-driverd.8 b/manual/cups/original/man8/cups-driverd.8 new file mode 100644 index 00000000..6c33a1c1 --- /dev/null +++ b/manual/cups/original/man8/cups-driverd.8 @@ -0,0 +1,122 @@ +.\" +.\" "$Id: cups-driverd.man.in 9419 2011-01-06 18:49:38Z mike $" +.\" +.\" cups-driverd man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2006 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH cups-driverd 8 "CUPS" "6 January 2011" "Apple Inc." +.SH NAME +cups-driverd \- cups driver daemon +.SH SYNOPSIS +.B cups-driverd +cat +.I ppd-name +.br +.B cups-driverd +list +.I request_id limit options +.SH DESCRIPTION +\fIcups-driverd\fR shows or lists PPD files. It is run in +response to CUPS-Add-Modify-Printer or CUPS-Get-Devices requests. +The first form ("cups-driverd cat ppd-name") writes the named PPD +file to stdout. The output format is an uncompressed PPD file. +.LP +The second form lists the available manufacturers or PPD files to +stdout as indicated by the \fIoptions\fR argument. The output +format is an IPP response message. The \fIrequest_id\fR argument +is the request ID from the original IPP request, typically 1. The +\fIlimit\fR argument is the limit value from the original IPP +request - 0 means no limit. Finally, the \fIoptions\fR argument +is a space-delimited list of attributes ("name=value name=value +\&...") that were passed in with the request. Currently +\fIcups-driverd\fR looks for the \fIppd-make\fR and +\fIrequested-attributes\fR attributes and tailors the output +accordingly. +.SH DRIVERS +Drivers can be static PPD files under the +\fI/usr/share/cups/model\fR directory or programs under the +\fI/usr/lib/cups/driver\fR directory. Static PPD files must +conform to the Adobe PPD File Format Specification version 4.3 +and may be compressed using the \fIgzip(1)\fR program. Driver +programs must implement the command-line interface shown in the +next section. +.SS DRIVER PROGRAMS +Driver programs provide a interface to dynamically-generated PPD +files. The following arguments are currently defined: +.TP 5 +drivername list +.br +Lists the supported PPD files to stdout. +.TP 5 +drivername cat ppdname +.br +Writes the named PPD file to stdout. +.PP +Driver programs MUST NOT query hardware or make other long-term operations that +would delay the return of a driver list. See the NOTES section below for +specific recommendations. +.SS LISTING FILES (drivername list) +When run with the single argument "list", the program must list +the available PPD files it can generate to stdout using the +following format: +.nf + "drivername:ppdname" language "make" "make and model" + "drivername:ppdname" language "make" "make and model" "1284 device id" + "drivername:ppdname" language "make" "make and model" "1284 device id" "(PPD product)" + "drivername:ppdname" language "make" "make and model" "1284 device id" "(PPD product)" "PostScript version" + "drivername:ppdname" language "make" "make and model" "1284 device id" "(PPD product)" "PostScript version" "type" +.fi +.LP +\fIDrivername\fR is the name of the driver program. \fIPpdname\fR +is the name used to select the given driver. \fILanguage\fR is +the locale associated with the default language of the PPD file, +typically "en". \fIMake\fR is the Manufacturer name from the PPD +file. \fIMake and model\fR is the NickName name from the PPD +file. \fI1284 device id\fR is the 1284DeviceId from the PPD file, +if any. \fI(PPD product)\fR is the Product string as it would appear in the PPD +file or from a PostScript query. \fIPostScript version\fR is the PSVersion +string as it would appear in the PPD file or from a PostScript query. \fIType\fR +is "postscript" for PostScript printers, "pdf" for PDF printers, "raster" for +raster printers, or "fax" for facsimile devices. +.SS WRITING FILES (drivername cat ppdname) +When the driver program is run with the "cat ppdname" arguments, +it must write the named PPD file to stdout, uncompressed. If the +named PPD file does not exist, the driver program must not write +any output to stdout and report the error to stderr instead. +.SS DRIVER ERROR MESSAGES +Error messages can be relayed back to \fIcupsd\fR by writing them +to stderr. The following prefixes are recognized: +.TP 5 +DEBUG: [drivername] +.br +Debugging messages +.TP 5 +ERROR: [drivername] +.br +Error messages +.TP 5 +INFO: [drivername] +.br +Informational messages +.SH NOTES +Due to performance considerations, driver programs have been officially +deprecated and should not be used for new development. Currently only the +CUPS web interface and \fIlpinfo(8)\fR command will request lists from all +driver programs. +.SH SEE ALSO +cupsd(8), cupsd.conf(5), cupstestppd(1), lpinfo(8), +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: cups-driverd.man.in 9419 2011-01-06 18:49:38Z mike $". +.\" diff --git a/manual/cups/original/man8/cups-lpd.8 b/manual/cups/original/man8/cups-lpd.8 new file mode 100644 index 00000000..d6b38a36 --- /dev/null +++ b/manual/cups/original/man8/cups-lpd.8 @@ -0,0 +1,124 @@ +.\" +.\" "$Id: cups-lpd.man.in 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" cups-lpd man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2006 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH cups-lpd 8 "CUPS" "4 August 2008" "Apple Inc." +.SH NAME +cups-lpd \- receive print jobs and report printer status to lpd clients +.SH SYNOPSIS +.B cups-lpd +[ -h +.I hostname[:port] +] [ -n ] [ -o +.I option=value +] +.SH DESCRIPTION +\fIcups-lpd\fR is the CUPS Line Printer Daemon ("LPD") +mini-server that supports legacy client systems that use the LPD +protocol. \fIcups-lpd\fR does not act as a standalone network +daemon but instead operates using the Internet "super-server" +\fIinetd(8)\fR or \fIxinetd(8)\fR. If you are using \fIinetd\fR, +add the following line to the \fIinetd.conf\fR file to enable the +\fIcups-lpd\fR mini-server: +.br +.nf + + printer stream tcp nowait lp /usr/lib/cups/daemon/cups-lpd cups-lpd \\ + -o document-format=application/octet-stream +.fi +.LP +.LP +\fBNote:\fR If you are using Solaris 10 or higher, you must run +the \fIinetdconv(1m)\fR program to register the changes to the +inetd.conf file. +.LP +If you are using the newer \fIxinetd(8)\fR daemon, create a file +named \fI/etc/xinetd.d/cups\fR containing the following lines: +.br +.nf + + service printer + { + socket_type = stream + protocol = tcp + wait = no + user = lp + group = sys + passenv = + server = /usr/lib/cups/daemon/cups-lpd + server_args = -o document-format=application/octet-stream + } +.fi +.SH OPTIONS +.TP 5 +-h hostname[:port] +.br +Sets the CUPS server (and port) to use. +.TP 5 +-n +.br +Disables reverse address lookups; normally \fIcups-lpd\fR will +try to discover the hostname of the client via a reverse DNS +lookup. +.TP 5 +-o name=value +.br +Inserts options for all print queues. Most often this is used to +disable the "l" filter so that remote print jobs are filtered as +needed for printing; the examples in the previous section set the +"document-format" option to "application/octet-stream" which +forces autodetection of the print file format. +.SH PERFORMANCE +\fIcups-lpd\fR performs well with small numbers of clients and +printers. However, since a new process is created for each +connection and since each process must query the printing system +before each job submission, it does not scale to larger +configurations. We highly recommend that large configurations +use the native IPP support provided by CUPS instead. +.SH SECURITY +\fIcups-lpd\fR currently does not perform any access control +based on the settings in \fIcupsd.conf(5)\fR or in the +\fIhosts.allow(5)\fR or \fIhosts.deny(5)\fR files used by TCP +wrappers. Therefore, running \fIcups-lpd\fR on your server will +allow any computer on your network (and perhaps the entire +Internet) to print to your server. +.LP +While \fIxinetd\fR has built-in access control support, you +should use the TCP wrappers package with \fIinetd\fR to limit +access to only those computers that should be able to print +through your server. +.LP +\fIcups-lpd\fR is not enabled by the standard CUPS distribution. +Please consult with your operating system vendor to determine +whether it is enabled on your system. +.SH COMPATIBILITY +\fIcups-lpd\fR does not enforce the restricted source port +number specified in RFC 1179, as using restricted ports does not +prevent users from submitting print jobs. While this behavior is +different than standard Berkeley LPD implementations, it should +not affect normal client operations. +.LP +The output of the status requests follows RFC 2569, Mapping +between LPD and IPP Protocols. Since many LPD implementations +stray from this definition, remote status reporting to LPD +clients may be unreliable. +.SH SEE ALSO +\fIcups(1)\fR, \fIcupsd(8)\fR, \fIinetconv(1m)\fR, +\fIinetd(8)\fR, \fIxinetd(8)\fR, +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: cups-lpd.man.in 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man8/cups-polld.8 b/manual/cups/original/man8/cups-polld.8 new file mode 100644 index 00000000..aee70687 --- /dev/null +++ b/manual/cups/original/man8/cups-polld.8 @@ -0,0 +1,38 @@ +.\" +.\" "$Id: cups-polld.man 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" cups-polld man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2006 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH cups-polld 8 "CUPS" "12 February 2006" "Apple Inc." +.SH NAME +cups-polld \- cups printer polling daemon +.SH SYNOPSIS +.B cups-polld +.I address ipp-port interval browse-port +.SH DESCRIPTION +\fIcups-polld\fR polls remote servers for a list of available +printers and printer classes every \fIinterval\fR seconds. +Printer and class information is then broadcast to the localhost +interface (127.0.0.1) on the specified browse port for reception +by \fIcupsd(8)\fR. +.PP +This program is started automatically by \fIcupsd\fR for every +\fIBrowsePoll\fR directive found in the \fIcupsd.conf(5)\fR file. +.SH SEE ALSO +\fIcupsd(8)\fR, \fIcupsd.conf(5)\fR, +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: cups-polld.man 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man8/cupsaccept.8 b/manual/cups/original/man8/cupsaccept.8 new file mode 100644 index 00000000..7c53d862 --- /dev/null +++ b/manual/cups/original/man8/cupsaccept.8 @@ -0,0 +1,79 @@ +.\" +.\" "$Id: cupsaccept.man 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" accept/reject man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2006 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH cupsaccept 8 "CUPS" "12 February 2006" "Apple Inc." +.SH NAME +cupsaccept/cupsreject \- accept/reject jobs sent to a destination +.SH SYNOPSIS +.B cupsaccept +[ -E ] [ -U +.I username +] [ -h +.I hostname[:port] +] destination(s) +.br +.B cupsreject +[ -E ] [ -U +.I username +] [ -h +.I hostname[:port] +] [ -r +.I reason +] destination(s) +.SH DESCRIPTION +\fIcupsaccept\fR instructs the printing system to accept print jobs to the +specified destinations. +.LP +\fIcupsreject\fR instructs the printing system to reject print jobs to the +specified destinations. The \fI-r\fR option sets the reason for rejecting +print jobs. If not specified the reason defaults to "Reason Unknown". +.SH OPTIONS +The following options are supported by both \fIcupsaccept\fR and +\fIcupsreject\fR: +.TP 5 +-E +.br +Forces encryption when connecting to the server. +.TP 5 +-U username +.br +Sets the username that is sent when connecting to the server. +.TP 5 +-h hostname[:port] +.br +Chooses an alternate server. +.TP 5 +-r "reason" +.br +Sets the reason string that is shown for a printer that is +rejecting jobs. +.SH COMPATIBILITY +Unlike the System V printing system, CUPS allows printer names to +contain any printable character except SPACE, TAB, "/", or "#". +Also, printer and class names are \fInot\fR case-sensitive. +.LP +The CUPS versions of \fIaccept\fR and \fIreject\fR may ask the +user for an access password depending on the printing system +configuration. This differs from the System V versions which +require the root user to execute these commands. +.SH SEE ALSO +\fIcancel(1)\fR, \fIcupsenable(8)\fR, \fIlp(1)\fR, +\fIlpadmin(8)\fR, \fIlpstat(1)\fR, +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: cupsaccept.man 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man8/cupsaddsmb.8 b/manual/cups/original/man8/cupsaddsmb.8 new file mode 100644 index 00000000..42ee4b02 --- /dev/null +++ b/manual/cups/original/man8/cupsaddsmb.8 @@ -0,0 +1,214 @@ +.\" +.\" "$Id: cupsaddsmb.man.in 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" cupsaddsmb man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2006 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH cupsaddsmb 8 "CUPS" "25 July 2007" "Apple Inc." +.SH NAME +cupsaddsmb \- export printers to samba for windows clients + +.SH SYNOPSIS +.B cupsaddsmb +[ -H +.I samba-server +] [ -U +.I samba-user[%samba-password] +] [ -h +.I cups-server[:port] +] [ -v ] -a +.br +.B cupsaddsmb +[ -H +.I samba-server +] [ -U +.I samba-user[%samba-password] +] [ -h +.I cups-server[:port] +] [ -v ] printer [ ... printer ] + +.SH DESCRIPTION +\fIcupsaddsmb\fR exports printers to the SAMBA software (version +2.2.0 or higher) for use with Windows clients. Depending on the +SAMBA configuration, you may need to provide a password to +export the printers. This program requires the Windows printer +driver files described below. + +.SH OPTIONS +\fIcupsaddsmb\fR supports the following options: +.TP 5 +-H samba-server +.br +Specifies the SAMBA server which defaults to the CUPS server. +.TP 5 +-U samba-user[%samba-password] +.br +Specifies the SAMBA print admin username which defaults to your +current username. If the username contains a percent (%) +character, then the text following the percent is treated as the +SAMBA password to use. +.TP 5 +-a +.br +Exports all known printers. Otherwise only the named printers are +exported. +.TP 5 +-h cups-server[:port] +.br +Specifies a different CUPS server to use. +.TP 5 +-v +.br +Specifies that verbose information should be shown. This is +useful for debugging SAMBA configuration problems. + +.SH SAMBA CONFIGURATION +\fIcupsaddsmb\fR uses the new RPC-based printing support in +SAMBA 2.2.x to provide printer drivers and PPD files to Windows +client machines. In order to use this functionality, you must +first configure the SAMBA \fIsmb.conf(5)\fR file to support +printing through CUPS and provide a printer driver download +share, as follows: +.nf + + [global] + load printers = yes + printing = cups + printcap name = cups + + [printers] + comment = All Printers + path = /var/spool/samba + browseable = no + public = yes + guest ok = yes + writable = no + printable = yes + + [print$] + comment = Printer Drivers + path = /etc/samba/drivers + browseable = yes + guest ok = no + read only = yes + write list = root +.fi +.LP +This configuration assumes a FHS-compliant installation of +SAMBA; adjust the [printers] and [print$] share paths +accordingly on your system as needed. + +.SH MICROSOFT POSTSCRIPT DRIVERS FOR WINDOWS +The base driver for Windows 2000 and higher is the Microsoft +PostScript driver, which is available on any system running +Windows 2000 or higher in the +%WINDIR%\\SYSTEM32\\SPOOL\\DRIVERS\\W32X86\\3 folder for 32-bit +drivers and +%WINDIR%\\SYSTEM32\\SPOOL\\DRIVERS\\X64\\3 folder for 64-bit +drivers. +.LP +The CUPS printer driver is preferred over the Microsoft driver +since it supports the page-label, job-billing, and +job-hold-until options fully on all printers. However, currently +only Windows 2000 and higher is supported by the Microsoft +driver, so you will also need to get the Adobe driver to support +Windows 95, 98, and Me clients. The Adobe and Microsoft drivers +for Windows 2000 are identical. +.LP +Once you have extracted the driver files, copy the 32-bit drivers +to the \fI/usr/share/cups/drivers\fR directory and the 64-bit +drivers to the \fI/usr/share/cups/drivers/x64\fR directory exactly +as named below: +.nf + + [Windows 2000 and higher] + ps5ui.dll + pscript.hlp + pscript.ntf + pscript5.dll +.fi +.LP +\fBNote:\fR Unlike Windows, case is significant - make sure that +you use the lowercase filenames shown above, otherwise +\fIcupsaddsmb\fR will fail to export the drivers. + +.SH CUPS POSTSCRIPT DRIVERS FOR WINDOWS +\fIcupsaddsmb\fR can use the CUPS v6 PostScript printer driver +for Windows, which is available for download from the CUPS web +site. +.LP +The CUPS printer driver is preferred over the Adobe and +Microsoft drivers since it supports the page-label, job-billing, +and job-hold-until options fully on all printers. However, +currently only Windows 2000 and higher is supported by the CUPS +driver, so you will also need to get the Adobe driver to support +Windows 95, 98, and Me clients. +.LP +Once you have extracted the driver files, copy the 32-bit drivers +to the \fI/usr/share/cups/drivers\fR directory and the 64-bit +drivers to the \fI/usr/share/cups/drivers/x64\fR directory exactly +as named below: +.nf + + [Windows 2000 and higher] + cups6.inf (from www.cups.org) + cups6.ini (from www.cups.org) + cupsps6.dll (from www.cups.org) + cupsui6.dll (from www.cups.org) + ps5ui.dll (from your Windows system) + pscript.hlp (from your Windows system) + pscript.ntf (from your Windows system) + pscript5.dll (from your Windows system) +.fi +.LP +\fBNote:\fR Unlike Windows, case is significant - make sure that +you use the lowercase filenames shown above, otherwise +\fIcupsaddsmb\fR will fail to export the drivers. + +.SH ADOBE POSTSCRIPT DRIVERS FOR WINDOWS 95, 98, AND ME +\fIcupsaddsmb\fR can use the Adobe PostScript printer driver for +Windows 95, 98, and ME, which are available for download from the +Adobe web site (http://www.adobe.com). +.LP +The Adobe driver does not support the page-label, job-billing, or +job-hold-until options. +.LP +Once you have installed the driver on a Windows system, copy the +following files to the \fI/usr/share/cups/drivers\fR directory +exactly as named below: +.nf + + [Windows 95, 98, and Me] + ADFONTS.MFM + ADOBEPS4.DRV + ADOBEPS4.HLP + ICONLIB.DLL + PSMON.DLL +.fi +.LP +\fBNote:\fR Unlike Windows, case is significant - make sure that +you use the UPPERCASE filenames shown above, otherwise +\fIcupsaddsmb\fR will fail to export the drivers. + +.SH KNOWN ISSUES +Getting the full set of Windows driver files should be easier. + +.SH SEE ALSO +\fIsmbd(8)\fR, \fIsmb.conf(5)\fR, +http://localhost:631/help +.br +http://www.cups.org/windows/ + +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: cupsaddsmb.man.in 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man8/cupsctl.8 b/manual/cups/original/man8/cupsctl.8 new file mode 100644 index 00000000..411ada83 --- /dev/null +++ b/manual/cups/original/man8/cupsctl.8 @@ -0,0 +1,107 @@ +.\" +.\" "$Id: cupsctl.man 9457 2011-01-11 03:04:04Z mike $" +.\" +.\" cupsctl man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 2007 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH cupsctl 8 "CUPS" "10 January 2011" "Apple Inc." +.SH NAME +cupsctl \- configure cupsd.conf options +.SH SYNOPSIS +.B cupsctl +[ -E ] [-U +.I username +] [ -h +.I server[:port] +] [ --[no-]debug-logging ] [ --[no-]remote-admin ] [ --[no-]remote-any ] +[ --[no-]remote-printers ] [ --[no-]share-printers ] [ --[no-]user-cancel-any ] +[ +.I name=value +] +.SH DESCRIPTION +\fIcupsctl\fR updates or queries the \fBcupsd.conf\fR file for a server. When +no changes are requested, the current configuration values are written to the +standard output in the format "name=value", one per line. +.SH OPTIONS +The following options are recognized: +.TP 5 +-E +.br +Enables encryption on the connection to the scheduler. +.TP 5 +-U \fIusername\fR +.br +Specifies an alternate username to use when authenticating with the scheduler. +.TP 5 +-h \fIserver[:port]\fR +.br +Specifies the server address. +.TP 5 +--[no-]debug-logging +.br +Enables or disables debug logging in the \fBerror_log\fR file. +.TP 5 +--[no-]remote-admin +.br +Enables or disables remote administration. +.TP 5 +--[no-]remote-any +.br +Enables or disables printing from any address, e.g. the Internet. +.TP 5 +--[no-]remote-printers +.br +Enables or disables the display of remote printers shared via the CUPS, LDAP, +or SLP protocols. +.TP 5 +--[no-]share-printers +.br +Enables or disables sharing of local printers with other computers. +.TP 5 +--[no-]user-cancel-any +.br +Allows or prevents users from canceling jobs owned by others. +.SH EXAMPLES +Display the current settings: +.nf + cupsctl +.fi +.LP +Enable debug logging: +.nf + cupsctl --debug-logging +.fi +.LP +Get the current debug logging state: +.nf + cupsctl | grep '^_debug_logging' | awk -F= '{print $2}' +.fi +.LP +Disable printer sharing: +.nf + cupsctl --no-shared-printers +.fi +.LP +Enable printing using the file: pseudo-device: +.nf + cupsctl FileDevice=Yes +.fi +.SH KNOWN ISSUES +You cannot set the Listen or Port directives using \fIcupsctl\fR. +.SH SEE ALSO +\fIcupsd.conf(5)\fR, \fIcupsd(8)\fR, +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: cupsctl.man 9457 2011-01-11 03:04:04Z mike $". +.\" diff --git a/manual/cups/original/man8/cupsd.8 b/manual/cups/original/man8/cupsd.8 new file mode 100644 index 00000000..a06eca10 --- /dev/null +++ b/manual/cups/original/man8/cupsd.8 @@ -0,0 +1,72 @@ +.\" +.\" "$Id: cupsd.man.in 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" cupsd man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2006 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH cupsd 8 "CUPS" "9 March 2009" "Apple Inc." +.SH NAME +cupsd \- cups scheduler +.SH SYNOPSIS +.B cupsd +[ -c +.I config-file +] [ -f ] [ -F ] [ -h ] [ -l ] [ -t ] +.SH DESCRIPTION +\fIcupsd\fR is the scheduler for CUPS. It implements a printing system based +upon the Internet Printing Protocol, version 2.1. If no options are specified +on the command-line then the default configuration file +\fI/etc/cups/cupsd.conf\fR will be used. +.SH OPTIONS +.TP 5 +-c config-file +.br +Uses the named configuration file. +.TP 5 +-f +.br +Run \fIcupsd\fR in the foreground; the default is to run in the +background as a "daemon". +.TP 5 +-F +.br +Run \fIcupsd\fR in the foreground but detach the process from the +controlling terminal and current directory. This is useful for +running \fIcupsd\fR from \fIinit(8)\fR. +.TP 5 +-h +.br +Shows the program usage. +.TP 5 +-l +.br +This option is passed to \fIcupsd\fR when it is run from +\fIlaunchd(8)\fR. +.TP 5 +-t +.br +Test the configuration file for syntax errors. +.SH COMPATIBILITY +\fIcupsd\fR implements all of the required IPP/2.1 attributes and +operations. It also implements several CUPS-specific administration +operations. +.SH SEE ALSO +\fIbackend(7)\fR, \fIclasses.conf(5)\fR, \fIcups-deviced(8)\fR, +\fIcups-driverd(8)\fR, \fIcups-lpd(8)\fR, \fIcups-polld(8)\fR, +\fIcupsd.conf(5)\fR, \fIfilter(7)\fR, \fIlaunchd(8)\fR, +\fImime.convs(5)\fR, \fImime.types(5)\fR, \fIprinters.conf(5)\fR, +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: cupsd.man.in 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man8/cupsenable.8 b/manual/cups/original/man8/cupsenable.8 new file mode 100644 index 00000000..0552f427 --- /dev/null +++ b/manual/cups/original/man8/cupsenable.8 @@ -0,0 +1,93 @@ +.\" +.\" "$Id: cupsenable.man 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" cupsenable/cupsdisable man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2006 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH cupsenable 8 "CUPS" "9 October 2008" "Apple Inc." +.SH NAME +cupsdisable, cupsenable \- stop/start printers and classes +.SH SYNOPSIS +.B cupsdisable +[ -E ] [-U +.I username +] [ -c ] [ -h +.I server[:port] +] [ -r +.I reason +] [ --hold ] destination(s) +.br +.B cupsenable +[ -E ] [-U +.I username +] [ -c ] [ -h +.I server[:port] +] [ --release ] destination(s) +.SH DESCRIPTION +\fIcupsenable\fR starts the named printers or classes. +.LP +\fIcupsdisable\fR stops the named printers or classes. The +following options may be used: +.TP 5 +-E +.br +Forces encryption of the connection to the server. +.TP 5 +-U username +.br +Uses the specified username when connecting to the server. +.TP 5 +-c +.br +Cancels all jobs on the named destination. +.TP 5 +-h server[:port] +.br +Uses the specified server and port. +.TP 5 +--hold +.br +Holds remaining jobs on the named printer. Useful for allowing the current +job to complete before performing maintenance. +.TP 5 +-r "reason" +.br +Sets the message associated with the stopped state. If no reason is specified +then the message is set to "Reason Unknown". +.TP 5 +--release +.br +Releases pending jobs for printing. Use after running \fIcupsdisable\fR with +the \fI--hold\fR option to resume printing. +.SH COMPATIBILITY +Unlike the System V printing system, CUPS allows printer names to +contain any printable character except SPACE, TAB, "/", or "#". +Also, printer and class names are \fInot\fR case-sensitive. +.LP +The System V versions of these commands are \fIdisable\fR and +\fIenable\fR. They have been renamed to avoid conflicts with the +\fIbash(1)\fR build-in commands of the same name. +.LP +The CUPS versions of \fIdisable\fR and \fIenable\fR may ask the +user for an access password depending on the printing system +configuration. This differs from the System V versions which +require the root user to execute these commands. +.SH SEE ALSO +\fIcupsaccept(8)\fR, \fIcupsreject(8)\fR, \fIcancel(1)\fR, \fIlp(1)\fR, +\fIlpadmin(8)\fR, \fIlpstat(1)\fR, +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. + +.\" +.\" End of "$Id: cupsenable.man 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man8/cupsfilter.8 b/manual/cups/original/man8/cupsfilter.8 new file mode 100644 index 00000000..7aa9c83e --- /dev/null +++ b/manual/cups/original/man8/cupsfilter.8 @@ -0,0 +1,91 @@ +.\" +.\" "$Id: cupsfilter.man 9030 2010-03-05 03:55:56Z mike $" +.\" +.\" cupsfilter man page for CUPS. +.\" +.\" Copyright 2007-2010 by Apple Inc. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH cupsfilter 8 "CUPS" "4 March 2010" "Apple Inc." +.SH NAME +cupsfilter \- convert a file to another format using cups filters +.SH SYNOPSIS +.B cupsfilter +[ -c +.I config-file +] [ -d +.I printer +] [ -e ] -j +.I job-id[,N] +[ -m +.I mime/type +] [ -n +.I copies +] [ -o +.I name=value +] [ -p +.I filename.ppd +] [ -t +.I title +] +.I filename +.SH DESCRIPTION +\fIcupsfilter\fR is a front-end to the CUPS filter subsystem which allows you +to convert a file to a specific format, just as if you had printed the file +through CUPS. By default, \fIcupsfilter\fR generates a PDF file. +.SH OPTIONS +.TP 5 +-c config-file +.br +Uses the named cupsd.conf configuration file. +.TP 5 +-d printer +Uses information from the named printer. +.TP 5 +-e +.br +Use every filter from the PPD file. +.TP 5 +-j job-id[,N] +.br +Converts document N from the specified job. If N is omitted, document 1 is +converted. +.TP 5 +-m mime/type +.br +Specifies the destination file type. The default file type is application/pdf. +Use printer/foo to convert to the printer format defined by the filters in the +PPD file. +.TP 5 +-n copies +.br +Specifies the number of copies to generate. +.TP 5 +-o name=value +.br +Specifies options to pass to the CUPS filters. +.TP 5 +-p filename.ppd +.br +Specifies the PPD file to use. +.TP 5 +-t title +.br +Specifies the document title. +.SH KNOWN ISSUES +\fIcupsfilter\fR currently does not use the filters defined in the PPD file. +This will be addressed in a future CUPS release. +.SH SEE ALSO +\fIcupsd.conf(5)\fR +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2010 by Apple Inc. +.\" +.\" End of "$Id: cupsfilter.man 9030 2010-03-05 03:55:56Z mike $". +.\" diff --git a/manual/cups/original/man8/lpadmin.8 b/manual/cups/original/man8/lpadmin.8 new file mode 100644 index 00000000..c388f03b --- /dev/null +++ b/manual/cups/original/man8/lpadmin.8 @@ -0,0 +1,228 @@ +.\" +.\" "$Id: lpadmin.man 9762 2011-05-11 05:30:50Z mike $" +.\" +.\" lpadmin man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2006 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH lpadmin 8 "CUPS" "10 May 2011" "Apple Inc." +.SH NAME +lpadmin \- configure cups printers and classes +.SH SYNOPSIS +.B lpadmin +[ -E ] [-U +.I username +] [ -h +.I server[:port] +] -d +.I destination +.br +.B lpadmin +[ -E ] [-U +.I username +] [ -h +.I server[:port] +] -p +.I destination +[ -R +.I name-default +] +.I option(s) +.br +.B lpadmin +[ -E ] [-U +.I username +] [ -h +.I server[:port] +] -x +.I destination +.SH DESCRIPTION +\fIlpadmin\fR configures printer and class queues provided by +CUPS. It can also be used to set the server default printer or +class. +.LP +When specified before the \fI-d\fR, \fI-p\fR, or \fI-x\fR +options, the \fI-E\fR option forces encryption when connecting to +the server. +.LP +The first form of the command (\fI-d\fR) sets the default printer +or class to \fIdestination\fR. Subsequent print jobs submitted +via the \fIlp(1)\fR or \fIlpr(1)\fR commands will use this +destination unless the user specifies otherwise with the +\fIlpoptions(1)\fR command. +.LP +The second form of the command (\fI-p\fR) configures the named +printer or class. The additional options are described below. +.LP +The third form of the command (\fI-x\fR) deletes the printer or +class \fIdestination\fR. Any jobs that are pending for the +destination will be removed and any job that is currently printed +will be aborted. +.SH CONFIGURATION OPTIONS +The following options are recognized when configuring a printer +queue: +.TP 5 +-c class +.br +Adds the named \fIprinter\fR to \fIclass\fR. If \fIclass\fR does +not exist it is created automatically. +.TP 5 +-i interface +.br +Sets a System V style interface script for the printer. This +option cannot be specified with the \fI-P\fR option (PPD file) +and is intended for providing support for legacy printer drivers. +.TP 5 +-m model +.br +Sets a standard System V interface script or PPD file for the printer from the +\fImodel\fR directory or using one of the driver interfaces. Use the \fI-m\fR +option with the \fIlpinfo(8)\fR command to get a list of supported models. +.TP 5 +-o cupsIPPSupplies=true +.TP 5 +-o cupsIPPSupplies=false +.br +Specifies whether IPP supply level values should be reported. +.TP 5 +-o cupsSNMPSupplies=true +.TP 5 +-o cupsSNMPSupplies=false +.br +Specifies whether SNMP supply level (RFC 3805) values should be reported. +.TP 5 +-o job-k-limit=value +.br +Sets the kilobyte limit for per-user quotas. The value is an +integer number of kilobytes; one kilobyte is 1024 bytes. +.TP 5 +-o job-page-limit=value +.br +Sets the page limit for per-user quotas. The value is the integer +number of pages that can be printed; double-sided pages are +counted as two pages. +.TP 5 +-o job-quota-period=value +.br +Sets the accounting period for per-user quotas. The value is an +integer number of seconds; 86,400 seconds are in one day. +.TP 5 +-o job-sheets-default=banner +.TP 5 +-o job-sheets-default=banner,banner +.br +Sets the default banner page(s) to use for print jobs. +.TP 5 +-o name=value +.br +Sets a PPD option for the printer. PPD options can be listed using the \fI-l\fR +option with the \fIlpoptions(1)\fR command. +.TP 5 +-o name-default=value +.br +Sets a default server-side option for the destination. Any print-time +option can be defaulted, e.g. "-o cpi-default=17" to set the default +"cpi" option value to 17. +.TP 5 +-o port-monitor=name +.br +Sets the binary communications program to use when printing, +"none", "bcp", or "tbcp". The default program is "none". The +specified port monitor must be listed in the printer's PPD file. +.TP 5 +-o printer-error-policy=name +.br +Sets the error policy to be used when the printer backend is +unable to send the job to the printer. The name must be one of +"abort-job", "retry-job", "retry-current-job", or "stop-printer". The default +error policy is "stop-printer" for printers and "retry-current-job" for +classes. +.TP 5 +-o printer-is-shared=true/false +.br +Sets the destination to shared/published or unshared/unpublished. +Shared/published destinations are publicly announced by the server +on the LAN based on the browsing configuration in +\fBcupsd.conf\fR, while unshared/unpublished destinations are not +announced. The default value is "true". +.TP 5 +-o printer-op-policy=name +.br +Sets the IPP operation policy associated with the destination. The +name must be defined in the \fBcupsd.conf\fR in a Policy section. +The default operation policy is "default". +.TP 5 +-R name-default +.br +Deletes the named option from \fIprinter\fR. +.TP 5 +-r class +.br +Removes the named \fIprinter\fR from \fIclass\fR. If the +resulting class becomes empty it is removed. +.TP 5 +-u allow:user,user,@group +.TP 5 +-u deny:user,user,@group +.TP 5 +-u allow:all +.TP 5 +-u deny:none +.br +Sets user-level access control on a destination. Names starting with +"@" are interpreted as UNIX groups. The latter two forms turn +user-level access control off. +.TP 5 +-v "device-uri" +.br +Sets the \fIdevice-uri\fR attribute of the printer queue. If +\fIdevice-uri\fR is a filename it is automatically converted to +the form \fIfile:///file/name\fR. Use the \fI-v\fR option with the +\fIlpinfo(8)\fR command to get a list of supported device URIs and schemes. +.TP 5 +-D "info" +.br +Provides a textual description of the destination. +.TP 5 +-E +.br +Enables the destination and accepts jobs; this is the same as running the +\fIcupsaccept(8)\fR and \fIcupsenable(8)\fR programs on the destination. +.TP 5 +-L "location" +.br +Provides a textual location of the destination. +.TP 5 +-P ppd-file +.br +Specifies a PostScript Printer Description file to use with the +printer. If specified, this option overrides the \fI-i\fR option +(interface script). +.SH COMPATIBILITY +Unlike the System V printing system, CUPS allows printer names to +contain any printable character except SPACE, TAB, "/", or "#". +Also, printer and class names are \fInot\fR case-sensitive. +Finally, the CUPS version of \fIlpadmin\fR may ask the user for +an access password depending on the printing system +configuration. This differs from the System V version which +requires the root user to execute this command. +.SH LIMITATIONS +The CUPS version of \fIlpadmin\fR does not support all of the +System V or Solaris printing system configuration options. +.SH SEE ALSO +\fIcupsaccept(8)\fR, \fIcupsenable(8)\fR, \fIlpinfo(8)\fR, +\fIlpoptions(1)\fR, +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: lpadmin.man 9762 2011-05-11 05:30:50Z mike $". +.\" diff --git a/manual/cups/original/man8/lpinfo.8 b/manual/cups/original/man8/lpinfo.8 new file mode 100644 index 00000000..42bda480 --- /dev/null +++ b/manual/cups/original/man8/lpinfo.8 @@ -0,0 +1,115 @@ +.\" +.\" "$Id: lpinfo.man 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" lpinfo man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2006 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH lpinfo 8 "CUPS" "5 December 2008" "Apple Inc." +.SH NAME +lpinfo \- show available devices or drivers +.SH SYNOPSIS +.B lpinfo +[ -E ] [ -U +.I username +] [ -h +.I server[:port] +] [ -l ] [ --device-id +.I device-id-string +] [ --exclude-schemes +.I scheme-list +] [ --include-schemes +.I scheme-list +] [ --language +.I locale +] [ --make-and-model +.I name +] [ --product +.I name +] -m +.br +.B lpinfo +[ -E ] [ -U +.I username +] [ -h +.I server[:port] +] [ -l ] [ --exclude-schemes +.I scheme-list +] [ --include-schemes +.I scheme-list +] [ --timeout +.I seconds +] -v +.SH DESCRIPTION +\fIlpinfo\fR lists the available devices or drivers known to the +CUPS server. The first form (\fI-m\fR) lists the available +drivers, while the second form (\fI-v\fR) lists the available +devices. +.SH OPTIONS +\fIlpinfo\fR accepts the following options: +.TP 5 +-E +.br +Forces encryption when connecting to the server. +.TP 5 +-U username +.br +Sets the username to use when connecting to the server. +.TP 5 +-h server[:port] +.br +Selects an alternate server. +.TP 5 +-l +.br +Shows a "long" listing of devices or drivers. +.TP 5 +--device-id device-id-string +.br +Specifies the IEEE-1284 device ID to match when listing drivers with the +\fI-m\fR option. +.TP 5 +--exclude-schemes scheme-list +.br +Specifies a comma-separated list of device or PPD schemes that should be +excluded from the results. Static PPD files use the "file" scheme. +.TP 5 +--include-schemes scheme-list +.br +Specifies a comma-separated list of device or PPD schemes that should be +included in the results. Static PPD files use the "file" scheme. +.TP 5 +--language locale +.br +Specifies the language to match when listing drivers with the \fI-m\fR option. +.TP 5 +--make-and-model name +.br +Specifies the make and model to match when listing drivers with the \fI-m\fR +option. +.TP 5 +--product name +.br +Specifies the product to match when listing drivers with the \fI-m\fR option. +.TP 5 +--timeout seconds +.br +Specifies the timeout when listing devices with the \fI-v\fR option. +.SH COMPATIBILITY +The \fIlpinfo\fR command is unique to CUPS. +.SH SEE ALSO +\fIlpadmin(8)\fR, +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: lpinfo.man 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/original/man8/lpmove.8 b/manual/cups/original/man8/lpmove.8 new file mode 100644 index 00000000..b5688f41 --- /dev/null +++ b/manual/cups/original/man8/lpmove.8 @@ -0,0 +1,66 @@ +.\" +.\" "$Id: lpmove.man 9771 2011-05-12 05:21:56Z mike $" +.\" +.\" lpmove man page for CUPS. +.\" +.\" Copyright 2007-2011 by Apple Inc. +.\" Copyright 1997-2006 by Easy Software Products. +.\" +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" +.TH lpmove 8 "CUPS" "12 February 2006" "Apple Inc." +.SH NAME +lpmove \- move a job or all jobs to a new destination +.SH SYNOPSIS +.B lpmove +[ -E ] [ -h +.I server[:port] +] [ -U +.I username +] +.I job destination +.br +.B lpmove +[ -E ] [ -h +.I server[:port] +] [ -U +.I username +] +.I source destination +.SH DESCRIPTION +\fBlpmove\fR moves the specified \fIjob\fR or all jobs from +\fIsource\fR to \fIdestination\fR. \fIjob\fR can be the job ID +number or the old destination and job ID: +.br +.nf + + lpmove 123 newprinter + lpmove oldprinter-123 newprinter +.fi +.SH OPTIONS +The \fIlpmove\fR command supports the following options: +.TP 5 +-E +.br +Forces encryption when connecting to the server. +.TP 5 +-U username +.br +Specifies an alternate username. +.TP 5 +-h server[:port] +.br +Specifies an alternate server. +.SH SEE ALSO +\fIcancel(1)\fR, \fIlp(1)\fR, +.br +http://localhost:631/help +.SH COPYRIGHT +Copyright 2007-2011 by Apple Inc. +.\" +.\" End of "$Id: lpmove.man 9771 2011-05-12 05:21:56Z mike $". +.\" diff --git a/manual/cups/translation_list b/manual/cups/translation_list index addd11c0..a87271ce 100644 --- a/manual/cups/translation_list +++ b/manual/cups/translation_list @@ -1,7 +1,45 @@ ●:cups:1.5.3:0000/00/00:cancel:1:2012/06/10::cyoichi@maple.ocn.ne.jp:Chonan Yoichi: +×:cups:1.5.3:0000/00/00:cups-config:1::::: +×:cups:1.5.3:0000/00/00:cupstestdsc:1::::: +×:cups:1.5.3:0000/00/00:cupstestppd:1::::: +×:cups:1.5.3:0000/00/00:ipptool:1::::: ●:cups:1.5.3:0000/00/00:lp:1:2012/06/06::cyoichi@maple.ocn.ne.jp:Chonan Yoichi: +×:cups:1.5.3:0000/00/00:lpoptions:1::::: +×:cups:1.5.3:0000/00/00:lppasswd:1::::: ●:cups:1.5.3:0000/00/00:lpq:1:2012/06/09::cyoichi@maple.ocn.ne.jp:Chonan Yoichi: ●:cups:1.5.3:0000/00/00:lpr:1:2012/06/06::cyoichi@maple.ocn.ne.jp:Chonan Yoichi: ●:cups:1.5.3:0000/00/00:lprm:1:2012/06/10::cyoichi@maple.ocn.ne.jp:Chonan Yoichi: ●:cups:1.5.3:0000/00/00:lpstat:1:2012/06/09::cyoichi@maple.ocn.ne.jp:Chonan Yoichi: +×:cups:1.5.3:0000/00/00:ppdc:1::::: +×:cups:1.5.3:0000/00/00:ppdhtml:1::::: +×:cups:1.5.3:0000/00/00:ppdi:1::::: +×:cups:1.5.3:0000/00/00:ppdmerge:1::::: +×:cups:1.5.3:0000/00/00:ppdpo:1::::: +×:cups:1.5.3:0000/00/00:classes.conf:5::::: +×:cups:1.5.3:0000/00/00:client.conf:5::::: +×:cups:1.5.3:0000/00/00:cups-snmp.conf:5::::: +×:cups:1.5.3:0000/00/00:cupsd.conf:5::::: +×:cups:1.5.3:0000/00/00:ipptoolfile:5::::: +×:cups:1.5.3:0000/00/00:mailto.conf:5::::: +×:cups:1.5.3:0000/00/00:mime.convs:5::::: +×:cups:1.5.3:0000/00/00:mime.types:5::::: +×:cups:1.5.3:0000/00/00:ppdcfile:5::::: +×:cups:1.5.3:0000/00/00:printers.conf:5::::: +×:cups:1.5.3:0000/00/00:subscriptions.conf:5::::: +×:cups:1.5.3:0000/00/00:backend:7::::: +×:cups:1.5.3:0000/00/00:filter:7::::: +×:cups:1.5.3:0000/00/00:notifier:7::::: +×:cups:1.5.3:0000/00/00:cups-deviced:8::::: +×:cups:1.5.3:0000/00/00:cups-driverd:8::::: +×:cups:1.5.3:0000/00/00:cups-lpd:8::::: +×:cups:1.5.3:0000/00/00:cups-polld:8::::: +×:cups:1.5.3:0000/00/00:cupsaccept:8::::: +×:cups:1.5.3:0000/00/00:cupsaddsmb:8::::: +×:cups:1.5.3:0000/00/00:cupsctl:8::::: +×:cups:1.5.3:0000/00/00:cupsd:8::::: +×:cups:1.5.3:0000/00/00:cupsenable:8::::: +×:cups:1.5.3:0000/00/00:cupsfilter:8::::: +×:cups:1.5.3:0000/00/00:lpadmin:8::::: ●:cups:1.5.3:0000/00/00:lpc:8:2012/06/15::cyoichi@maple.ocn.ne.jp:Chonan Yoichi: +×:cups:1.5.3:0000/00/00:lpinfo:8::::: +×:cups:1.5.3:0000/00/00:lpmove:8:::::