[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Groff-commit] groff/tmac groff_trace.man
From: |
Eric S. Raymond |
Subject: |
[Groff-commit] groff/tmac groff_trace.man |
Date: |
Sun, 04 Feb 2007 00:21:53 +0000 |
CVSROOT: /sources/groff
Module name: groff
Changes by: Eric S. Raymond <esr> 07/02/04 00:21:53
Modified files:
tmac : groff_trace.man
Log message:
Adapted to use .SY/.OP/.YS, but this time with a proper Ellipsis
string and without macro name shortening.
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/groff/tmac/groff_trace.man?cvsroot=groff&r1=1.3&r2=1.4
Patches:
Index: groff_trace.man
===================================================================
RCS file: /sources/groff/groff/tmac/groff_trace.man,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -b -r1.3 -r1.4
--- groff_trace.man 24 Oct 2006 08:04:14 -0000 1.3
+++ groff_trace.man 4 Feb 2007 00:21:53 -0000 1.4
@@ -1,15 +1,3 @@
-.
-.TH GROFF_TRACE @MAN7EXT@ "@MDATE@" "Groff Version @VERSION@"
-.SH NAME
-groff_trace \- groff macro package trace.tmac
-.SH SYNOPSIS
-.\" The .SH was moved to this place to make `apropos' happy.
-.
-.
-.\" --------------------------------------------------------------------
-.\" Legalize
-.\" --------------------------------------------------------------------
-.
.ig
groff_trace.7
@@ -31,287 +19,21 @@
A copy of the Free Documentation License is included as a file called
FDL in the main directory of the groff source package.
..
-.
-.\" --------------------------------------------------------------------
-.\" Setup
-.\" --------------------------------------------------------------------
-.
-.do nr groff_trace_C \n[.C]
-.cp 0
-.
-.mso www.tmac
-.
-.if n \{\
-. mso tty-char.tmac
-. ftr CR R
-. ftr CI I
-. ftr CB B
-.\}
-.
.ds Ellipsis .\|.\|.\&\"
.
-.\" Global static variables for inter-macro communication
-.rr @+Example_font
-.
-.\" --------------------------------------------------------------------
-.\" setup for the macro definitions below
-.\"
-.\" naming: namespace:category_macro.variable_name (experimental)
-.
-.\" --------------------------------------------------------------------
-.\" configuration of prompt for `.Shell_cmd'* macros
-.ds trace:Shell_cmd.prompt_text sh#\" prompt for shell commands
-.ds trace:Shell_cmd+.prompt_text >\" prompt on continuation lines
-.ds trace:Shell_cmd_base.prompt_font I\" font for prompts
-.
-.\" automatically determine setup from the configuration above
-.als @f trace:Shell_cmd_base.prompt_font\"
-.als @t trace:Shell_cmd.prompt_text\"
-.als @t+ trace:Shell_cmd+.prompt_text\"
-.ds trace:Shell_cmd.prompt address@hidden@t]\f[]\" needed
-.ds trace:Shell_cmd+.prompt address@hidden@t+]\f[]\" needed
-.nr @w \w'\*[trace:Shell_cmd.prompt]'\"
-.nr @w+ \w'\*[trace:Shell_cmd+.prompt]'\"
-.ft address@hidden
-.\" Full prompt width is maximum of texts plus 1m
-.nr trace:Shell_cmd_base.prompt_width (address@hidden>address@hidden)\" needed
-.ft
-.rm @f
-.rm @f+
-.rm @t
-.rm @t+
-.rr @w
-.rr @w+
-.
-.\"--------------------------------------------------------------------
-.\" Ignore all arguments like a comment, even after a .eo call.
-.de c
-..
-.c --------------------------------------------------------------------
-.de BIR
-. ie (\\n[.$] < 3) \
-. BI \\$@
-. el \{\
-. ds @tmp@ \fB\\$1\f[]\fI\\$2\f[]
-. shift 2
-. Text address@hidden@]\fR\\$*\f[]
-. rm @tmp@
-. \}
-..
-.c --------------------------------------------------------------------
-.c .Env_var (<env_var_name> [<punct>])
-.c
-.c Display an environment variable, with optional punctuation.
-.c
-.de Env_var
-. nh
-. SM
-. Text \f[CB]\\$1\f[]\\$2
-. hy
-..
-.c --------------------------------------------------------------------
-.c .Error (<text>...)
-.c
-.c Print error message to terminal and abort.
-.c
-.de Error
-. tm \\$*
-. ab
-..
-.c --------------------------------------------------------------------
-.de Example
-. if address@hidden \
-. Error previous .Example was not terminated by a ./Example
-. nr @+Example_font \\n[.f]
-. nh
-. nf
-.c RS \\n[trace:Shell_cmd_base.prompt_width]u
-. ft CR
-..
-.c --------------------------------------------------------------------
-.de /Example
-. if address@hidden \
-. Error no previous call to .Example
-. ft address@hidden
-.c RE
-. fi
-. hy
-. rr @+Example_font
-..
-.c --------------------------------------------------------------------
-.de Macdef
-. if (\\n[.$] <= 0) \
-. Error \\$0 needs at least one argument.
-. ds @s .\f[B]\\$1\f[]\"
-. shift
-. if (\\n[.$] > 0) \
-. as @s \~\f[I]\\$*\f[]\"
-. IP address@hidden
-. rm @s
-..
-.c --------------------------------------------------------------------
-.de Macdef+
-. br
-. ns
-. Macdef \\$@
-..
-.c --------------------------------------------------------------------
-.c .Shell_cmd (<CR> [<CI>] ...)
-.c
-.c A shell command line; display args alternating in fonts CR and CI.
-.c
-.c Examples:
-.c .Shell_cmd "groffer --dpi 100 file"
-.c result: `sh# groffer --dpi 100 file'
-.c with 'sh#' in font I, the rest in CR
-.c
-.c .Shell_cmd groffer\~--dpi\~100\~file
-.c result: the same as above
-.c
-.c .Shell_cmd "groffer --dpi=" value " file"
-.c result: sh# groffer --dpi=value file
-.c with `groffer --dpi=' and `file' in CR; `value' in CI
-.c
-.c .Shell_cmd groffer\~--dpi= value \~file
-.c result: the same as the previous example
-.c
-.de Shell_cmd
-. trace:Shell_cmd_base "\*[trace:Shell_cmd.prompt]" \\$@
-..
-.c --------------------------------------------------------------------
-.c .Shell_cmd+ (<CR> [<CI>] ...)
-.c
-.c A continuation line for .Shell_cmd.
-.c
-.de Shell_cmd+
-. trace:Shell_cmd_base "\*[trace:Shell_cmd+.prompt]" \\$@
-..
-.c --------------------------------------------------------------------
-.c .Shell_cmd_base (<prompt> [<CR> [<CI>] ...])
-.c
-.c A shell command line; display args alternating in fonts CR and CI.
-.c Internal, do not use directly.
-.c
-.c Globals: read-only register @.Shell_cmd_width
-.c
-.de trace:Shell_cmd_base
-. if (\\n[.$] <= 0) \
-. return
-. nr @+font \\n[.f]\"
-. ds @prompt \\$1\"
-. ft CR
-. c gap between prompt and command
-. nr @+gap \\n[trace:Shell_cmd_base.prompt_width]-\\w'address@hidden'\"
-. ds @res address@hidden'address@hidden'\"
-. shift
-. ds @cf CR\"
-. while (\\n[.$] > 0) \{\
-. as @res address@hidden"
-. shift
-. ie 'address@hidden'CR' \
-. ds @cf I\"
-. el \
-. ds @cf CR\"
-. \}
-. br
-. ad l
-. nh
-. nf
-. Text address@hidden"
-. fi
-. hy
-. ad
-. br
-. ft address@hidden
-. rr @+font
-. rr @+gap
-. rm @cf
-. rm @res
-..
-.c --------------------------------------------------------------------
-.c .Text (<text>...)
-.c
-.c Treat the arguments as text, no matter how they look.
-.c
-.de Text
-. if (\\n[.$] == 0) \
-. return
-. nop \)\\$*\)
-..
-.c --------------------------------------------------------------------
-.c .Topic ([<indent>])
-.c
-.c A bulleted paragraph.
-.c
-.de Topic
-. ie (\\n[.$] = 0) \
-. .ds @indent 2m\"
-. el \
-. .ds @indent \\$1\"
-. TP address@hidden
-. Text \[bu]
-. rm @indent
-..
-.c --------------------------------------------------------------------
-.c .TP+ ()
-.c
-.c Continuation line for .TP header.
-.c
-.de TP+
-. br
-. ns
-. TP \\$1
-..
-.c --------------------------------------------------------------------
-.de 'char
-. ds @tmp@ `\f(CR\\$1\f[]'
-. shift
-. Text address@hidden@]\\$*
-. rm @tmp@
-..
-.c --------------------------------------------------------------------
-.de option
-. ds @tmp@ \f(CB\\$1\f[]
-. shift 1
-. Text address@hidden@]\\$*
-. rm @tmp@
-..
-.c --------------------------------------------------------------------
-.de argument
-. ds @tmp@ \f(CI\\$1\f[]
-. shift 1
-. Text address@hidden@]\\$*
-. rm @tmp@
-..
-.c --------------------------------------------------------------------
-.de request
-. ds @tmp@ \f(CB\\$1\f[]
-. shift 1
-. Text address@hidden@]\\$*
-. rm @tmp@
-..
-.c --------------------------------------------------------------------
-.de escape
-. ds @tmp@ \f[CB]\\$1\f[]
-. shift 1
-. Text address@hidden@]\\$*
-. rm @tmp@
-..
-.
-.
+.TH GROFF_TRACE @MAN7EXT@ "@MDATE@" "Groff Version @VERSION@"
+.SH NAME
+groff_trace \- groff macro package trace.tmac
.\" --------------------------------------------------------------------
.\" SH SYNOPSIS
.\" --------------------------------------------------------------------
+.SH SYNOPSIS
.
-.B groff -m trace
-.RI [ options\*[Ellipsis] ]
-.RI [ files\*[Ellipsis] ]
-.
-.
-.P
-Elements in brackets denote optional arguments, and the ellipsis means
-that there can be any number of arguments of this kind.
-.
+.SY groff
+.B -m trace
+.OP options\*[Ellipsis]
+.OP files\*[Ellipsis]
+.YS
.
.\" --------------------------------------------------------------------
.SH DESCRIPTION
@@ -380,20 +102,19 @@
.\" --------------------------------------------------------------------
.SS "Command line option"
.
-.P
-.Shell_cmd "echo '."
-.Shell_cmd+ ".de test_macro"
-.Shell_cmd+ ".."
-.Shell_cmd+ ".test_macro"
-.Shell_cmd+ ".test_macro some dummy arguments"
-.Shell_cmd+ "' | groff -m trace >/dev/null"
-.P
-.Example
+.EX
+\fIsh#\fP echo '.
+> .de test_macro
+> ..
+> .test_macro
+> .test_macro some dummy arguments
+> ' | groff -m trace >/dev/null
+
*** de trace enter: test_macro
*** trace exit: test_macro
*** de trace enter: test_macro "some" "dummy" "arguments"
*** trace exit: test_macro "some" "dummy" "arguments"
-./Example
+.EE
.
.P
The entry and the exit of each macro call is displayed on the terminal
@@ -403,22 +124,21 @@
.\" --------------------------------------------------------------------
.SS "Nested macro calls"
.
-.P
-.Shell_cmd "echo '."
-.Shell_cmd+ ".de child"
-.Shell_cmd+ ".."
-.Shell_cmd+ ".de parent"
-.Shell_cmd+ ".child"
-.Shell_cmd+ ".."
-.Shell_cmd+ ".parent"
-.Shell_cmd+ "' | groff -m trace >/dev/null"
-.P
-.Example
+.EX
+\fIsh#\fP echo '.
+> .de child
+> ..
+> .de parent
+> .child
+> ..
+> .parent
+> ' | groff -m trace >/dev/null
+
*** de trace enter: parent
*** de trace enter: child
*** trace exit: child
*** trace exit: parent
-./Example
+.EE
.
.P
This shows that macro calls can be nested.
@@ -429,21 +149,21 @@
.\" --------------------------------------------------------------------
.SS "Activating with .mso"
.
-.Shell_cmd "echo '."
-.Shell_cmd+ ".de before"
-.Shell_cmd+ ..
-.Shell_cmd+ ".mso trace.tmac"
-.Shell_cmd+ ".de after"
-.Shell_cmd+ ..
-.Shell_cmd+ .before
-.Shell_cmd+ .after
-.Shell_cmd+ .before
-.Shell_cmd+ "' | groff >/dev/null"
-.P
-.Example
+.EX
+\fIsh#\fP echo '.
+> .de before
+> ..
+> .mso trace.tmac
+> .de after
+> ..
+> .before
+> .after
+> .before
+> ' | groff >/dev/null
+
*** de trace enter: after
*** trace exit: after
-./Example
+.EE
.
.P
Here, the tracing is activated within the document, not by a command
@@ -472,9 +192,9 @@
macro call
.
.P
-.Example
+.EX
\&.foo \e\e\e\en[bar]
-./Example
+.EE
.
.P
normally passes `\e\en[bar]' to macro `.foo', but with the redefined
@@ -488,9 +208,9 @@
example
.
.P
-.Example
+.EX
\&.foo \eEn[bar]
-./Example
+.EE
.
.
.\" --------------------------------------------------------------------
@@ -513,7 +233,7 @@
.\" --------------------------------------------------------------------
.
.TP
-.Env_var $GROFF_TMAC_PATH
+.B $GROFF_TMAC_PATH
A colon-separated list of additional tmac directories in which to
search for macro files; see
.BR groff_tmac (@MAN5EXT@)
@@ -579,8 +299,6 @@
.BR info (1)
file.
.
-.cp \n[groff_trace_C]
-.
.\" Local Variables:
.\" mode: nroff
.\" End:
- [Groff-commit] groff/tmac groff_trace.man,
Eric S. Raymond <=