瀏覽代碼

Manpage update

Yann Weber 8 年之前
父節點
當前提交
fc3d64c29b
共有 2 個檔案被更改,包括 17 行新增5 行删除
  1. 9
    2
      docs/man/man1/ttail.1
  2. 8
    3
      src/include/doxygen.h

+ 9
- 2
docs/man/man1/ttail.1 查看文件

5
 ttail \- timed tail for logfiles
5
 ttail \- timed tail for logfiles
6
 .SH "SYNOSPIS"
6
 .SH "SYNOSPIS"
7
 .PP
7
 .PP
8
-ttail [OPTION]\&.\&.\&. [FILE]\&.\&.\&. 
8
+ttail [OPTION]\&.\&.\&. [FILE]\&.\&.\&. 
9
 .SH "DESCRIPTION"
9
 .SH "DESCRIPTION"
10
 .PP
10
 .PP
11
 Display loglines given a minimum date and/or a maximum date\&.
11
 Display loglines given a minimum date and/or a maximum date\&.
12
 .PP
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
 \fB-d --date-min=DATE\fP
15
 \fB-d --date-min=DATE\fP
14
 .RS 4
16
 .RS 4
15
 Start to output loglines starting from this date 
17
 Start to output loglines starting from this date 
30
 Set a constant prefix len to drop for each logline 
32
 Set a constant prefix len to drop for each logline 
31
 .RE
33
 .RE
32
 .PP
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
 \fB-r --re-prefix=REGEX\fP
40
 \fB-r --re-prefix=REGEX\fP
34
 .RS 4
41
 .RS 4
35
 Drop matching prefix for each logline 
42
 Drop matching prefix for each logline 
162
 %Oy The year (offset from C) using the locale's alternative numeric symbols\&.
169
 %Oy The year (offset from C) using the locale's alternative numeric symbols\&.
163
 .SH "Known limitations"
170
 .SH "Known limitations"
164
 .PP
171
 .PP
165
-Loglines has to be sorted\&.
172
+Files given as argument has to be sorted\&.
166
 .SH "AUTHOR"
173
 .SH "AUTHOR"
167
 .PP
174
 .PP
168
 Written by Yann Weber <yann.weber@members.fsf.org>
175
 Written by Yann Weber <yann.weber@members.fsf.org>

+ 8
- 3
src/include/doxygen.h 查看文件

1
 /**@page ttail
1
 /**@page ttail
2
  *@brief timed tail for logfiles
2
  *@brief timed tail for logfiles
3
  *@section SYNOSPIS
3
  *@section SYNOSPIS
4
- *ttail [OPTION]... [FILE]...
4
+ *ttail [OPTION]... [FILE]...
5
  *@section DESCRIPTION
5
  *@section DESCRIPTION
6
  *Display loglines given a minimum date and/or a maximum date.
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
  *@par -d --date-min=DATE
11
  *@par -d --date-min=DATE
9
  *Start to output loglines starting from this date
12
  *Start to output loglines starting from this date
10
  *@par -m --date-max=DATE
13
  *@par -m --date-max=DATE
14
  *-m --date-max options (see @ref datefmt for more details)
17
  *-m --date-max options (see @ref datefmt for more details)
15
  *@par -p --prefix-len
18
  *@par -p --prefix-len
16
  *Set a constant prefix len to drop for each logline
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
  *@par -r --re-prefix=REGEX
22
  *@par -r --re-prefix=REGEX
18
  *Drop matching prefix for each logline
23
  *Drop matching prefix for each logline
19
  *@par -E --re-extended 
24
  *@par -E --re-extended 
156
  * 
161
  * 
157
  * \%Oy    The year (offset from %C) using the locale's alternative numeric symbols.
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
  *@section AUTHOR
167
  *@section AUTHOR
163
  *Written by Yann Weber &lt;yann.weber@members.fsf.org&gt;
168
  *Written by Yann Weber &lt;yann.weber@members.fsf.org&gt;

Loading…
取消
儲存