xref: /openbsd-src/usr.bin/fgen/fgen.1 (revision 5d84952f66229097727f906257c0ec53710164c1)
1*5d84952fSjsg.\"	$OpenBSD: fgen.1,v 1.7 2023/01/04 14:58:04 jsg Exp $
296ea29a1Sjason.\"	$NetBSD: fgen.1,v 1.6 2001/06/13 10:46:05 wiz Exp $
396ea29a1Sjason.\"
496ea29a1Sjason.\" Copyright (c) 1998 Eduardo Horvath, All Rights Reserved.
596ea29a1Sjason.\"
696ea29a1Sjason.\" Redistribution and use in source and binary forms, with or without
796ea29a1Sjason.\" modification, are permitted provided that the following conditions
896ea29a1Sjason.\" are met:
996ea29a1Sjason.\" 1. Redistributions of source code must retain the above copyright
1096ea29a1Sjason.\"    notice, this list of conditions and the following disclaimer.
1196ea29a1Sjason.\" 2. Redistributions in binary form must reproduce the above copyright
1296ea29a1Sjason.\"    notice, this list of conditions and the following disclaimer in the
1396ea29a1Sjason.\"    documentation and/or other materials provided with the distribution.
1496ea29a1Sjason.\"
1596ea29a1Sjason.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
1696ea29a1Sjason.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
1796ea29a1Sjason.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
1896ea29a1Sjason.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
1996ea29a1Sjason.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
2096ea29a1Sjason.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
2196ea29a1Sjason.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
2296ea29a1Sjason.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
2396ea29a1Sjason.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
2496ea29a1Sjason.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2596ea29a1Sjason.\"
26*5d84952fSjsg.Dd $Mdocdate: January 4 2023 $
2796ea29a1Sjason.Dt FGEN 1
2896ea29a1Sjason.Os
2996ea29a1Sjason.Sh NAME
3096ea29a1Sjason.Nm fgen
3196ea29a1Sjason.Nd IEEE 1275 Open Firmware FCode Tokenizer
3296ea29a1Sjason.Sh SYNOPSIS
3396ea29a1Sjason.Nm
3496ea29a1Sjason.Op Fl d Ar level
3596ea29a1Sjason.Op Fl o Ar outfile
3696ea29a1Sjason.Ar infile
3796ea29a1Sjason.Sh DESCRIPTION
3896ea29a1SjasonReads Forth source and generates tokenized FCode object file.
391bc46cbfSsobrado.Pp
401bc46cbfSsobradoThe options are as follows:
411bc46cbfSsobrado.Bl -tag -width Ds
421bc46cbfSsobrado.It Fl d Ar level
431bc46cbfSsobradoSets the debug
441bc46cbfSsobrado.Ar level .
451bc46cbfSsobradoWhen the debug level is greater than zero, additional debugging messages
461bc46cbfSsobradoare printed to standard output.
471bc46cbfSsobradoDifferent levels of verbosity are available if compiled with DEBUG.
481bc46cbfSsobrado.It Fl o Ar outfile
491bc46cbfSsobradoWrite output to
501bc46cbfSsobrado.Ar outfile
511bc46cbfSsobradoinstead of standard output.
521bc46cbfSsobrado.El
5396ea29a1Sjason.Sh AUTHORS
542aeff9fbSjmcWritten by
5576c04420Sschwarze.An Eduardo E. Horvath Aq Mt eeh@one-o.com
5696ea29a1Sjason.Sh BUGS
5796ea29a1SjasonString escape sequences are not recognized so things such as
5896ea29a1Sjason.Pp
5996ea29a1Sjason.Li \&" foo \&"\&(01 02\&) \&"n \&"
6096ea29a1Sjason.Pp
6196ea29a1Sjasonwill result in the string
6296ea29a1Sjason.Pp
6396ea29a1Sjason.Dq  foo \&"\&(01 02\&) \&"n .
6496ea29a1Sjason.Pp
6596ea29a1SjasonHexadecimal numbers with dots in them such as
6696ea29a1Sjason.Li 100.0000
6796ea29a1Sjasonare not parsed.
6896ea29a1Sjason.Pp
6996ea29a1SjasonPermissions on the output file are often incorrect.
7096ea29a1Sjason.Pp
7196ea29a1SjasonOutput to the standard output device can cause problems.
72