mirror of
https://github.com/reactos/reactos.git
synced 2025-04-30 19:19:00 +00:00
Sample man files
svn path=/trunk/; revision=9491
This commit is contained in:
parent
0f711c642b
commit
f11893f56e
2 changed files with 178 additions and 0 deletions
78
rosapps/sysutils/man/man/foo.1
Normal file
78
rosapps/sysutils/man/man/foo.1
Normal file
|
@ -0,0 +1,78 @@
|
||||||
|
.\" Process this file with
|
||||||
|
.\" groff -man -Tascii foo.1
|
||||||
|
.\"
|
||||||
|
.TH FOO 1 "MARCH 1995" Linux "User Manuals"
|
||||||
|
.SH NAME
|
||||||
|
foo \- frobnicate the bar library
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B foo [-bar] [-c
|
||||||
|
.I config-file
|
||||||
|
.B ]
|
||||||
|
.I file
|
||||||
|
.B ...
|
||||||
|
.SH DESCRIPTION
|
||||||
|
.B foo
|
||||||
|
frobnicates the bar library by tweaking internal
|
||||||
|
symbol tables. By default it parses all baz segments
|
||||||
|
and rearranges them in reverse order by time for the
|
||||||
|
.BR xyzzy (1)
|
||||||
|
linker to find them. The symdef entry is then compressed
|
||||||
|
using the WBG (Whiz-Bang-Gizmo) algorithm.
|
||||||
|
All files are processed in the order specified.
|
||||||
|
.SH OPTIONS
|
||||||
|
.IP -b
|
||||||
|
Do not write 'busy' to stdout while processing.
|
||||||
|
.IP "-c config-file"
|
||||||
|
Use the alternate system wide
|
||||||
|
.I config-file
|
||||||
|
instead of
|
||||||
|
.IR /etc/foo.conf .
|
||||||
|
This overrides any
|
||||||
|
.B FOOCONF
|
||||||
|
environment variable.
|
||||||
|
.IP -a
|
||||||
|
In addition to the baz segments, also parse the
|
||||||
|
blurfl headers.
|
||||||
|
.IP -r
|
||||||
|
Recursive mode. Operates as fast as lightning
|
||||||
|
at the expense of a megabyte of virtual memory.
|
||||||
|
.SH FILES
|
||||||
|
.I /etc/foo.conf
|
||||||
|
.RS
|
||||||
|
The system wide configuration file. See
|
||||||
|
.BR foo (5)
|
||||||
|
for further details.
|
||||||
|
.RE
|
||||||
|
.I ~/.foorc
|
||||||
|
.RS
|
||||||
|
Per user configuration file. See
|
||||||
|
.BR foo (5)
|
||||||
|
for further details.
|
||||||
|
.SH ENVIRONMENT
|
||||||
|
.IP FOOCONF
|
||||||
|
If non-null the full pathname for an alternate system wide
|
||||||
|
.IR foo.conf .
|
||||||
|
Overridden by the
|
||||||
|
.B -c
|
||||||
|
option.
|
||||||
|
.SH DIAGNOSTICS
|
||||||
|
The following diagnostics may be issued on stderr:
|
||||||
|
|
||||||
|
Bad magic number.
|
||||||
|
.RS
|
||||||
|
The input file does not look like an archive file.
|
||||||
|
.RE
|
||||||
|
Old style baz segments.
|
||||||
|
.RS
|
||||||
|
.B foo
|
||||||
|
can only handle new style baz segments. COBOL
|
||||||
|
object libraries are not supported in this version.
|
||||||
|
.SH BUGS
|
||||||
|
The command name should have been chosen more carefully
|
||||||
|
to reflect its purpose.
|
||||||
|
.SH AUTHOR
|
||||||
|
Jens Schweikhardt <schweikh@noc.dfn.de>
|
||||||
|
.SH "SEE ALSO"
|
||||||
|
.BR bar (1),
|
||||||
|
.BR foo (5),
|
||||||
|
.BR xyzzy (1)
|
100
rosapps/sysutils/man/man/man.1
Normal file
100
rosapps/sysutils/man/man/man.1
Normal file
|
@ -0,0 +1,100 @@
|
||||||
|
./" My first man page for ReactOS :)
|
||||||
|
.TH ReactOS manual project 2004
|
||||||
|
|
||||||
|
.SH NAME
|
||||||
|
man.exe - manual browser for ReactOS
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B man [
|
||||||
|
.I manual page
|
||||||
|
.B ]
|
||||||
|
.SH DESCRIPTION
|
||||||
|
This project is UNIX(tm) man compatible tool for ReactOS.
|
||||||
|
.NL
|
||||||
|
Manual browser support next tags:
|
||||||
|
.NL
|
||||||
|
.I ./"
|
||||||
|
as comment tag
|
||||||
|
.NL
|
||||||
|
.I .NL
|
||||||
|
as "new line" tag (ReactOS only)
|
||||||
|
.NL
|
||||||
|
.I .B
|
||||||
|
as "bold" tag
|
||||||
|
.NL
|
||||||
|
.I .I
|
||||||
|
as "italic" tag
|
||||||
|
.NL
|
||||||
|
.I .SH
|
||||||
|
as part tag
|
||||||
|
.NL
|
||||||
|
.I .TH
|
||||||
|
as page descriptor
|
||||||
|
.NL
|
||||||
|
.SH OPTIONS
|
||||||
|
At this moment man support only
|
||||||
|
.B "/?, /h, -h, --help"
|
||||||
|
arguments :)
|
||||||
|
.SH FILES
|
||||||
|
Now all of manual pages must be in
|
||||||
|
.B c:\man\
|
||||||
|
directory. This is hack or
|
||||||
|
bug, i don't know... We planed use ENVIRONMENT
|
||||||
|
varrible to set manual path.
|
||||||
|
.NL
|
||||||
|
Manual files should have extension which marks section of his content.
|
||||||
|
.NL
|
||||||
|
.SH SECTIONS
|
||||||
|
.B (1)
|
||||||
|
basic commands. (dir,del,man,etc...)
|
||||||
|
.NL
|
||||||
|
.B (2)
|
||||||
|
kernel calls
|
||||||
|
.NL
|
||||||
|
.B (3)
|
||||||
|
calls from system librares
|
||||||
|
.NL
|
||||||
|
.B (4)
|
||||||
|
device files or devices
|
||||||
|
.NL
|
||||||
|
.B (5)
|
||||||
|
file syntax description
|
||||||
|
.NL
|
||||||
|
.B (6)
|
||||||
|
games
|
||||||
|
.NL
|
||||||
|
.B (7)
|
||||||
|
different information (such as licences, manifestos, etc...)
|
||||||
|
.NL
|
||||||
|
.B (8)
|
||||||
|
administration tools (Admin or root only)
|
||||||
|
.NL
|
||||||
|
.B (9)
|
||||||
|
additional kernel information
|
||||||
|
.NL
|
||||||
|
|
||||||
|
.SH ENVIRONMENT
|
||||||
|
Comming soon
|
||||||
|
.SH BUGS
|
||||||
|
Heh... A lot of. For example:
|
||||||
|
.NL
|
||||||
|
.I Scroll-bug
|
||||||
|
man can't correctly scroll screen
|
||||||
|
.NL
|
||||||
|
.I .NL hack
|
||||||
|
tag who absent in original man
|
||||||
|
.NL
|
||||||
|
.I ./" hack
|
||||||
|
at the end of man file must be ./" tag
|
||||||
|
.NL
|
||||||
|
.I putchar() method
|
||||||
|
all text displays with putchar() function.
|
||||||
|
.NL
|
||||||
|
And we have non correct word carry.
|
||||||
|
|
||||||
|
.SH AUTHOR
|
||||||
|
Semyon <tappak> Novikov
|
||||||
|
.NL
|
||||||
|
.I <tappak@freemail.ru>
|
||||||
|
.NL
|
||||||
|
Sorry for my English. I'm just a Russian first-year student.
|
||||||
|
./"
|
Loading…
Reference in a new issue