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