File: sdf.html

package info (click to toggle)
sdf 2.001%2B1-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 6,140 kB
  • ctags: 2,440
  • sloc: perl: 18,543; sh: 31; makefile: 29
file content (909 lines) | stat: -rw-r--r-- 20,239 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
<!doctype html public "-//W30//DTD W3 HTML 2.0//EN">

<HTML>

<!-- This file was generated using SDF 2.001 by
     Ian Clatworthy (ianc@mincom.com). SDF is freely
     available from http://www.mincom.com/mtr/sdf. -->

<HEAD>
<TITLE>SDF 2.001: SDF Reference: sdf - SDF Conversion Utility</TITLE>
</HEAD>
<BODY BGCOLOR="ffffff">

<DIV CLASS="header">
<P><IMG SRC="../sdflogo.gif" ALIGN="Right"></P>
<DIV CLASS="navigate">
<P ALIGN="Center"><A HREF="re_sdf.html">Contents</A> | <A HREF="in_prog.html">Parent Topic</A> | <A HREF="in_prog.html">Previous Topic</A> | <A HREF="sdfapi.html">Next Topic</A> <BR><A HREF="../index.html">Home</A> | <A HREF="../catalog.html">Catalog</A></P>
</DIV>
<BR CLEAR="Right">
</DIV>
<DIV CLASS="main">
<H1><A NAME="sdf">11.2. sdf - SDF Conversion Utility</A></H1>
<HR>
<H2><A NAME="Purpose">Purpose</A></H2>
<P><A HREF="../ref/sdf.html">sdf</A> converts <A HREF="http://www.mincom.com/mtr/sdf/">SDF</A> files to other document formats.</P>
<HR>
<H2><A NAME="Usage">Usage</A></H2>
<PRE>
usage  : sdf [+alias] [-h[help]] [-o[out_ext]]
         [-l[log_ext]] [-O[out_dir]] [-2 format]
         [-D variable,..] [-n split_level]
         [-f flag,..] [-I include_path,..]
         [-p[prefilter]] [-a parameters] [-P[plang]]
         [-N[line_numbers]] [-g[get_report]]
         [-r report] [-L locale] [-k look]
         [-s style] [-S page_size] [-c config]
         [-u uses,..] [-H head_level] [-K head_look]
         [-d driver] [-y post_filter]
         [-z post_process,..] [-t target]
         [-v[verbose]] [-T trace_levels,..]
         [-w width] [-Y library_path,..]
         sdf_file ...
purpose: convert an sdf file to another format
version: 2.001    (SDF 2.001)
</PRE>
<P>The options are:</P>
<TABLE CLASS="columns" BORDER>
<TR CLASS="heading">
<TD>
<STRONG>Option</STRONG>
</TD>
<TD>
<STRONG>Description</STRONG>
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_h">-h</A>
</TD>
<TD>
display help on options
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_o">-o</A>
</TD>
<TD>
output file extension
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_l">-l</A>
</TD>
<TD>
log file extension
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_O">-O</A>
</TD>
<TD>
output to input file's (or explicit) directory
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_2">-2</A>
</TD>
<TD>
the output format you want
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_D">-D</A>
</TD>
<TD>
define variables
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_n">-n</A>
</TD>
<TD>
heading level to autosplit into topics
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_f">-f</A>
</TD>
<TD>
define flags (i.e. DOC_* variables)
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_I">-I</A>
</TD>
<TD>
search path for include files, templates, etc.
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_p">-p</A>
</TD>
<TD>
pre-filter input file from each argument
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_a">-a</A>
</TD>
<TD>
parameters for the pre-filter
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_P">-P</A>
</TD>
<TD>
pre-filter as a programming language
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_N">-N</A>
</TD>
<TD>
number lines in pretty-printed source code
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_g">-g</A>
</TD>
<TD>
pre-filter using sdfget with the report specified
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_r">-r</A>
</TD>
<TD>
report to run on the SDF to transform it before formatting
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_L">-L</A>
</TD>
<TD>
locale
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_k">-k</A>
</TD>
<TD>
look library
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_s">-s</A>
</TD>
<TD>
style of document
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_S">-S</A>
</TD>
<TD>
page size for paper documents
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_c">-c</A>
</TD>
<TD>
configuration library
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_u">-u</A>
</TD>
<TD>
modules to use
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_H">-H</A>
</TD>
<TD>
initial heading level
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_K">-K</A>
</TD>
<TD>
heading look (H, A or P)
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_d">-d</A>
</TD>
<TD>
format driver - default is expand
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_y">-y</A>
</TD>
<TD>
filter to post-filter the output with
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_z">-z</A>
</TD>
<TD>
list of post processing actions to do
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_t">-t</A>
</TD>
<TD>
logical target format
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_v">-v</A>
</TD>
<TD>
verbose mode
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_T">-T</A>
</TD>
<TD>
debugging trace levels
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_w">-w</A>
</TD>
<TD>
width for text-based outputs
</TD>
</TR>
<TR>
<TD>
<A HREF="#sdf_Y">-Y</A>
</TD>
<TD>
search path for libraries
</TD>
</TR>
</TABLE>

