samba-mirror/docs/docbook/manpages/testprns.1.xml

<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
                  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [

<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="testprns.1">

<refmeta>
	<refentrytitle>testprns</refentrytitle>
	<manvolnum>1</manvolnum>
</refmeta>


<refnamediv>
	<refname>testprns</refname>
	<refpurpose>check printer name for validity with smbd</refpurpose>
</refnamediv>

<refsynopsisdiv>
	<cmdsynopsis>
		<command>testprns</command>
		<arg choice="req">printername</arg>
		<arg choice="opt">printcapname</arg>
	</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>

	<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
	<manvolnum>7</manvolnum></citerefentry> suite.</para>

	<para><command>testprns</command> is a very simple test program 
	to determine whether a given printer name is valid for use in 
	a service to be provided by <citerefentry><refentrytitle>smbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry>.</para>

	<para>"Valid" in this context means "can be found in the 
	printcap specified". This program is very stupid - so stupid in 
	fact that it would be wisest to always specify the printcap file 
	to use. </para>

</refsect1>


<refsect1>
	<title>OPTIONS</title>

	<variablelist>
		<varlistentry>
		<term>printername</term>
		<listitem><para>The printer name to validate.</para>
		
		<para>Printer names are taken from the first field in each 
		record in the printcap file, single printer names and sets 
		of aliases separated by vertical bars ("|") are recognized. 
		Note that no validation or checking of the printcap syntax is 
		done beyond that required to extract the printer name. It may
		be that the print spooling system is more forgiving or less 
		forgiving than <command>testprns</command>. However, if 
		<command>testprns</command> finds the printer then <citerefentry>
		<refentrytitle>smbd</refentrytitle><manvolnum>8</manvolnum>
		</citerefentry> should do so as well. </para></listitem>
		</varlistentry>
		
		<varlistentry>	
		<term>printcapname</term>
		<listitem><para>This is the name of the printcap file within
		which to search for the given printer name. </para>

		<para>If no printcap name is specified <command>testprns
		</command> will attempt to scan the printcap file name 
		specified at compile time. </para></listitem>
		</varlistentry>
	</variablelist>
</refsect1>


<refsect1>
	<title>FILES</title>

	<variablelist>
		<varlistentry>
		<term><filename>/etc/printcap</filename></term>
		<listitem><para>This is usually the default printcap 
		file to scan. See <filename>printcap (5)</filename>. 
		</para></listitem>
		</varlistentry>
	</variablelist>
</refsect1>


<refsect1>
	<title>DIAGNOSTICS</title>

	<para>If a printer is found to be valid, the message 
	"Printer name &lt;printername&gt; is valid" will be 
	displayed. </para>

	<para>If a printer is found to be invalid, the message
	"Printer name &lt;printername&gt; is not valid" will be 
	displayed. </para>

	<para>All messages that would normally be logged during
	operation of the Samba daemons are logged by this program to the 
	file <filename>test.log</filename> in the current directory. The
	program runs at debuglevel 3, so quite extensive logging 
	information is written. The log should be checked carefully 
	for errors and warnings. </para>

	<para>Other messages are self-explanatory. </para>
</refsect1>


<refsect1>
	<title>VERSION</title>

	<para>This man page is correct for version 3.0 of 
	the Samba suite.</para>
</refsect1>

<refsect1>
	<title>SEE ALSO</title>
	<para><filename>printcap(5)</filename>, 
	<citerefentry><refentrytitle>smbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbclient</refentrytitle>
	<manvolnum>1</manvolnum></citerefentry></para>
</refsect1>

<refsect1>
	<title>AUTHOR</title>
	
	<para>The original Samba software and related utilities 
	were created by Andrew Tridgell. Samba is now developed
	by the Samba Team as an Open Source project similar 
	to the way the Linux kernel is developed.</para>
	
	<para>The original Samba man pages were written by Karl Auer. 
	The man page sources were converted to YODL format (another 
	excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
	ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 
	release by Jeremy Allison.  The conversion to DocBook for 
	Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2
	for Samba 3.0 was done by Alexander Bokovoy.</para>
</refsect1>

</refentry>