Initial import from FreeBSD RELENG_4:
[dragonfly.git] / gnu / usr.bin / binutils / 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 .\"
31 .Dd December 29, 1999
32 .Dt GASP 1
33 .Os
34 .Sh NAME
35 .Nm gasp
36 .Nd the GNU Assembler Macro Preprocessor
37 .Sh SYNOPSIS
38 .Nm
39 .Op Fl adhMpsuv
40 .Op Fl c Ar char
41 .Op Fl o Ar outfile
42 .Op Fl D Ns Ar name=value
43 .Op Fl I Ns Ar path
44 .Op infile
45 .Sh DESCRIPTION
46 .Nm
47 is the GNU Assembler Macro Preprocessor.
48 The argument 
49 .Ar infile
50 is processed and the resulting text is sent to the standard output.
51 .Pp
52 The options are as follows:
53 .Bl -tag -width "-Dname=value"
54 .It Fl a
55 Enter enter alternate macro mode.
56 Also specifiable as
57 .Op Fl \-alternate
58 .It Fl c Ar char
59 Change the comment character from `!'
60 Also specifiable as
61 .Op Fl \-commentchar\ char
62 .It Fl d
63 Print limited debugging information.
64 Also specifiable as
65 .Op Fl \-debug
66 .It Fl h
67 Print the help message.
68 Also specifiable as
69 .Op Fl \-help
70 .It Fl M
71 Enter MRI compatibility mode
72 Also specifiable as
73 .Op Fl \-mri
74 .It Fl o Ar outfile
75 Specify the output file.
76 Also specifiable as
77 .Op Fl \-output\ outfile
78 .It Fl p
79 Print line numbers.
80 Also specifiable as
81 .Op Fl \-print
82 .It Fl s
83 Copy source through as comments.
84 Also specifiable as
85 .Op Fl \-copysource
86 .It Fl u
87 Allow unreasonable nesting.
88 Also specifiable as
89 .Op Fl \-unreasonable
90 .It Fl v
91 Print the program version and exit.
92 Also specifiable as
93 .Op Fl \-version
94 .It Fl D Ns Ar name=value
95 Define the preprocessor symbol
96 .Ar name
97 to have the value specified by "value".
98 .It Fl I Ns Ar path
99 Add
100 .Ar path
101 to the include path list.
102 .El
103 .Sh SEE ALSO
104 .Xr cpp 1 ,
105 .Xr m4 1
106 .Rs
107 .%T The gasp GNU hypertext system info pages
108 .Re
109 .Sh HISTORY
110 The
111 .Nm
112 command is part of the GNU Binutils package.
113 .Sh AUTHORS
114 This man page was written by
115 .An David E. O'Brien .