.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.19) .\" .\" 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" '' '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 turned on, 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. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" 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 "SDNGEN 1" .TH SDNGEN 1 "2011-11-09" "perl v5.12.4" "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" sdngen \- SDF Tuning File Generator .SH "PURPOSE" .IX Header "PURPOSE" \&\fIsdngen\fR extracts \s-1SDF\s0 template information from a \fIFrameMaker\fR template. .SH "USAGE" .IX Header "USAGE" .Vb 6 \& usage : sdngen [\-h[help]] [\-o[out_ext]] \& [\-l[log_ext]] [\-O[out_dir]] [\-p para_root] \& [\-f font_root] [\-t tbl_root] \& [\-e existing_template] file ... \&purpose: generate an SDF template from a Frame one \&version: 2.000 (SDF 2.001) .Ve .PP The options are: .PP .Vb 9 \& Option Description \& \-h display help on options \& \-o output file extension \& \-l log file extension \& \-O output to input file\*(Aqs (or explicit) directory \& \-p default parent for a paragraph format \& \-f default parent for a font format \& \-t default parent for a table format \& \-e existing template file .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" 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 By default, generated output goes to standard output. To direct output to a file per input file, use the \-o option to specify an extension for output files. If the \-o option is specified without a parameter, an extension of \fIout\fR is assumed. .PP Likewise, error messages go to standard error by default. Use the \-l option to create a log file per input file. If the \-l option is specified without a parameter, an extension of \fIlog\fR is assumed. .PP By default, generated output and log files are created in the current directory. Use the \-O option to specify an explicit output directory. If the \-O option is specified without a parameter, the input file's directory is used. .PP The \-p option can be used to specify the root paragraph format from which others are derived. The default paragraph root is \fIBody\fR. .PP The \-f option can be used to specify the root font (i.e. phrase) format from which others are derived. The default font root is \&\fIEmphasis\fR. .PP The \-t option can be used to specify the root table format from which others are derived. The default table root is \fIFormat A\fR. .PP As formats often appear in families (e.g. Heading1, Heading2, etc.), \&\fIsdngen\fR will use the (alphabetically) previous format as the parent if it makes a better parent (i.e. there are less differences) than the default one. .PP If a template already exists, it can be specified using the \-e option. In this case, \fIsdngen\fR will get as much information as it can from that file including: .IP "\(bu" 4 the root format for each type .IP "\(bu" 4 the order of formats within a type .IP "\(bu" 4 the parent for each format. .PP Within each type, formats which are unknown in the existing template are output after those that are known. .SH "EXAMPLES" .IX Header "EXAMPLES" To generate an \s-1SDF\s0 tuning file file: .PP .Vb 1 \& sdngen \-osdn mytemplate.mif .Ve .PP This will create a template file called \fImytemplate.sdn\fR.