<P>The aliases are:</P>
<TABLE CLASS="columns" BORDER>
<TR CLASS="heading">
<TD>
<STRONG>Alias</STRONG>
</TD>
<TD>
<STRONG>Description</STRONG>
</TD>
</TR>
<TR>
<TD>
mc
</TD>
<TD>
generate a MIMS chapter
</TD>
</TR>
<TR>
<TD>
ms
</TD>
<TD>
generate a MIMS spec
</TD>
</TR>
<TR>
<TD>
mt
</TD>
<TD>
generate a MIMS topic
</TD>
</TR>
<TR>
<TD>
sdf2doc_fm
</TD>
<TD>
generate Frame binary format via FrameMaker
</TD>
</TR>
<TR>
<TD>
sdf2dvi_sgml
</TD>
<TD>
generate DVI format via SGML
</TD>
</TR>
<TR>
<TD>
sdf2fvo_fm
</TD>
<TD>
generate FrameViewer format via FrameMaker
</TD>
</TR>
<TR>
<TD>
sdf2hlp_mif
</TD>
<TD>
generate Windows Help input files via MIF
</TD>
</TR>
<TR>
<TD>
sdf2html_
</TD>
<TD>
generate a HTML document
</TD>
</TR>
<TR>
<TD>
sdf2html_dir
</TD>
<TD>
generate an SDF directory in HTML
</TD>
</TR>
<TR>
<TD>
sdf2html_fm
</TD>
<TD>
generate a HTML document via FrameMaker
</TD>
</TR>
<TR>
<TD>
sdf2html_topics
</TD>
<TD>
generate HTML topics
</TD>
</TR>
<TR>
<TD>
sdf2htx_
</TD>
<TD>
generate MIMS HTX format
</TD>
</TR>
<TR>
<TD>
sdf2info_sgml
</TD>
<TD>
generate GNU info format via SGML
</TD>
</TR>
<TR>
<TD>
sdf2latex_
</TD>
<TD>
generate LaTeX
</TD>
</TR>
<TR>
<TD>
sdf2latex_pod
</TD>
<TD>
generate LaTeX format via POD
</TD>
</TR>
<TR>
<TD>
sdf2latex_sgml
</TD>
<TD>
generate LaTeX format via SGML
</TD>
</TR>
<TR>
<TD>
sdf2lyx_sgml
</TD>
<TD>
generate a LyX file via SGML
</TD>
</TR>
<TR>
<TD>
sdf2man_pod
</TD>
<TD>
generate Man page format via POD
</TD>
</TR>
<TR>
<TD>
sdf2mf6_
</TD>
<TD>
generate MIMS F6 help format
</TD>
</TR>
<TR>
<TD>
sdf2mif_
</TD>
<TD>
generate Frame MIF format
</TD>
</TR>
<TR>
<TD>
sdf2pdf_html
</TD>
<TD>
generate PDF via HTML
</TD>
</TR>
<TR>
<TD>
sdf2pdf_mif
</TD>
<TD>
generate PostScript and PDF via FrameMaker
</TD>
</TR>
<TR>
<TD>
sdf2pod_
</TD>
<TD>
generate POD format
</TD>
</TR>
<TR>
<TD>
sdf2ps_fm
</TD>
<TD>
generate PostScript via FrameMaker
</TD>
</TR>
<TR>
<TD>
sdf2ps_fmbook
</TD>
<TD>
generate PostScript via a FrameMaker book
</TD>
</TR>
<TR>
<TD>
sdf2ps_html
</TD>
<TD>
generate PostScript via HTML
</TD>
</TR>
<TR>
<TD>
sdf2ps_pod
</TD>
<TD>
generate PostScript via POD
</TD>
</TR>
<TR>
<TD>
sdf2ps_sgml
</TD>
<TD>
generate PostScript via SGML
</TD>
</TR>
<TR>
<TD>
sdf2rtf_fm
</TD>
<TD>
generate RTF format via FrameMaker
</TD>
</TR>
<TR>
<TD>
sdf2rtf_mif
</TD>
<TD>
generate RTF format via MIF
</TD>
</TR>
<TR>
<TD>
sdf2rtf_sgml
</TD>
<TD>
generate RTF format via SGML format
</TD>
</TR>
<TR>
<TD>
sdf2sdf_expand
</TD>
<TD>
generate expanded SDF
</TD>
</TR>
<TR>
<TD>
sdf2sdf_raw
</TD>
<TD>
generate raw SDF
</TD>
</TR>
<TR>
<TD>
sdf2sgml_
</TD>
<TD>
generate SGML format
</TD>
</TR>
<TR>
<TD>
sdf2txt_
</TD>
<TD>
generate plain text format
</TD>
</TR>
<TR>
<TD>
sdf2txt_fm
</TD>
<TD>
generate plain text format via FrameMaker
</TD>
</TR>
<TR>
<TD>
sdf2txt_pod
</TD>
<TD>
generate plain text format via POD
</TD>
</TR>
</TABLE>

