dm_roff_ms_header Function

public pure function dm_roff_ms_header(title, author, institution, font_family, font_size, left_header, center_header, right_header, left_footer, center_footer, right_footer, page_one) result(roff)

Creates a new GNU roff document with macro package ms. The result has to be piped to groff(1).

The font family must be one of the following types:

• ROFF_FONT_AVANT_GARDE
• ROFF_FONT_BOOKMAN
• ROFF_FONT_HELVETICA
• ROFF_FONT_HELVETICA_NARROW
• ROFF_FONT_NEW_CENTURY_SCHOOLBOOK
• ROFF_FONT_PALATINO
• ROFF_FONT_TIMES_ROMAN

If no font family and size is provided, Times Roman in 10 pt is used by default. To set a fractional font size, multiply the size by 1000. For instance, pass 10500 in argument font_size to select a size of 10.5 pt.

The return value is newline-terminated. Append a request or macro to the output of this function to create a valid groff(1) document.

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in),	optional		::	title	Document title.
character(len=*),	intent(in),	optional		::	author	Author name.
character(len=*),	intent(in),	optional		::	institution	Institution name.
integer,	intent(in),	optional		::	font_family	Font family enumerator (ROFF_FONT_*).
integer,	intent(in),	optional		::	font_size	Font size in pt.
character(len=*),	intent(in),	optional		::	left_header	Left header content.
character(len=*),	intent(in),	optional		::	center_header	Center header content.
character(len=*),	intent(in),	optional		::	right_header	Right header content.
character(len=*),	intent(in),	optional		::	left_footer	Left footer content.
character(len=*),	intent(in),	optional		::	center_footer	Center footer content.
character(len=*),	intent(in),	optional		::	right_footer	Right footer content.
logical,	intent(in),	optional		::	page_one	Enable header on page 1.

Return Value character(len=:), allocatable

Output string.