Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

yodlconverters(1) [debian man page]

yodlconverters(1)					    Your Own Document Language						 yodlconverters(1)

NAME
yodl2... - miscellaneous Yodl converters SYNOPSIS
yodl2... [OPTION]... FILE DESCRIPTION
This manual page describes the various shell scripts that convert documents in the Yodl language to other formats. The basic converters are: o yodl2html(1): converts to HTML, writes a file with the extension .html. o yodl2man(1): converts to nroff `man' format, writes .man. Can be further processed with e.g. nroff -Tascii -man file.man. o yodl2latex(1): converts to LaTeX output, writes .latex. Can be further processed with, e.g., latex file.latex. o yodl2txt(1): converts to plain ASCII, writes .txt. This is a very rudimentary converter, a last-resort. NOTE: Starting with Yodl version 3.00.0 Yodl's default file inclusion behavior has changed. The current working directory no longer remains fixed at the directory in which Yodl is called, but is volatile, changing to the directory in which a yodl-file is located. This has the advantage that Yodl's file inclusion behavior now matches the way C's #include directive operates; it has the disadvantage that it may break some current documents. Conversion, however is simple but can be avoided altogether if the -L (--legacy-include) option is used (see below). OPTIONS
The options are identical to those of the yodl(1) program. Additionally, the following options are available: o --no-warnings: By default the convertors call yodl(1) using the -w flag. The option --no-warnings suppresses this flag. o --intermediate=<filename>: By default, files used for the communication between yodl and yodlpost are removed following the conversion. The --intermedi- ate=<filename> option may be provided to retain these files, called <filename> and <filename>.idx. FILES
Each yodl2format converter requires a file format.yo in Yodl's include path (e.g., /usr/share/yodl). This file is auto-loaded before FILE (see the synopsys) is loaded, to make the conversion to format possible. The output is written to one or more files having the extension .format. SEE ALSO
yodlstriproff(1), yodl(1), yodlbuiltins(7), yodlletter(7), yodlmacros(7), yodlmanpage(7), yodlpost(1), yodlverbinsert(1). BUGS
- AUTHOR
Frank B. Brokken (f.b.brokken@rug.nl), yodl_3.00.0.tar.gz 1996-2010 yodlconverters(1)

Check Out this Related Man Page

cdoc(1) 						      General Commands Manual							   cdoc(1)

Name
       cdoc - invokes CDA Converter

Syntax
       cdoc [ -s format ] [ -d format ] [ -O options_file ] [ -o outputfile ] inputfile

Description
       The command converts the revisable format file, inputfile, to another revisable format or to a final form file.	If inputfile is not speci-
       fied, reads from standard input.  Unless a destination file is specified with the -o option, the command writes files to standard output.

Options
       -s format	   Specifies the format of inputfile and invokes an appropriate input converter as part of CDA. The ddif, dtif, dots  (for
			   analysis  output  only) and text converters are provided in the base system kit.  Additional converters can be added by
			   the CDA Converter Library and other layered products.  Converter Library and other layered products.  Contact your sys-
			   tem manager for a complete list of the input formats supported on your system. The default format is ddif.

       -d format	   Specifies  the  format  of outputfile and invokes an appropriate output converter as part of CDA. The ddif, dtif, text,
			   analysis, and ps converters are provided in the base system kit. Additional converters can be added	by  the  CDA  Con-
			   verter  Library  and other layered products. Contact your system manager for a complete list of the output formats sup-
			   ported on your system.  The default format is ddif.

       -O options_file	   Names the file passed to the input and output converters to control specific processing  options  for  each	converter.
			   Refer to your documentation set for a description of converter options.

			   The	options  file  has a default file type of .cda_options. Each line of the options file specifies a format name that
			   can optionally be followed by _input or _output to restrict the option to either an input or output converter. The sec-
			   ond	word  is  a valid option preceded by one or more spaces, tabs, or a slash (/) and can contain upper- and lowercase
			   letters, numbers, dollar signs, and underlines. The case of letters is not significant. If an option requires a  value,
			   then spaces, tabs, or an equal sign can separate the option from the value.

			   Each  line  can  optionally be preceded by spaces and tabs and can be terminated by any character other than those that
			   can be used to specify the format names and options. The syntax and interpretation of the text that follows the  format
			   name is specified by the supplier of the front and back end converters for the specified format.

			   To  specify several options for the same input or output format, specify one option on a line. If an invalid option for
			   an input or output format or an invalid value for an option is specified, the option may be ignored or an error message
			   may	be  returned.  Each  input or output format that supports processing options specifies any restrictions or special
			   formats required when specifying options.

			   By default, any messages that occur during processing of the options file are written  to  the  system  standard  error
			   location.  For those input and output formats that support a LOG option, messages can be directed to a log file.

       -o outputfile	   Specifies the name of the output file.  If not specified, writes to standard output.

See Also
       vdoc(1), dxvdoc(1X), DDIF(5), DTIF(5), DOTS(5), CDA(5)

																	   cdoc(1)
Man Page