Skip to content

Commit d6a987a

Browse files
jansorgjansorg
committed
prep: updating documentation for release of v0.12.2
1 parent 7a42799 commit d6a987a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+668
-689
lines changed

‎docs/man/tom-cancel.3

+15-13
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
1-
.TH "tom" "3" "Feb 2021" "Auto generated by spf13/cobra" ""
21
.nh
3-
.ad l
4-
2+
.TH "tom" "3" "Jul 2022" "Auto generated by spf13/cobra" ""
53

64
.SH NAME
75
.PP
8-
tom\-cancel \- cancel removed the currently running activity. No data will be recorded.
6+
tom-cancel - cancel removed the currently running activity. No data will be recorded.
97

108

119
.SH SYNOPSIS
@@ -20,22 +18,26 @@ cancel removed the currently running activity. No data will be recorded.
2018

2119
.SH OPTIONS
2220
.PP
23-
\fB\-h\fP, \fB\-\-help\fP[=false]
24-
help for cancel
21+
\fB-h\fP, \fB--help\fP[=false]
22+
help for cancel
2523

2624

2725
.SH OPTIONS INHERITED FROM PARENT COMMANDS
2826
.PP
29-
\fB\-\-backup\-dir\fP=""
30-
backup directory (default is $HOME/.tom/backup)
27+
\fB--backup-dir\fP=""
28+
backup directory (default is $HOME/.tom/backup)
29+
30+
.PP
31+
\fB-c\fP, \fB--config\fP=""
32+
config file (default is $HOME/.tom/tom.yaml)
3133

3234
.PP
33-
\fB\-c\fP, \fB\-\-config\fP=""
34-
config file (default is $HOME/.tom/tom.yaml)
35+
\fB--data-dir\fP=""
36+
data directory (default is $HOME/.tom)
3537

3638
.PP
37-
\fB\-\-data\-dir\fP=""
38-
data directory (default is $HOME/.tom)
39+
\fB--iso-dates\fP[=false]
40+
use ISO date format instead of a locale-specific format (default is false)
3941

4042

4143
.SH SEE ALSO
@@ -45,4 +47,4 @@ cancel removed the currently running activity. No data will be recorded.
4547

4648
.SH HISTORY
4749
.PP
48-
3\-Feb\-2021 Auto generated by spf13/cobra
50+
19-Jul-2022 Auto generated by spf13/cobra

‎docs/man/tom-config-set.3

+19-17
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,61 @@
1-
.TH "tom" "3" "Feb 2021" "Auto generated by spf13/cobra" ""
21
.nh
3-
.ad l
4-
2+
.TH "tom" "3" "Jul 2022" "Auto generated by spf13/cobra" ""
53

64
.SH NAME
75
.PP
8-
tom\-config\-set \- Sets a configuration value
6+
tom-config-set - Sets a configuration value
97

108

119
.SH SYNOPSIS
1210
.PP
13-
\fBtom config set <key> <value>\fP
11+
\fBtom config set \fP
1412

1513

1614
.SH DESCRIPTION
1715
.PP
18-
Sets a configuration value to a new value. Use \fB\fCtom config\fR to see a list of all supported keys. Bash completion will suggest the names of built\-in keys.
16+
Sets a configuration value to a new value. Use \fB\fCtom config\fR to see a list of all supported keys. Bash completion will suggest the names of built-in keys.
1917

2018

2119
.SH OPTIONS
2220
.PP
23-
\fB\-h\fP, \fB\-\-help\fP[=false]
24-
help for set
21+
\fB-h\fP, \fB--help\fP[=false]
22+
help for set
2523

2624

2725
.SH OPTIONS INHERITED FROM PARENT COMMANDS
2826
.PP
29-
\fB\-\-backup\-dir\fP=""
30-
backup directory (default is $HOME/.tom/backup)
27+
\fB--backup-dir\fP=""
28+
backup directory (default is $HOME/.tom/backup)
29+
30+
.PP
31+
\fB-c\fP, \fB--config\fP=""
32+
config file (default is $HOME/.tom/tom.yaml)
3133

3234
.PP
33-
\fB\-c\fP, \fB\-\-config\fP=""
34-
config file (default is $HOME/.tom/tom.yaml)
35+
\fB--data-dir\fP=""
36+
data directory (default is $HOME/.tom)
3537

3638
.PP
37-
\fB\-\-data\-dir\fP=""
38-
data directory (default is $HOME/.tom)
39+
\fB--iso-dates\fP[=false]
40+
use ISO date format instead of a locale-specific format (default is false)
3941

4042

4143
.SH EXAMPLE
4244
.PP
4345
.RS
4446

4547
.nf
46-
tom config set data\_dir $HOME/tom\-data
48+
tom config set data_dir $HOME/tom-data
4749

4850
.fi
4951
.RE
5052

5153

5254
.SH SEE ALSO
5355
.PP
54-
\fBtom\-config(3)\fP
56+
\fBtom-config(3)\fP
5557

5658

5759
.SH HISTORY
5860
.PP
59-
3\-Feb\-2021 Auto generated by spf13/cobra
61+
19-Jul-2022 Auto generated by spf13/cobra

