Sample man files
[reactos.git] / rosapps / sysutils / man / man / man.1
1 ./" My first man page for ReactOS :)
2 .TH ReactOS manual project 2004
3
4 .SH NAME
5 man.exe - manual browser for ReactOS
6 .SH SYNOPSIS
7 .B man [
8 .I manual page
9 .B ]
10 .SH DESCRIPTION
11 This project is UNIX(tm) man compatible tool for ReactOS.
12 .NL
13 Manual browser support next tags:
14 .NL
15 .I ./"
16 as comment tag
17 .NL
18 .I .NL
19 as "new line" tag (ReactOS only)
20 .NL
21 .I .B
22 as "bold" tag
23 .NL
24 .I .I
25 as "italic" tag
26 .NL
27 .I .SH
28 as part tag
29 .NL
30 .I .TH
31 as page descriptor
32 .NL
33 .SH OPTIONS
34 At this moment man support only
35 .B "/?, /h, -h, --help"
36 arguments :)
37 .SH FILES
38 Now all of manual pages must be in
39 .B c:\man\
40 directory. This is hack or
41 bug, i don't know... We planed use ENVIRONMENT
42 varrible to set manual path.
43 .NL
44 Manual files should have extension which marks section of his content.
45 .NL
46 .SH SECTIONS
47 .B (1)
48 basic commands. (dir,del,man,etc...)
49 .NL
50 .B (2)
51 kernel calls
52 .NL
53 .B (3)
54 calls from system librares
55 .NL
56 .B (4)
57 device files or devices
58 .NL
59 .B (5)
60 file syntax description
61 .NL
62 .B (6)
63 games
64 .NL
65 .B (7)
66 different information (such as licences, manifestos, etc...)
67 .NL
68 .B (8)
69 administration tools (Admin or root only)
70 .NL
71 .B (9)
72 additional kernel information
73 .NL
74
75 .SH ENVIRONMENT
76 Comming soon
77 .SH BUGS
78 Heh... A lot of. For example:
79 .NL
80 .I Scroll-bug
81 man can't correctly scroll screen
82 .NL
83 .I .NL hack
84 tag who absent in original man
85 .NL
86 .I ./" hack
87 at the end of man file must be ./" tag
88 .NL
89 .I putchar() method
90 all text displays with putchar() function.
91 .NL
92 And we have non correct word carry.
93
94 .SH AUTHOR
95 Semyon <tappak> Novikov
96 .NL
97 .I <tappak@freemail.ru>
98 .NL
99 Sorry for my English. I'm just a Russian first-year student.
100 ./"