xref: /openbsd-src/usr.bin/fgen/fgen.1 (revision 5d84952f66229097727f906257c0ec53710164c1)
1.\"	$OpenBSD: fgen.1,v 1.7 2023/01/04 14:58:04 jsg 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.\"
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 $Mdocdate: January 4 2023 $
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
38Reads Forth source and generates tokenized FCode object file.
39.Pp
40The options are as follows:
41.Bl -tag -width Ds
42.It Fl d Ar level
43Sets the debug
44.Ar level .
45When the debug level is greater than zero, additional debugging messages
46are printed to standard output.
47Different levels of verbosity are available if compiled with DEBUG.
48.It Fl o Ar outfile
49Write output to
50.Ar outfile
51instead of standard output.
52.El
53.Sh AUTHORS
54Written by
55.An Eduardo E. Horvath Aq Mt eeh@one-o.com
56.Sh BUGS
57String escape sequences are not recognized so things such as
58.Pp
59.Li \&" foo \&"\&(01 02\&) \&"n \&"
60.Pp
61will result in the string
62.Pp
63.Dq  foo \&"\&(01 02\&) \&"n .
64.Pp
65Hexadecimal numbers with dots in them such as
66.Li 100.0000
67are not parsed.
68.Pp
69Permissions on the output file are often incorrect.
70.Pp
71Output to the standard output device can cause problems.
72