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