aboutsummaryrefslogtreecommitdiffhomepage
path: root/DOCS
diff options
context:
space:
mode:
authorGravatar diego <diego@b3059339-0415-0410-9bf9-f77b7e298cf2>2003-12-07 00:49:44 +0000
committerGravatar diego <diego@b3059339-0415-0410-9bf9-f77b7e298cf2>2003-12-07 00:49:44 +0000
commit73f2cc10d6e0381b178d64d57d77eb6c3428e537 (patch)
treed9185278de9872d040d7fe11d7c98fb12922edb4 /DOCS
parente2b64667f24056f4c22fef22f7a3cbc727a13eb0 (diff)
updates, fixes, cosmetics
git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@11562 b3059339-0415-0410-9bf9-f77b7e298cf2
Diffstat (limited to 'DOCS')
-rw-r--r--DOCS/tech/manpage.txt14
1 files changed, 9 insertions, 5 deletions
diff --git a/DOCS/tech/manpage.txt b/DOCS/tech/manpage.txt
index 64d5ba25c7..5186e1dcb5 100644
--- a/DOCS/tech/manpage.txt
+++ b/DOCS/tech/manpage.txt
@@ -17,7 +17,7 @@ What belongs in the man page?
-----------------------------
- option descriptions (all)
- - usage (options, config files, controls)
+ - usage (options, configuration files, controls)
- basic examples
@@ -55,18 +55,21 @@ A setting of 4 should look readable. Here's an overview again:
- groff: Groff is the "official" tool to convert man pages.
To get good results you need a recent version (1.18.2).
- groff -man -Thtml mplayer.1 > manpage.html
- groff -rLL=64n -m man -Tascii mplayer.1 | col -bx > manpage.txt
+ groff -m man -T html mplayer.1 > man_page.html
+ groff -m man -T ascii -rLL=78n mplayer.1 | col -bx > man_page.txt
The groff man page lists other output formats to use with -T.
+
- man2html: You can view it through a CGI script:
http://localhost/cgi-bin/man2html?mplayer
The output is unusable as the script doesn't seem to support
the macro definitions. Maybe manually changing all leads to
acceptable results.
- - rman: rman -f html mplayer.1 > manpage.rman.html
+
+ - rman: rman -f html mplayer.1 > man_page.rman.html
The output is ugly as rman doesn't understand many of the
macros used.
- - troffcvt: troff2html -man mplayer.1 > manpage.tcvt.html
+
+ - troffcvt: troff2html -man mplayer.1 > man_page.tcvt.html
The (good) output is similar to groff but simplified...
@@ -127,6 +130,7 @@ The man page/groff format
Just read this and RTFS:
+ man 7 roff
http://www.tldp.org/HOWTO/mini/Man-Page.html
man 7 man
man 7 groff