<HR>
<H2><A NAME="Description">Description</A></H2>
<P><A NAME="sdf_h">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.</A></P>
<P><A NAME="sdf_o">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 <EM>out</EM> is assumed.</A></P>
<P><A NAME="sdf_l">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 <EM>log</EM> is assumed.</A></P>
<P><A NAME="sdf_O">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.</A></P>
<P><A NAME="sdf_2">The -2 option is a convenient way of specifying the alias (collection of options) which generates the output you want. e.g.</A></P>
<PRE>
     sdf -2html abc
</PRE>
<P>is equivalent to:</P>
<PRE>
     sdf +sdf2html abc
</PRE>
<P><A NAME="sdf_D">The -D option is used to define variables. These are typically used for controlling conditional text and substituting text which changes. The format used is:</A></P>
<PRE>
 -Dvariable1=value1,variable2=value2
</PRE>
<P><A NAME="sdf_f">A flag is a shorthand way of specifying variables in the DOC family. i.e. -ftoc=3 is equivalent to -DDOC_TOC=3. The format of the -f option is:</A></P>
<PRE>
 -fflag1=value1,flag2=value2
</PRE>
<P>If a variable or flag is specified without a value, 1 is assumed.</P>
<P>To generate <A HREF="http://www.w3.org/hypertext/WWW/MarkUp/">HTML</A> topics, the command is:</P>
<PRE>
     sdf -2topics abc
