--- embedaddon/sudo/doc/sudoreplay.mdoc.in 2013/07/22 10:46:12 1.1.1.2 +++ embedaddon/sudo/doc/sudoreplay.mdoc.in 2014/06/15 16:12:54 1.1.1.4 @@ -1,5 +1,5 @@ .\" -.\" Copyright (c) 2009-2012 Todd C. Miller +.\" Copyright (c) 2009-2014 Todd C. Miller .\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above @@ -14,7 +14,7 @@ .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.Dd February 5, 2013 +.Dd February 15, 2014 .Dt SUDOREPLAY @mansectsu@ .Os Sudo @PACKAGE_VERSION@ .Sh NAME @@ -23,25 +23,15 @@ .Sh SYNOPSIS .Nm sudoreplay .Op Fl h -.Bk -words -.Op Fl d Ar directory -.Ek -.Bk -words +.Op Fl d Ar dir .Op Fl f Ar filter -.Ek -.Bk -words -.Op Fl m Ar max_wait -.Ek -.Bk -words -.Op Fl s Ar speed_factor -.Ek +.Op Fl m Ar num +.Op Fl s Ar num ID .Pp .Nm sudoreplay .Op Fl h -.Bk -words -.Op Fl d Ar directory -.Ek +.Op Fl d Ar dir .Fl l .Op search expression .Sh DESCRIPTION @@ -77,7 +67,7 @@ log file. The .Em ID may also be determined using -.Nm sudoreplay Ns No 's +.Nm sudoreplay Ns 's list mode. .Pp In list mode, @@ -89,7 +79,9 @@ In replay mode, if the standard output has not been re .Nm sudoreplay will act on the following keys: .Bl -tag -width 12n -.It So Li \ Sc No (space) +.It So Li \en Sc No or So Li \er Sc +Skip to the next replay event; useful for long pauses. +.It So Li \ Sc Pq space Pause output; press any key to resume. .It Ql < Reduce the playback speed by one half. @@ -98,33 +90,27 @@ Double the playback speed. .El .Pp The options are as follows: -.Bl -tag -width 12n -.It Fl d Ar directory -Use -.Ar directory -to for the session logs instead of the default, +.Bl -tag -width Fl +.It Fl d Ar dir , Fl -directory Ns = Ns Ar dir +Store session logs in +.Ar dir +instead of the default, .Pa @iolog_dir@ . -.It Fl f Ar filter +.It Fl f Ar filter , Fl -filter Ns = Ns Ar filter +Select which I/O type(s) to display. By default, .Nm sudoreplay -will play back the command's standard output, standard error and tty output. +will display the command's standard output, standard error and tty output. The -.Fl f -option can be used to select which of these to output. -The .Ar filter argument is a comma-separated list, consisting of one or more of following: .Em stdout , .Em stderr , and .Em ttyout . -.It Fl h -The -.Fl h No ( Em help Ns No ) -option causes -.Nm sudoreplay -to print a short help message to the standard output and exit. -.It Fl l Op Ar search expression +.It Fl h , -help +Display a short help message to the standard output and exit. +.It Fl l , -list Op Ar search expression Enable .Dq list mode . In this mode, @@ -209,7 +195,7 @@ operator is optional, adjacent predicates have an impl .Em and unless separated by an .Em or . -.It Fl m Ar max_wait +.It Fl m , -max-wait Ar max_wait Specify an upper bound on how long to wait between key presses or output data. By default, .Nm sudoreplay @@ -224,7 +210,7 @@ will limit these pauses to at most seconds. The value may be specified as a floating point number, e.g.\& .Em 2.5 . -.It Fl s Ar speed_factor +.It Fl s , -speed Ar speed_factor This option causes .Nm sudoreplay to adjust the number of seconds it will wait between key presses or @@ -239,13 +225,10 @@ would make the output twice as fast whereas a of .Em .5 would make the output twice as slow. -.It Fl V -The -.Fl V No ( Em version Ns No ) -option causes +.It Fl V , -version +Print the .Nm sudoreplay -to print its version number -and exit. +versions version number and exit. .El .Ss Date and time format The time and date may be specified multiple ways, common formats include: @@ -279,9 +262,14 @@ Exactly one day from now. .It 2 hours ago 2 hours ago. .It next Friday -The first second of the next Friday. -.It this week -The current time but the first day of the coming week. +The first second of the Friday in the next (upcoming) week. +Not to be confused with +.Dq this friday +which would match the friday of the current week. +.It last week +The current time but 7 days ago. +This is equivalent to +.Dq a week ago . .It a fortnight ago The current time but 14 days ago. .It 10:01 am 9/17/2009 @@ -295,6 +283,20 @@ The current time but 14 days ago. .It 10:01 am Sep 17, 2009 10:01 am, September 17, 2009. .El +.Pp +Note that relative time specifications do not always work as expected. +For example, the +.Dq next +qualifier is intended to be used in conjunction with a day such as +.Dq next Monday . +When used with units of weeks, months, years, etc +the result will be one more than expected. +For example, +.Dq next week +will result in a time exactly two weeks from now, which is probably +not what was intended. +This will be addressed in a future version of +.Nm sudoreplay . .Sh FILES .Bl -tag -width 24n .It Pa @iolog_dir@