docs/docbook/manpages/smbspool.8.sgml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
   2 <refentry id="smbspool.8">
   3
   4 <refmeta>
   5         <refentrytitle>smbspool</refentrytitle>
   6         <manvolnum>8</manvolnum>
   7 </refmeta>
   8
   9
  10 <refnamediv>
  11         <refname>smbspool</refname>
  12         <refpurpose>send a print file to an SMB printer</refpurpose>
  13 </refnamediv>
  14
  15 <refsynopsisdiv>
  16         <cmdsynopsis>
  17                 <command>smbspool</command>
  18                 <arg choice="req">job</arg>
  19                 <arg choice="req">user</arg>
  20                 <arg choice="req">title</arg>
  21                 <arg choice="req">copies</arg>
  22                 <arg choice="req">options</arg>
  23                 <arg choice="opt">filename</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>smbspool is a very small print spooling program that
  34         sends a print file to an SMB printer. The command-line arguments
  35         are position-dependent for compatibility with the Common UNIX
  36         Printing System, but you can use smbspool with any printing system
  37         or from a program or script.</para>
  38
  39         <para><emphasis>DEVICE URI</emphasis></para>
  40
  41         <para>smbspool specifies the destination using a Uniform Resource
  42         Identifier ("URI") with a method of "smb". This string can take
  43         a number of forms:</para>
  44
  45         <itemizedlist>
  46                 <listitem><para>smb://server/printer</para></listitem>
  47                 <listitem><para>smb://workgroup/server/printer</para></listitem>
  48                 <listitem><para>smb://username:password@server/printer</para></listitem>
  49                 <listitem><para>smb://username:password@workgroup/server/printer</para></listitem>
  50         </itemizedlist>
  51
  52         <para>smbspool tries to get the URI from argv[0]. If argv[0]
  53         contains the name of the program then it looks in the <envar>
  54         DEVICE_URI</envar> environment variable.</para>
  55
  56         <para>Programs using the <command>exec(2)</command> functions can
  57         pass the URI in argv[0], while shell scripts must set the
  58         <envar>DEVICE_URI</envar> environment variable prior to
  59         running smbspool.</para>
  60 </refsect1>
  61
  62 <refsect1>
  63         <title>OPTIONS</title>
  64
  65         <itemizedlist>
  66                 <listitem><para>The job argument (argv[1]) contains the
  67                 job ID number and is presently not used by smbspool.
  68                 </para></listitem>
  69
  70                 <listitem><para>The user argument (argv[2]) contains the
  71                 print user's name and is presently not used by smbspool.
  72                 </para></listitem>
  73
  74                 <listitem><para>The title argument (argv[3]) contains the
  75                 job title string and is passed as the remote file name
  76                 when sending the print job.</para></listitem>
  77
  78                 <listitem><para>The copies argument (argv[4]) contains
  79                 the number of copies to be printed of the named file. If
  80                 no filename is provided then this argument is not used by
  81                 smbspool.</para></listitem>
  82
  83                 <listitem><para>The options argument (argv[5]) contains
  84                 the print options in a single string and is currently
  85                 not used by smbspool.</para></listitem>
  86
  87                 <listitem><para>The filename argument (argv[6]) contains the
  88                 name of the file to print. If this argument is not specified
  89                 then the print file is read from the standard input.</para>
  90                 </listitem>
  91         </itemizedlist>
  92 </refsect1>
  93
  94
  95 <refsect1>
  96         <title>VERSION</title>
  97
  98         <para>This man page is correct for version 3.0 of the Samba suite.</para>
  99 </refsect1>
 100
 101 <refsect1>
 102         <title>SEE ALSO</title>
 103         <para><citerefentry><refentrytitle>smbd</refentrytitle>
 104         <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>Samba</refentrytitle>
 105         <manvolnum>7</manvolnum></citerefentry>.</para>
 106 </refsect1>
 107
 108 <refsect1>
 109         <title>AUTHOR</title>
 110
 111         <para><command>smbspool</command> was written by Michael Sweet
 112         at Easy Software Products.</para>
 113
 114         <para>The original Samba software and related utilities
 115         were created by Andrew Tridgell. Samba is now developed
 116         by the Samba Team as an Open Source project similar
 117         to the way the Linux kernel is developed.</para>
 118
 119         <para>The original Samba man pages were written by Karl Auer.
 120         The man page sources were converted to YODL format (another
 121         excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 122         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 123         release by Jeremy Allison.  The conversion to DocBook for
 124         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2
 125         for Samba 3.0 was done by Alexander Bokovoy.</para>
 126 </refsect1>
 127
 128 </refentry>