This repository has been archived by the owner on Oct 15, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 123
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: add man pages for the record tooling
- Loading branch information
1 parent
b1b37e2
commit d072027
Showing
16 changed files
with
511 additions
and
50 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # kdb-record-clear(1) -- Clear the recording session | ||
|
|
||
| ## SYNOPSIS | ||
|
|
||
| `kdb record-clear`<br> | ||
|
|
||
| ## DESCRIPTION | ||
|
|
||
| This command removes all the recorded changes in the KDB. | ||
| It will NOT undo the changes themselves. | ||
| This command can be executed while recording is active and when it is not active. | ||
|
|
||
| ## OPTIONS | ||
|
|
||
| - `-H`, `--help`: | ||
| Show the man page. | ||
| - `-V`, `--version`: | ||
| Print version info. | ||
| - `-p`, `--profile <profile>`: | ||
| Use a different kdb profile. | ||
| - `-C`, `--color <when>`: | ||
| Print never/auto(default)/always colored output. | ||
| - `-v`, `--verbose`: | ||
| Explain what is happening. Prints additional information in case of errors/warnings. | ||
| - `-d`, `--debug`: | ||
| Give debug information. Prints additional debug information in case of errors/warnings. | ||
|
|
||
| ## SEE ALSO | ||
|
|
||
| - [kdb-record-start(1)](kdb-record-start.md) on how to start the recording session | ||
| - [kdb-record-stop(1)](kdb-record-stop.md) on how to stop the recording session | ||
| - [kdb-record-state(1)](kdb-record-state.md) on how to get information about the current recording session | ||
| - [kdb-record-undo(1)](kdb-record-undo.md) on how to undo changes that have been recorded | ||
| - [kdb-record-rm(1)](kdb-record-rm.md) on how to remove a single key from the recording session |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| # kdb-record-export(1) -- Export recorded changes | ||
|
|
||
| ## SYNOPSIS | ||
|
|
||
| `kdb record-export <format>`<br> | ||
|
|
||
| ## DESCRIPTION | ||
|
|
||
| This command exports the recorded changes into the specified output format. | ||
| The parameter `format` must be a valid storage plugin. | ||
|
|
||
| ## OPTIONS | ||
|
|
||
| - `-H`, `--help`: | ||
| Show the man page. | ||
| - `-V`, `--version`: | ||
| Print version info. | ||
| - `-p`, `--profile <profile>`: | ||
| Use a different kdb profile. | ||
| - `-C`, `--color <when>`: | ||
| Print never/auto(default)/always colored output. | ||
| - `-v`, `--verbose`: | ||
| Explain what is happening. Prints additional information in case of errors/warnings. | ||
| - `-d`, `--debug`: | ||
| Give debug information. Prints additional debug information in case of errors/warnings. | ||
|
|
||
| ## SEE ALSO | ||
|
|
||
| - [kdb-record-start(1)](kdb-record-start.md) on how to start the recording session | ||
| - [kdb-record-stop(1)](kdb-record-stop.md) on how to stop the recording session | ||
| - [kdb-record-state(1)](kdb-record-state.md) on how to get information about the current recording session |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| # kdb-record-rm(1) -- Remove a key from the recording session | ||
|
|
||
| ## SYNOPSIS | ||
|
|
||
| `kdb record-rm <key>`<br> | ||
|
|
||
| ## DESCRIPTION | ||
|
|
||
| This command removes the specified `key` from the recording session. | ||
|
|
||
| ## OPTIONS | ||
|
|
||
| - `-H`, `--help`: | ||
| Show the man page. | ||
| - `-V`, `--version`: | ||
| Print version info. | ||
| - `-p`, `--profile <profile>`: | ||
| Use a different kdb profile. | ||
| - `-C`, `--color <when>`: | ||
| Print never/auto(default)/always colored output. | ||
| - `-v`, `--verbose`: | ||
| Explain what is happening. Prints additional information in case of errors/warnings. | ||
| - `-d`, `--debug`: | ||
| Give debug information. Prints additional debug information in case of errors/warnings. | ||
|
|
||
| ## SEE ALSO | ||
|
|
||
| - [kdb-record-start(1)](kdb-record-start.md) on how to start the recording session | ||
| - [kdb-record-stop(1)](kdb-record-stop.md) on how to stop the recording session | ||
| - [kdb-record-state(1)](kdb-record-state.md) on how to get information about the current recording session | ||
| - [kdb-record-clear(1)](kdb-record-clear.md) on how to remove all keys from the recording session | ||
| - [kdb-record-undo(1)](kdb-record-undo.md) on how to undo changes that have been recorded |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # kdb-record-start(1) -- Start session recording | ||
|
|
||
| ## SYNOPSIS | ||
|
|
||
| `kdb record-start [<parent_key>]`<br> | ||
|
|
||
| ## DESCRIPTION | ||
|
|
||
| This command starts session recording. | ||
| If there is already a previous session, the new changes are appended. | ||
| If you want to make sure you start at a clean state, use `kdb record-clear` first. | ||
| By default, all changes to the KDB are recorded. | ||
| The optional parameter `parent_key` can be used to restrict recording to a specific subtree of the KDB. | ||
|
|
||
| ## OPTIONS | ||
|
|
||
| - `-H`, `--help`: | ||
| Show the man page. | ||
| - `-V`, `--version`: | ||
| Print version info. | ||
| - `-p`, `--profile <profile>`: | ||
| Use a different kdb profile. | ||
| - `-C`, `--color <when>`: | ||
| Print never/auto(default)/always colored output. | ||
| - `-v`, `--verbose`: | ||
| Explain what is happening. Prints additional information in case of errors/warnings. | ||
| - `-d`, `--debug`: | ||
| Give debug information. Prints additional debug information in case of errors/warnings. | ||
|
|
||
| ## SEE ALSO | ||
|
|
||
| - [kdb-record-stop(1)](kdb-record-stop.md) on how to stop the recording session | ||
| - [kdb-record-state(1)](kdb-record-state.md) on how to get information about the current recording session | ||
| - [kdb-record-clear(1)](kdb-record-clear.md) on how to clear the recording session |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| # kdb-record-state(1) -- Print information about the state of a recording session | ||
|
|
||
| ## SYNOPSIS | ||
|
|
||
| `kdb record-state`<br> | ||
|
|
||
| ## DESCRIPTION | ||
|
|
||
| This command prints out information about the current state of the recording session. | ||
| This includes: | ||
|
|
||
| - Whether recording is currently enabled or not | ||
| - What parts of the KDB will be recorded | ||
| - How many keys have been recorded | ||
| - Which keys have been recorded | ||
|
|
||
| ## OPTIONS | ||
|
|
||
| - `-H`, `--help`: | ||
| Show the man page. | ||
| - `-V`, `--version`: | ||
| Print version info. | ||
| - `-p`, `--profile <profile>`: | ||
| Use a different kdb profile. | ||
| - `-C`, `--color <when>`: | ||
| Print never/auto(default)/always colored output. | ||
| - `-v`, `--verbose`: | ||
| Explain what is happening. Prints additional information in case of errors/warnings. | ||
| - `-d`, `--debug`: | ||
| Give debug information. Prints additional debug information in case of errors/warnings. | ||
|
|
||
| ## SEE ALSO | ||
|
|
||
| - [kdb-record-start(1)](kdb-record-start.md) on how to start the recording session | ||
| - [kdb-record-stop(1)](kdb-record-stop.md) on how to stop the recording session |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| # kdb-record-stop(1) -- Stop session recording | ||
|
|
||
| ## SYNOPSIS | ||
|
|
||
| `kdb record-stop`<br> | ||
|
|
||
| ## DESCRIPTION | ||
|
|
||
| This command stops the current recording session. | ||
| Changes that are made to KDB after this command will no longer be recorded. | ||
| The recording session will NOT be cleared. | ||
|
|
||
| ## OPTIONS | ||
|
|
||
| - `-H`, `--help`: | ||
| Show the man page. | ||
| - `-V`, `--version`: | ||
| Print version info. | ||
| - `-p`, `--profile <profile>`: | ||
| Use a different kdb profile. | ||
| - `-C`, `--color <when>`: | ||
| Print never/auto(default)/always colored output. | ||
| - `-v`, `--verbose`: | ||
| Explain what is happening. Prints additional information in case of errors/warnings. | ||
| - `-d`, `--debug`: | ||
| Give debug information. Prints additional debug information in case of errors/warnings. | ||
|
|
||
| ## SEE ALSO | ||
|
|
||
| - [kdb-record-start(1)](kdb-record-start.md) on how to start the recording session | ||
| - [kdb-record-state(1)](kdb-record-state.md) on how to get information about the current recording session | ||
| - [kdb-record-clear(1)](kdb-record-clear.md) on how to clear the recording session |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| # kdb-record-undo(1) -- Undo the changes performed during a recording session | ||
|
|
||
| ## SYNOPSIS | ||
|
|
||
| `kdb record-undo [<parent_key>]`<br> | ||
|
|
||
| ## DESCRIPTION | ||
|
|
||
| This command will undo all the changes that have been recorded. | ||
| The optional parameter `parent_key` can be used to restrict the undo operation to a specific subtree of the KDB. | ||
| After execution, the recording session will no longer contain the undone keys. | ||
|
|
||
| ## OPTIONS | ||
|
|
||
| - `-H`, `--help`: | ||
| Show the man page. | ||
| - `-V`, `--version`: | ||
| Print version info. | ||
| - `-p`, `--profile <profile>`: | ||
| Use a different kdb profile. | ||
| - `-C`, `--color <when>`: | ||
| Print never/auto(default)/always colored output. | ||
| - `-v`, `--verbose`: | ||
| Explain what is happening. Prints additional information in case of errors/warnings. | ||
| - `-d`, `--debug`: | ||
| Give debug information. Prints additional debug information in case of errors/warnings. | ||
|
|
||
| ## SEE ALSO | ||
|
|
||
| - [kdb-record-start(1)](kdb-record-clear.md) on how to start the recording session | ||
| - [kdb-record-state(1)](kdb-record-state.md) on how to get information about the current recording session | ||
| - [kdb-record-stop(1)](kdb-record-stop.md) on how to stop the recording session |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| .\" generated with Ronn-NG/v0.10.1 | ||
| .\" http://github.com/apjanke/ronn-ng/tree/0.10.1.pre3 | ||
| .TH "KDB\-RECORD\-CLEAR" "1" "April 2023" "" | ||
| .SH "NAME" | ||
| \fBkdb\-record\-clear\fR \- Clear the recording session | ||
| .SH "SYNOPSIS" | ||
| \fBkdb record\-clear\fR | ||
| .br | ||
| .SH "DESCRIPTION" | ||
| This command removes all the recorded changes in the KDB\. It will NOT undo the changes themselves\. This command can be executed while recording is active and when it is not active\. | ||
| .SH "OPTIONS" | ||
| .TP | ||
| \fB\-H\fR, \fB\-\-help\fR | ||
| Show the man page\. | ||
| .TP | ||
| \fB\-V\fR, \fB\-\-version\fR | ||
| Print version info\. | ||
| .TP | ||
| \fB\-p\fR, \fB\-\-profile <profile>\fR | ||
| Use a different kdb profile\. | ||
| .TP | ||
| \fB\-C\fR, \fB\-\-color <when>\fR | ||
| Print never/auto(default)/always colored output\. | ||
| .TP | ||
| \fB\-v\fR, \fB\-\-verbose\fR | ||
| Explain what is happening\. Prints additional information in case of errors/warnings\. | ||
| .TP | ||
| \fB\-d\fR, \fB\-\-debug\fR | ||
| Give debug information\. Prints additional debug information in case of errors/warnings\. | ||
| .SH "SEE ALSO" | ||
| .IP "\(bu" 4 | ||
| kdb\-record\-start(1) \fIkdb\-record\-start\.md\fR on how to start the recording session | ||
| .IP "\(bu" 4 | ||
| kdb\-record\-stop(1) \fIkdb\-record\-stop\.md\fR on how to stop the recording session | ||
| .IP "\(bu" 4 | ||
| kdb\-record\-state(1) \fIkdb\-record\-state\.md\fR on how to get information about the current recording session | ||
| .IP "\(bu" 4 | ||
| kdb\-record\-undo(1) \fIkdb\-record\-undo\.md\fR on how to undo changes that have been recorded | ||
| .IP "\(bu" 4 | ||
| kdb\-record\-rm(1) \fIkdb\-record\-rm\.md\fR on how to remove a single key from the recording session | ||
| .IP "" 0 | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| .\" generated with Ronn-NG/v0.10.1 | ||
| .\" http://github.com/apjanke/ronn-ng/tree/0.10.1.pre3 | ||
| .TH "KDB\-RECORD\-EXPORT" "1" "April 2023" "" | ||
| .SH "NAME" | ||
| \fBkdb\-record\-export\fR \- Export recorded changes | ||
| .SH "SYNOPSIS" | ||
| \fBkdb record\-export <format>\fR | ||
| .br | ||
| .SH "DESCRIPTION" | ||
| This command exports the recorded changes into the specified output format\. The parameter \fBformat\fR must be a valid storage plugin\. | ||
| .SH "OPTIONS" | ||
| .TP | ||
| \fB\-H\fR, \fB\-\-help\fR | ||
| Show the man page\. | ||
| .TP | ||
| \fB\-V\fR, \fB\-\-version\fR | ||
| Print version info\. | ||
| .TP | ||
| \fB\-p\fR, \fB\-\-profile <profile>\fR | ||
| Use a different kdb profile\. | ||
| .TP | ||
| \fB\-C\fR, \fB\-\-color <when>\fR | ||
| Print never/auto(default)/always colored output\. | ||
| .TP | ||
| \fB\-v\fR, \fB\-\-verbose\fR | ||
| Explain what is happening\. Prints additional information in case of errors/warnings\. | ||
| .TP | ||
| \fB\-d\fR, \fB\-\-debug\fR | ||
| Give debug information\. Prints additional debug information in case of errors/warnings\. | ||
| .SH "SEE ALSO" | ||
| .IP "\(bu" 4 | ||
| kdb\-record\-start(1) \fIkdb\-record\-start\.md\fR on how to start the recording session | ||
| .IP "\(bu" 4 | ||
| kdb\-record\-stop(1) \fIkdb\-record\-stop\.md\fR on how to stop the recording session | ||
| .IP "\(bu" 4 | ||
| kdb\-record\-state(1) \fIkdb\-record\-state\.md\fR on how to get information about the current recording session | ||
| .IP "" 0 | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| .\" generated with Ronn-NG/v0.10.1 | ||
| .\" http://github.com/apjanke/ronn-ng/tree/0.10.1.pre3 | ||
| .TH "KDB\-RECORD\-RM" "1" "April 2023" "" | ||
| .SH "NAME" | ||
| \fBkdb\-record\-rm\fR \- Remove a key from the recording session | ||
| .SH "SYNOPSIS" | ||
| \fBkdb record\-rm <key>\fR | ||
| .br | ||
| .SH "DESCRIPTION" | ||
| This command removes the specified \fBkey\fR from the recording session\. | ||
| .SH "OPTIONS" | ||
| .TP | ||
| \fB\-H\fR, \fB\-\-help\fR | ||
| Show the man page\. | ||
| .TP | ||
| \fB\-V\fR, \fB\-\-version\fR | ||
| Print version info\. | ||
| .TP | ||
| \fB\-p\fR, \fB\-\-profile <profile>\fR | ||
| Use a different kdb profile\. | ||
| .TP | ||
| \fB\-C\fR, \fB\-\-color <when>\fR | ||
| Print never/auto(default)/always colored output\. | ||
| .TP | ||
| \fB\-v\fR, \fB\-\-verbose\fR | ||
| Explain what is happening\. Prints additional information in case of errors/warnings\. | ||
| .TP | ||
| \fB\-d\fR, \fB\-\-debug\fR | ||
| Give debug information\. Prints additional debug information in case of errors/warnings\. | ||
| .SH "SEE ALSO" | ||
| .IP "\(bu" 4 | ||
| kdb\-record\-start(1) \fIkdb\-record\-start\.md\fR on how to start the recording session | ||
| .IP "\(bu" 4 | ||
| kdb\-record\-stop(1) \fIkdb\-record\-stop\.md\fR on how to stop the recording session | ||
| .IP "\(bu" 4 | ||
| kdb\-record\-state(1) \fIkdb\-record\-state\.md\fR on how to get information about the current recording session | ||
| .IP "\(bu" 4 | ||
| kdb\-record\-clear(1) \fIkdb\-record\-clear\.md\fR on how to remove all keys from the recording session | ||
| .IP "\(bu" 4 | ||
| kdb\-record\-undo(1) \fIkdb\-record\-undo\.md\fR on how to undo changes that have been recorded | ||
| .IP "" 0 | ||
|
|
Oops, something went wrong.