[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 WIDTH="80%">
<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#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 WIDTH="80%">
<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>
	35
	36	<DIV CLASS="table"><TABLE WIDTH="80%">
	37	<TR>
	38	<TH>Directive</TH>
	39	<TH>Value</TH>
	40	</TR>
	41	<TR>
4744bd90	42	<TD><CODE><A HREF="ref-cupsd-conf.html#Browsing">Browsing</A></CODE></TD>
09ec0018	43	<TD><CODE>@CUPS_BROWSING@</CODE></TD>
	44	</TR>
	45	<TR>
4744bd90	46	<TD><CODE><A HREF="ref-cupsd-conf.html#BrowseLocalProtocols">BrowseLocalProtocols</A></CODE></TD>
09ec0018	47	<TD><CODE>@CUPS_BROWSE_LOCAL_PROTOCOLS@</CODE></TD>
	48	</TR>
	49	<TR>
4744bd90	50	<TD><CODE><A HREF="ref-cupsd-conf.html#BrowseRemoteProtocols">BrowseRemoteProtocols</A></CODE></TD>
09ec0018	51	<TD><CODE>@CUPS_BROWSE_REMOTE_PROTOCOLS@</CODE></TD>
	52	</TR>
	53	<TR>
4744bd90	54	<TD><CODE><A HREF="ref-cupsd-conf.html#BrowseShortNames">BrowseShortNames</A></CODE></TD>
09ec0018	55	<TD><CODE>@CUPS_BROWSE_SHORT_NAMES@</CODE></TD>
	56	</TR>
	57	<TR>
4744bd90	58	<TD><CODE><A HREF="ref-cupsd-conf.html#ConfigFilePerm">ConfigFilePerm</A></CODE></TD>
09ec0018	59	<TD><CODE>@CUPS_CONFIG_FILE_PERM@</CODE></TD>
	60	</TR>
	61	<TR>
4744bd90	62	<TD><CODE><A HREF="ref-cupsd-conf.html#DefaultShared">DefaultShared</A></CODE></TD>
09ec0018	63	<TD><CODE>@CUPS_DEFAULT_SHARED@</CODE></TD>
	64	</TR>
	65	<TR>
4744bd90	66	<TD><CODE><A HREF="ref-cupsd-conf.html#ImplicitClasses">ImplicitClasses</A></CODE></TD>
09ec0018	67	<TD><CODE>@CUPS_IMPLICIT_CLASSES@</CODE></TD>
	68	</TR>
	69	<TR>
4744bd90	70	<TD><CODE><A HREF="ref-cupsd-conf.html#LogFilePerm">LogFilePerm</A></CODE></TD>
09ec0018	71	<TD><CODE>@CUPS_LOG_FILE_PERM@</CODE></TD>
09ec0018	72	</TR>
e00b005a	73	<TR>
4744bd90	74	<TD><CODE><A HREF="ref-cupsd-conf.html#UseNetworkDefault">UseNetworkDefault</A></CODE></TD>
e00b005a	75	<TD><CODE>@CUPS_USE_NETWORK_DEFAULT@</CODE></TD>
e00b005a	76	</TR>
09ec0018	77	</TABLE></DIV>
ef416fc2	78
09ec0018	79
09ec0018	80	<H2 CLASS="title"><A NAME="DIRECTORIES">Directories</A></H2>
ef416fc2	81
	82	<DIV CLASS="table"><TABLE WIDTH="80%">
	83	<TR>
	84	<TH>Directory</TH>
	85	<TH>Purpose</TH>
	86	</TR>
	87	<TR>
	88	<TD><VAR>@CUPS_SERVERROOT@</VAR></TD>
	89	<TD>The location of configuration files such as
	90	<VAR>printers.conf</VAR>. Overridden by the <A
4744bd90	91	HREF="ref-cupsd-conf.html#ServerRoot"><CODE>ServerRoot</CODE></A>
ef416fc2	92	directive in <VAR>cupsd.conf</VAR>.</TD>
	93	</TR>
	94	<TR>
	95	<TD><VAR>@bindir@</VAR></TD>
	96	<TD>The location of user programs.</TD>
	97	</TR>
	98	<TR>
	99	<TD><VAR>@includedir@</VAR></TD>
	100	<TD>The location of CUPS include files.</TD>
	101	</TR>
	102	<TR>
	103	<TD><VAR>@libdir@</VAR></TD>
	104	<TD>The location of CUPS library files.</TD>
	105	</TR>
	106	<TR>
	107	<TD><VAR>@CUPS_SERVERBIN@</VAR></TD>
	108	<TD>The location of server programs such as backends and
	109	filters. Overridden by the <A
4744bd90	110	HREF="ref-cupsd-conf.html#ServerBin"><CODE>ServerBin</CODE></A>
ef416fc2	111	directive in <VAR>cupsd.conf</VAR>.</TD>
	112	</TR>
	113	<TR>
	114	<TD><VAR>@sbindir@</VAR></TD>
	115	<TD>The location of administrator programs.</TD>
	116	</TR>
	117	<TR>
	118	<TD><VAR>@CUPS_DATADIR@</VAR></TD>
	119	<TD>The location of data files such as fonts. Overridden
	120	by the <A
4744bd90	121	HREF="ref-cupsd-conf.html#DataDir"><CODE>DataDir</CODE></A>
ef416fc2	122	directive in <VAR>cupsd.conf</VAR>.</TD>
	123	</TR>
	124	<TR>
	125	<TD><VAR>@CUPS_DOCROOT@</VAR></TD>
	126	<TD>The location of documentation files. Overridden by
	127	the <A
4744bd90	128	HREF="ref-cupsd-conf.html#DocumentRoot"><CODE>DocumentRoot</CODE></A>
ef416fc2	129	directive in <VAR>cupsd.conf</VAR>.</TD>
	130	</TR>
	131	<TR>
	132	<TD><VAR>@CUPS_LOCALEDIR@</VAR></TD>
	133	<TD>The location of localization files.</TD>
	134	</TR>
	135	<TR>
	136	<TD><VAR>@CUPS_CACHEDIR@</VAR></TD>
	137	<TD>The location of cache files such as
	138	<VAR>ppds.dat</VAR> and <VAR>remote.cache</VAR>.
	139	Overridden by the <A
4744bd90	140	HREF="ref-cupsd-conf.html#CacheDir"><CODE>CacheDir</CODE></A>
ef416fc2	141	directive in <VAR>cupsd.conf</VAR>.</TD>
	142	</TR>
	143	<TR>
	144	<TD><VAR>@CUPS_LOGDIR@</VAR></TD>
	145	<TD>The location of the <VAR>access_log</VAR>,
	146	<VAR>error_log</VAR>, and <VAR>page_log</VAR> files.
	147	Overridden by the <A
4744bd90	148	HREF="ref-cupsd-conf.html#AccessLog"><CODE>AccessLog</CODE></A>,
ef416fc2	149	<A
4744bd90	150	HREF="ref-cupsd-conf.html#ErrorLog"><CODE>ErrorLog</CODE></A>,
ef416fc2	151	<A
4744bd90	152	HREF="ref-cupsd-conf.html#PageLog"><CODE>PageLog</CODE></A>,
ef416fc2	153	directive in <VAR>cupsd.conf</VAR>.</TD>
	154	</TR>
	155	<TR>
	156	<TD><VAR>@CUPS_STATEDIR@</VAR></TD>
	157	<TD>The location of the domain socket file and state data
	158	such as authentication certificates. Overridden by the <A
4744bd90	159	HREF="ref-cupsd-conf.html#StateDir"><CODE>StateDir</CODE></A>
ef416fc2	160	directive in <VAR>cupsd.conf</VAR>.</TD>
	161	</TR>
	162	<TR>
	163	<TD><VAR>@CUPS_REQUESTS@</VAR></TD>
	164	<TD>The location of spooled print jobs. Overridden by the
	165	<A
4744bd90	166	HREF="ref-cupsd-conf.html#RequestRoot"><CODE>RequestRoot</CODE></A>
ef416fc2	167	directive in <VAR>cupsd.conf</VAR>.</TD>
	168	</TR>
	169	</TABLE></DIV>
	170
ef416fc2	171	</BODY>
ef416fc2	172	</HTML>