docs/docbook/manpages/testprns.1.xml

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