‎docs/man/tom-config.3

+19-17
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
1-
.TH "tom" "3" "Feb 2021" "Auto generated by spf13/cobra" ""
21
.nh
3-
.ad l
4-
2+
.TH "tom" "3" "Jul 2022" "Auto generated by spf13/cobra" ""
53

64
.SH NAME
75
.PP
8-
tom\-config \- Output configuration values as YAML or JSON.
6+
tom-config - Output configuration values as YAML or JSON.
97

108

119
.SH SYNOPSIS
@@ -15,38 +13,42 @@ tom\-config \- Output configuration values as YAML or JSON.
1513

1614
.SH DESCRIPTION
1715
.PP
18-
If no arguments are passed, then the complete configuration will be printed. If one or more arguments are passed, then each is printed with its current configuration values. Bash completion will suggest built\-in configuration keys.
16+
If no arguments are passed, then the complete configuration will be printed. If one or more arguments are passed, then each is printed with its current configuration values. Bash completion will suggest built-in configuration keys.
1917

2018

2119
.SH OPTIONS
2220
.PP
23-
\fB\-h\fP, \fB\-\-help\fP[=false]
24-
help for config
21+
\fB-h\fP, \fB--help\fP[=false]
22+
help for config
2523

2624
.PP
27-
\fB\-o\fP, \fB\-\-output\fP="yaml"
28-
Output format. Supported: yaml | json
25+
\fB-o\fP, \fB--output\fP="yaml"
26+
Output format. Supported: yaml | json
2927

3028

3129
.SH OPTIONS INHERITED FROM PARENT COMMANDS
3230
.PP
33-
\fB\-\-backup\-dir\fP=""
34-
backup directory (default is $HOME/.tom/backup)
31+
\fB--backup-dir\fP=""
32+
backup directory (default is $HOME/.tom/backup)
33+
34+
.PP
35+
\fB-c\fP, \fB--config\fP=""
36+
config file (default is $HOME/.tom/tom.yaml)
3537

3638
.PP
37-
\fB\-c\fP, \fB\-\-config\fP=""
38-
config file (default is $HOME/.tom/tom.yaml)
39+
\fB--data-dir\fP=""
40+
data directory (default is $HOME/.tom)
3941

4042
.PP
41-
\fB\-\-data\-dir\fP=""
42-
data directory (default is $HOME/.tom)
43+
\fB--iso-dates\fP[=false]
44+
use ISO date format instead of a locale-specific format (default is false)
4345

4446

4547
.SH SEE ALSO
4648
.PP
47-
\fBtom(3)\fP, \fBtom\-config\-set(3)\fP
49+
\fBtom(3)\fP, \fBtom-config-set(3)\fP
4850

4951

5052
.SH HISTORY
5153
.PP
52-
3\-Feb\-2021 Auto generated by spf13/cobra
54+
19-Jul-2022 Auto generated by spf13/cobra

‎docs/man/tom-create-project.3

+20-18
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
1-
.TH "tom" "3" "Feb 2021" "Auto generated by spf13/cobra" ""
21
.nh
3-
.ad l
4-
2+
.TH "tom" "3" "Jul 2022" "Auto generated by spf13/cobra" ""
53

64
.SH NAME
75
.PP
8-
tom\-create\-project \- Create a new project
6+
tom-create-project - Create a new project
97

108

119
.SH SYNOPSIS
@@ -20,30 +18,34 @@ Create a new project
2018

2119
.SH OPTIONS
2220
.PP
23-
\fB\-h\fP, \fB\-\-help\fP[=false]
24-
help for project
21+
\fB-h\fP, \fB--help\fP[=false]
22+
help for project
2523

2624
.PP
27-
\fB\-o\fP, \fB\-\-output\fP="plain"
28-
Output format. Supported: plain | json. Default: plain
25+
\fB-o\fP, \fB--output\fP="plain"
26+
Output format. Supported: plain | json. Default: plain
2927

3028
.PP
31-
\fB\-p\fP, \fB\-\-parent\fP=""
32-
Optional parent project ID. If defined the new project will be made a child project of this. If defined the name will be used as is for the name of the new project.
29+
\fB-p\fP, \fB--parent\fP=""
30+
Optional parent project ID. If defined the new project will be made a child project of this. If defined the name will be used as is for the name of the new project.
3331

3432

3533
.SH OPTIONS INHERITED FROM PARENT COMMANDS
3634
.PP
37-
\fB\-\-backup\-dir\fP=""
38-
backup directory (default is $HOME/.tom/backup)
35+
\fB--backup-dir\fP=""
36+
backup directory (default is $HOME/.tom/backup)
37+
38+
.PP
39+
\fB-c\fP, \fB--config\fP=""
40+
config file (default is $HOME/.tom/tom.yaml)
3941

4042
.PP
41-
\fB\-c\fP, \fB\-\-config\fP=""
42-
config file (default is $HOME/.tom/tom.yaml)
43+
\fB--data-dir\fP=""
44+
data directory (default is $HOME/.tom)
4345