</PRE>
<P><A NAME="sdf_n">By default, this will create sub-topics for each heading already in a separate file. It will also <EM>autosplit</EM> level 1 headings into sub-topics. The -n option can be used to control which level headings are split at:</A></P>
<UL>
<LI>1 autosplits on level 1 headings (the default)
<LI>2 autosplits on level 2 headings
<LI>3 autosplits on level 3 headings
<LI>0 disables autosplitting.</UL>
<P><A NAME="sdf_I">Include files are searched for in the current directory, then in the directories given by the -I option, then in the default library directory.</A></P>
<P>By default, <A HREF="../ref/sdf.html">sdf</A> is configured to <EM>prefilter</EM> files with certain extensions. For example:</P>
<PRE>
 sdf mytable.tbl
</PRE>
<P>is equivalent to executing <A HREF="../ref/sdf.html">sdf</A> on a file which only contains:</P>
<PRE>
 !include &quot;mytable.pl&quot;; table
</PRE>
<P><A NAME="sdf_p">The -p option can be used to explicitly prefilter files or to override the default prefilter used. If a parameter is not provided, the prefilter is assumed to be <EM>table</EM>.</A></P>
<P><A NAME="sdf_a">The -a option can be used to specify parameters for the prefilter. For example:</A></P>
<PRE>
 sdf -aformat='15,75,10' mytable.tbl
</PRE>
<P><A NAME="sdf_P">The -P option prefilters the input files as programming languages. The parameter is the language to use. If none is provided, the extension is assumed to be the language name. For example:</A></P>
<PRE>
 sdf -P myapp.c
</PRE>
<P>is equivalent to executing <A HREF="../ref/sdf.html">sdf</A> on a file which only contains:</P>
<PRE>
 !include &quot;myapp.c&quot;; example; wide; lang='c'
</PRE>
<P><A NAME="sdf_N">The -N option adds line numbers at the frequency given. The default frequency is 1. i.e. every line.</A></P>
<P><A NAME="sdf_g"> </A>The -g option prefilters the input files by executing <A HREF="../ref/sdfget.html">sdfget</A> using the default report (default.sdg). To change the report used, specify the report name as the parameter. If the report name doesn't include an extension, sdg is assumed.</P>
<P><HR WIDTH="80%" ALIGN="Left">
<STRONG>Note: </STRONG><A HREF="../ref/sdfget.html">sdfget</A> searches for reports in the current directory, then in the <EM>stdlib</EM> directory within SDF's library directory.
<HR WIDTH="80%" ALIGN="Left"></P>
<P><A NAME="sdf_r">The -r option runs the nominated SDR report on each input before formatting. In other words, SDR reports provide a mechanism for:</A></P>
<UL>
<LI>analysing the SDF just before it would be formatted, and
<LI>replacing that SDF with the output of the report (also SDF) so that the final output is a nicely formatted report.</UL>
<P>For example, the <EM>sdf_dir</EM> report generates a directory (tree) of the components (files) included in an SDF document. Reports are stored in <EM>sdr</EM> files and are searched for using the usual rules.</P>
<P><A NAME="sdf_L">The -L option can be used to specify a <EM>locale</EM>. The default locale name is specified in <TT>sdf.ini</TT>. Locale naming follows POSIX conventions (i.e. language_country), so the locale name for American english is <EM>en_us</EM>. The information for each locale is stored in the <TT>locale</TT> directory, so you'll need to have to look in there to see what locales are available. (As the default locale can be set in <TT>sdf.ini</TT>, this isn't as ugly as it first sounds.)</A></P>
<P><HR WIDTH="80%" ALIGN="Left">
<STRONG>Note: </STRONG>At the moment, a locale file simply contains a list of language specific strings. Ultimately, it should be extended to support localisation of date and time formats.
<HR WIDTH="80%" ALIGN="Left"></P>
<P><A NAME="sdf_k">The -k option is used to specify a <EM>look</EM>. The default look library is specified in <TT>sdf.ini</TT>.</A></P>
<P><A NAME="sdf_s">The -s option can be used to specify a document <EM>style</EM>. Typical values are:</A></P>
<UL>
<LI><EM>document</EM> - a technical document
<LI><EM>memo</EM> - a memo
<LI><EM>fax</EM> - a facsimile
<LI><EM>minutes</EM> - minutes of a meeting.</UL>
<P><A NAME="sdf_S">The -S option is used to specify the page size. Values supported include:</A></P>
<TABLE CLASS="columns" BORDER>
<TR CLASS="heading">
<TD>
<STRONG>Name</STRONG>
</TD>
<TD>
<STRONG>Width</STRONG>
</TD>
<TD>
<STRONG>Height</STRONG>
</TD>
<TD>
<STRONG>Comment</STRONG>
</TD>
</TR>
<TR>
<TD>
global
</TD>
<TD>
21.0cm
</TD>
<TD>
11.0in
</TD>
<TD>
will fit on either A4 or letter
</TD>
</TR>
<TR>
<TD>
A3
</TD>
<TD>
29.7cm
</TD>
<TD>
42.0cm
</TD>
<TD>
&nbsp;
</TD>
</TR>
<TR>
<TD>
A4
</TD>
<TD>
21.0cm
</TD>
<TD>
29.7cm
</TD>
<TD>
&nbsp;
</TD>
</TR>
<TR>
<TD>
A5
</TD>
<TD>
14.8cm
</TD>
<TD>
21.0cm
</TD>
<TD>
&nbsp;
</TD>
</TR>
<TR>
<TD>
B4
</TD>
<TD>
25.7cm
</TD>
<TD>
36.4cm
</TD>
<TD>
&nbsp;
</TD>
</TR>
<TR>
<TD>
B5
</TD>
<TD>
17.6cm
</TD>
<TD>
25.0cm
</TD>
<TD>
&nbsp;
</TD>
</TR>
<TR>
<TD>
letter
</TD>
<TD>
8.5in
</TD>
<TD>
11.0in
</TD>
<TD>
&nbsp;
</TD>
</TR>
<TR>
<TD>
legal
</TD>
<TD>
8.5in
</TD>
<TD>
14.0in
</TD>
<TD>
&nbsp;
</TD>
</TR>
<TR>
<TD>
tabloid
</TD>
<TD>
11.0in
</TD>
<TD>
17.0in
</TD>
<TD>
&nbsp;
</TD>
</TR>
</TABLE>

