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

<HTML>
<!-- SECTION: Getting Started -->
<HEAD>
	<TITLE>Standard Configuration</TITLE>
</HEAD>
<BODY>

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