User's manual. Section 1.

WR(1): document writer


USAGE

        usage: wr [-DIPSehlmprsu] [-b dir] [-c sect] [-o file] [-w wid] {file}
            -D: debug
            -I: debug indents
            -P: debug paragraphs
            -S: debug split
            -b dir: change the default refer bib dir
            -c sect: with -h, generate a man page in the given section
            -e: use spanish for labels
            -h: generate html
            -l: generate latex
            -m: generate man page
            -o file: generate a single output file
            -p: generate pdf
            -r: generate roff
            -s: generate ps
            -u: do not generate output for unix
            -w wid: text width for text formats
        

DESCRIPTION

Wr is a document writer that knows how to convert a simple format to one of raw text (for manual pages), troff source, LaTeX source, HTML, PostScript or PDF. It knows how to handle figures (including [cite pic(1)] source) and tables.

The output file(s) are generated in the directory where the command is run, unless flag -o is used to indicate an output file. In this case, output file(s) are generated in the directory of the indicated output file, and this may include extra files for figures using the output file name as a prefix.

The input file may have any name, but the suggested extension is .w for all wr input files.

EXAMPLES

Generate text output for a file:

        ; wr file
        

Generate output for many of them

        ; lf -g , | wr
        

Generate html and place the output at another directory (including any auxiliary files for figures):

        ; wr -h -o /dest/dir/out.html file
        

Besides the file mentioned in the see-also section, all manual pages are also examples of the input format.

SOURCE

  • /zx/sys/src/clive/cmd/wr

SEE ALSO

  • /zx/sys/src/clive/cmd/wr/example for an up to date example source file describing the input language.
  • The Wr document writer. Francisco Ballesteros, 2014, for an out of date but more readable description of the input language.

BUGS

Wr does not generate PDF nor images on its own. For figures, wr relies on convert (from imagemagick) and a few scripts contained in both ghostscript and TeX to generate and convert EPS files. If there are errors while compiling a document with images, it might be that some of these packages are missing. Installing
  • Ghostscript-9.18.pkg, and
  • ImageMagick-6.9.1-0.pkg
seem to suffice for OSX hosts, and you should add
  • mactex-20150613.pkg
if you want LaTeX with pdflatex to compile generated TeX.


User's manual. Section 1.