[thirdparty/cups.git] / doc / help / standard.html.in

<HTML>
<!-- SECTION: Getting Started -->
<HEAD>
	<TITLE>Standard Configuration</TITLE>
	<LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css">
</HEAD>
<BODY>

<H1 CLASS="title">Standard Configuration</H1>

<P>This document describes the standard configuration for this CUPS
server.</P>

<BLOCKQUOTE><B>Note:</B>

<!-- Packagers: Change the following statement and the following sections
     if you make any changes to the standard CUPS distribution that are
     not automatically updated by the configure script. -->
<P>This file reflects the standard CUPS configuration as distributed
by Apple Inc, the developer of CUPS.</P>

</BLOCKQUOTE>


<H2 CLASS="title"><A NAME="CUPSD">cupsd Configuration</A></H2>

<P><CODE>cupsd(8)</CODE> is configured by default to show
printers shared by other systems and only allow local access to
the system and its printers. Administration operations require
Basic authentication with membership in the group
"@CUPS_GROUP@".</P>

<P>Connections are accepted via domain socket
(<VAR>@CUPS_DEFAULT_DOMAINSOCKET@</VAR>) or "localhost"
(127.0.0.1).</P>

<H3><A NAME="SETTINGS">Settings</A></H3>

<DIV CLASS="table"><TABLE SUMMARY="Default Values">
<CAPTION>Table 1: Default Values</CAPTION>
<TR>
	<TH>Directive</TH>
	<TH>Value</TH>
</TR>
<TR>
	<TD><CODE><A HREF="ref-cupsd-conf.html#Browsing">Browsing</A></CODE></TD>
	<TD><CODE>@CUPS_BROWSING@</CODE></TD>
</TR>
<TR>
	<TD><CODE><A HREF="ref-cupsd-conf.html#BrowseLocalProtocols">BrowseLocalProtocols</A></CODE></TD>
	<TD><CODE>@CUPS_BROWSE_LOCAL_PROTOCOLS@</CODE></TD>
</TR>
<TR>
	<TD><CODE><A HREF="ref-cupsd-conf.html#BrowseRemoteProtocols">BrowseRemoteProtocols</A></CODE></TD>
	<TD><CODE>@CUPS_BROWSE_REMOTE_PROTOCOLS@</CODE></TD>
</TR>
<TR>
	<TD><CODE><A HREF="ref-cupsd-conf.html#BrowseShortNames">BrowseShortNames</A></CODE></TD>
	<TD><CODE>@CUPS_BROWSE_SHORT_NAMES@</CODE></TD>
</TR>
<TR>
	<TD><CODE><A HREF="ref-cupsd-conf.html#ConfigFilePerm">ConfigFilePerm</A></CODE></TD>
	<TD><CODE>@CUPS_CONFIG_FILE_PERM@</CODE></TD>
</TR>
<TR>
	<TD><CODE><A HREF="ref-cupsd-conf.html#DefaultShared">DefaultShared</A></CODE></TD>
	<TD><CODE>@CUPS_DEFAULT_SHARED@</CODE></TD>
</TR>
<TR>
	<TD><CODE><A HREF="ref-cupsd-conf.html#ImplicitClasses">ImplicitClasses</A></CODE></TD>
	<TD><CODE>@CUPS_IMPLICIT_CLASSES@</CODE></TD>
</TR>
<TR>
	<TD><CODE><A HREF="ref-cupsd-conf.html#LogFilePerm">LogFilePerm</A></CODE></TD>
	<TD><CODE>@CUPS_LOG_FILE_PERM@</CODE></TD>
</TR>
<TR>
	<TD><CODE><A HREF="ref-cupsd-conf.html#MaxCopies">MaxCopies</A></CODE></TD>
	<TD><CODE>@CUPS_MAX_COPIES@</CODE></TD>
</TR>
<TR>
	<TD><CODE><A HREF="ref-cupsd-conf.html#UseNetworkDefault">UseNetworkDefault</A></CODE></TD>
	<TD><CODE>@CUPS_USE_NETWORK_DEFAULT@</CODE></TD>
</TR>
</TABLE></DIV>


<H2 CLASS="title"><A NAME="DIRECTORIES">Directories</A></H2>

<DIV CLASS="table"><TABLE SUMMARY="Directories">
<CAPTION>Table 2: Directories</CAPTION>
<TR>
	<TH>Directory</TH>
	<TH>Purpose</TH>
</TR>
<TR>
	<TD><VAR>@CUPS_SERVERROOT@</VAR></TD>
	<TD>The location of configuration files such as
	<VAR>printers.conf</VAR>. Overridden by the <A
	HREF="ref-cupsd-conf.html#ServerRoot"><CODE>ServerRoot</CODE></A>
	directive in <VAR>cupsd.conf</VAR>.</TD>
