Browse Source

Add relative date documentation to manpage

Yann Weber 7 years ago
parent
commit
04f0ddd897
1 changed files with 15 additions and 2 deletions
  1. 15
    2
      src/include/doxygen.h

+ 15
- 2
src/include/doxygen.h View File

@@ -24,9 +24,22 @@
24 24
  *@par -v[v[v[...]]]
25 25
  *Augment the loglevel
26 26
  *
27
- *@section datefmt Date format
28
- * The dateformat understood by ttail is the strptime date format :
27
+ *@section datefmt Date formats
29 28
  *
29
+ * ttail understand two date formats : strprtime and relative
30
+ *
31
+ *@subsection datefmt_rel Relative date format
32
+ *Relative date format is used with -d --date-min or -m --date-max arguments.
33
+ *The shape of a relative date is "-#[VAL][UNIT]" with VAL an integer and UNIT
34
+ *one of the recognized units :
35
+ *- y[ear]
36
+ *- M[onth]
37
+ *- d[ay]
38
+ *- h[our]
39
+ *- m[in]
40
+ *- s[ec]
41
+ *
42
+ *@subsection datefmt_strptime Strptime date format
30 43
  * The supported input field descriptors are listed below.  In case a text string (such as the name
31 44
  * of a day of the week or a month name) is to be matched, the comparison is case insensitive.   In
32 45
  * case a number is to be matched, leading zeros are permitted but not required.

Loading…
Cancel
Save