xref: /openbsd-src/usr.bin/fgen/fgen.1 (revision f2da64fbbbf1b03f09f390ab01267c93dfd77c4c)
1.\"	$OpenBSD: fgen.1,v 1.6 2013/07/16 00:07:52 schwarze Exp $
2.\"	$NetBSD: fgen.1,v 1.6 2001/06/13 10:46:05 wiz Exp $
3.\"
4.\" Copyright (c) 1998 Eduardo Horvath, 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 Eduardo Horvath.
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 $Mdocdate: July 16 2013 $
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.Pp
45The options are as follows:
46.Bl -tag -width Ds
47.It Fl d Ar level
48Sets the debug
49.Ar level .
50When the debug level is greater than zero, additional debugging messages
51are printed to standard output.
52Different levels of verbosity are available if compiled with DEBUG.
53.It Fl o Ar outfile
54Write output to
55.Ar outfile
56instead of standard output.
57.El
58.Sh AUTHORS
59Written by
60.An Eduardo E. Horvath Aq Mt eeh@one-o.com
61.Sh BUGS
62String escape sequences are not recognized so things such as
63.Pp
64.Li \&" foo \&"\&(01 02\&) \&"n \&"
65.Pp
66will result in the string
67.Pp
68.Dq  foo \&"\&(01 02\&) \&"n .
69.Pp
70Hexadecimal numbers with dots in them such as
71.Li 100.0000
72are not parsed.
73.Pp
74Permissions on the output file are often incorrect.
75.Pp
76Output to the standard output device can cause problems.
77