docs/manpages/testprns.1.xml

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