</TR>
<TR>
	<TD><VAR>@bindir@</VAR></TD>
	<TD>The location of user programs.</TD>
</TR>
<TR>
	<TD><VAR>@includedir@</VAR></TD>
	<TD>The location of CUPS include files.</TD>
</TR>
<TR>
	<TD><VAR>@libdir@</VAR></TD>
	<TD>The location of CUPS library files.</TD>
</TR>
<TR>
	<TD><VAR>@CUPS_SERVERBIN@</VAR></TD>
	<TD>The location of server programs such as backends and
	filters. Overridden by the <A
	HREF="ref-cupsd-conf.html#ServerBin"><CODE>ServerBin</CODE></A>
	directive in <VAR>cupsd.conf</VAR>.</TD>
</TR>
<TR>
	<TD><VAR>@sbindir@</VAR></TD>
	<TD>The location of administrator programs.</TD>
</TR>
<TR>
	<TD><VAR>@CUPS_DATADIR@</VAR></TD>
	<TD>The location of data files such as fonts. Overridden
	by the <A
	HREF="ref-cupsd-conf.html#DataDir"><CODE>DataDir</CODE></A>
	directive in <VAR>cupsd.conf</VAR>.</TD>
</TR>
<TR>
	<TD><VAR>@CUPS_DOCROOT@</VAR></TD>
	<TD>The location of documentation files. Overridden by
	the <A
	HREF="ref-cupsd-conf.html#DocumentRoot"><CODE>DocumentRoot</CODE></A>
	directive in <VAR>cupsd.conf</VAR>.</TD>
</TR>
<TR>
	<TD><VAR>@CUPS_LOCALEDIR@</VAR></TD>
	<TD>The location of localization files.</TD>
</TR>
<TR>
	<TD><VAR>@CUPS_CACHEDIR@</VAR></TD>
	<TD>The location of cache files such as
	<VAR>ppds.dat</VAR> and <VAR>remote.cache</VAR>.
	Overridden by the <A
	HREF="ref-cupsd-conf.html#CacheDir"><CODE>CacheDir</CODE></A>
	directive in <VAR>cupsd.conf</VAR>.</TD>
</TR>
<TR>
	<TD><VAR>@CUPS_LOGDIR@</VAR></TD>
	<TD>The location of the <VAR>access_log</VAR>,
	<VAR>error_log</VAR>, and <VAR>page_log</VAR> files.
	Overridden by the <A
	HREF="ref-cupsd-conf.html#AccessLog"><CODE>AccessLog</CODE></A>,
	<A
	HREF="ref-cupsd-conf.html#ErrorLog"><CODE>ErrorLog</CODE></A>,
	<A
	HREF="ref-cupsd-conf.html#PageLog"><CODE>PageLog</CODE></A>,
	directive in <VAR>cupsd.conf</VAR>.</TD>
</TR>
<TR>
	<TD><VAR>@CUPS_STATEDIR@</VAR></TD>
	<TD>The location of the domain socket file and state data
	such as authentication certificates. Overridden by the <A
	HREF="ref-cupsd-conf.html#StateDir"><CODE>StateDir</CODE></A>
	directive in <VAR>cupsd.conf</VAR>.</TD>
</TR>
<TR>
	<TD><VAR>@CUPS_REQUESTS@</VAR></TD>
	<TD>The location of spooled print jobs. Overridden by the
	<A
	HREF="ref-cupsd-conf.html#RequestRoot"><CODE>RequestRoot</CODE></A>
	directive in <VAR>cupsd.conf</VAR>.</TD>
</TR>
</TABLE></DIV>

</BODY>
</HTML>
Commit	Line	Data
ef416fc2	1	<HTML>
	2	<!-- SECTION: Getting Started -->
	3	<HEAD>
	4	<TITLE>Standard Configuration</TITLE>
178cb736	5	<LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css">
ef416fc2	6	</HEAD>
	7	<BODY>
	8
178cb736 MS	9	<H1 CLASS="title">Standard Configuration</H1>
178cb736 MS	10
ef416fc2	11	<P>This document describes the standard configuration for this CUPS
	12	server.</P>
	13
	14	<BLOCKQUOTE><B>Note:</B>
	15
	16	<!-- Packagers: Change the following statement and the following sections
	17	if you make any changes to the standard CUPS distribution that are
	18	not automatically updated by the configure script. -->
	19	<P>This file reflects the standard CUPS configuration as distributed
178cb736	20	by Apple Inc, the developer of CUPS.</P>
ef416fc2	21
	22	</BLOCKQUOTE>
	23
	24
