Module Name: src
Committed By: christos
Date: Sat Jan 16 21:15:51 UTC 2016
Modified Files:
src/usr.bin/m4: m4.1
Log Message:
Update documentation.
To generate a diff of this commit:
cvs rdiff -u -r1.25 -r1.26 src/usr.bin/m4/m4.1
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/usr.bin/m4/m4.1
diff -u src/usr.bin/m4/m4.1:1.25 src/usr.bin/m4/m4.1:1.26
--- src/usr.bin/m4/m4.1:1.25 Tue Jan 7 08:32:21 2014
+++ src/usr.bin/m4/m4.1 Sat Jan 16 16:15:51 2016
@@ -1,4 +1,4 @@
-.\" $NetBSD: m4.1,v 1.25 2014/01/07 13:32:21 wiz Exp $
+.\" $NetBSD: m4.1,v 1.26 2016/01/16 21:15:51 christos Exp $
.\" @(#) $OpenBSD: m4.1,v 1.56 2009/10/14 17:19:47 sthen Exp $
.\"
.\" Copyright (c) 1989, 1993
@@ -31,7 +31,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd January 7, 2014
+.Dd January 16, 2015
.Dt M4 1
.Os
.Sh NAME
@@ -39,15 +39,19 @@
.Nd macro language processor
.Sh SYNOPSIS
.Nm m4
-.Op Fl gPs
+.Op Fl EgGiPQsv
.Oo
.Sm off
.Fl D Ar name Op No = Ar value
.Sm on
.Oc
.Op Fl d Ar flags
+.Op Fl e Ar filename
+.Op Fl F Ar filename
.Op Fl I Ar dirname
+.Op Fl L Ar number
.Op Fl o Ar filename
+.Op Fl R Ar filename
.Op Fl t Ar macro
.Op Fl U Ns Ar name
.Op Ar
@@ -98,12 +102,12 @@ recognized as special when not followed
.Pp
The options are as follows:
.Bl -tag -width Ds
-.It Fl D Ns Ar name Ns Op Pf = Ns Ar value
+.It Fl D , Fl Fl define Ar name Ns Op Pf = Ns Ar value
Define the symbol
.Ar name
to have some value (or
.Dv NULL ) .
-.It Fl d Ar "flags"
+.It Fl d , Fl Fl debug Ar "flags"
Set trace flags.
.Ar flags
may hold the following:
@@ -130,7 +134,18 @@ turn on all options.
.Pp
By default, trace is set to
.Qq eq .
-.It Fl g
+.If Fl E , Fl Fl fatal-warnings
+Warnings make
+.Nm
+exit.
+.If Fl e , Fl Fl error-output Ar filename
+Redirect error output to filename.
+.If Fl F , Fl Fl freeze-state Ar filename
+Save the input state to
+.Ar filename .
+.If Fl G , Fl Fl traditional
+Disable GNU-m4 extensions.
+.It Fl g , Fl Fl gnu
Activate GNU-m4 compatibility mode.
In this mode, translit handles simple character
ranges (e.g., a-z), regular expressions mimic emacs behavior,
@@ -140,29 +155,43 @@ empty names for macro definitions are al
and eval understands
.Sq 0rbase:value
numbers.
-.It Fl I Ar "dirname"
+.It Fl Fl help
+Print help message and exit.
+.It Fl I , Fl Fl include Ar "dirname"
Add directory
.Ar dirname
to the include path.
.It Fl o Ar filename
Send trace output to
.Ar filename .
-.It Fl P
+.It Fl i , Fl Fl interactive
+Set unbuffered output, disable tty signals.
+.It Fl L , Fl Fl nesting-limit
+Set the nesting limit in macro expansions.
+This is unimplemented and unlimited.
+.It Fl P , Fl Fl prefix-builtins
Prefix all built-in macros with
.Sq m4_ .
For example, instead of writing
.Ic define ,
use
.Ic m4_define .
-.It Fl s
+.It Fl Q , Fl Fl quiet , Fl Fl silent
+Don't print warnings.
+.It Fl R , Fl Fl reload-state Ar filename
+Reload a previously saved state from
+.Ar filename .
+.It Fl s , Fl Fl synclines
Output line synchronization directives, suitable for
.Xr cpp 1 .
-.It Fl t Ar macro
+.It Fl t , Fl Fl trace Ar macro
Turn tracing on for
.Ar macro .
-.It Fl "U" Ns Ar "name"
+.It Fl U , Fl Fl undefine Ar "name"
Undefine the symbol
.Ar name .
+.It Fl v , Fl Fl version
+Print the version and exit.
.El
.Sh SYNTAX
.Nm m4
