docs/docbook/manpages/smbspool.8.sgml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
   2 <refentry id="smbspool">
   3
   4 <refmeta>
   5         <refentrytitle>smbspool</refentrytitle>
   6         <manvolnum>8</manvolnum>
   7 </refmeta>
   8
   9
  10 <refnamediv>
  11         <refname>smbspool</refname>
  12         <refpurpose>send print file to an SMB printer</refpurpose>
  13 </refnamediv>
  14
  15 <refsynopsisdiv>
  16         <cmdsynopsis>
  17                 <command>smbspool</command>
  18                 <arg>job</arg>
  19                 <arg>user</arg>
  20                 <arg>title</arg>
  21                 <arg>copies</arg>
  22                 <arg>options</arg>
  23                 <arg>filename</arg>
  24         </cmdsynopsis>
  25 </refsynopsisdiv>
  26
  27 <refsect1>
  28         <title>DESCRIPTION</title>
  29
  30         <para>This tool is part of the <ulink url="samba.7.html">
  31         Samba</ulink> 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>
  49                 </listitem>
  50                 <listitem><para>smb://username:password@workgroup/server/printer
  51                 </para></listitem>
  52         </itemizedlist>
  53
  54         <para>smbspool tries to get the URI from argv[0]. If argv[0]
  55         contains the name of the program then it looks in the <envar>
  56         DEVICE_URI</envar> environment variable.</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 than 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 presently
  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 2.2 of
 101         the Samba suite.</para>
 102 </refsect1>
 103
 104 <refsect1>
 105         <title>SEE ALSO</title>
 106         <para><ulink url="smbd.8.html"><command>smbd(8)</command></ulink>,
 107         and <ulink url="samba.7.html">samba(7)</ulink>.
 108         </para>
 109 </refsect1>
 110
 111 <refsect1>
 112         <title>AUTHOR</title>
 113
 114         <para><command>smbspool</command> was written by Michael Sweet
 115         at Easy Software Products.</para>
 116
 117         <para>The original Samba software and related utilities
 118         were created by Andrew Tridgell. Samba is now developed
 119         by the Samba Team as an Open Source project similar
 120         to the way the Linux kernel is developed.</para>
 121
 122         <para>The original Samba man pages were written by Karl Auer.
 123         The man page sources were converted to YODL format (another
 124         excellent piece of Open Source software, available at
 125         <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 126         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 127         release by Jeremy Allison.  The conversion to DocBook for
 128         Samba 2.2 was done by Gerald Carter</para>
 129 </refsect1>
 130
 131 </refentry>