tagdb/src/usage.txt at main · tlikonen/tagdb · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
Usage: {program} [options] [--] TAG ...

  The default operation prints all database records that match all the
  given TAG(s). The TAG name arguments can be any substring of the
  actual tag names.

General options

  -v, --verbose
        Verbose output. Print records’ timestamps.

  -q, --quiet
        Quiet output. Don’t print records’ metadata, just the content.

  --utc
        Print timestamps in UTC time instead of local time zone. This is
        relevant with verbose (-v) output and edit (-e).

  --db=FILE
        Use FILE as the database file instead of the default. The
        program will try to create all the necessary directories for
        FILE. The default database file is “{database}” and its location
        is defined by variable XDG_DATA_HOME (default:
        “$HOME/.local/share”).

  --format=MODE
        Set output format to MODE which can be “text”, “text-color” or
        “org-mode”. You can add suffix “/default” to MODE in which case
        the specified mode will be saved as the default output mode.

Command options

  -s, --short TAG ...
        Short output. This is like the default operation but only prints
        the first line of records’ content. The first line could be used
        as record’s title.

  -n, --count TAG ...
        Count and print how many records match the given TAG(s).

  -c, --create TAG ...
        Create a new database record associated with the given tags. The
        default text editor (variable: EDITOR) is launched for editing
        the record. Empty lines at the beginning and end are ignored.

  --cs, --create-stdin TAG ...
        Same as the command “-c” but the standard input stream is saved
        as record’s content.

  -e, --edit TAG ...
        Find all records that match the given tags and launch the
        default text editor (variable: EDITOR) for editing the records’
        contents and tags. Empty lines at the beginning and end of the
        record content are ignored. If a record has empty content the
        record will be deleted from the database.

  -l, --list [TAG ...]
        List tags that match the given TAG name string(s). If no
        arguments are given list all tags. Tags are listed in alphabetic
        case insensitive order with a number that represents a count how
        many records are associated with the tag.

  -r, --retag OLD NEW
        Retag records. All database records associated with the old tag
        will be associated with the new tag. The old tag is then
        removed.

  -h, --help
        Print this help text.

  --version
        Print program’s version and copyright information.