sdngen(1) [debian man page]
SDNGEN(1) User Contributed Perl Documentation SDNGEN(1) NAME
sdngen - SDF Tuning File Generator PURPOSE
sdngen extracts SDF template information from a FrameMaker template. USAGE
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) The options are: Option Description -h display help on options -o output file extension -l log file extension -O output to input file's (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 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. 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 out is assumed. 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 log is assumed. 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. The -p option can be used to specify the root paragraph format from which others are derived. The default paragraph root is Body. 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 Emphasis. The -t option can be used to specify the root table format from which others are derived. The default table root is Format A. As formats often appear in families (e.g. Heading1, Heading2, etc.), sdngen 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. If a template already exists, it can be specified using the -e option. In this case, sdngen will get as much information as it can from that file including: o the root format for each type o the order of formats within a type o the parent for each format. Within each type, formats which are unknown in the existing template are output after those that are known. EXAMPLES
To generate an SDF tuning file file: sdngen -osdn mytemplate.mif This will create a template file called mytemplate.sdn. perl v5.12.4 2011-11-09 SDNGEN(1)
Check Out this Related Man Page
SDFAPI(1) User Contributed Perl Documentation SDFAPI(1) NAME
sdfapi - API Extraction Utility PURPOSE
sdfapi extracts Application Programming Interface information from (Perl) source code. USAGE
usage : sdfapi [-h[help]] [-o[out_ext]] [-l[log_ext]] [-O[out_dir]] [-f fmt_tag] [-p[pattern]] [-s sym_type,..] [-j] file ... purpose: extract the API from a (perl) library version: 2.000 (SDF 2.001) The options are: Option Description -h display help on options -o output file extension -l log file extension -O output to input file's (or explicit) directory -f output format tag -p only symbols matching pattern -s only symbols of these types -j add SDF-style hypertext jumps from each symbol 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. 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 out is assumed. 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 log is assumed. 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. The format of the output can be controlled using the -f option. Supported formats are std and concise. The default is std. std format is: require "abc.pl"; $myvar = ... $result = &myfunc($myparams); concise format has fewer blank lines and uses 1 line per symbol. A comma-separated list of symbol types to output can be specified using the -s option. Supported symbol types are: o sub - subroutines o var - variables The default is to extract all symbols. The -p option is used to extract only a subset of the symbols. If not supplied, the pattern is symbols beginning with a letter. If supplied without an option, the pattern defaults to all symbols. If perl libraries use the coding convention that symbols beginning with underscore are private, then -p_ can be used to extract the private symbols. The -j option can be used to request SDF-style hypertext jumps be added for each symbol. The jump target is lib_sym where: o lib is the library name o sym is the symbol name. LIMITATIONS AND FUTURE DIRECTIONS
The only language currently supported is Perl. It would be useful to extract messages from the scripts too. This would require a new utility called sdfmsg say, which searched through the source (including libraries) for AppMsg and AppExit calls. Internally, it may be better to implement formats via routines. This would give better control over output. e.g. it would be up to the routine to decide if it wanted to output the 'require' header. perl v5.12.4 2011-11-09 SDFAPI(1)