xenial (1) yodlverbinsert.1.gz

Provided by: yodl_3.06.00-1_amd64 bug

NAME

       yodlverbinsert - Generate verb-sections from parts of a file

SYNOPSIS

       yodlverbinsert [OPTIONS] [marker] file

DESCRIPTION

       Verbinsert  is a simple C support program that can be used to generate verb()-sections in Yodl files from
       sections of existing files. The files from which sections are included are usually C or Cpp source files,
       accepting either // or /*-style comment. See the EXAMPLES section for illustrations.

       Verbinsert  offers  the  possibility  to  indent  both  the  initial verb-statement and the inserted file
       contents. Furthermore, an additional empty line may be inserted before the first line  that  is  actually
       inserted.

       Blank lines at the beginning and end of files are ignored.

       o      marker
              The  argument marker must start in file’s first column en must either start as a standard C or C++
              comment: // or /* must be used. Following that, the remainder of the argument is used as a  label,
              e.g.,  //label,  /*LABEL*/.  Except  for  the  first two characters and their locations no special
              restrictions are imposed upon the markers. A labeled section ends at the next //= (when the  label
              started  with  //)  or  at  the  next /**/ (when the label started with /*). Like the markers, the
              end-markers must also start in the file’s first column.

       o      file
              The argument file must be an existing file.

       Verbinsert writes its selected section to its standard output stream.

       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  Yodl’s
       -L (--legacy-include) option is used.

OPTIONS

       The  default  values of options are listed with each of the options between square brackets. The defaults
       were chosen so that yodlverbinsert performs the behavior of an earlier version of this program, which was
       not distributed with Yodl.

       o      -a
              Process  all lines of file (except initial and trailing blank lines). The argument marker must not
              be specified.

       o      -n
              Immediately following the indentation:  lines  are  prefixed  by  numbers,  occupying  2  columns,
              followed by a colon and a blank.

       o      -N
              Do  not  write a newline immediately following verb-statement’s open-parenthesis. By default it is
              written, causing an additional line to be inserted before the first line that’s actually  inserted
              from a file.

       o      -s nSpaces [0]
              start each line that is written into the verb-section with nSpaces additional blanks.

       o      -S nSpaces [8]
              prefix the verb of the verb-section by nSpaces additional blanks.

       o      -t nTabs [0]
              start  each  line  that  is written into the verb-section with nTabs additional tab characters. If
              both -s and -t are specified, the tabs are inserted first.

       o      -T nTabs [0]
              prefix the verb of the verb-section by nTabs additional tab characters. If  both  -S  and  -T  are
              specified, the tabs are inserted first.

EXAMPLE

       Assume the file demo contains the following text:

       preceding text

       //one
       one 1

       //=

       /*two*/

           two

       /**/

       trailing text

       Then the following commands write the shown output to the program’s standard output:

       o      yodlverbinsert //one demo
                      verb(
              one 1
              )

       o      yodlverbinsert -N //one demo
                      verb(one 1
              )

       o      yodlverbinsert -n -s4 ’/*two*/’ demo
                      verb(
                      1: two
              )

SEE ALSO

       yodlstriproff(1),    yodl(1),    yodlbuiltins(7),    yodlconverters(1),   yodlletter(7),   yodlmacros(7),
       yodlmanpage(7), yodlpost(1)

BUGS

       -

AUTHOR

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