2006-08-22 Josh Stone <joshua.i.stone@intel.com>

	PR 3094
	From Eugeniy Meshcheryakov <eugen@debian.org>:
	* stap.1.in: In groff, '-' produces a Unicode hyphen.  Use '\-'
	where a plain-old minus sign is desired, e.g., code examples.
	* lket.5.in, stapex.5.in, stapfuncs.5.in, stapprobes.5.in: ditto

6 files changed, 47 insertions, 39 deletions

diff --git a/ChangeLog b/ChangeLog
index bef8f6f1..09a3814e 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2006-08-22  Josh Stone  <joshua.i.stone@intel.com>
+
+	PR 3094
+	From Eugeniy Meshcheryakov <eugen@debian.org>:
+	* stap.1.in: In groff, '-' produces a Unicode hyphen.  Use '\-'
+	where a plain-old minus sign is desired, e.g., code examples.
+	* lket.5.in, stapex.5.in, stapfuncs.5.in, stapprobes.5.in: ditto
+
 2006-08-15  Roland McGrath  <roland@redhat.com>
 
 	* systemtap.spec.in (elfutils_version): Require 0.123 now.
diff --git a/lket.5.in b/lket.5.in
index 61378519..eb802d59 100644
--- a/lket.5.in
+++ b/lket.5.in
@@ -204,10 +204,10 @@ Where
 is the combination of:
 
 .SAMPLE
-((cmd->device->host->host_no & 0xFF) << 24) |
-((cmd->device->channel & 0xFF) << 16) |
-((cmd->device->lun & 0xFF) << 8) |
-(cmd->device->id & 0xFF)
+((cmd\->device\->host\->host_no & 0xFF) << 24) |
+((cmd\->device\->channel & 0xFF) << 16) |
+((cmd\->device\->lun & 0xFF) << 8) |
+(cmd\->device\->id & 0xFF)
 .ESAMPLE
 
 .TP
@@ -483,25 +483,25 @@ Data format is:
 
 By default, LKET will log the trace data in binary format.
 
-To get a better performance for binary tracing, the "-b" option should
-be turned on for stap and thus -M option has to be added to stop stpd
+To get a better performance for binary tracing, the "\-b" option should
+be turned on for stap and thus \-M option has to be added to stop stpd
 merging per-cpu files.
 
 You could use the command 
-.I lket-b2a
+.I lket\-b2a
 to convert the binary trace data 
 generated by LKET into readable data in ascii format.
 
-.I lket-b2a
+.I lket\-b2a
 uses the pre-cpu binary trace data files as inputs, and generates
 an output file named 
 .I lket.out
-You should use "stap -b -M" with LKET to get those pre-cpu files
+You should use "stap \-b \-M" with LKET to get those pre-cpu files
 (stpd_cpu*) before using it.
 
 If you want LKET to log trace data in ASCII format directly, you should:
 .SAMPLE
-stap -D ASCII_TRACE ...
+stap \-D ASCII_TRACE ...
 .ESAMPLE
 
 .SH EVENT REGISTER
@@ -572,9 +572,9 @@ data for that event?
 
 LKET provides a way to do this without modifying the codes in
 the tapset of that event hook. You can simply use printf to trace
-extra data. For example, supposing you want to trace sk_buff->mac_len
-and sk_buff->priority besides the sk_buff->len, sk_buff->protocol and
-sk_buff->truesize for the 
+extra data. For example, supposing you want to trace sk_buff\->mac_len
+and sk_buff\->priority besides the sk_buff\->len, sk_buff\->protocol and
+sk_buff\->truesize for the 
 .B netdev 
 event hooks:
 
@@ -586,7 +586,7 @@ probe register_event
 }
 probe addevent.netdev.transmit
 {
-    printf("%4b%4b", $skb->mac_len, $skb->priority)
+    printf("%4b%4b", $skb\->mac_len, $skb\->priority)
 }
 .ESAMPLE
 
@@ -596,16 +596,16 @@ Here are some examples of using LKET:
 
 .TP
 To turn on all event hooks:
-stap -e "probe addevent.* {}" -bM
+stap \-e "probe addevent.* {}" \-bM
 .TP
 To probe syscall:
