Skip to content

Commit

Permalink
prep: updating documentation for release of v0.12.2
Browse files Browse the repository at this point in the history
  • Loading branch information
jansorg committed Jul 19, 2022
1 parent 7a42799 commit d6a987a
Show file tree
Hide file tree
Showing 56 changed files with 668 additions and 689 deletions.
28 changes: 15 additions & 13 deletions docs/man/tom-cancel.3
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
.TH "tom" "3" "Feb 2021" "Auto generated by spf13/cobra" ""
.nh
.ad l

.TH "tom" "3" "Jul 2022" "Auto generated by spf13/cobra" ""

.SH NAME
.PP
tom\-cancel \- cancel removed the currently running activity. No data will be recorded.
tom-cancel - cancel removed the currently running activity. No data will be recorded.


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

.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
help for cancel
\fB-h\fP, \fB--help\fP[=false]
help for cancel


.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-backup\-dir\fP=""
backup directory (default is $HOME/.tom/backup)
\fB--backup-dir\fP=""
backup directory (default is $HOME/.tom/backup)

.PP
\fB-c\fP, \fB--config\fP=""
config file (default is $HOME/.tom/tom.yaml)

.PP
\fB\-c\fP, \fB\-\-config\fP=""
config file (default is $HOME/.tom/tom.yaml)
\fB--data-dir\fP=""
data directory (default is $HOME/.tom)

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


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

.SH HISTORY
.PP
3\-Feb\-2021 Auto generated by spf13/cobra
19-Jul-2022 Auto generated by spf13/cobra
36 changes: 19 additions & 17 deletions docs/man/tom-config-set.3
Original file line number Diff line number Diff line change
@@ -1,59 +1,61 @@
.TH "tom" "3" "Feb 2021" "Auto generated by spf13/cobra" ""
.nh
.ad l

.TH "tom" "3" "Jul 2022" "Auto generated by spf13/cobra" ""

.SH NAME
.PP
tom\-config\-set \- Sets a configuration value
tom-config-set - Sets a configuration value


.SH SYNOPSIS
.PP
\fBtom config set <key> <value>\fP
\fBtom config set \fP


.SH DESCRIPTION
.PP
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.
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.


.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
help for set
\fB-h\fP, \fB--help\fP[=false]
help for set


.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-backup\-dir\fP=""
backup directory (default is $HOME/.tom/backup)
\fB--backup-dir\fP=""
backup directory (default is $HOME/.tom/backup)

.PP
\fB-c\fP, \fB--config\fP=""
config file (default is $HOME/.tom/tom.yaml)

.PP
\fB\-c\fP, \fB\-\-config\fP=""
config file (default is $HOME/.tom/tom.yaml)
\fB--data-dir\fP=""
data directory (default is $HOME/.tom)

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


.SH EXAMPLE
.PP
.RS

.nf
tom config set data\_dir $HOME/tom\-data
tom config set data_dir $HOME/tom-data

.fi
.RE


.SH SEE ALSO
.PP
\fBtom\-config(3)\fP
\fBtom-config(3)\fP


.SH HISTORY
.PP
3\-Feb\-2021 Auto generated by spf13/cobra
19-Jul-2022 Auto generated by spf13/cobra
36 changes: 19 additions & 17 deletions docs/man/tom-config.3
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
.TH "tom" "3" "Feb 2021" "Auto generated by spf13/cobra" ""
.nh
.ad l

.TH "tom" "3" "Jul 2022" "Auto generated by spf13/cobra" ""

.SH NAME
.PP
tom\-config \- Output configuration values as YAML or JSON.
tom-config - Output configuration values as YAML or JSON.


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

.SH DESCRIPTION
.PP
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.
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.


.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
help for config
\fB-h\fP, \fB--help\fP[=false]
help for config

.PP
\fB\-o\fP, \fB\-\-output\fP="yaml"
Output format. Supported: yaml | json
\fB-o\fP, \fB--output\fP="yaml"
Output format. Supported: yaml | json


.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-backup\-dir\fP=""
backup directory (default is $HOME/.tom/backup)
\fB--backup-dir\fP=""
backup directory (default is $HOME/.tom/backup)

.PP
\fB-c\fP, \fB--config\fP=""
config file (default is $HOME/.tom/tom.yaml)

.PP
\fB\-c\fP, \fB\-\-config\fP=""
config file (default is $HOME/.tom/tom.yaml)
\fB--data-dir\fP=""
data directory (default is $HOME/.tom)

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


.SH SEE ALSO
.PP
\fBtom(3)\fP, \fBtom\-config\-set(3)\fP
\fBtom(3)\fP, \fBtom-config-set(3)\fP