<P>Additional page sizes can be configured in <TT>sdf.ini</TT>. To specify a rotated version of a named page size, append an <EM>R</EM>. 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:</P>
<PRE>
     {{width}}x{{height}}
</PRE>
<P>where <EM>width</EM> and <EM>height</EM> are the respective sizes in points.</P>
<P><A NAME="sdf_c">The -c option is used to specify a configuration library.</A></P>
<P><A NAME="sdf_u">A list of modules to use can be specified via the -u option.</A></P>
<P><A NAME="sdf_H"> </A>The initial heading level to start on can be specified via the -H option. This is useful if you want to preview how a topic will be displayed without regenerating the complete document. If a topic begins with a level 1 heading (e.g. H1) and you wish to format it as a document (i.e. the level 1 text becomes the DOC_NAME for <A HREF="../ref/mbuild_t.html">build_title</A>), use the -H option with a value of 0.</P>
<P><A NAME="sdf_K">The look of headings can also be adjusted. By default, H-style headings are numbered, A-style headings are lettered and P-style headings are plain. To force a particular style for all headings, the -K option can be used. Sensible parameter values are H, A and P although other values may work depending on what paragraph styles are configured at your site.</A></P>
<P><A NAME="sdf_d">The -d option is used to specify the format driver. Values supported include:</A></P>
<UL>
<LI><EM>expand</EM> - format as expanded text (the default)
<LI><EM>mif</EM> - Maker Interchange Format
<LI><EM>pod</EM> - Plain Old Documentation (as used by <A HREF="http://www.perl.com/perl/index.html">Perl</A>).</UL>
<P>Additional drivers can be configured in <TT>sdf.ini</TT>.</P>
<P><A NAME="sdf_y">The -y option can to used to specify a post-filter.</A></P>
<P><A NAME="sdf_z">The -z option can be used to specify a list of post-processing actions you want to execute on each output file after it is generated. The actions supported include:</A></P>
<UL>
<LI><EM>ps</EM> - generate PostScript
<LI><EM>doc</EM> - generate a Frame (binary) file
<LI><EM>fvo</EM> - generate a Frame View-Only file
<LI><EM>txt</EM> - generate a text file
<LI><EM>rtf</EM> - generate an RTF file
<LI><EM>clean</EM> - delete the output file (must be last).</UL>
<P>Additional actions can be configured in <TT>sdf.ini</TT>. By convention, the generated files are given the same names as the action keywords.</P>
<P><A NAME="sdf_t">The -t option is used to specify the logical target format. If none is specified, the default is the first post processing action, if any. Otherwise, the default is the format driver name.</A></P>
<P><A NAME="sdf_v">The -v option enables verbose mode. This is useful for debugging problems related to post processing. In particular, post processing actions containing the pattern <EM>clean</EM> are skipped in verbose mode. You can also switch off the post processing messages by using a verbose value of -1. Values higher than 1 switch on additional trace messages as follows:</A></P>
<UL>
2 - show how names of files and libraries are resolved
<BR>
3 - show the directories searched for libraries
<BR>
4 - show the directories searched for modules
<BR>
5 - show the directories searched for normal files.</UL>
<P><A NAME="sdf_T">The -T option can be used to switch on debug tracing. The parameter is a comma-separated list of name-value pairs where each name is a <EM>tracing group</EM> and each value is the level of tracing for that group. To get the trace output provided by the -v option, one can use the <EM>user</EM> group like this:</A></P>
<PRE>
  sdf -Tuser=2 ...