09ec0018	25	<H2 CLASS="title"><A NAME="CUPSD">cupsd Configuration</A></H2>
ef416fc2	26
	27	<P><CODE>cupsd(8)</CODE> is configured by default to show
	28	printers shared by other systems and only allow local access to
	29	the system and its printers. Administration operations require
	30	Basic authentication with membership in the group
	31	"@CUPS_GROUP@".</P>
	32
	33	<P>Connections are accepted via domain socket
	34	(<VAR>@CUPS_DEFAULT_DOMAINSOCKET@</VAR>) or "localhost"
	35	(127.0.0.1).</P>
	36
09ec0018	37	<H3><A NAME="SETTINGS">Settings</A></H3>
09ec0018	38
480ef0fe	39	<DIV CLASS="table"><TABLE SUMMARY="Default Values">
480ef0fe	40	<CAPTION>Table 1: Default Values</CAPTION>
09ec0018	41	<TR>
	42	<TH>Directive</TH>
	43	<TH>Value</TH>
	44	</TR>
	45	<TR>
4744bd90	46	<TD><CODE><A HREF="ref-cupsd-conf.html#Browsing">Browsing</A></CODE></TD>
09ec0018	47	<TD><CODE>@CUPS_BROWSING@</CODE></TD>
	48	</TR>
	49	<TR>
4744bd90	50	<TD><CODE><A HREF="ref-cupsd-conf.html#BrowseLocalProtocols">BrowseLocalProtocols</A></CODE></TD>
09ec0018	51	<TD><CODE>@CUPS_BROWSE_LOCAL_PROTOCOLS@</CODE></TD>
	52	</TR>
	53	<TR>
4744bd90	54	<TD><CODE><A HREF="ref-cupsd-conf.html#BrowseRemoteProtocols">BrowseRemoteProtocols</A></CODE></TD>
09ec0018	55	<TD><CODE>@CUPS_BROWSE_REMOTE_PROTOCOLS@</CODE></TD>
	56	</TR>
	57	<TR>
4744bd90	58	<TD><CODE><A HREF="ref-cupsd-conf.html#BrowseShortNames">BrowseShortNames</A></CODE></TD>
09ec0018	59	<TD><CODE>@CUPS_BROWSE_SHORT_NAMES@</CODE></TD>
	60	</TR>
	61	<TR>
4744bd90	62	<TD><CODE><A HREF="ref-cupsd-conf.html#ConfigFilePerm">ConfigFilePerm</A></CODE></TD>
09ec0018	63	<TD><CODE>@CUPS_CONFIG_FILE_PERM@</CODE></TD>
	64	</TR>
	65	<TR>
4744bd90	66	<TD><CODE><A HREF="ref-cupsd-conf.html#DefaultShared">DefaultShared</A></CODE></TD>
09ec0018	67	<TD><CODE>@CUPS_DEFAULT_SHARED@</CODE></TD>
	68	</TR>
	69	<TR>
4744bd90	70	<TD><CODE><A HREF="ref-cupsd-conf.html#ImplicitClasses">ImplicitClasses</A></CODE></TD>
09ec0018	71	<TD><CODE>@CUPS_IMPLICIT_CLASSES@</CODE></TD>
	72	</TR>
	73	<TR>
4744bd90	74	<TD><CODE><A HREF="ref-cupsd-conf.html#LogFilePerm">LogFilePerm</A></CODE></TD>
09ec0018	75	<TD><CODE>@CUPS_LOG_FILE_PERM@</CODE></TD>
09ec0018	76	</TR>
f7deaa1a	77	<TR>
	78	<TD><CODE><A HREF="ref-cupsd-conf.html#MaxCopies">MaxCopies</A></CODE></TD>
	79	<TD><CODE>@CUPS_MAX_COPIES@</CODE></TD>
	80	</TR>
e00b005a	81	<TR>
4744bd90	82	<TD><CODE><A HREF="ref-cupsd-conf.html#UseNetworkDefault">UseNetworkDefault</A></CODE></TD>
e00b005a	83	<TD><CODE>@CUPS_USE_NETWORK_DEFAULT@</CODE></TD>
e00b005a	84	</TR>
09ec0018	85	</TABLE></DIV>
ef416fc2	86
09ec0018	87
09ec0018	88	<H2 CLASS="title"><A NAME="DIRECTORIES">Directories</A></H2>
ef416fc2	89
480ef0fe	90	<DIV CLASS="table"><TABLE SUMMARY="Directories">
480ef0fe	91	<CAPTION>Table 2: Directories</CAPTION>
ef416fc2	92	<TR>
	93	<TH>Directory</TH>
	94	<TH>Purpose</TH>
	95	</TR>
	96	<TR>
	97	<TD><VAR>@CUPS_SERVERROOT@</VAR></TD>
	98	<TD>The location of configuration files such as
	99	<VAR>printers.conf</VAR>. Overridden by the <A
