WARNS=6 safeness:
[dragonfly.git] / gnu / usr.bin / binutils214 / gasp / gasp.1
1 .\" Copyright (c) 1999
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"     and David E. O'Brien
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\" 3. Neither the name of the University nor the names of its contributors
14 .\"    may be used to endorse or promote products derived from this software
15 .\"    without specific prior written permission.
16 .\"
17 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 .\" SUCH DAMAGE.
28 .\"
29 .\" $FreeBSD: src/gnu/usr.bin/binutils/gasp/gasp.1,v 1.1.2.4 2002/09/01 23:39:14 obrien Exp $
30 .\" $DragonFly: src/gnu/usr.bin/binutils214/gasp/Attic/gasp.1,v 1.1 2004/02/01 08:53:03 dillon Exp $
31 .\"
32 .Dd December 29, 1999
33 .Dt GASP 1
34 .Os
35 .Sh NAME
36 .Nm gasp
37 .Nd the GNU Assembler Macro Preprocessor
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl adhMpsuv
41 .Op Fl c Ar char
42 .Op Fl o Ar outfile
43 .Op Fl D Ns Ar name=value
44 .Op Fl I Ns Ar path
45 .Op infile
46 .Sh DESCRIPTION
47 .Nm
48 is the GNU Assembler Macro Preprocessor.
49 The argument 
50 .Ar infile
51 is processed and the resulting text is sent to the standard output.
52 .Pp
53 The options are as follows:
54 .Bl -tag -width "-Dname=value"
55 .It Fl a
56 Enter enter alternate macro mode.
57 Also specifiable as
58 .Op Fl \-alternate
59 .It Fl c Ar char
60 Change the comment character from `!'
61 Also specifiable as
62 .Op Fl \-commentchar\ char
63 .It Fl d
64 Print limited debugging information.
65 Also specifiable as
66 .Op Fl \-debug
67 .It Fl h
68 Print the help message.
69 Also specifiable as
70 .Op Fl \-help
71 .It Fl M
72 Enter MRI compatibility mode
73 Also specifiable as
74 .Op Fl \-mri
75 .It Fl o Ar outfile
76 Specify the output file.
77 Also specifiable as
78 .Op Fl \-output\ outfile
79 .It Fl p
80 Print line numbers.
81 Also specifiable as
82 .Op Fl \-print
83 .It Fl s
84 Copy source through as comments.
85 Also specifiable as
86 .Op Fl \-copysource
87 .It Fl u
88 Allow unreasonable nesting.
89 Also specifiable as
90 .Op Fl \-unreasonable
91 .It Fl v
92 Print the program version and exit.
93 Also specifiable as
94 .Op Fl \-version
95 .It Fl D Ns Ar name=value
96 Define the preprocessor symbol
97 .Ar name
98 to have the value specified by "value".
99 .It Fl I Ns Ar path
100 Add
101 .Ar path
102 to the include path list.
103 .El
104 .Sh SEE ALSO
105 .Xr cpp 1 ,
106 .Xr m4 1
107 .Rs
108 .%T The gasp GNU hypertext system info pages
109 .Re
110 .Sh HISTORY
111 The
112 .Nm
113 command is part of the GNU Binutils package.
114 .Sh AUTHORS
115 This man page was written by
116 .An David E. O'Brien .