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