xref: /openbsd-src/gnu/usr.bin/binutils-2.17/bfd/doc/doc.str (revision 3d8817e467ea46cf4772788d6804dd293abfb01a)
1*3d8817e4Smiod: DOCDD
2*3d8817e4Smiod	skip_past_newline
3*3d8817e4Smiod	get_stuff_in_command kill_bogus_lines catstr
4*3d8817e4Smiod	;
5*3d8817e4Smiod
6*3d8817e4Smiod: ENDDD
7*3d8817e4Smiod	skip_past_newline
8*3d8817e4Smiod	;
9*3d8817e4Smiod
10*3d8817e4Smiod: EXAMPLE
11*3d8817e4Smiod	skip_past_newline
12*3d8817e4Smiod	get_stuff_in_command kill_bogus_lines do_fancy_stuff translatecomments
13*3d8817e4Smiod	courierize catstr
14*3d8817e4Smiod
15*3d8817e4Smiod	;
16*3d8817e4Smiod
17*3d8817e4Smiod: INODE
18*3d8817e4Smiod	"@node " catstr skip_past_newline copy_past_newline catstr
19*3d8817e4Smiod	;
20*3d8817e4Smiod
21*3d8817e4Smiod: CODE_FRAGMENT
22*3d8817e4Smiod	EXAMPLE
23*3d8817e4Smiod	;
24*3d8817e4Smiod
25*3d8817e4Smiod: COMMENT
26*3d8817e4Smiod	skip_past_newline
27*3d8817e4Smiod	get_stuff_in_command
28*3d8817e4Smiod	drop
29*3d8817e4Smiod	;
30*3d8817e4Smiod
31*3d8817e4Smiod: SYNOPSIS
32*3d8817e4Smiod	skip_past_newline
33*3d8817e4Smiod	"@strong{Synopsis}\n" catstr
34*3d8817e4Smiod	"@example\n" catstr
35*3d8817e4Smiod	get_stuff_in_command
36*3d8817e4Smiod	kill_bogus_lines
37*3d8817e4Smiod	indent
38*3d8817e4Smiod	catstr
39*3d8817e4Smiod	"@end example\n" catstr
40*3d8817e4Smiod
41*3d8817e4Smiod	;
42*3d8817e4Smiod
43*3d8817e4Smiod: func
44*3d8817e4Smiod	"@findex "	- a
45*3d8817e4Smiod	skip_past_newline
46*3d8817e4Smiod	copy_past_newline
47*3d8817e4Smiod	dup		- a x x
48*3d8817e4Smiod	"@subsubsection @code{" - a x x b
49*3d8817e4Smiod	swap
50*3d8817e4Smiod	remchar
51*3d8817e4Smiod	"}\n" - a x b x c
52*3d8817e4Smiod	catstr 	catstr 	catstr 	catstr 	catstr
53*3d8817e4Smiod	;
54*3d8817e4Smiod
55*3d8817e4Smiod: FUNCTION
56*3d8817e4Smiod	"@findex "	- a
57*3d8817e4Smiod	skip_past_newline
58*3d8817e4Smiod	copy_past_newline
59*3d8817e4Smiod	dup		- a x x
60*3d8817e4Smiod	"@subsubsection @code{" - a x x b
61*3d8817e4Smiod	swap
62*3d8817e4Smiod	remchar
63*3d8817e4Smiod	"}\n" - a x b x c
64*3d8817e4Smiod	catstr 	catstr 	catstr 	catstr 	catstr
65*3d8817e4Smiod	;
66*3d8817e4Smiod
67*3d8817e4Smiod: bodytext
68*3d8817e4Smiod	get_stuff_in_command
69*3d8817e4Smiod	bulletize
70*3d8817e4Smiod	kill_bogus_lines
71*3d8817e4Smiod	do_fancy_stuff
72*3d8817e4Smiod	courierize
73*3d8817e4Smiod	catstr
74*3d8817e4Smiod	"\n" catstr
75*3d8817e4Smiod	;
76*3d8817e4Smiod
77*3d8817e4Smiod: asection
78*3d8817e4Smiod	skip_past_newline
79*3d8817e4Smiod	catstr
80*3d8817e4Smiod	copy_past_newline
81*3d8817e4Smiod	do_fancy_stuff catstr
82*3d8817e4Smiod	bodytext
83*3d8817e4Smiod	;
84*3d8817e4Smiod
85*3d8817e4Smiod: SECTION
86*3d8817e4Smiod	"@section " asection  ;
87*3d8817e4Smiod
88*3d8817e4Smiod: SUBSECTION
89*3d8817e4Smiod	"@subsection " asection  ;
90*3d8817e4Smiod
91*3d8817e4Smiod: SUBSUBSECTION
92*3d8817e4Smiod	"@subsubsection " asection  ;
93*3d8817e4Smiod
94*3d8817e4Smiod: subhead
95*3d8817e4Smiod	skip_past_newline
96*3d8817e4Smiod	bodytext
97*3d8817e4Smiod	;
98*3d8817e4Smiod
99*3d8817e4Smiod
100*3d8817e4Smiod
101*3d8817e4Smiod
102*3d8817e4Smiod: DESCRIPTION
103*3d8817e4Smiod	"@strong{Description}@*\n" catstr subhead ;
104*3d8817e4Smiod
105*3d8817e4Smiod: RETURNS
106*3d8817e4Smiod	"@strong{Returns}@*\n" catstr subhead ;
107*3d8817e4Smiod
108*3d8817e4Smiod: INTERNAL_FUNCTION
109*3d8817e4Smiod	func ;
110*3d8817e4Smiod
111*3d8817e4Smiod
112*3d8817e4Smiod: INTERNAL_DEFINITION
113*3d8817e4Smiod	func ;
114*3d8817e4Smiod
115*3d8817e4Smiod
116*3d8817e4Smiod: INTERNAL
117*3d8817e4Smiod	func ;
118*3d8817e4Smiod
119*3d8817e4Smiod: TYPEDEF
120*3d8817e4Smiod	FUNCTION ;
121*3d8817e4Smiod
122*3d8817e4Smiod: SENUM
123*3d8817e4Smiod	skip_past_newline
124*3d8817e4Smiod	"Here are the possible values for @code{enum "
125*3d8817e4Smiod	copy_past_newline remchar catstr
126*3d8817e4Smiod	"}:\n\n" catstr catstr
127*3d8817e4Smiod	;
128*3d8817e4Smiod: ENUM
129*3d8817e4Smiod	skip_past_newline
130*3d8817e4Smiod	"@deffn {} "
131*3d8817e4Smiod	copy_past_newline catstr catstr
132*3d8817e4Smiod	;
133*3d8817e4Smiod: ENUMX
134*3d8817e4Smiod	skip_past_newline
135*3d8817e4Smiod	"@deffnx {} "
136*3d8817e4Smiod	copy_past_newline catstr
137*3d8817e4Smiod	catstr
138*3d8817e4Smiod	;
139*3d8817e4Smiod: ENUMEQ
140*3d8817e4Smiod	skip_past_newline
141*3d8817e4Smiod	"@deffn {} "
142*3d8817e4Smiod	copy_past_newline catstr catstr
143*3d8817e4Smiod	skip_past_newline
144*3d8817e4Smiod	;
145*3d8817e4Smiod: ENUMEQX
146*3d8817e4Smiod	skip_past_newline
147*3d8817e4Smiod	"@deffnx {} "
148*3d8817e4Smiod	copy_past_newline catstr
149*3d8817e4Smiod	catstr
150*3d8817e4Smiod	skip_past_newline
151*3d8817e4Smiod	;
152*3d8817e4Smiod: ENUMDOC
153*3d8817e4Smiod	skip_past_newline
154*3d8817e4Smiod	get_stuff_in_command
155*3d8817e4Smiod	strip_trailing_newlines
156*3d8817e4Smiod	catstr
157*3d8817e4Smiod	"\n@end deffn\n" catstr
158*3d8817e4Smiod	;
159