Annotation of src/usr.bin/fgen/fgen.1, Revision 1.1
1.1 ! jason 1: .\" $OpenBSD$
! 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: .\" The following requests are required for all man pages.
! 32: .Dd October 31, 1998
! 33: .Dt FGEN 1
! 34: .Os
! 35: .Sh NAME
! 36: .Nm fgen
! 37: .Nd IEEE 1275 Open Firmware FCode Tokenizer
! 38: .Sh SYNOPSIS
! 39: .Nm
! 40: .Op Fl d Ar level
! 41: .Op Fl o Ar outfile
! 42: .Ar infile
! 43: .Sh DESCRIPTION
! 44: Reads Forth source and generates tokenized FCode object file.
! 45: .\" This next request is for sections 1, 6, 7 & 8 only
! 46: .\" .Sh ENVIRONMENT
! 47: .\" .Sh FILES
! 48: .\" .Sh EXAMPLES
! 49: .\" This next request is for sections 1, 6, 7 & 8 only
! 50: .\" (command return values (to shell) and fprintf/stderr type diagnostics)
! 51: .\" .Sh DIAGNOSTICS
! 52: .\" .Sh ERRORS
! 53: .\" .Sh SEE ALSO
! 54: .\" Cross-references should be ordered by section (low to high), then in
! 55: .\" alphabetical order.
! 56: .\" .Sh STANDARDS
! 57: .\" .Sh HISTORY
! 58: .Sh AUTHORS
! 59: Written by Eduardo E. Horvath <eeh@one-o.com>
! 60: .Sh BUGS
! 61: String escape sequences are not recognized so things such as
! 62: .Pp
! 63: .Li \&" foo \&"\&(01 02\&) \&"n \&"
! 64: .Pp
! 65: will result in the string
! 66: .Pp
! 67: .Dq foo \&"\&(01 02\&) \&"n .
! 68: .Pp
! 69: Hexadecimal numbers with dots in them such as
! 70: .Li 100.0000
! 71: are not parsed.
! 72: .Pp
! 73: Permissions on the output file are often incorrect.
! 74: .Pp
! 75: Output to the standard output device can cause problems.