GROFF_PRESENT(7)

NAME
groff_present - groff presentation macros

SYNOPSIS
groff -mm -mpresent [options ...] [files ...]

DESCRIPTION
The presentation macros are based upon the groff mm macros. They are useful for making presentations with the use of a beamer, but without use of the PAUSE macro, they can also be used for making slides.

The post-processor presentps(1) is needed for manipulation of the PostScript output of groff(1) in order to make it a presentation.

USAGE
A presentation can be made with the following commands.
    % groff -mm -mpresent file.rof > file.pps
    % presentps -l < file.pps > file.ps
    % ps2pdf file.ps
    % acroread file.pdf

Slides can be made with the following command.
    % groff -P-l -mm -mpresent file.rof > file.ps

  Macros

ADDCONTENT string
    Adds string to the contents which can be made with the macro END.

BACKGROUND args
    Defines the background to be used. This macro should be invoked before the page is started. A description of args is given below.
    Default: None

    Solid color
        Makes a solid background.

    GradX color1 color2
        Makes a gradient background in the x-direction from color1 to color2.

    GradY color1 color2
        Makes a gradient background in the y-direction from color1 to color2.

    GradAngle color1 color2 steps angle
        Makes a gradient background in a direction with an angle from color1 to color2.

    None
        No background is made.

BLOCKS [once] [x [y [length]
    A block is started with the upper right corner at x,y. By omission of y and/or x the current coordinates are used. If length is given, the line length is set to this. If the first option is once this block only appears once, so after a PAUSE this block does not show up anymore.

BLOCKE
    Ends a block. The position is reset to the position before the block was started.

COLOR color [arg1 [arg2]]
    Sets the foreground color. color must be the name of a predefined color or a color defined with the macro DEFCOLOR. If color is P, the foreground color is set to the previous color. If arg1 is given then only this is printed in the specified color. If arg2 is given, this is put directly after arg1 in the current color.
    Default: black (DEFCOLOR is mapped onto the groff request .defcolor.)

DEFAULTCOLOR color
    Sets the default color for headers, footers, and text. Use this macro after defining HEADER.
    Default: black

DEFCOLOR name red green blue
    Defines a color name with the values for red, green, and blue represented by the other arguments. These values must be between 0 and 1.
    See also subsection Predefined colors.

DESTINATION name
    Defines a destination name to which a link can be made.

END Generates a contents page build up from the titles specified with the macro TITLE and additional text specified by the macro ADDCONTENT.

FILL x1 y1 x2 y2 args
    Since the routines are there anyway for making the backgrounds, we might as well use them for filling rectangles. For a description of args see macro BACKGROUND.

FOOTER
    If this macro is defined it is called at the bottom of the page.

FOOTERSIZE n
    Sets the size of the footer to nv. For technical reasons the minimum is 2.
    Default: 3

HEADER
    If this macro is defined it is called at the top of the page.

INITCOLOR color
    Sets the color for text. Should be used at the start of the presentation instead of COLOR.
    Default: black

LINK name string
    Makes a link from string to the destination name.

LINKCOLOR color [border-width [border-color]]
    Sets the foreground color for the text of a link. Optionally the width and the color of the border for the link can also be set.
    Default: blue7 0 black

MARGIN left [right]
    Sets the left and right margins. If right is not given, it is set equal to the left margin.
    Default: 0.75i

MARKD name
    Shows the output of groff that has been marked with name on the same page with the use of the macros MARKS and MARKE.

MARKE
    Ends the marking of output previously started by the macro MARKS.

MARKS name
    Starts the marking of output with name.

PAUSE
    Pauses the presentation at this point.

SUBTITLE string
    Makes a subtitle in a way that can be specified with SUBTITLEFORMAT in a big font (smaller than with TITLE) in a color that can be specified with the macro SUBTITLECOLOR.

SUBTITLECOLOR name
    Sets the color of subtitles to name.
    Default: blue4

SUBTITLEFORMAT L | C | R | I [n]
    Sets the format for subtitles.
    Default: I

    L   left adjusted

    C   centered

    R   right adjusted

    I [n]
        indented with indentation n if given (default 0.5i)

TITLE string
    Makes a title in a way that can be specified with the macro TITLEFORMAT in a big font in a color that can be specified with the macro TITLECOLOR.

TITLECOLOR name
    Sets the color of titles to name.
    Default: blue4

TITLEFORMAT L | C | R | I [n]
    Sets the format for titles.
    Default: C

    L   left adjusted

    C   centered

    R   right adjusted

    I [n]
        indented with indentation n if given (default 0.5i)

  Strings

\*[colname]
    Changes the foreground color to name. If name is P the foreground color is set to the previous color.
    Deprecated: use \m[name] and \m[] instead.

\*[subtitle]
    Holds the last subtitle. It is reset by the macro TITLE.

\*[title]
    Holds the last title.

  Predefined colors
The following colors are predefined:
    red green blue cyan magenta yellow white black
The following colors are also predefined:
    redn greenn bluen cyann magentan yellown grayn
Where n is a number between 1 and 9 representing the intensity of the color.

groff(1) has some predefined colors of its own, which can also be used.

FILES

.../groff/.../tmac/m.tmac

.../groff/.../tmac/present.tmac

SEE ALSO
groff(1), groff_mm(7), presentps(1), ps2pdf(1), acroread(1), groff_piclink(7)

AUTHOR
Bob Diertens, <b.diertens@uva.nl>