From 1aa1fbaee16d3c89b995b057e31d1d5fcea2cd67 Mon Sep 17 00:00:00 2001 From: Sami Kerola Date: Sat, 17 Sep 2011 23:44:33 +0200 Subject: docs: align scriptreplay.1 with howto-man-page.txt Signed-off-by: Sami Kerola --- term-utils/scriptreplay.1 | 195 ++++++++-------------------------------------- 1 file changed, 31 insertions(+), 164 deletions(-) diff --git a/term-utils/scriptreplay.1 b/term-utils/scriptreplay.1 index 7788af7f3..257589cb9 100644 --- a/term-utils/scriptreplay.1 +++ b/term-utils/scriptreplay.1 @@ -1,149 +1,7 @@ -.\" Automatically generated by Pod::Man version 1.02 -.\" Mon Sep 3 02:16:06 2001 -.\" -.\" Standard preamble: -.\" ====================================================================== -.de Sh \" Subsection heading -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.de Vb \" Begin verbatim text -.ft CW -.nf -.ne \\$1 -.. -.de Ve \" End verbatim text -.ft R - -.fi -.. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. | will give a -.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used -.\" to do unbreakable dashes and therefore won't be available. \*(C` and -.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<> -.tr \(*W-|\(bv\*(Tr -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' -.ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" -. ds C` ` -. ds C' ' -'br\} -.el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' -'br\} -.\" -.\" If the F register is turned on, we'll generate index entries on stderr -.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and -.\" index entries marked with X<> in POD. Of course, you'll have to process -.\" the output yourself in some meaningful fashion. -.if \nF \{\ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" -. . -. nr % 0 -. rr F -.\} -.\" -.\" For nroff, turn off justification. Always turn off hyphenation; it -.\" makes way too many mistakes in technical documents. -.hy 0 -.if n .na -.\" -.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). -.\" Fear. Run. Save yourself. No user-serviceable parts. -.bd B 3 -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C -.\" ====================================================================== -.\" -.IX Title "REPLAY 1" -.TH REPLAY 1 "September 2001" "util-linux" "User Commands" -.UC +.TH SCRIPTREPLAY 1 "September 2011" "util-linux" "User Commands" .SH "NAME" scriptreplay \- play back typescripts, using timing information .SH "SYNOPSIS" -.IX Header "SYNOPSIS" .B scriptreplay .RI [ options ] .RB [ \-t ] @@ -151,7 +9,6 @@ scriptreplay \- play back typescripts, using timing information .RI [ typescript .RI [ divisor ]] .SH "DESCRIPTION" -.IX Header "DESCRIPTION" This program replays a typescript, using timing information to ensure that output happens at the same speed as it originally appeared when the script was recorded. @@ -174,7 +31,8 @@ run with the .B \-t parameter. .PP -By default, the typescript to display is assumed to be named \*(L"typescript\*(R", +By default, the typescript to display is assumed to be named +.BR typescript , but other filenames may be specified, as the second parameter or with option .BR \-s . .PP @@ -193,8 +51,9 @@ File containing script timing output. File containing the script terminal output. .TP .BR \-d , " \-\-divisor " \fInumber\fR -Speed up the replay displaying this \fInumber\fR of times. -The argument is a floating point number. It's called divisor +Speed up the replay displaying this +.I number +of times. The argument is a floating point number. It's called divisor because it divides the timings by this factor. .TP .BR \-V , " \-\-version" @@ -203,23 +62,20 @@ Display version information and exit. .BR \-h , " \-\-help" Display a help message and exit. .SH "EXAMPLE" -.IX Header "EXAMPLE" -.Vb 7 -\& % script -t 2> timingfile -\& Script started, file is typescript -\& % ls -\& -\& % exit -\& Script done, file is typescript -\& % scriptreplay timingfile -.Ve +.nf +% script --timing=file.tm script.out +Script started, file is script.out +% ls + +% exit +Script done, file is script.out +% scriptreplay --timing file.tm --typescript script.out +.nf .SH "SEE ALSO" -.IX Header "SEE ALSO" .BR script (1) .SH "COPYRIGHT" -.IX Header "COPYRIGHT" Copyright \(co 2008 James Youngman -.PP +.br Copyright \(co 2008 Karel Zak .PP This is free software; see the source for copying conditions. There is NO @@ -228,13 +84,24 @@ PURPOSE. .PP Released under the GNU General Public License version 2 or later. .SH "AUTHOR" -.IX Header "AUTHOR" The original .B scriptreplay -program was written by Joey Hess . -The program was re-written in C by James Youngman and Karel Zak . +program was written by +.UR joey\@\:kitenet.net +Joey Hess +.UE . +The program was re-written in C by +.UR jay\@\:gnu.org +James Youngman +.UE +and +.UR kzak\@\:redhat.com +Karel Zak +.UE . .SH AVAILABILITY The .B scriptreplay command is part of the util-linux package and is available from -ftp://ftp.kernel.org/pub/linux/utils/util-linux/. +.UR ftp://\:ftp.kernel.org\:/pub\:/linux\:/utils\:/util-linux/ +Linux Kernel Archive +.UE . -- cgit v1.2.3-55-g7522