4446
.PP
45-
\fB\-\-data\-dir\fP=""
46-
data directory (default is $HOME/.tom)
47+
\fB--iso-dates\fP[=false]
48+
use ISO date format instead of a locale-specific format (default is false)
4749

4850

4951
.SH EXAMPLE
@@ -59,9 +61,9 @@ tom create project "Installation" "Deployment" "Support"
5961

6062
.SH SEE ALSO
6163
.PP
62-
\fBtom\-create(3)\fP
64+
\fBtom-create(3)\fP
6365

6466

6567
.SH HISTORY
6668
.PP
67-
3\-Feb\-2021 Auto generated by spf13/cobra
69+
19-Jul-2022 Auto generated by spf13/cobra

‎docs/man/tom-create-tag.3

+16-14
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
1-
.TH "tom" "3" "Feb 2021" "Auto generated by spf13/cobra" ""
21
.nh
3-
.ad l
4-
2+
.TH "tom" "3" "Jul 2022" "Auto generated by spf13/cobra" ""
53

64
.SH NAME
75
.PP
8-
tom\-create\-tag \- create a new tag
6+
tom-create-tag - create a new tag
97

108

119
.SH SYNOPSIS
@@ -20,29 +18,33 @@ create a new tag
2018

2119
.SH OPTIONS
2220
.PP
23-
\fB\-h\fP, \fB\-\-help\fP[=false]
24-
help for tag
21+
\fB-h\fP, \fB--help\fP[=false]
22+
help for tag
2523

2624

2725
.SH OPTIONS INHERITED FROM PARENT COMMANDS
2826
.PP
29-
\fB\-\-backup\-dir\fP=""
30-
backup directory (default is $HOME/.tom/backup)
27+
\fB--backup-dir\fP=""
28+
backup directory (default is $HOME/.tom/backup)
29+
30+
.PP
31+
\fB-c\fP, \fB--config\fP=""
32+
config file (default is $HOME/.tom/tom.yaml)
3133

3234
.PP
33-
\fB\-c\fP, \fB\-\-config\fP=""
34-
config file (default is $HOME/.tom/tom.yaml)
35+
\fB--data-dir\fP=""
36+
data directory (default is $HOME/.tom)
3537

3638
.PP
37-
\fB\-\-data\-dir\fP=""
38-
data directory (default is $HOME/.tom)
39+
\fB--iso-dates\fP[=false]
40+
use ISO date format instead of a locale-specific format (default is false)
3941

4042

4143
.SH SEE ALSO
4244
.PP
43-
\fBtom\-create(3)\fP
45+
\fBtom-create(3)\fP
4446

4547

4648
.SH HISTORY
4749
.PP
48-
3\-Feb\-2021 Auto generated by spf13/cobra
50+
19-Jul-2022 Auto generated by spf13/cobra

‎docs/man/tom-create.3

+16-14
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
1-
.TH "tom" "3" "Feb 2021" "Auto generated by spf13/cobra" ""
21
.nh
3-
.ad l
4-
2+
.TH "tom" "3" "Jul 2022" "Auto generated by spf13/cobra" ""
53

64
.SH NAME
75
.PP
8-
tom\-create \- create new content. See the available sub commands.
6+
tom-create - create new content. See the available sub commands.
97

108

119
.SH SYNOPSIS
@@ -20,29 +18,33 @@ create new content. See the available sub commands.
2018

2119
.SH OPTIONS
2220
.PP
23-
\fB\-h\fP, \fB\-\-help\fP[=false]
24-
help for create
21+
\fB-h\fP, \fB--help\fP[=false]
22+
help for create
2523

2624

2725
.SH OPTIONS INHERITED FROM PARENT COMMANDS
2826
.PP
29-
\fB\-\-backup\-dir\fP=""
30-
backup directory (default is $HOME/.tom/backup)
27+
\fB--backup-dir\fP=""
28+
backup directory (default is $HOME/.tom/backup)
29+
30+
.PP
31+
\fB-c\fP, \fB--config\fP=""
32+
config file (default is $HOME/.tom/tom.yaml)
3133

3234
.PP
33-
\fB\-c\fP, \fB\-\-config\fP=""
34-
config file (default is $HOME/.tom/tom.yaml)
35+
\fB--data-dir\fP=""
36+
data directory (default is $HOME/.tom)
3537

3638
.PP
37-
\fB\-\-data\-dir\fP=""
38-
data directory (default is $HOME/.tom)
39+
\fB--iso-dates\fP[=false]
40+
use ISO date format instead of a locale-specific format (default is false)
3941

4042

4143
.SH SEE ALSO
4244
.PP
43-
\fBtom(3)\fP, \fBtom\-create\-project(3)\fP, \fBtom\-create\-tag(3)\fP
45+
\fBtom(3)\fP, \fBtom-create-project(3)\fP, \fBtom-create-tag(3)\fP
4446

4547

4648
.SH HISTORY
4749
.PP
48-
3\-Feb\-2021 Auto generated by spf13/cobra
50+
19-Jul-2022 Auto generated by spf13/cobra

0 commit comments

Comments
 (0)