docs/docbook/manpages/testprns.1.sgml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
   2 <refentry id="testprns.1">
   3
   4 <refmeta>
   5         <refentrytitle>testprns</refentrytitle>
   6         <manvolnum>1</manvolnum>
   7 </refmeta>
   8
   9
  10 <refnamediv>
  11         <refname>testprns</refname>
  12         <refpurpose>check printer name for validity with smbd</refpurpose>
  13 </refnamediv>
  14
  15 <refsynopsisdiv>
  16         <cmdsynopsis>
  17                 <command>testprns</command>
  18                 <arg choice="req">printername</arg>
  19                 <arg choice="opt">printcapname</arg>
  20         </cmdsynopsis>
  21 </refsynopsisdiv>
  22
  23 <refsect1>
  24         <title>DESCRIPTION</title>
  25
  26         <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
  27         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  28
  29         <para><command>testprns</command> is a very simple test program
  30         to determine whether a given printer name is valid for use in
  31         a service to be provided by <citerefentry><refentrytitle>smbd</refentrytitle>
  32         <manvolnum>8</manvolnum></citerefentry>.</para>
  33
  34         <para>"Valid" in this context means "can be found in the
  35         printcap specified". This program is very stupid - so stupid in
  36         fact that it would be wisest to always specify the printcap file
  37         to use. </para>
  38
  39 </refsect1>
  40
  41
  42 <refsect1>
  43         <title>OPTIONS</title>
  44
  45         <variablelist>
  46                 <varlistentry>
  47                 <term>printername</term>
  48                 <listitem><para>The printer name to validate.</para>
  49
  50                 <para>Printer names are taken from the first field in each
  51                 record in the printcap file, single printer names and sets
  52                 of aliases separated by vertical bars ("|") are recognized.
  53                 Note that no validation or checking of the printcap syntax is
  54                 done beyond that required to extract the printer name. It may
  55                 be that the print spooling system is more forgiving or less
  56                 forgiving than <command>testprns</command>. However, if
  57                 <command>testprns</command> finds the printer then <citerefentry>
  58                 <refentrytitle>smbd</refentrytitle><manvolnum>8</manvolnum>
  59                 </citerefentry> should do so as well. </para></listitem>
  60                 </varlistentry>
  61
  62                 <varlistentry>
  63                 <term>printcapname</term>
  64                 <listitem><para>This is the name of the printcap file within
  65                 which to search for the given printer name. </para>
  66
  67                 <para>If no printcap name is specified <command>testprns
  68                 </command> will attempt to scan the printcap file name
  69                 specified at compile time. </para></listitem>
  70                 </varlistentry>
  71         </variablelist>
  72 </refsect1>
  73
  74
  75 <refsect1>
  76         <title>FILES</title>
  77
  78         <variablelist>
  79                 <varlistentry>
  80                 <term><filename>/etc/printcap</filename></term>
  81                 <listitem><para>This is usually the default printcap
  82                 file to scan. See <filename>printcap (5)</filename>.
  83                 </para></listitem>
  84                 </varlistentry>
  85         </variablelist>
  86 </refsect1>
  87
  88
  89 <refsect1>
  90         <title>DIAGNOSTICS</title>
  91
  92         <para>If a printer is found to be valid, the message
  93         "Printer name &lt;printername&gt; is valid" will be
  94         displayed. </para>
  95
  96         <para>If a printer is found to be invalid, the message
  97         "Printer name &lt;printername&gt; is not valid" will be
  98         displayed. </para>
  99
 100         <para>All messages that would normally be logged during
 101         operation of the Samba daemons are logged by this program to the
 102         file <filename>test.log</filename> in the current directory. The
 103         program runs at debuglevel 3, so quite extensive logging
 104         information is written. The log should be checked carefully
 105         for errors and warnings. </para>
 106
 107         <para>Other messages are self-explanatory. </para>
 108 </refsect1>
 109
 110
 111 <refsect1>
 112         <title>VERSION</title>
 113
 114         <para>This man page is correct for version 2.2 of
 115         the Samba suite.</para>
 116 </refsect1>
 117
 118 <refsect1>
 119         <title>SEE ALSO</title>
 120         <para><filename>printcap(5)</filename>,
 121         <citerefentry><refentrytitle>smbd</refentrytitle>
 122         <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbclient</refentrytitle>
 123         <manvolnum>1</manvolnum></citerefentry></para>
 124 </refsect1>
 125
 126 <refsect1>
 127         <title>AUTHOR</title>
 128
 129         <para>The original Samba software and related utilities
 130         were created by Andrew Tridgell. Samba is now developed
 131         by the Samba Team as an Open Source project similar
 132         to the way the Linux kernel is developed.</para>
 133
 134         <para>The original Samba man pages were written by Karl Auer.
 135         The man page sources were converted to YODL format (another
 136         excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 137         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 138         release by Jeremy Allison.  The conversion to DocBook for
 139         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2
 140         for Samba 3.0 was done by Alexander Bokovoy.</para>
 141 </refsect1>
 142
 143 </refentry>
 144