share/man/man5/genassym.cf.5

   1 .\"     $NetBSD: genassym.cf.5,v 1.11 2005/09/11 23:32:48 wiz 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 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .Dd August 18, 2005
  27 .Dt GENASSYM.CF 5
  28 .Os
  29 .Sh NAME
  30 .Nm genassym.cf
  31 .Nd assym.h definition file
  32 .Sh DESCRIPTION
  33 The
  34 .Nm
  35 file is used by
  36 .Xr genassym 1
  37 to make constant C expressions known to assembler source files.
  38 Lines starting with '#' are discarded by
  39 .Xr genassym 1 .
  40 Lines starting with
  41 .Em include ,
  42 .Em ifdef ,
  43 .Em if ,
  44 .Em else
  45 or
  46 .Em endif
  47 are preceded with '#' and passed otherwise unmodified to the C compiler.
  48 Lines starting with
  49 .Em quote
  50 get passed on with the
  51 .Em quote
  52 command removed.
  53 The first word after a
  54 .Em define
  55 command is taken as a CPP identifier and the rest of the line has to be
  56 a constant C expression. The output of
  57 .Xr genassym 1
  58 will assign the numerical value of this expression to the CPP identifier.
  59 .Em "export X"
  60 is a shorthand for
  61 .Em "define X X" .
  62 .Em "struct X"
  63 remembers X for the
  64 .Em member
  65 command and does a
  66 .Em "define X_SIZEOF sizeof(X)" .
  67 .Em "member X"
  68 does a
  69 .Em "define X offsetof(\*[Lt]last struct\*[Gt], X)" .
  70 .Em "config \*[Lt]ctype\*[Gt] \*[Lt]gcc constraint\*[Gt] \*[Lt]asm print modifier\*[Gt]"
  71 can be used to customize the output of
  72 .Xr genassym 1 .
  73 When producing C output, values are casted to \*[Lt]ctype\*[Gt] (default: long)
  74 before they get handed to printf. \*[Lt]gcc constraint\*[Gt] (default: n) is the
  75 constraint used in the __asm__ statements. \*[Lt]asm print modifier\*[Gt] (default:
  76 empty) can be used to force gcc to output operands in different ways
  77 then normal. The "a" modifier e.g. stops gcc from emitting immediate
  78 prefixes in front of constants for the i386 and m68k port.
  79 .Sh FILES
  80 .Pa /usr/src/sys/arch/${MACHINE}/${MACHINE}/genassym.cf
  81 .Sh SEE ALSO
  82 .Xr genassym 1
  83 .Sh HISTORY
  84 The
  85 .Nm
  86 file appeared in
  87 .Nx 1.3 .