diff options
| -rw-r--r-- | raidgrep.1.asciidoc | 12 | ||||
| -rw-r--r-- | src/main.rs | 3 |
2 files changed, 15 insertions, 0 deletions
diff --git a/raidgrep.1.asciidoc b/raidgrep.1.asciidoc index 30e0b2f..584713e 100644 --- a/raidgrep.1.asciidoc +++ b/raidgrep.1.asciidoc @@ -48,6 +48,18 @@ command line: *-d* 'path', *--dir* 'path':: Path to the folder with logs [default: .] +*-s* 'sorting', *--sort* 'sorting':: + Sort the output according to the given fields. Valid fields are 'boss', + 'date', 'cm' and 'outcome'. Fields can be comma-separated, then later + fields are used to break ties. Fields can be prefixed by ~ to indicate + sorting in the opposite direction. + + + + Note that using this option will cause raidgrep to buffer all results until + the search has finished, which means that no output will happen until every + file has been searched. It can also lead to a higher memory consumption, + based on how many logs are matched. Therefore, it is advised that you do + not use this option unless needed. + + == PREDICATES The following predicates can be used after the options. Note that they should diff --git a/src/main.rs b/src/main.rs index 43a6f59..84d1063 100644 --- a/src/main.rs +++ b/src/main.rs @@ -81,6 +81,9 @@ pub struct Opt { no_color: bool, /// Sort the output. + /// + /// Valid sorting fields are date, boss, cm and outcome. Prefix the field with ~ to sort in + /// descending order. #[structopt(short = "s", long = "sort")] sorting: Option<Sorting>, |