--- embedaddon/sudo/doc/sudoreplay.man.in 2013/07/22 10:46:12 1.1.1.4 +++ embedaddon/sudo/doc/sudoreplay.man.in 2013/10/14 07:56:34 1.1.1.5 @@ -1,7 +1,7 @@ .\" DO NOT EDIT THIS FILE, IT IS NOT THE MASTER! .\" IT IS GENERATED AUTOMATICALLY FROM sudoreplay.mdoc.in .\" -.\" Copyright (c) 2009-2012 Todd C. Miller +.\" Copyright (c) 2009-2013 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 @@ -16,7 +16,7 @@ .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.TH "SUDOREPLAY" "@mansectsu@" "February 5, 2013" "Sudo @PACKAGE_VERSION@" "System Manager's Manual" +.TH "SUDOREPLAY" "@mansectsu@" "September 11, 2013" "Sudo @PACKAGE_VERSION@" "System Manager's Manual" .nh .if n .ad l .SH "NAME" @@ -26,15 +26,15 @@ .HP 11n \fBsudoreplay\fR [\fB\-h\fR] -[\fB\-d\fR\ \fIdirectory\fR] +[\fB\-d\fR\ \fIdir\fR] [\fB\-f\fR\ \fIfilter\fR] -[\fB\-m\fR\ \fImax_wait\fR] -[\fB\-s\fR\ \fIspeed_factor\fR] +[\fB\-m\fR\ \fInum\fR] +[\fB\-s\fR\ \fInum\fR] ID .HP 11n \fBsudoreplay\fR [\fB\-h\fR] -[\fB\-d\fR\ \fIdirectory\fR] +[\fB\-d\fR\ \fIdir\fR] \fB\-l\fR [search expression] .SH "DESCRIPTION" @@ -92,37 +92,30 @@ Reduce the playback speed by one half. Double the playback speed. .PP The options are as follows: -.TP 14n -\fB\-d\fR \fIdirectory\fR -.br -Use -\fIdirectory\fR -to for the session logs instead of the default, +.TP 12n +\fB\-d\fR \fIdir\fR, \fB\--directory\fR=\fIdir\fR +Store session logs in +\fIdir\fR +instead of the default, \fI@iolog_dir@\fR. -.TP 14n -\fB\-f\fR \fIfilter\fR +.TP 12n +\fB\-f\fR \fIfilter\fR, \fB\--filter\fR=\fIfilter\fR +Select which I/O type(s) to display. By default, \fBsudoreplay\fR -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 -\fB\-f\fR -option can be used to select which of these to output. -The \fIfilter\fR argument is a comma-separated list, consisting of one or more of following: \fIstdout\fR, \fIstderr\fR, and \fIttyout\fR. -.TP 14n -\fB\-h\fR -The -\fB\-h\fR (\fIhelp\fR) -option causes -\fBsudoreplay\fR -to print a short help message to the standard output and exit. -.TP 14n -\fB\-l\fR [\fIsearch expression\fR] +.TP 12n +\fB\-h\fR, \fB\--help\fR +Display a short help message to the standard output and exit. +.TP 12n +\fB\-l\fR, \fB\--list\fR [\fIsearch expression\fR] Enable ``list mode''. In this mode, @@ -217,8 +210,8 @@ unless separated by an .PP .RE .PD 0 -.TP 14n -\fB\-m\fR \fImax_wait\fR +.TP 12n +\fB\-m\fR, \fB\--max-wait\fR \fImax_wait\fR Specify an upper bound on how long to wait between key presses or output data. By default, \fBsudoreplay\fR @@ -234,8 +227,8 @@ seconds. The value may be specified as a floating point number, e.g.\& \fI2.5\fR. .PD -.TP 14n -\fB\-s\fR \fIspeed_factor\fR +.TP 12n +\fB\-s\fR, \fB\--speed\fR \fIspeed_factor\fR This option causes \fBsudoreplay\fR to adjust the number of seconds it will wait between key presses or @@ -250,14 +243,11 @@ would make the output twice as fast whereas a of \fI.5\fR would make the output twice as slow. -.TP 14n -\fB\-V\fR -The -\fB\-V\fR (\fIversion\fR) -option causes +.TP 12n +\fB\-V\fR, \fB\--version\fR +Print the \fBsudoreplay\fR -to print its version number -and exit. +versions version number and exit. .SS "Date and time format" The time and date may be specified multiple ways, common formats include: .TP 8n @@ -296,10 +286,15 @@ yesterday 2 hours ago. .TP 8n next Friday -The first second of the next Friday. +The first second of the Friday in the next (upcoming) week. +Not to be confused with +``this friday'' +which would match the friday of the current week. .TP 8n -this week -The current time but the first day of the coming week. +last week +The current time but 7 days ago. +This is equivalent to +``a week ago''. .TP 8n a fortnight ago The current time but 14 days ago. @@ -318,6 +313,20 @@ The current time but 14 days ago. .TP 8n 10:01 am Sep 17, 2009 10:01 am, September 17, 2009. +.PP +Note that relative time specifications do not always work as expected. +For example, the +``next'' +qualifier is intended to be used in conjunction with a day such as +``next Monday''. +When used with units of weeks, months, years, etc +the result will be one more than expected. +For example, +``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 +\fBsudoreplay\fR. .SH "FILES" .TP 26n \fI@iolog_dir@\fR