docs/manpages/testprns.1.xml

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