-stap -e "probe addevent.syscall {}" -bM
+stap \-e "probe addevent.syscall {}" \-bM
 .TP
 To only probe syscall.entry:
-stap -e "probe addevent.syscall.entry {}" -bM
+stap \-e "probe addevent.syscall.entry {}" \-bM
 .TP
 To probe netdev transmition and log extra data of mac_len and priority:
-stap -e "probe addevent.netdev.transmit { printf(\\"%4b%4b\\", $skb->mac_len, $skb->priority) }" -bM
+stap \-e "probe addevent.netdev.transmit { printf(\\"%4b%4b\\", $skb\->mac_len, $skb\->priority) }" \-bM
 
 .SH SEE ALSO
 .IR stap (1)
diff --git a/stap.1.in b/stap.1.in
index c805f54d..c7fb9b30 100644
--- a/stap.1.in
+++ b/stap.1.in
@@ -78,7 +78,7 @@ This manual corresponds to version @VERSION@.
 The systemtap translator supports the following options.  Any other option
 prints a list of supported options.
 .\" undocumented for now:
-.\" -t test mode
+.\" \-t test mode
 .TP
 .B \-v
 Increase verbosity.  Produce a larger volume of informative (?) output
@@ -203,7 +203,7 @@ by its first keyword.
 .PP
 If the first part is the identifier
 .BR kernel_vr " or " kernel_v
-to refer to the kernel version number, with ("2.6.13-1.322FC3smp") or
+to refer to the kernel version number, with ("2.6.13\-1.322FC3smp") or
 without ("2.6.13") the release code suffix, then
 the second part is one of the six standard numeric comparison operators
 .BR < ", " <= ", " == ", " != ", " > ", and " >= ,
