2009/CaoCourseTme2: tool.1

File tool.1, 4.7 KB (added by franck, 15 years ago)
Line 
1.\" ---------------------------------------------------------------------------
2.TH TOOLNAME VERSION "Mois Jour, Annee" "UPMC/ASIM/LIP6"
3.\" $Id$
4.\" @(#)AA/MM/JJ UPMC/ASIM/LIP6; Author: FirstName LastName
5.\" ---------------------------------------------------------------------------
6.\" Main useful commands
7.\" --------------------
8.\" .TH Head and Foot of page
9.\" .SH at the line begining is a Section Header
10.\" .SS at the line begining is a Sub-Section Header
11.\" .TP <num> allows to present a list of items, the nextline is the title,
12.\"     the following lines is the corpus shifted of <num> chars.
13.\"     if <num> is omited, the default value is 7
14.\" .so filename allows to include a filename (absolute or relative to MANPATH)
15.\" \fB is for  Bold font \fP is to return to Previous font
16.\" \fI is to underlined or to change to Italic font
17.\" .B .I can be used for Bold or Italic, if place a the line beginning
18.\" .br at the line begining break the line, a blank line put a blank line
19.\" .nf Begins a Non-Formatted zone where each line-break is put as-is
20.\" .fi Returns to Formatted mode .nf/.fi is usefull for example to draw tables
21.\" ---------------------------------------------------------------------------
22
23.\" Tool Name description
24.\" ---------------------
25.SH NAME
26
27Tool - a single phrase about this tool
28
29.\" OrganizationAddress, same for all man
30.\" -------------------------------------
31.SH ORIGIN
32
33This software belongs to the \fIALLIANCE\fP CAD system from the CAO-VLSI team at \fBASIM/LIP6/UPMC\fP laboratory.
34
35.nf
36LIP6/ASIM University P. et M. Curie
37          4, place Jussieu
38          75252 PARIS Cedex 05, FRANCE
39
40Fax       (33)-1 44277080
41E-mail    alliance\-users@asim.lip6.fr
42http      //asim.lip6.fr/alliance
43.fi
44
45.\" Tool prototype, optionnal parameter must be enclosed in []
46.\" ----------------------------------------------------------
47.SH SYNOPSIS
48
49\fBoutil\fP [\fB-option1p\fP] [\fB-option2\fP] [\fB-option3 \fIparametre\fP]
50.br
51argument1 argument2
52
53.\" Tool description, from 1 paragraph to several pages
54.\" ---------------------------------------------------
55.SH DESCRIPTION
56
57\fBTool\fP is a tool that is just defined to describe how to write a man.
58blablabla, blablabla, blablabla, blablabla, blablabla, blablabla,
59blablabla, blablabla, blablabla, blablabla, blablabla, blablabla.
60
61.\" Each option must be detailled
62.\" -----------------------------
63.SS OPTIONS
64
65.TP
66.B -option1
67Detailled description of option1, detailled description of option1,
68detailled description of option1, detailled description of option1,
69detailled description of option1, detailled description of option1,
70detailled description of option1, detailled description of option1.
71
72A second \fIparagraph\fP if necessary, a second paragraph if necessary, a
73second paragraph if necessary, a second paragraph if necessary, a second
74paragraph if necessary, a second paragraph if necessary, a second paragraph
75if necessary, a second paragraph if necessary. 
76
77.TP
78.B -opt2
79Detailled description of option2, detailled description of option1,
80detailled description of option2, detailled description of option1,
81detailled description of option2, detailled description of option1,
82detailled description of option2, detailled description of option1,
83detailled description of option2, detailled description of option1.
84
85.\" This section is dedicated to present UNIX environement required
86.\" ---------------------------------------------------------------
87.SH ENVIRONMENT
88
89This section is dedicated to present UNIX environement required.
90\fBTool\fP relies on the proper setting of the following environment
91variables:
92
93.TP 20
94.B VARIABLE1(1)
95uses to do something. Number in parenthesis is the manual number if it
96exists.
97
98.TP 20
99.B VARIABLE2
100uses to do otherthing.
101
102.\" Typical example section
103.\" -----------------------
104.SH EXAMPLES
105
106Give few typical examples can be very useful, and help the user if the tool
107description is not very clear. That is also the only section read by the
108user :-)
109
110.nf
111          an non
112             formated text
113             printed
114          as is
115.fi
116
117.\" Errors section
118.\" --------------
119.SH DIAGNOSTICS
120
121This section must help the user to understand main error. It can be a FAQ.
122
123
124.\" At last, give the user links to more information
125.\" ------------------------------------------------
126.SH SEE ALSO
127
128Help the user to find relative informations.
129
130.\" What should be done in case of strange behaviour
131.\" ------------------------------------------------
132.SH BUG REPORT
133
134This tool is under development at the \fBASIM/LIP6/UPMC\fP laboratory,
135cao-vlsi research team.  We need your feedbak to improve documentation and
136tools.  If you find bugs, please send an email to~:
137.br
138.I my_name@asim.lip6.fr
139.br
140Thanks for doing this.