.SH HISTORY
.PP
3\-Feb\-2021 Auto generated by spf13/cobra
19-Jul-2022 Auto generated by spf13/cobra
38 changes: 20 additions & 18 deletions docs/man/tom-create-project.3
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
.TH "tom" "3" "Feb 2021" "Auto generated by spf13/cobra" ""
.nh
.ad l

.TH "tom" "3" "Jul 2022" "Auto generated by spf13/cobra" ""

.SH NAME
.PP
tom\-create\-project \- Create a new project
tom-create-project - Create a new project


.SH SYNOPSIS
Expand All @@ -20,30 +18,34 @@ Create a new project

.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
help for project
\fB-h\fP, \fB--help\fP[=false]
help for project

.PP
\fB\-o\fP, \fB\-\-output\fP="plain"
Output format. Supported: plain | json. Default: plain
\fB-o\fP, \fB--output\fP="plain"
Output format. Supported: plain | json. Default: plain

.PP
\fB\-p\fP, \fB\-\-parent\fP=""
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.
\fB-p\fP, \fB--parent\fP=""
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.


.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-backup\-dir\fP=""
backup directory (default is $HOME/.tom/backup)
\fB--backup-dir\fP=""
backup directory (default is $HOME/.tom/backup)

.PP
\fB-c\fP, \fB--config\fP=""
config file (default is $HOME/.tom/tom.yaml)

.PP
\fB\-c\fP, \fB\-\-config\fP=""
config file (default is $HOME/.tom/tom.yaml)
\fB--data-dir\fP=""
data directory (default is $HOME/.tom)

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


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

.SH SEE ALSO
.PP
\fBtom\-create(3)\fP
\fBtom-create(3)\fP


.SH HISTORY
.PP
3\-Feb\-2021 Auto generated by spf13/cobra
19-Jul-2022 Auto generated by spf13/cobra
30 changes: 16 additions & 14 deletions docs/man/tom-create-tag.3
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
.TH "tom" "3" "Feb 2021" "Auto generated by spf13/cobra" ""
.nh
.ad l

.TH "tom" "3" "Jul 2022" "Auto generated by spf13/cobra" ""

.SH NAME
.PP
tom\-create\-tag \- create a new tag
tom-create-tag - create a new tag


.SH SYNOPSIS
Expand All @@ -20,29 +18,33 @@ create a new tag

.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
help for tag
\fB-h\fP, \fB--help\fP[=false]
help for tag


.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-backup\-dir\fP=""
backup directory (default is $HOME/.tom/backup)
\fB--backup-dir\fP=""
backup directory (default is $HOME/.tom/backup)

.PP
\fB-c\fP, \fB--config\fP=""
config file (default is $HOME/.tom/tom.yaml)

.PP
\fB\-c\fP, \fB\-\-config\fP=""
config file (default is $HOME/.tom/tom.yaml)
\fB--data-dir\fP=""
data directory (default is $HOME/.tom)

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


.SH SEE ALSO
.PP
\fBtom\-create(3)\fP
\fBtom-create(3)\fP


.SH HISTORY
.PP
3\-Feb\-2021 Auto generated by spf13/cobra
19-Jul-2022 Auto generated by spf13/cobra
30 changes: 16 additions & 14 deletions docs/man/tom-create.3
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
.TH "tom" "3" "Feb 2021" "Auto generated by spf13/cobra" ""
.nh
.ad l

.TH "tom" "3" "Jul 2022" "Auto generated by spf13/cobra" ""

.SH NAME
.PP
tom\-create \- create new content. See the available sub commands.
tom-create - create new content. See the available sub commands.


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

.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
help for create
\fB-h\fP, \fB--help\fP[=false]
help for create


.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-backup\-dir\fP=""
backup directory (default is $HOME/.tom/backup)
\fB--backup-dir\fP=""
backup directory (default is $HOME/.tom/backup)

.PP
\fB-c\fP, \fB--config\fP=""
config file (default is $HOME/.tom/tom.yaml)

.PP
\fB\-c\fP, \fB\-\-config\fP=""
config file (default is $HOME/.tom/tom.yaml)
\fB--data-dir\fP=""
data directory (default is $HOME/.tom)

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


.SH SEE ALSO
.PP
\fBtom(3)\fP, \fBtom\-create\-project(3)\fP, \fBtom\-create\-tag(3)\fP
\fBtom(3)\fP, \fBtom-create-project(3)\fP, \fBtom-create-tag(3)\fP


.SH HISTORY
.PP
3\-Feb\-2021 Auto generated by spf13/cobra
19-Jul-2022 Auto generated by spf13/cobra
Loading

0 comments on commit d6a987a

Please sign in to comment.