Browse Source

Add manpage to git repo

Yann Weber 3 years ago
parent
commit
491de41e54
3 changed files with 171 additions and 3 deletions
  1. 1
    1
      .gitignore
  2. 2
    2
      docs/Makefile.am
  3. 168
    0
      docs/man/man1/ttail.1

+ 1
- 1
.gitignore View File

@@ -21,4 +21,4 @@ tests/*.log
21 21
 tests/*.trs
22 22
 tests/Makefile*
23 23
 docs/html
24
-docs/man
24
+docs/man/man3

+ 2
- 2
docs/Makefile.am View File

@@ -1,7 +1,7 @@
1
+dist_man_MANS= $(top_srcdir)/docs/man/man1/ttail.1
1 2
 if HAVE_DOXYGEN
2 3
 CLEANFILES = doxyfile.stamp
3 4
 directory = $(top_srcdir)/docs/man/man3/
4
-dist_man_MANS= $(top_srcdir)/docs/man/man1/ttail.1
5 5
 
6 6
 $(directory)/man_page_1.3: doxyfile.stamp
7 7
 $(directory)/man_page_2.3: doxyfile.stamp
@@ -19,5 +19,5 @@ $(top_srcdir)/docs/man/man1/ttail.1: doxyfile.stamp
19 19
 	sed -i 's/^.TH "ttail" 3/.TH "ttail" 1/' $(top_srcdir)/docs/man/man1/ttail.1
20 20
 
21 21
 clean-local:
22
-	-rm -rf $(top_srcdir)/docs/html $(top_srcdir)/docs/man $(top_srcdir)/docs/doxygen_sqlite3.db
22
+	-rm -rf $(top_srcdir)/docs/html $(top_srcdir)/docs/man/man3 $(top_srcdir)/docs/doxygen_sqlite3.db
23 23
 endif

+ 168
- 0
docs/man/man1/ttail.1 View File

@@ -0,0 +1,168 @@
1
+.TH "ttail" 1 "Mon May 15 2017" "Version 0.0.1" "ttail" \" -*- nroff -*-
2
+.ad l
3
+.nh
4
+.SH NAME
5
+ttail \- timed tail for logfiles
6
+.SH "SYNOSPIS"
7
+.PP
8
+ttail [OPTION]\&.\&.\&. [FILE]\&.\&.\&. 
9
+.SH "DESCRIPTION"
10
+.PP
11
+Display loglines given a minimum date and/or a maximum date\&.
12
+.PP
13
+\fB-d --date-min=DATE\fP
14
+.RS 4
15
+Start to output loglines starting from this date 
16
+.RE
17
+.PP
18
+\fB-m --date-max=DATE\fP
19
+.RS 4
20
+Stop to output loglines starting from this date 
21
+.RE
22
+.PP
23
+\fB-f --date-format=FMT\fP
24
+.RS 4
25
+The date format present in the logfiles and used by -d --date-min and -m --date-max options (see \fBDate formats\fP for more details) 
26
+.RE
27
+.PP
28
+\fB-p --prefix-len\fP
29
+.RS 4
30
+Set a constant prefix len to drop for each logline 
31
+.RE
32
+.PP
33
+\fB-r --re-prefix=REGEX\fP
34
+.RS 4
35
+Drop matching prefix for each logline 
36
+.RE
37
+.PP
38
+\fB-E --re-extended \fP
39
+.RS 4
40
+Interpret -r --re-prefix as an extended regular expression (specified by POSIX) 
41
+.RE
42
+.PP
43
+\fB-I --re-ignore-cas\fP
44
+.RS 4
45
+Ignore case for -r --re-prefix option (specified by POSIX) 
46
+.RE
47
+.PP
48
+\fB-v[v[v[\&.\&.\&.]]]\fP
49
+.RS 4
50
+Augment the loglevel
51
+.RE
52
+.PP
53
+.SH "Date formats"
54
+.PP
55
+ttail understand two date formats : strprtime and relative
56
+.SS "Relative date format"
57
+Relative date format is used with -d --date-min or -m --date-max arguments\&. The shape of a relative date is '-#[VAL][UNIT]' with VAL an integer and UNIT one of the recognized units :
58
+.IP "\(bu" 2
59
+y[ear]
60
+.IP "\(bu" 2
61
+M[onth]
62
+.IP "\(bu" 2
63
+d[ay]
64
+.IP "\(bu" 2
65
+h[our]
66
+.IP "\(bu" 2
67
+m[in]
68
+.IP "\(bu" 2
69
+s[ec]
70
+.PP
71
+.SS "Strptime date format"
72
+The supported input field descriptors are listed below\&. In case a text string (such as the name of a day of the week or a month name) is to be matched, the comparison is case insensitive\&. In case a number is to be matched, leading zeros are permitted but not required\&.
73
+.PP
74
+%% The % character\&.
75
+.PP
76
+%a or A The name of the day of the week according to the current locale, in abbreviated form or the full name\&.
77
+.PP
78
+%b or B or h The month name according to the current locale, in abbreviated form or the full name\&.
79
+.PP
80
+%c The date and time representation for the current locale\&.
81
+.PP
82
+%C The century number (0-99)\&.
83
+.PP
84
+%d or e The day of month (1-31)\&.
85
+.PP
86
+%D Equivalent to m/d/y\&. (This is the American style date, very confusing to non-Ameri‐ cans, especially since d/m/y is widely used in Europe\&. The ISO 8601 standard format is Y-m-d\&.)
87
+.PP
88
+%H The hour (0-23)\&.
89
+.PP
90
+%I The hour on a 12-hour clock (1-12)\&.
91
+.PP
92
+%j The day number in the year (1-366)\&.
93
+.PP
94
+%m The month number (1-12)\&.
95
+.PP
96
+%M The minute (0-59)\&.
97
+.PP
98
+%n Arbitrary whitespace\&.
99
+.PP
100
+%p The locale's equivalent of AM or PM\&. (Note: there may be none\&.)
101
+.PP
102
+%r The 12-hour clock time (using the locale's AM or PM)\&. In the POSIX locale equivalent to %I:M:S p\&. If t_fmt_ampm is empty in the LC_TIME part of the current locale, then the behavior is undefined\&.
103
+.PP
104
+%R Equivalent to H:M\&.
105
+.PP
106
+%S The second (0-60; 60 may occur for leap seconds; earlier also 61 was allowed)\&.
107
+.PP
108
+%t Arbitrary whitespace\&.
109
+.PP
110
+%T Equivalent to H:M:S\&.
111
+.PP
112
+%U The week number with Sunday the first day of the week (0-53)\&. The first Sunday of Janu‐ ary is the first day of week 1\&.
113
+.PP
114
+%w The ordinal number of the day of the week (0-6), with Sunday = 0\&.
115
+.PP
116
+%W The week number with Monday the first day of the week (0-53)\&. The first Monday of Janu‐ ary is the first day of week 1\&.
117
+.PP
118
+%x The date, using the locale's date format\&.
119
+.PP
120
+%X The time, using the locale's time format\&.
121
+.PP
122
+%y The year within century (0-99)\&. When a century is not otherwise specified, values in the range 69-99 refer to years in the twentieth century (1969-1999); values in the range 00-68 refer to years in the twenty-first century (2000-2068)\&.
123
+.PP
124
+%Y The year, including century (for example, 1991)\&.
125
+.PP
126
+Some field descriptors can be modified by the E or O modifier characters to indicate that an alternative format or specification should be used\&. If the alternative format or specification does not exist in the current locale, the unmodified field descriptor is used\&.
127
+.PP
128
+The E modifier specifies that the input string may contain alternative locale-dependent versions of the date and time representation:
129
+.PP
130
+%Ec The locale's alternative date and time representation\&.
131
+.PP
132
+%EC The name of the base year (period) in the locale's alternative representation\&.
133
+.PP
134
+%Ex The locale's alternative date representation\&.
135
+.PP
136
+%EX The locale's alternative time representation\&.
137
+.PP
138
+%Ey The offset from EC (year only) in the locale's alternative representation\&.
139
+.PP
140
+%EY The full alternative year representation\&.
141
+.PP
142
+The O modifier specifies that the numerical input may be in an alternative locale-dependent for‐ mat:
143
+.PP
144
+%Od or Oe The day of the month using the locale's alternative numeric symbols; leading zeros are permitted but not required\&.
145
+.PP
146
+%OH The hour (24-hour clock) using the locale's alternative numeric symbols\&.
147
+.PP
148
+%OI The hour (12-hour clock) using the locale's alternative numeric symbols\&.
149
+.PP
150
+%Om The month using the locale's alternative numeric symbols\&.
151
+.PP
152
+%OM The minutes using the locale's alternative numeric symbols\&.
153
+.PP
154
+%OS The seconds using the locale's alternative numeric symbols\&.
155
+.PP
156
+%OU The week number of the year (Sunday as the first day of the week) using the locale's alternative numeric symbols\&.
157
+.PP
158
+%Ow The ordinal number of the day of the week (Sunday=0), using the locale's alternative numeric symbols\&.
159
+.PP
160
+%OW The week number of the year (Monday as the first day of the week) using the locale's alternative numeric symbols\&.
161
+.PP
162
+%Oy The year (offset from C) using the locale's alternative numeric symbols\&.
163
+.SH "Known limitations"
164
+.PP
165
+Loglines has to be sorted\&.
166
+.SH "AUTHOR"
167
+.PP
168
+Written by Yann Weber yann.weber@members.fsf.org 

Loading…
Cancel
Save