OpenCores
URL https://opencores.org/ocsvn/or1k/or1k/trunk

Subversion Repositories or1k

[/] [or1k/] [trunk/] [insight/] [tix/] [man/] [man.macros] - Blame information for rev 1765

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 578 markom
'\" The definitions below are for supplemental macros used in Tix
2
'\" manual entries.
3
'\"
4
'\" .HS name section [date [version]]
5
'\"     Replacement for .TH in other man pages.  See below for valid
6
'\"     section names.
7
'\"
8
'\" .AP type name in/out [indent]
9
'\"     Start paragraph describing an argument to a library procedure.
10
'\"     type is type of argument (int, etc.), in/out is either "in", "out",
11
'\"     or "in/out" to describe whether procedure reads or modifies arg,
12
'\"     and indent is equivalent to second arg of .IP (shouldn't ever be
13
'\"     needed;  use .AS below instead)
14
'\"
15
'\" .AS [type [name]]
16
'\"     Give maximum sizes of arguments for setting tab stops.  Type and
17
'\"     name are examples of largest possible arguments that will be passed
18
'\"     to .AP later.  If args are omitted, default tab stops are used.
19
'\"
20
'\" .BS
21
'\"     Start box enclosure.  From here until next .BE, everything will be
22
'\"     enclosed in one large box.
23
'\"
24
'\" .BE
25
'\"     End of box enclosure.
26
'\"
27
'\" .VS
28
'\"     Begin vertical sidebar, for use in marking newly-changed parts
29
'\"     of man pages.
30
'\"
31
'\" .VE
32
'\"     End of vertical sidebar.
33
'\"
34
'\" .DS
35
'\"     Begin an indented unfilled display.
36
'\"
37
'\" .DE
38
'\"     End of indented unfilled display.
39
'\"
40
.\"
41
'\"     # Heading for Tix man pages
42
.de HS
43
.ds ^3 \\0
44
.if !"\\$3"" .ds ^3 \\$3
45
.if '\\$2'cmds'      .TH "\\$1" 1 "\\*(^3" "\\$4" "\\$5"
46
.if '\\$2'lib'       .TH "\\$1" 3 "\\*(^3" "\\$4" "\\$5"
47
.if '\\$2'ncmds'     .TH "\\$1" n "\\*(^3" "\\$4" "\\$5"
48
.if '\\$2'tcl'       .TH "\\$1" n "\\*(^3"  Tcl   "Tcl Built-In Commands"
49
.if '\\$2'tk'        .TH "\\$1" n "\\*(^3"  Tk    "Tk Commands"
50
.if '\\$2'tclc'      .TH "\\$1" 3 "\\*(^3"  Tcl   "Tcl Library Procedures"
51
.if '\\$2'tkc'       .TH "\\$1" 3 "\\*(^3"  Tk    "Tk Library Procedures"
52
.if '\\$2'tclcmds'   .TH "\\$1" 1 "\\*(^3"  Tcl    "Tcl Applications"
53
.if '\\$2'tkcmds'    .TH "\\$1" 1 "\\*(^3"  Tk    "Tk Applications"
54
.if '\\$2'tix'        .TH "\\$1" n "\\*(^3"  Tix    "Tix Commands"
55
.if '\\$2'tixcmds'    .TH "\\$1" 1 "\\*(^3"  Tix    "Tix Applications"
56
.if t .wh -1.3i ^B
57
.nr ^l \\n(.l
58
.ad b
59
..
60
'\"     # Start an argument description
61
.de AP
62
.ie !"\\$4"" .TP \\$4
63
.el \{\
64
.   ie !"\\$2"" .TP \\n()Cu
65
.   el          .TP 15
66
.\}
67
.ie !"\\$3"" \{\
68
.ta \\n()Au \\n()Bu
69
\&\\$1  \\fI\\$2\\fP    (\\$3)
70
.\".b
71
.\}
72
.el \{\
73
.br
74
.ie !"\\$2"" \{\
75
\&\\$1  \\fI\\$2\\fP
76
.\}
77
.el \{\
78
\&\\fI\\$1\\fP
79
.\}
80
.\}
81
..
82
'\"     # define tabbing values for .AP
83
.de AS
84
.nr )A 10n
85
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
86
.nr )B \\n()Au+15n
87
.\"
88
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
89
.nr )C \\n()Bu+\\w'(in/out)'u+2n
90
..
91
'\"     # BS - start boxed text
92
'\"     # ^y = starting y location
93
'\"     # ^b = 1
94
.de BS
95
.br
96
.mk ^y
97
.nr ^b 1u
98
.if n .nf
99
.if n .ti 0
100
.if n \l'\\n(.lu\(ul'
101
.if n .fi
102
..
103
'\"     # BE - end boxed text (draw box now)
104
.de BE
105
.nf
106
.ti 0
107
.mk ^t
108
.ie n \l'\\n(^lu\(ul'
109
.el \{\
110
.\"     Draw four-sided box normally, but don't draw top of
111
.\"     box if the box started on an earlier page.
112
.ie !\\n(^b-1 \{\
113
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
114
.\}
115
.el \}\
116
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
117
.\}
118
.\}
119
.fi
120
.br
121
.nr ^b 0
122
..
123
'\"     # VS - start vertical sidebar
124
'\"     # ^Y = starting y location
125
'\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
126
.de VS
127
.mk ^Y
128
.ie n 'mc \s12\(br\s0
129
.el .nr ^v 1u
130
..
131
'\"     # VE - end of vertical sidebar
132
.de VE
133
.ie n 'mc
134
.el \{\
135
.ev 2
136
.nf
137
.ti 0
138
.mk ^t
139
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
140
.sp -1
141
.fi
142
.ev
143
.\}
144
.nr ^v 0
145
..
146
'\"     # Special macro to handle page bottom:  finish off current
147
'\"     # box/sidebar if in box/sidebar mode, then invoked standard
148
'\"     # page bottom macro.
149
.de ^B
150
.ev 2
151
'ti 0
152
'nf
153
.mk ^t
154
.if \\n(^b \{\
155
.\"     Draw three-sided box if this is the box's first page,
156
.\"     draw two sides but no top otherwise.
157
.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
158
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
159
.\}
160
.if \\n(^v \{\
161
.nr ^x \\n(^tu+1v-\\n(^Yu
162
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
163
.\}
164
.bp
165
'fi
166
.ev
167
.if \\n(^b \{\
168
.mk ^y
169
.nr ^b 2
170
.\}
171
.if \\n(^v \{\
172
.mk ^Y
173
.\}
174
..
175
'\"     # DS - begin display
176
.de DS
177
.RS
178
.nf
179
.sp
180
..
181
'\"     # DE - end display
182
.de DE
183
.fi
184
.RE
185
.sp
186
..

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.