4744bd90	100	HREF="ref-cupsd-conf.html#ServerRoot"><CODE>ServerRoot</CODE></A>
ef416fc2	101	directive in <VAR>cupsd.conf</VAR>.</TD>
	102	</TR>
	103	<TR>
	104	<TD><VAR>@bindir@</VAR></TD>
	105	<TD>The location of user programs.</TD>
	106	</TR>
	107	<TR>
	108	<TD><VAR>@includedir@</VAR></TD>
	109	<TD>The location of CUPS include files.</TD>
	110	</TR>
	111	<TR>
	112	<TD><VAR>@libdir@</VAR></TD>
	113	<TD>The location of CUPS library files.</TD>
	114	</TR>
	115	<TR>
	116	<TD><VAR>@CUPS_SERVERBIN@</VAR></TD>
	117	<TD>The location of server programs such as backends and
	118	filters. Overridden by the <A
4744bd90	119	HREF="ref-cupsd-conf.html#ServerBin"><CODE>ServerBin</CODE></A>
ef416fc2	120	directive in <VAR>cupsd.conf</VAR>.</TD>
	121	</TR>
	122	<TR>
	123	<TD><VAR>@sbindir@</VAR></TD>
	124	<TD>The location of administrator programs.</TD>
	125	</TR>
	126	<TR>
	127	<TD><VAR>@CUPS_DATADIR@</VAR></TD>
	128	<TD>The location of data files such as fonts. Overridden
	129	by the <A
4744bd90	130	HREF="ref-cupsd-conf.html#DataDir"><CODE>DataDir</CODE></A>
ef416fc2	131	directive in <VAR>cupsd.conf</VAR>.</TD>
	132	</TR>
	133	<TR>
	134	<TD><VAR>@CUPS_DOCROOT@</VAR></TD>
	135	<TD>The location of documentation files. Overridden by
	136	the <A
4744bd90	137	HREF="ref-cupsd-conf.html#DocumentRoot"><CODE>DocumentRoot</CODE></A>
ef416fc2	138	directive in <VAR>cupsd.conf</VAR>.</TD>
	139	</TR>
	140	<TR>
	141	<TD><VAR>@CUPS_LOCALEDIR@</VAR></TD>
	142	<TD>The location of localization files.</TD>
	143	</TR>
	144	<TR>
	145	<TD><VAR>@CUPS_CACHEDIR@</VAR></TD>
	146	<TD>The location of cache files such as
	147	<VAR>ppds.dat</VAR> and <VAR>remote.cache</VAR>.
	148	Overridden by the <A
4744bd90	149	HREF="ref-cupsd-conf.html#CacheDir"><CODE>CacheDir</CODE></A>
ef416fc2	150	directive in <VAR>cupsd.conf</VAR>.</TD>
	151	</TR>
	152	<TR>
	153	<TD><VAR>@CUPS_LOGDIR@</VAR></TD>
	154	<TD>The location of the <VAR>access_log</VAR>,
	155	<VAR>error_log</VAR>, and <VAR>page_log</VAR> files.
	156	Overridden by the <A
4744bd90	157	HREF="ref-cupsd-conf.html#AccessLog"><CODE>AccessLog</CODE></A>,
ef416fc2	158	<A
4744bd90	159	HREF="ref-cupsd-conf.html#ErrorLog"><CODE>ErrorLog</CODE></A>,
ef416fc2	160	<A
4744bd90	161	HREF="ref-cupsd-conf.html#PageLog"><CODE>PageLog</CODE></A>,
ef416fc2	162	directive in <VAR>cupsd.conf</VAR>.</TD>
	163	</TR>
	164	<TR>
	165	<TD><VAR>@CUPS_STATEDIR@</VAR></TD>
	166	<TD>The location of the domain socket file and state data
	167	such as authentication certificates. Overridden by the <A
4744bd90	168	HREF="ref-cupsd-conf.html#StateDir"><CODE>StateDir</CODE></A>
ef416fc2	169	directive in <VAR>cupsd.conf</VAR>.</TD>
	170	</TR>
	171	<TR>
	172	<TD><VAR>@CUPS_REQUESTS@</VAR></TD>
	173	<TD>The location of spooled print jobs. Overridden by the
	174	<A
4744bd90	175	HREF="ref-cupsd-conf.html#RequestRoot"><CODE>RequestRoot</CODE></A>
ef416fc2	176	directive in <VAR>cupsd.conf</VAR>.</TD>
	177	</TR>
	178	</TABLE></DIV>
	179
ef416fc2	180	</BODY>
ef416fc2	181	</HTML>