empire/empserver
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

tests/README: Cover info.ps and document .NA use for commands

Browse source 
Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
This commit is contained in:
Markus Armbruster 2015-03-08 12:44:02 +01:00
parent 8ca51001f0
commit c869c868e2
1 changed files with 6 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

7
info/README
View file

@ -4,9 +4,12 @@ Make remakes info pages, table of contents and index automatically.
This requires Perl 5 and troff. To remake just formatted info pages, This requires Perl 5 and troff. To remake just formatted info pages,
run make info. run make info.
To remake HTML info, run make html. This is not done by default. The To make HTML info, run make html. This is not done by default. The
recommended start page is TOP.html, but you may also like all.html. recommended start page is TOP.html, but you may also like all.html.
To make a single PostScript file for printing, run make info.ps. This
is not done by default. The result is currently quite ugly.
--- How to add a new info page --- --- How to add a new info page ---
@ -43,6 +46,8 @@ The first line must be a title header:
The second line must be a name header: The second line must be a name header:
.NA arg1 arg2 .NA arg1 arg2
- arg1 must be the name - arg1 must be the name
- if the info page is for an Empire command, then arg2 must be the
exact command name
- arg2 is a one-line description of the info page which will be put - arg2 is a one-line description of the info page which will be put
on the subject pages that your info page belongs to. It should be on the subject pages that your info page belongs to. It should be
in double quotes in double quotes