Contents | Parent Topic | Previous Topic | Next Topic
Home | Catalog
sdf converts SDF files to other document formats.
usage : sdf [+alias] [-h[help]] [-o[out_ext]] [-l[log_ext]] [-2 format] [-D variable,..] [-n split_level] [-f flag,..] [-I include_path,..] [-p prefilter] [-a parameters] [-P[plang]] [-N[line_numbers]] [-r report] [-L locale] [-k look] [-s style] [-S page_size] [-c config] [-u uses,..] [-H head_level] [-d driver] [-y post_filter] [-z post_process,..] [-t target] [-v[verbose]] [-w width] sdf_file ... purpose: convert an sdf file to another format version: 2.000 (SDF 2.000)
The options are:
Option | Description |
-h | display help on options |
-o | output file extension |
-l | log file extension |
-2 | the output format you want |
-D | define variables |
-n | heading level to autosplit into topics |
-f | define flags (i.e. DOC_* variables) |
-I | search path for include files, templates, etc. |
-p | pre-filter input file from each argument |
-a | parameters for the pre-filter |
-P | pre-filter as a programming language |
-N | number lines in pretty-printed source code |
-r | report to pre-filter the input with |
-L | locale |
-k | look library |
-s | style of document |
-S | page size for paper documents |
-c | configuration library |
-u | modules to use |
-H | initial heading level |
-d | format driver - default is expand |
-y | filter to post-filter the output with |
-z | list of post processing actions to do |
-t | logical target format |
-v | verbose mode |
-w | width for text-based outputs |
The aliases are:
Alias | Description |
mc | generate a MIMS chapter |
ms | generate a MIMS spec |
mt | generate a MIMS topic |
sdf2doc_fm | generate Frame binary format via FrameMaker |
sdf2dvi_sgml | generate DVI format via SGML |
sdf2fvo_fm | generate FrameViewer format via FrameMaker |
sdf2hlp_mif | generate Windows Help input files via MIF |
sdf2html_ | generate a HTML document |
sdf2html_dir | generate an SDF directory in HTML |
sdf2html_fm | generate a HTML document via FrameMaker |
sdf2html_topics | generate HTML topics |
sdf2htx_ | generate MIMS HTX format |
sdf2info_sgml | generate GNU info format via SGML |
sdf2latex_pod | generate LaTeX format via POD |
sdf2latex_sgml | generate LaTeX format via SGML |
sdf2lyx_sgml | generate a LyX file via SGML |
sdf2man_pod | generate Man page format via POD |
sdf2mf6_ | generate MIMS F6 help format |
sdf2mif_ | generate Frame MIF format |
sdf2pdf_mif | generate PostScript and PDF via FrameMaker |
sdf2pod_ | generate POD format |
sdf2ps_fm | generate PostScript via FrameMaker |
sdf2ps_fmbook | generate PostScript via a FrameMaker book |
sdf2ps_pod | generate PostScript via POD |
sdf2ps_sgml | generate PostScript via SGML |
sdf2rtf_fm | generate RTF format via FrameMaker |
sdf2rtf_mif | generate RTF format via MIF |
sdf2rtf_sgml | generate RTF format via SGML format |
sdf2sdf_expand | generate expanded SDF |
sdf2sdf_raw | generate raw SDF |
sdf2sgml_ | generate SGML format |
sdf2txt_ | generate plain text format |
sdf2txt_fm | generate plain text format via FrameMaker |
sdf2txt_pod | generate plain text format via POD |
sdf -2html abc
is equivalent to:
sdf +sdf2html abc
-Dvariable1=value1,variable2=value2
-fflag1=value1,flag2=value2
If a variable or flag is specified without a value, 1 is assumed.
To generate HTML topics, the command is:
sdf -2topics abc
By default, sdf is configured to prefilter files with certain extensions. For example:
sdf mytable.tbl
is equivalent to executing sdf on a file which only contains:
!include "mytable.pl"; table
sdf -aformat='15,75,10' mytable.tbl
sdf -P myapp.c
is equivalent to executing sdf on a file which only contains:
!include "myapp.c"; example; wide; lang='c'
The -N option adds line numbers at the frequency given. The default fequency is 1. i.e. every line.
The -k option is used to specify a look. The default look library is specified in sdf.ini.
The -s option can be used to specify a document style. Typical values are:
The -S option is used to specify the page size. Values supported include:
Name | Width | Height | Comment |
global | 21.0cm | 11.0in | will fit on either A4 or letter |
A3 | 29.7cm | 42.0cm | |
A4 | 21.0cm | 29.7cm | |
A5 | 14.8cm | 21.0cm | |
B4 | 25.7cm | 36.4cm | |
B5 | 17.6cm | 25.0cm | |
letter | 8.5in | 11.0in | |
legal | 8.5in | 14.0in | |
tabloid | 11.0in | 17.0in |
Additional page sizes can be configured in sdf.ini. To specify a rotated version of a named page size, append an R. For example, A4R implies a width of 29.7cm and a height of 21cm. A custom page size can also be specified using the format:
{{width}}x{{height}}
where width and height are the respective sizes in points.
The -c option is used to specify a configuration library.
A list of modules to use can be specified via the -u option.
The -d option is used to specify the format driver. Values supported include:
Additional drivers can be configured in sdf.ini.
The -y option can to used to specify a post-filter.
Additional actions can be configured in sdf.ini. By convention, the generated files are given the same names as the action keywords.
The -w option is used to specify the width for text-based outputs.
The -z, -D, -f and -I options are list options. i.e. multiple values can be separated by commas and/or the options can be supplied multiple times.
Convert mydoc.sdf to a technical document in mif format, output is mydoc.mif:
sdf -2mif mydoc.sdf
Convert mydoc.sdf to online documentation in FrameViewer format, output is mydoc.fvo:
sdf -2fvo mydoc.sdf
Convert mydoc.sdf to online documentation in HTML, output is mydoc.html:
sdf -2html mydoc.sdf
The following command will build the reference documentation for a SDF module in HTML:
sdf -2html abc.sdm
Many of the default post processing (-z) actions only works on Unix as FrameMaker for Windows does not support batch conversion.
Topics mode has several limitations:
Contents | Parent Topic | Previous Topic | Next Topic
Home | Catalog