Browse Source

Manpage update

Yann Weber 7 years ago
parent
commit
fc3d64c29b
2 changed files with 17 additions and 5 deletions
  1. 9
    2
      docs/man/man1/ttail.1
  2. 8
    3
      src/include/doxygen.h

+ 9
- 2
docs/man/man1/ttail.1 View File

@@ -5,11 +5,13 @@
5 5
 ttail \- timed tail for logfiles
6 6
 .SH "SYNOSPIS"
7 7
 .PP
8
-ttail [OPTION]\&.\&.\&. [FILE]\&.\&.\&. 
8
+ttail [OPTION]\&.\&.\&. [FILE]\&.\&.\&. 
9 9
 .SH "DESCRIPTION"
10 10
 .PP
11 11
 Display loglines given a minimum date and/or a maximum date\&.
12 12
 .PP
13
+For huge files (or a huge list of files) you should have better performance giving files as argument (thank's to binary search on file list and in files)\&.
14
+.PP
13 15
 \fB-d --date-min=DATE\fP
14 16
 .RS 4
15 17
 Start to output loglines starting from this date 
@@ -30,6 +32,11 @@ The date format present in the logfiles and used by -d --date-min and -m --date-
30 32
 Set a constant prefix len to drop for each logline 
31 33
 .RE
32 34
 .PP
35
+\fB-P --permissive\fP
36
+.RS 4
37
+Tell ttail to continue after some errors (prefix or date not found, invalid file, etc\&.) 
38
+.RE
39
+.PP
33 40
 \fB-r --re-prefix=REGEX\fP
34 41
 .RS 4
35 42
 Drop matching prefix for each logline 
@@ -162,7 +169,7 @@ The O modifier specifies that the numerical input may be in an alternative local
162 169
 %Oy The year (offset from C) using the locale's alternative numeric symbols\&.
163 170
 .SH "Known limitations"
164 171
 .PP
165
-Loglines has to be sorted\&.
172
+Files given as argument has to be sorted\&.
166 173
 .SH "AUTHOR"
167 174
 .PP
168 175
 Written by Yann Weber <yann.weber@members.fsf.org>

+ 8
- 3
src/include/doxygen.h View File

@@ -1,10 +1,13 @@
1 1
 /**@page ttail
2 2
  *@brief timed tail for logfiles
3 3
  *@section SYNOSPIS
4
- *ttail [OPTION]... [FILE]...
4
+ *ttail [OPTION]... [FILE]...
5 5
  *@section DESCRIPTION
6 6
  *Display loglines given a minimum date and/or a maximum date.
7 7
  *
8
+ *For huge files (or a huge list of files) you should have better performance
9
+ *giving files as argument (thank's to binary search on file list and in files).
10
+ *
8 11
  *@par -d --date-min=DATE
9 12
  *Start to output loglines starting from this date
10 13
  *@par -m --date-max=DATE
@@ -14,6 +17,8 @@
14 17
  *-m --date-max options (see @ref datefmt for more details)
15 18
  *@par -p --prefix-len
16 19
  *Set a constant prefix len to drop for each logline
20
+ *@par -P --permissive
21
+ *Tell ttail to continue after some errors (prefix or date not found, invalid file, etc.)
17 22
  *@par -r --re-prefix=REGEX
18 23
  *Drop matching prefix for each logline
19 24
  *@par -E --re-extended 
@@ -156,8 +161,8 @@
156 161
  * 
157 162
  * \%Oy    The year (offset from %C) using the locale's alternative numeric symbols.
158 163
  *
159
- *@section known_limits Known limitations
160
- *Loglines has to be sorted.
164
+ *@section known_limitations Known limitations
165
+ *Files given as argument has to be sorted.
161 166
  *
162 167
  *@section AUTHOR
163 168
  *Written by Yann Weber &lt;yann.weber@members.fsf.org&gt;

Loading…
Cancel
Save