No empty .Rs/.Re
[netbsd-mini2440.git] / usr.bin / fgen / fgen.1
blob197c606af5dfa63ea84fc754296be0ef3cc8156f
1 .\"     $NetBSD: fgen.1,v 1.8 2002/02/08 01:36:22 ross Exp $
2 .\"
3 .\" Copyright (c) 1998 Eduardo Horvath, All Rights Reserved.
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 .\"
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 .\"
25 .\" The following requests are required for all man pages.
26 .Dd October 31, 1998
27 .Dt FGEN 1
28 .Os
29 .Sh NAME
30 .Nm fgen
31 .Nd IEEE 1275 Open Firmware FCode Tokenizer
32 .Sh SYNOPSIS
33 .Nm
34 .Op Fl d Ar level
35 .Op Fl o Ar outfile
36 .Ar infile
37 .Sh DESCRIPTION
38 Reads Forth source and generates tokenized FCode object file.
39 .\" This next request is for sections 1, 6, 7 & 8 only
40 .\" .Sh ENVIRONMENT
41 .\" .Sh FILES
42 .\" .Sh EXAMPLES
43 .\" This next request is for sections 1, 6, 7 & 8 only
44 .\"     (command return values (to shell) and fprintf/stderr type diagnostics)
45 .\" .Sh DIAGNOSTICS
46 .\" .Sh ERRORS
47 .\" .Sh SEE ALSO
48 .\" Cross-references should be ordered by section (low to high), then in
49 .\"     alphabetical order.
50 .\" .Sh STANDARDS
51 .\" .Sh HISTORY
52 .Sh AUTHORS
53 Written by Eduardo E. Horvath \*[Lt]eeh@one-o.com\*[Gt]
54 .Sh BUGS
55 String escape sequences are not recognized so things such as
56 .Pp
57 .Li \&" foo \&"\&(01 02\&) \&"n \&"
58 .Pp
59 will result in the string
60 .Pp
61 .Dq  foo \&"\&(01 02\&) \&"n .
62 .Pp
63 Hexadecimal numbers with dots in them such as
64 .Li 100.0000
65 are not parsed.
66 .Pp
67 Permissions on the output file are often incorrect.
68 .Pp
69 Output to the standard output device can cause problems.