@@ -235,7 +235,7 @@ The following code might adapt to hypothetical kernel version drift:
 .SAMPLE
 probe kernel.function ( 
   %( kernel_v <= "2.6.12" %? "__mm_do_fault" %: 
-     %( kernel_vr == "2.6.13-1.8273FC3smp" %? "do_page_fault" %:
+     %( kernel_vr == "2.6.13\-1.8273FC3smp" %? "do_page_fault" %:
         UNSUPPORTED %) %)
 ) { /* ... */ }
 
@@ -309,7 +309,7 @@ STMT, then the iteration expression EXP3.
 Loop over each element of the named global array, assigning current
 key to VAR.  The array may not be modified within the statement.
 By adding a single 
-.BR + " or " -
+.BR + " or " \-
 operator after the VAR or the ARRAY identifier, the iteration will
 proceed in a sorted order, by ascending or descending index or value.
 .TP
@@ -349,20 +349,20 @@ typical C rules for signed integers.  Division by zero or overflow is
 detected and results in an error.
 .TP
 binary numeric operators
-.B * / % + - >> << & ^ | && ||
+.B * / % + \- >> << & ^ | && ||
 .TP
 binary string operators
 .B .
 (string concatenation)
 .TP
 numeric assignment operators
-.B = *= /= %= += -= >>= <<= &= ^= |=
+.B = *= /= %= += \-= >>= <<= &= ^= |=
 .TP
 string assignment operators
 .B = .=
 .TP
 unary numeric operators
-.B + - ! ~ ++ -- 
+.B + \- ! ~ ++ \-\- 
 .TP
 binary numeric or string comparison operators
 .B < > <= >= == !=
@@ -604,11 +604,11 @@ are made available to it using a macro
 Here are some examples:
 .SAMPLE
 function add_one (val) %{
-  THIS->__retvalue = THIS->val + 1;
+  THIS\->__retvalue = THIS\->val + 1;
 %}
 function add_one_str (val) %{
-  strlcpy (THIS->__retvalue, THIS->val, MAXSTRINGLEN);
-  strlcat (THIS->__retvalue, "one", MAXSTRINGLEN);
+  strlcpy (THIS\->__retvalue, THIS\->val, MAXSTRINGLEN);
+  strlcat (THIS\->__retvalue, "one", MAXSTRINGLEN);
 %}
 .ESAMPLE
 The function argument and return value types have to be inferred by
@@ -640,9 +640,9 @@ subdirectories are derived from the selected kernel version (the
 option),
 in order to allow more kernel-version-specific scripts to override less
 specific ones.  For example, for a kernel version
-.IR 2.6.12-23.FC3
+.IR 2.6.12\-23.FC3
 the following patterns would be searched, in sequence:
-.IR 2.6.12-23.FC3/*.stp ,
+.IR 2.6.12\-23.FC3/*.stp ,
 .IR 2.6.12/*.stp ,
 .IR 2.6/*.stp ,
 and finally
@@ -748,7 +748,7 @@ to kernel crash or data corruption.
 .PP
 The resource use limits are set by macros in the generated C code.
 These may be overridden with the
-.R \-D
+.BR \-D
 flag.  A selection of these is as follows: 
 .TP
 MAXNESTING
@@ -804,7 +804,7 @@ The location of kernel module building infrastructure.
 .TP
 /usr/lib/debug/lib/modules/VERSION
 The location of kernel debugging information when packaged into the
-.IR kernel-debuginfo
+.IR kernel\-debuginfo
 RPM.
 .TP
 /usr/libexec/systemtap/stpd
diff --git a/stapex.5.in b/stapex.5.in
index 42c4e4d8..d43edda0 100644
--- a/stapex.5.in
+++ b/stapex.5.in
@@ -38,7 +38,7 @@ probe end {
   foreach (x+ in odds) {
     log("odds[" . sprint(x) . "] = " . sprint(odds[x]))
   }
-  foreach (x in evens-) {
+  foreach (x in evens\-) {
     log("evens[" . sprint(x) . "] = " . sprint(evens[x]))
   }
 }
@@ -84,7 +84,7 @@ function fibonacci(i) {
   if (i < 1) error ("bad number")
   if (i == 1) return 1
   if (i == 2) return 2
-  return fibonacci (i-1) + fibonacci (i-2)
+  return fibonacci (i\-1) + fibonacci (i\-2)
 }
 probe begin {
   log ("11th fibonacci number: " . sprint (fibonacci (11)))
@@ -107,7 +107,7 @@ To list the probeable functions in the kernel, use the last-pass
 option to the translator.  That output needs to be filtered because
 each inlined function instance is listed separately.
 .SAMPLE
-% stap -p2 -e \[aq]probe kernel.function("*") {}\[aq] | sort | uniq
+% stap \-p2 \-e \[aq]probe kernel.function("*") {}\[aq] | sort | uniq
 .ESAMPLE
 
 
diff --git a/stapfuncs.5.in b/stapfuncs.5.in
index c95a9fad..74f65969 100644
--- a/stapfuncs.5.in
+++ b/stapfuncs.5.in
@@ -10,7 +10,7 @@ function is described with a signature, and its behavior/restrictions.
 The signature line includes the name of the function, the type of
 its return value (if any), and the names and types of all parameters.
 The syntax is the same as printed with the 
-.IR stap " option " -p2 .
+.IR stap " option " \-p2 .
 Examples:
 
 .TP
diff --git a/stapprobes.5.in b/stapprobes.5.in
index 7f3f5951..552c5382 100644
--- a/stapprobes.5.in
+++ b/stapprobes.5.in
@@ -88,7 +88,7 @@ timer.jiffies(N).randomize(M)
 .ESAMPLE
 The probe handler is run every N jiffies (a kernel-defined unit of
 time, typically between 1 and 60 ms).  If the "randomize" component is
-given, a linearly distributed random value in the range [-M..+M] is
+given, a linearly distributed random value in the range [\-M..+M] is
 added to N every time the handler is run.  N is restricted to a
 reasonable range (1 to around a million), and M is restricted to be
 smaller than N.  There are no target variables provided in either
@@ -196,7 +196,7 @@ pointers (char *) may be copied to systemtap string values using the
 .IR kernel_string " or " user_string
 functions.
 .TP
-$var->field
+$var\->field
 traversal to a structure's field.  The indirection operator
 may be repeated to follow more levels of pointers.
 .TP
@@ -742,7 +742,7 @@ case, the handler would run once during startup and twice during
 shutdown.
 .TP
 timer.jiffies(1000).randomize(200)
-refers to a periodic interrupt, every 1000 +/- 200 jiffies.
+refers to a periodic interrupt, every 1000 +/\- 200 jiffies.
 .TP
 kernel.function("*init*"), kernel.function("*exit*")
 refers to all kernel functions with "init" or "exit" in the name.