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