libsablot/doc/man/sabcmd.1

   1 .TH sabcmd 1 "June 17, 2002"
   2 .LO 1
   3 .SH NAME
   4 sabcmd \- a command line interface to Sablotron XSLT processor
   5 .SH SYNOPSIS
   6 .B sabcmd
   7 [options] <stylesheet> [<input> [<output>]] [assignments]
   8 .br
   9 .B sabcmd
  10 [options] -batch-xml <input> [<stylesheet> [<output>]]+ [assignments]
  11 .br
  12 .B sabcmd
  13 [options] -batch-xsl <stylesheet> [<input> [<output>]]+ [assignments]
  14 .br
  15 .SH DESCRIPTION
  16 .B sabcmd
  17 is a command line interface to Sablotron XSLT processor. You can
  18 use is to transform XML files with XSLT stylesheets.
  19 .P
  20 The only required parameter is a stylesheet; this is a URI of
  21 an XSLT stylesheet to be used for the transformation process. If you
  22 omit an input file, the standard input is used. In addition, you can
  23 specify an output file. If no output file is given, the output is sent to
  24 the standard output.
  25 .P
  26 sabcmd can also run in a batch mode to process single input file with
  27 multiple stylesheets (--batch-xml) or to apply a stylesheet to multiple
  28 input files (--batch-xsl).
  29 .P
  30 .B Assignments
  31 allow to pass parameters and named buffers to the
  32 processor. The assignments have always the form of
  33 .IP
  34 name1=value1 name2=value2 ...
  35 .P
  36 where name is either an ASCII string for named buffers or an ASCII string
  37 with the leading '$' sign for parameters. (Note that you need to use the
  38 right quotes to prevent the shell interpreter from performing an expansion
  39 of variables).
  40 .SH OPTIONS
  41 Option can be of two forms - short or long. If some options have
  42 values, the values are separated with a whitespace for short options
  43 and with a equal sign ('=') for long options.
  44 .IP
  45 -L mylog.log
  46 .P
  47 is the same as
  48 .IP
  49 --log-file=mylog.log
  50 .SS COMMON OPTIONS
  51 .TP
  52 .B -x, --batch-xml
  53 multiple stylesheets, single input file
  54 .TP
  55 .B -s, --batch-xsl
  56 multiple input files, single stylesheet
  57 .TP
  58 .B -b, --base=NAME
  59 set the hard base URI to NAME
  60 .TP
  61 .B --debug-options
  62 display the information on debugging options
  63 .TP
  64 .B \-?, --help
  65 display this help message
  66 .TP
  67 .B \-L, --log-file=NAME
  68 set the log file, turns logging on
  69 .TP
  70 .B \-m, --measure
  71 measure the time of processing
  72 .TP
  73 .B -v, --version
  74 display the version information
  75 .SS DEBUG OPTIONS
  76 .TP
  77 .B --debug
  78 display results of the command line parse
  79 .TP
  80 .B \-t, --times=COUNT
  81 run sabcmd the specified number of times
  82 .TP
  83 .B \-f, --flags
  84 pass flags given to SablotSetOptions()
  85 .TP
  86 .B \-F, --use-SPF
  87 use SablotProcessFiles()
  88 .TP
  89 .B \-S, --use-SPS
  90 use SablotProcessStrings(). Give 2 args (stylesheet,
  91 input). Precede each by @.
  92 .TP
  93 .B --use-SPS-on-files
  94 use SablotProcessStrings() on the contents of the given files.
  95 .SH ENVIRONMENT
  96 When the <xsl:sort> instruction is used without the 'lang' attribute,
  97 common locale related environment variables apply..
  98 .SH BUGS
  99 There are no known bugs related to
 100 .B sabcmd
 101 currently. Most of bugs you can meet are related to Sablotron
 102 processor itself. In such a case, please take a look at Sablotron's
 103 home website (www.gingerall.org) or contact us at <sab-bugs@gingerall.cz>.
 104
 105 .SH AUTHOR
 106 Pavel Hlavnicka <pavel@gingerall.cz>