]> git.ipfire.org Git - thirdparty/cups.git/blob - man/cupsctl.man
Import cups.org releases
[thirdparty/cups.git] / man / cupsctl.man
1 .\"
2 .\" "$Id: cupsctl.man 9457 2011-01-11 03:04:04Z mike $"
3 .\"
4 .\" cupsctl man page for CUPS.
5 .\"
6 .\" Copyright 2007-2011 by Apple Inc.
7 .\" Copyright 2007 by Easy Software Products.
8 .\"
9 .\" These coded instructions, statements, and computer programs are the
10 .\" property of Apple Inc. and are protected by Federal copyright
11 .\" law. Distribution and use rights are outlined in the file "LICENSE.txt"
12 .\" which should have been included with this file. If this file is
13 .\" file is missing or damaged, see the license at "http://www.cups.org/".
14 .\"
15 .TH cupsctl 8 "CUPS" "10 January 2011" "Apple Inc."
16 .SH NAME
17 cupsctl \- configure cupsd.conf options
18 .SH SYNOPSIS
19 .B cupsctl
20 [ -E ] [-U
21 .I username
22 ] [ -h
23 .I server[:port]
24 ] [ --[no-]debug-logging ] [ --[no-]remote-admin ] [ --[no-]remote-any ]
25 [ --[no-]remote-printers ] [ --[no-]share-printers ] [ --[no-]user-cancel-any ]
26 [
27 .I name=value
28 ]
29 .SH DESCRIPTION
30 \fIcupsctl\fR updates or queries the \fBcupsd.conf\fR file for a server. When
31 no changes are requested, the current configuration values are written to the
32 standard output in the format "name=value", one per line.
33 .SH OPTIONS
34 The following options are recognized:
35 .TP 5
36 -E
37 .br
38 Enables encryption on the connection to the scheduler.
39 .TP 5
40 -U \fIusername\fR
41 .br
42 Specifies an alternate username to use when authenticating with the scheduler.
43 .TP 5
44 -h \fIserver[:port]\fR
45 .br
46 Specifies the server address.
47 .TP 5
48 --[no-]debug-logging
49 .br
50 Enables or disables debug logging in the \fBerror_log\fR file.
51 .TP 5
52 --[no-]remote-admin
53 .br
54 Enables or disables remote administration.
55 .TP 5
56 --[no-]remote-any
57 .br
58 Enables or disables printing from any address, e.g. the Internet.
59 .TP 5
60 --[no-]remote-printers
61 .br
62 Enables or disables the display of remote printers shared via the CUPS, LDAP,
63 or SLP protocols.
64 .TP 5
65 --[no-]share-printers
66 .br
67 Enables or disables sharing of local printers with other computers.
68 .TP 5
69 --[no-]user-cancel-any
70 .br
71 Allows or prevents users from canceling jobs owned by others.
72 .SH EXAMPLES
73 Display the current settings:
74 .nf
75 cupsctl
76 .fi
77 .LP
78 Enable debug logging:
79 .nf
80 cupsctl --debug-logging
81 .fi
82 .LP
83 Get the current debug logging state:
84 .nf
85 cupsctl | grep '^_debug_logging' | awk -F= '{print $2}'
86 .fi
87 .LP
88 Disable printer sharing:
89 .nf
90 cupsctl --no-shared-printers
91 .fi
92 .LP
93 Enable printing using the file: pseudo-device:
94 .nf
95 cupsctl FileDevice=Yes
96 .fi
97 .SH KNOWN ISSUES
98 You cannot set the Listen or Port directives using \fIcupsctl\fR.
99 .SH SEE ALSO
100 \fIcupsd.conf(5)\fR, \fIcupsd(8)\fR,
101 .br
102 http://localhost:631/help
103 .SH COPYRIGHT
104 Copyright 2007-2011 by Apple Inc.
105 .\"
106 .\" End of "$Id: cupsctl.man 9457 2011-01-11 03:04:04Z mike $".
107 .\"