xref: /netbsd/share/man/man5/genassym.cf.5 (revision bf9ec67e)
1.\"	$NetBSD: genassym.cf.5,v 1.9 2002/02/13 08:18:12 ross Exp $
2.\"
3.\" Copyright (c) 1997 Matthias Pfaller.
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	  This product includes software developed by Matthias Pfaller.
17.\" 4. The name of the author may not be used to endorse or promote products
18.\"    derived from this software without specific prior written permission
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30.\"
31.Dd April 25, 1998
32.Dt GENASSYM.CF 5
33.Os
34.Sh NAME
35.Nm genassym.cf
36.Nd assym.h definition file
37.Sh DESCRIPTION
38The
39.Nm
40file is used by
41.Xr genassym.sh 8
42to make constant C expressions known to assembler source files.
43Lines starting with '#' are discarded by
44.Xr genassym.sh 8 .
45Lines starting with
46.Em include ,
47.Em ifdef ,
48.Em if ,
49.Em else
50or
51.Em endif
52are preceded with '#' and passed otherwise unmodified to the C compiler.
53Lines starting with
54.Em quote
55get passed on with the
56.Em quote
57command removed.
58The first word after a
59.Em define
60command is taken as a CPP identifier and the rest of the line has to be
61a constant C expression. The output of
62.Xr genassym.sh 8
63will assign the numerical value of this expression to the CPP identifier.
64.Em "export X"
65is a shorthand for
66.Em "define X X" .
67.Em "struct X"
68remembers X for the
69.Em member
70command and does a
71.Em "define X_SIZEOF sizeof(X)" .
72.Em "member X"
73does a
74.Em "define X offsetof(\*[Lt]last struct\*[Gt], X)" .
75.Em "config \*[Lt]ctype\*[Gt] \*[Lt]gcc constraint\*[Gt] \*[Lt]asm print modifier\*[Gt]"
76can be used to customize the output of
77.Xr genassym.sh 8 .
78When producing C output, values are casted to \*[Lt]ctype\*[Gt] (default: long)
79before they get handed to printf. \*[Lt]gcc constraint\*[Gt] (default: n) is the
80constraint used in the __asm__ statements. \*[Lt]asm print modifier\*[Gt] (default:
81empty) can be used to force gcc to output operands in different ways
82then normal. The "a" modifier e.g. stops gcc from emitting immediate
83prefixes in front of constants for the i386 and m68k port.
84.Sh FILES
85.Pa /sys/arch/${MACHINE}/${MACHINE}/genassym.cf
86.Sh SEE ALSO
87.Xr genassym.sh 8
88.Sh HISTORY
89The
90.Nm
91file appeared in
92.Nx 1.3 .
93