.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "SDFBATCH 1"
.TH SDFBATCH 1 "2023-08-02" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
sdfbatch \- Batch Processing Utility
.SH "PURPOSE"
.IX Header "PURPOSE"
\&\fIsdfbatch\fR is a preprocessor for \fIfmbatch\fR, \fIFrameMaker\fR's
command-line driven batch processing utility.
.SH "USAGE"
.IX Header "USAGE"
.Vb 7
\& usage  : sdfbatch [+alias] [\-h[help]] [\-f fmt_file]
\&         [\-F fmt_what] [\-u] [\-p[print_doc]]
\&         [\-P paper_size] [\-s[save_ext]]
\&         [\-S save_fmt] [\-n] [\-t timeout]
\&         frame_file ...
\&purpose: generate fmbatch input file
\&version: 2.000    (SDF 2.001)
.Ve
.PP
The options are:
.PP
.Vb 11
\& Option       Description
\& \-h           display help on options
\& \-f           formats file
\& \-F           formats to import
\& \-u           update documents
\& \-p           print documents
\& \-P           paper size name
\& \-s           save extension
\& \-S           save file format
\& \-n           output the batch file (instead of calling fmbatch)
\& \-t           timeout for printer driver to generate ps
.Ve
.PP
The aliases are:
.PP
.Vb 2
\& Alias        Description
\& fm2ps        convert Frame files to PostScript
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Given a set of \fIFrameMaker\fR documents, \fIsdfbatch\fR can be used to:
.IP "\(bu" 4
change the formatting of the documents (ala \fIUse Formats From\fR)
.IP "\(bu" 4
update the documents (i.e. cross-references, etc.)
.IP "\(bu" 4
print the documents
.IP "\(bu" 4
save the documents in a nominated file format
.PP
The \-h option provides help. If it is specified without a parameter, a
brief description of each option is displayed. To display the
attributes for an option, specify the option letter as a parameter.
.PP
To change formatting, use the \-f option to specify the file to import
the formats from. The \-F option can be used to specify what formats
are imported. The argument to the \-F option is a set of the characters
in the table below.
.PP
.Vb 10
\& Character    Meaning
\& p            Paragraph formats
\& f            Font formats
\& l            Page layouts
\& c            Cross references
\& v            Variables
\& r            Reference page contents
\& t            Table formats
\& x            Conditional text
\& k            Color
\& m            math
\& B            Preserve manual page breaks
\& O            Preserve other formatting overrides
.Ve
.PP
By default, all formats are imported.
.PP
To update documents, use the \-u option.
.PP
To print documents, use the \-p option. If a parameter is not provided,
the file will be printed to the default printer. To print to a
\&\fIPostScript\fR file, specify the \*(L"file\*(R" keyword as the parameter.
Alternatively, the parameter is the name of a \fIprint settings\fR file.
.PP
When generating a \fIPostScript\fR file, the paper size can be specified
using the \-P option. The default value is \fIglobal\fR. The paper size
name is actually mapped to a \fIprint settings\fR file called
\&\fIpaper_size\fR.\fIfmver\fR in the \fIstdlib\fR library directory. \fIfmver\fR is
typically either fm4 or fm5, depending on which version of FrameMaker
you are using.
.PP
To save documents, use the \-s option. By default, this saves each
file. To change the extension, supply an argument to the \-s option.
.PP
To specify a different format, use the \-S option. Possible values are:
.IP "\(bu" 4
m \- \s-1MIF\s0
.IP "\(bu" 4
a \- line-oriented \s-1ASCII\s0
.IP "\(bu" 4
t \- paragraph-oriented \s-1ASCII\s0
.IP "\(bu" 4
d \- Frame document
.IP "\(bu" 4
l \- View-Only Frame document
.IP "\(bu" 4
\&\- \- file's current format [default]
.PP
Take care with the file extension \- any existing files will be
replaced without warning.
.PP
The \-n option causes the generated \fIfmbatch\fR file to be output. i.e.
fmbatch is not called. This option is useful for debugging.
.PP
The \-t option enables the user to tune the time-out used when waiting
for the print driver to generate a PostScript file. The default value
is 300 seconds (i.e. 5 minutes).
.PP
A combination of the f, u, p and s options can be supplied if more
that one operation is required per file. For example, you may wish to
import formats and then save the resultant file. For each file, the
operations are always done in the following order:
.IP "1." 4
formatting
.IP "2." 4
updating
.IP "3." 4
printing
.IP "4." 4
saving
.PP
\&\fBNote: \fRNot all of the values documented for the \-F and \-S options
may be supported in Frame versions before 4.0 and additional values
may be supported in future versions. As such, the values supplied to
these options are simply embedded in the generated \fIsdfbatch\fR file.
i.e. no checking is done on the value. This behaviour is considered a
feature.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
To format and print a set of files:
.PP
.Vb 1
\&        sdfbatch \-fmyfmts.doc \-p *.doc
.Ve
.PP
To convert mif files to binary files:
.PP
.Vb 1
\&        sdfbatch \-sdoc \-Sd *.mif
.Ve
.PP
To copy Frame variables from a file to a set of files:
.PP
.Vb 1
\&        sdfbatch \-fvariable.mif \-Fv \-s *.doc
.Ve