</PRE>
<P>This is slightly different from the -v option in that intermediate files are not implicitly kept. Additional tracing groups will be added over time (probably one per output driver).</P>
<P><A NAME="sdf_w">The -w option is used to specify the width for text-based outputs.</A></P>
<P>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.</P>
<HR>
<H2><A NAME="Examples">Examples</A></H2>
<P>Convert <TT>mydoc.sdf</TT> to a technical document in mif format, output is <TT>mydoc.mif</TT>:</P>
<PRE>
 sdf -2mif mydoc.sdf
</PRE>
<P>Convert <TT>mydoc.sdf</TT> to online documentation in <A HREF="http://www.frame.com">FrameViewer</A> format, output is <TT>mydoc.fvo</TT>:</P>
<PRE>
 sdf -2fvo mydoc.sdf
</PRE>
<P>Convert <TT>mydoc.sdf</TT> to online documentation in HTML, output is <TT>mydoc.html</TT>:</P>
<PRE>
 sdf -2html mydoc.sdf
</PRE>
<P>The following command will build the reference documentation for a SDF module in HTML:</P>
<PRE>
 sdf -2html abc.sdm
</PRE>
<HR>
<H2><A NAME="Limitations and future directions">Limitations and future directions</A></H2>
<P>Many of the default post processing (-z) actions only works on <A HREF="http://www.cis.ohio-state.edu/hypertext/faq/usenet/unix-faq/faq/top.html">Unix</A> as <A HREF="http://www.frame.com/PRODUCTS/Products.doc.html">FrameMaker</A> for <A HREF="http://www.microsoft.com/windows">Windows</A> does not support batch conversion.</P>
<P>Topics mode has several limitations:</P>
<UL>
<LI>only documents in the current directory can be converted
<LI>all sub-topics must also be in the current directory.</UL>
</DIV>
<DIV CLASS="footer">
<DIV CLASS="navigate">
<P ALIGN="Center"><A HREF="re_sdf.html">Contents</A> | <A HREF="in_prog.html">Parent Topic</A> | <A HREF="in_prog.html">Previous Topic</A> | <A HREF="sdfapi.html">Next Topic</A> <BR><A HREF="../index.html">Home</A> | <A HREF="../catalog.html">Catalog</A></P>
</DIV>
</DIV>

</BODY>
</HTML>