Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
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 docu-
       ments 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,	chang-
       ing  to the directory in	which a	yodl-file is located. This has the ad-
       vantage 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 be-
       low).

OPTIONS
       The options are identical to those of the yodl(1) program.

       Additionally, the following options are available:

       o      --no-warnings:
	      By default the converters	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., tmp/wip/macros). This file is auto-loaded before FILE (see
       the synopsis) is	loaded,	to make	the conversion to format possible.

       The output is written to	one or more files having the  extension	 .for-
       mat.

SEE ALSO
       yodlstriproff(1),   yodl(1),   yodlbuiltins(7),	 yodlletter(7),	 yodl-
       macros(7), yodlmanpage(7), yodlpost(1), yodlverbinsert(1).

BUGS
       -

AUTHOR
       Frank B.	Brokken	(f.b.brokken@rug.nl),

yodl_3.10.00.tar.gz		   1996-2017		     yodlconverters(1)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | FILES | SEE ALSO | BUGS | AUTHOR

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=yodl2html&sektion=1&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help