diff --git a/core/build/build-manpage.sh b/core/build/build-manpage.sh new file mode 100755 index 000000000..5adf74375 --- /dev/null +++ b/core/build/build-manpage.sh @@ -0,0 +1,44 @@ +#!/bin/bash + +cd "$(dirname "${BASH_SOURCE[0]}")" + +source ./builder-alias.sh + +set -ea +shopt -s expand_aliases + +PROFILE=${PROFILE:-debug} +if [ "${PROFILE}" = "release" ]; then + BUILD_FLAGS="--release" +else + if [ "$PROFILE" != "debug" ]; then + >&2 echo "Unknown profile $PROFILE: falling back to debug..." + PROFILE=debug + fi +fi + +if [ -z "$ARCH" ]; then + ARCH=$(uname -m) +fi + +if [ "$ARCH" = "arm64" ]; then + ARCH="aarch64" +fi + +RUST_ARCH="$ARCH" +if [ "$ARCH" = "riscv64" ]; then + RUST_ARCH="riscv64gc" +fi + +cd ../.. +FEATURES="$(echo $ENVIRONMENT | sed 's/-/,/g')" +RUSTFLAGS="" +if [[ "${ENVIRONMENT}" =~ (^|-)console($|-) ]]; then + RUSTFLAGS="--cfg tokio_unstable" +fi +echo "FEATURES=\"$FEATURES\"" +echo "RUSTFLAGS=\"$RUSTFLAGS\"" +rust-zig-builder cargo test --manifest-path=./core/Cargo.toml --lib $BUILD_FLAGS --features test,$FEATURES --locked 'export_manpage_' +if [ "$(ls -nd "core/man" | awk '{ print $3 }')" != "$UID" ]; then + rust-zig-builder sh -c "chown -R $UID:$UID core/target && chown -R $UID:$UID core/man && chown -R $UID:$UID /usr/local/cargo" +fi \ No newline at end of file diff --git a/core/man/start-cli/start-cli-auth-get-pubkey.1 b/core/man/start-cli/start-cli-auth-get-pubkey.1 new file mode 100644 index 000000000..703bb20ac --- /dev/null +++ b/core/man/start-cli/start-cli-auth-get-pubkey.1 @@ -0,0 +1,13 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-auth-get-pubkey 1 "get-pubkey " +.SH NAME +start\-cli\-auth\-get\-pubkey \- Get the public key from the server +.SH SYNOPSIS +\fBstart\-cli auth get\-pubkey\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Get the public key from the server +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-auth-login.1 b/core/man/start-cli/start-cli-auth-login.1 new file mode 100644 index 000000000..127904b72 --- /dev/null +++ b/core/man/start-cli/start-cli-auth-login.1 @@ -0,0 +1,13 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-auth-login 1 "login " +.SH NAME +start\-cli\-auth\-login \- Login to a new auth session +.SH SYNOPSIS +\fBstart\-cli auth login\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Login to a new auth session +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-auth-logout.1 b/core/man/start-cli/start-cli-auth-logout.1 new file mode 100644 index 000000000..905838ecf --- /dev/null +++ b/core/man/start-cli/start-cli-auth-logout.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-auth-logout 1 "logout " +.SH NAME +start\-cli\-auth\-logout \- Logout from current auth session +.SH SYNOPSIS +\fBstart\-cli auth logout\fR [\fB\-h\fR|\fB\-\-help\fR] <\fISESSION\fR> +.SH DESCRIPTION +Logout from current auth session +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fISESSION\fR> + diff --git a/core/man/start-cli/start-cli-auth-reset-password.1 b/core/man/start-cli/start-cli-auth-reset-password.1 new file mode 100644 index 000000000..147ab9ef7 --- /dev/null +++ b/core/man/start-cli/start-cli-auth-reset-password.1 @@ -0,0 +1,13 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-auth-reset-password 1 "reset-password " +.SH NAME +start\-cli\-auth\-reset\-password \- Reset the password +.SH SYNOPSIS +\fBstart\-cli auth reset\-password\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Reset the password +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-auth-session-kill.1 b/core/man/start-cli/start-cli-auth-session-kill.1 new file mode 100644 index 000000000..accdd9055 --- /dev/null +++ b/core/man/start-cli/start-cli-auth-session-kill.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-auth-session-kill 1 "kill " +.SH NAME +start\-cli\-auth\-session\-kill \- Terminate auth sessions +.SH SYNOPSIS +\fBstart\-cli auth session kill\fR [\fB\-h\fR|\fB\-\-help\fR] [\fIIDS\fR] +.SH DESCRIPTION +Terminate auth sessions +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +[\fIIDS\fR] +Session identifiers diff --git a/core/man/start-cli/start-cli-auth-session-list.1 b/core/man/start-cli/start-cli-auth-session-list.1 new file mode 100644 index 000000000..be54a0344 --- /dev/null +++ b/core/man/start-cli/start-cli-auth-session-list.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-auth-session-list 1 "list " +.SH NAME +start\-cli\-auth\-session\-list \- Display all auth sessions +.SH SYNOPSIS +\fBstart\-cli auth session list\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Display all auth sessions +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-auth-session.1 b/core/man/start-cli/start-cli-auth-session.1 new file mode 100644 index 000000000..7ca18ae60 --- /dev/null +++ b/core/man/start-cli/start-cli-auth-session.1 @@ -0,0 +1,20 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-auth-session 1 "session " +.SH NAME +start\-cli\-auth\-session \- List or kill auth sessions +.SH SYNOPSIS +\fBstart\-cli auth session\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +List or kill auth sessions +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-auth\-session\-kill(1) +Terminate auth sessions +.TP +start\-cli\-auth\-session\-list(1) +Display all auth sessions diff --git a/core/man/start-cli/start-cli-auth.1 b/core/man/start-cli/start-cli-auth.1 new file mode 100644 index 000000000..e2283bd00 --- /dev/null +++ b/core/man/start-cli/start-cli-auth.1 @@ -0,0 +1,29 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-auth 1 "auth " +.SH NAME +start\-cli\-auth \- Commands related to Authentication i.e. login, logout +.SH SYNOPSIS +\fBstart\-cli auth\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands related to Authentication i.e. login, logout +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-auth\-get\-pubkey(1) +Get the public key from the server +.TP +start\-cli\-auth\-login(1) +Login to a new auth session +.TP +start\-cli\-auth\-logout(1) +Logout from current auth session +.TP +start\-cli\-auth\-reset\-password(1) +Reset the password +.TP +start\-cli\-auth\-session(1) +List or kill auth sessions diff --git a/core/man/start-cli/start-cli-backup-create.1 b/core/man/start-cli/start-cli-backup-create.1 new file mode 100644 index 000000000..f43e3ce4a --- /dev/null +++ b/core/man/start-cli/start-cli-backup-create.1 @@ -0,0 +1,25 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-backup-create 1 "create " +.SH NAME +start\-cli\-backup\-create \- Create a backup for all packages +.SH SYNOPSIS +\fBstart\-cli backup create\fR [\fB\-\-old\-password\fR] [\fB\-\-package\-ids\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fITARGET_ID\fR> <\fIPASSWORD\fR> +.SH DESCRIPTION +Create a backup for all packages +.SH OPTIONS +.TP +\fB\-\-old\-password\fR \fI\fR +Previous backup password +.TP +\fB\-\-package\-ids\fR \fI\fR +Package IDs to include in backup +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fITARGET_ID\fR> +Backup target identifier +.TP +<\fIPASSWORD\fR> +Password for backup encryption diff --git a/core/man/start-cli/start-cli-backup-target-cifs-add.1 b/core/man/start-cli/start-cli-backup-target-cifs-add.1 new file mode 100644 index 000000000..4e20c033b --- /dev/null +++ b/core/man/start-cli/start-cli-backup-target-cifs-add.1 @@ -0,0 +1,25 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-backup-target-cifs-add 1 "add " +.SH NAME +start\-cli\-backup\-target\-cifs\-add \- Add a new backup target +.SH SYNOPSIS +\fBstart\-cli backup target cifs add\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIHOSTNAME\fR> <\fIPATH\fR> <\fIUSERNAME\fR> [\fIPASSWORD\fR] +.SH DESCRIPTION +Add a new backup target +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIHOSTNAME\fR> +CIFS server hostname +.TP +<\fIPATH\fR> +Path on the CIFS share +.TP +<\fIUSERNAME\fR> +CIFS authentication username +.TP +[\fIPASSWORD\fR] +CIFS authentication password diff --git a/core/man/start-cli/start-cli-backup-target-cifs-remove.1 b/core/man/start-cli/start-cli-backup-target-cifs-remove.1 new file mode 100644 index 000000000..8dab94a3c --- /dev/null +++ b/core/man/start-cli/start-cli-backup-target-cifs-remove.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-backup-target-cifs-remove 1 "remove " +.SH NAME +start\-cli\-backup\-target\-cifs\-remove \- Remove existing backup target +.SH SYNOPSIS +\fBstart\-cli backup target cifs remove\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIID\fR> +.SH DESCRIPTION +Remove existing backup target +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIID\fR> +Backup target identifier diff --git a/core/man/start-cli/start-cli-backup-target-cifs-update.1 b/core/man/start-cli/start-cli-backup-target-cifs-update.1 new file mode 100644 index 000000000..a8721bda5 --- /dev/null +++ b/core/man/start-cli/start-cli-backup-target-cifs-update.1 @@ -0,0 +1,28 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-backup-target-cifs-update 1 "update " +.SH NAME +start\-cli\-backup\-target\-cifs\-update \- Update an existing backup target +.SH SYNOPSIS +\fBstart\-cli backup target cifs update\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIID\fR> <\fIHOSTNAME\fR> <\fIPATH\fR> <\fIUSERNAME\fR> [\fIPASSWORD\fR] +.SH DESCRIPTION +Update an existing backup target +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIID\fR> +Backup target identifier +.TP +<\fIHOSTNAME\fR> +CIFS server hostname +.TP +<\fIPATH\fR> +Path on the CIFS share +.TP +<\fIUSERNAME\fR> +CIFS authentication username +.TP +[\fIPASSWORD\fR] +CIFS authentication password diff --git a/core/man/start-cli/start-cli-backup-target-cifs.1 b/core/man/start-cli/start-cli-backup-target-cifs.1 new file mode 100644 index 000000000..e7afdc199 --- /dev/null +++ b/core/man/start-cli/start-cli-backup-target-cifs.1 @@ -0,0 +1,23 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-backup-target-cifs 1 "cifs " +.SH NAME +start\-cli\-backup\-target\-cifs \- Add, remove, or update a backup target +.SH SYNOPSIS +\fBstart\-cli backup target cifs\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Add, remove, or update a backup target +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-backup\-target\-cifs\-add(1) +Add a new backup target +.TP +start\-cli\-backup\-target\-cifs\-remove(1) +Remove existing backup target +.TP +start\-cli\-backup\-target\-cifs\-update(1) +Update an existing backup target diff --git a/core/man/start-cli/start-cli-backup-target-info.1 b/core/man/start-cli/start-cli-backup-target-info.1 new file mode 100644 index 000000000..c1ff66f11 --- /dev/null +++ b/core/man/start-cli/start-cli-backup-target-info.1 @@ -0,0 +1,25 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-backup-target-info 1 "info " +.SH NAME +start\-cli\-backup\-target\-info \- Display backup information for a package +.SH SYNOPSIS +\fBstart\-cli backup target info\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fITARGET_ID\fR> <\fISERVER_ID\fR> <\fIPASSWORD\fR> +.SH DESCRIPTION +Display backup information for a package +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fITARGET_ID\fR> +Backup target identifier +.TP +<\fISERVER_ID\fR> +Unique server identifier +.TP +<\fIPASSWORD\fR> +Password for backup encryption diff --git a/core/man/start-cli/start-cli-backup-target-list.1 b/core/man/start-cli/start-cli-backup-target-list.1 new file mode 100644 index 000000000..49886b84d --- /dev/null +++ b/core/man/start-cli/start-cli-backup-target-list.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-backup-target-list 1 "list " +.SH NAME +start\-cli\-backup\-target\-list \- List existing backup targets +.SH SYNOPSIS +\fBstart\-cli backup target list\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +List existing backup targets +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-backup-target-mount.1 b/core/man/start-cli/start-cli-backup-target-mount.1 new file mode 100644 index 000000000..caf558310 --- /dev/null +++ b/core/man/start-cli/start-cli-backup-target-mount.1 @@ -0,0 +1,25 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-backup-target-mount 1 "mount " +.SH NAME +start\-cli\-backup\-target\-mount \- Mount a backup target +.SH SYNOPSIS +\fBstart\-cli backup target mount\fR [\fB\-\-server\-id\fR] [\fB\-\-allow\-partial\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fITARGET_ID\fR> <\fIPASSWORD\fR> +.SH DESCRIPTION +Mount a backup target +.SH OPTIONS +.TP +\fB\-\-server\-id\fR \fI\fR +Unique server identifier +.TP +\fB\-\-allow\-partial\fR +Leave media mounted even if backupfs fails to mount +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fITARGET_ID\fR> +Backup target identifier +.TP +<\fIPASSWORD\fR> +Password for backup encryption diff --git a/core/man/start-cli/start-cli-backup-target-umount.1 b/core/man/start-cli/start-cli-backup-target-umount.1 new file mode 100644 index 000000000..5b8bb75ef --- /dev/null +++ b/core/man/start-cli/start-cli-backup-target-umount.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-backup-target-umount 1 "umount " +.SH NAME +start\-cli\-backup\-target\-umount \- Unmount a backup target +.SH SYNOPSIS +\fBstart\-cli backup target umount\fR [\fB\-h\fR|\fB\-\-help\fR] [\fITARGET_ID\fR] +.SH DESCRIPTION +Unmount a backup target +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +[\fITARGET_ID\fR] +Backup target identifier diff --git a/core/man/start-cli/start-cli-backup-target.1 b/core/man/start-cli/start-cli-backup-target.1 new file mode 100644 index 000000000..82d1de933 --- /dev/null +++ b/core/man/start-cli/start-cli-backup-target.1 @@ -0,0 +1,29 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-backup-target 1 "target " +.SH NAME +start\-cli\-backup\-target \- Commands related to a backup target +.SH SYNOPSIS +\fBstart\-cli backup target\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands related to a backup target +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-backup\-target\-cifs(1) +Add, remove, or update a backup target +.TP +start\-cli\-backup\-target\-info(1) +Display backup information for a package +.TP +start\-cli\-backup\-target\-list(1) +List existing backup targets +.TP +start\-cli\-backup\-target\-mount(1) +Mount a backup target +.TP +start\-cli\-backup\-target\-umount(1) +Unmount a backup target diff --git a/core/man/start-cli/start-cli-backup.1 b/core/man/start-cli/start-cli-backup.1 new file mode 100644 index 000000000..5e60d0432 --- /dev/null +++ b/core/man/start-cli/start-cli-backup.1 @@ -0,0 +1,20 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-backup 1 "backup " +.SH NAME +start\-cli\-backup \- Commands related to backup creation and backup targets +.SH SYNOPSIS +\fBstart\-cli backup\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands related to backup creation and backup targets +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-backup\-create(1) +Create a backup for all packages +.TP +start\-cli\-backup\-target(1) +Commands related to a backup target diff --git a/core/man/start-cli/start-cli-db-apply.1 b/core/man/start-cli/start-cli-db-apply.1 new file mode 100644 index 000000000..f88966143 --- /dev/null +++ b/core/man/start-cli/start-cli-db-apply.1 @@ -0,0 +1,22 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-db-apply 1 "apply " +.SH NAME +start\-cli\-db\-apply \- Update a database record +.SH SYNOPSIS +\fBstart\-cli db apply\fR [\fB\-\-allow\-model\-mismatch\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIEXPR\fR> [\fIPATH\fR] +.SH DESCRIPTION +Update a database record +.SH OPTIONS +.TP +\fB\-\-allow\-model\-mismatch\fR +Allow database model mismatch +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIEXPR\fR> +Database patch expression to apply +.TP +[\fIPATH\fR] +Path to the database diff --git a/core/man/start-cli/start-cli-db-dump.1 b/core/man/start-cli/start-cli-db-dump.1 new file mode 100644 index 000000000..d8c55918d --- /dev/null +++ b/core/man/start-cli/start-cli-db-dump.1 @@ -0,0 +1,22 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-db-dump 1 "dump " +.SH NAME +start\-cli\-db\-dump \- Filter and query the database +.SH SYNOPSIS +\fBstart\-cli db dump\fR [\fB\-p\fR|\fB\-\-include\-private\fR] [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fIPATH\fR] +.SH DESCRIPTION +Filter and query the database +.SH OPTIONS +.TP +\fB\-p\fR, \fB\-\-include\-private\fR +Include private data in output +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +[\fIPATH\fR] +Path to the database diff --git a/core/man/start-cli/start-cli-db-put-ui.1 b/core/man/start-cli/start-cli-db-put-ui.1 new file mode 100644 index 000000000..5b3587f17 --- /dev/null +++ b/core/man/start-cli/start-cli-db-put-ui.1 @@ -0,0 +1,22 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-db-put-ui 1 "ui " +.SH NAME +start\-cli\-db\-put\-ui \- Add path and value to db +.SH SYNOPSIS +\fBstart\-cli db put ui\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIPOINTER\fR> <\fIVALUE\fR> +.SH DESCRIPTION +Add path and value to db +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIPOINTER\fR> +JSON pointer to specific value +.TP +<\fIVALUE\fR> +JSON value to set diff --git a/core/man/start-cli/start-cli-db-put.1 b/core/man/start-cli/start-cli-db-put.1 new file mode 100644 index 000000000..a087f07aa --- /dev/null +++ b/core/man/start-cli/start-cli-db-put.1 @@ -0,0 +1,17 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-db-put 1 "put " +.SH NAME +start\-cli\-db\-put \- Command for adding UI record to db +.SH SYNOPSIS +\fBstart\-cli db put\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Command for adding UI record to db +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-db\-put\-ui(1) +Add path and value to db diff --git a/core/man/start-cli/start-cli-db.1 b/core/man/start-cli/start-cli-db.1 new file mode 100644 index 000000000..cace8f21c --- /dev/null +++ b/core/man/start-cli/start-cli-db.1 @@ -0,0 +1,23 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-db 1 "db " +.SH NAME +start\-cli\-db \- Commands to interact with the db i.e. dump, put, apply +.SH SYNOPSIS +\fBstart\-cli db\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands to interact with the db i.e. dump, put, apply +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-db\-apply(1) +Update a database record +.TP +start\-cli\-db\-dump(1) +Filter and query the database +.TP +start\-cli\-db\-put(1) +Command for adding UI record to db diff --git a/core/man/start-cli/start-cli-diagnostic-disk-forget.1 b/core/man/start-cli/start-cli-diagnostic-disk-forget.1 new file mode 100644 index 000000000..71f864d8e --- /dev/null +++ b/core/man/start-cli/start-cli-diagnostic-disk-forget.1 @@ -0,0 +1,13 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-diagnostic-disk-forget 1 "forget " +.SH NAME +start\-cli\-diagnostic\-disk\-forget \- Remove disk filesystem +.SH SYNOPSIS +\fBstart\-cli diagnostic disk forget\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Remove disk filesystem +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-diagnostic-disk-repair.1 b/core/man/start-cli/start-cli-diagnostic-disk-repair.1 new file mode 100644 index 000000000..d2ef7c301 --- /dev/null +++ b/core/man/start-cli/start-cli-diagnostic-disk-repair.1 @@ -0,0 +1,13 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-diagnostic-disk-repair 1 "repair " +.SH NAME +start\-cli\-diagnostic\-disk\-repair \- Repair disk corruption +.SH SYNOPSIS +\fBstart\-cli diagnostic disk repair\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Repair disk corruption +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-diagnostic-disk.1 b/core/man/start-cli/start-cli-diagnostic-disk.1 new file mode 100644 index 000000000..e92a503f6 --- /dev/null +++ b/core/man/start-cli/start-cli-diagnostic-disk.1 @@ -0,0 +1,20 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-diagnostic-disk 1 "disk " +.SH NAME +start\-cli\-diagnostic\-disk \- Command to remove disk from filesystem +.SH SYNOPSIS +\fBstart\-cli diagnostic disk\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Command to remove disk from filesystem +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-diagnostic\-disk\-forget(1) +Remove disk filesystem +.TP +start\-cli\-diagnostic\-disk\-repair(1) +Repair disk corruption diff --git a/core/man/start-cli/start-cli-diagnostic-error.1 b/core/man/start-cli/start-cli-diagnostic-error.1 new file mode 100644 index 000000000..8435f72fd --- /dev/null +++ b/core/man/start-cli/start-cli-diagnostic-error.1 @@ -0,0 +1,13 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-diagnostic-error 1 "error " +.SH NAME +start\-cli\-diagnostic\-error \- Display diagnostic error +.SH SYNOPSIS +\fBstart\-cli diagnostic error\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Display diagnostic error +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-diagnostic-kernel-logs.1 b/core/man/start-cli/start-cli-diagnostic-kernel-logs.1 new file mode 100644 index 000000000..0d1502109 --- /dev/null +++ b/core/man/start-cli/start-cli-diagnostic-kernel-logs.1 @@ -0,0 +1,28 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-diagnostic-kernel-logs 1 "kernel-logs " +.SH NAME +start\-cli\-diagnostic\-kernel\-logs \- Display kernel logs +.SH SYNOPSIS +\fBstart\-cli diagnostic kernel\-logs\fR [\fB\-l\fR|\fB\-\-limit\fR] [\fB\-c\fR|\fB\-\-cursor\fR] [\fB\-b\fR|\fB\-\-boot\fR] [\fB\-B\fR|\fB\-\-before\fR] [\fB\-f\fR|\fB\-\-follow\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Display kernel logs +.SH OPTIONS +.TP +\fB\-l\fR, \fB\-\-limit\fR \fI\fR +Maximum number of log entries +.TP +\fB\-c\fR, \fB\-\-cursor\fR \fI\fR +Start from this cursor position +.TP +\fB\-b\fR, \fB\-\-boot\fR \fI\fR +Filter logs by boot ID +.TP +\fB\-B\fR, \fB\-\-before\fR +Show logs before the cursor position +.TP +\fB\-f\fR, \fB\-\-follow\fR +Follow log output in real\-time +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-diagnostic-logs.1 b/core/man/start-cli/start-cli-diagnostic-logs.1 new file mode 100644 index 000000000..dc3aeb4b8 --- /dev/null +++ b/core/man/start-cli/start-cli-diagnostic-logs.1 @@ -0,0 +1,28 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-diagnostic-logs 1 "logs " +.SH NAME +start\-cli\-diagnostic\-logs \- Display OS logs +.SH SYNOPSIS +\fBstart\-cli diagnostic logs\fR [\fB\-l\fR|\fB\-\-limit\fR] [\fB\-c\fR|\fB\-\-cursor\fR] [\fB\-b\fR|\fB\-\-boot\fR] [\fB\-B\fR|\fB\-\-before\fR] [\fB\-f\fR|\fB\-\-follow\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Display OS logs +.SH OPTIONS +.TP +\fB\-l\fR, \fB\-\-limit\fR \fI\fR +Maximum number of log entries +.TP +\fB\-c\fR, \fB\-\-cursor\fR \fI\fR +Start from this cursor position +.TP +\fB\-b\fR, \fB\-\-boot\fR \fI\fR +Filter logs by boot ID +.TP +\fB\-B\fR, \fB\-\-before\fR +Show logs before the cursor position +.TP +\fB\-f\fR, \fB\-\-follow\fR +Follow log output in real\-time +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-diagnostic-rebuild.1 b/core/man/start-cli/start-cli-diagnostic-rebuild.1 new file mode 100644 index 000000000..7397e3844 --- /dev/null +++ b/core/man/start-cli/start-cli-diagnostic-rebuild.1 @@ -0,0 +1,13 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-diagnostic-rebuild 1 "rebuild " +.SH NAME +start\-cli\-diagnostic\-rebuild \- Teardown and rebuild containers +.SH SYNOPSIS +\fBstart\-cli diagnostic rebuild\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Teardown and rebuild containers +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-diagnostic-restart.1 b/core/man/start-cli/start-cli-diagnostic-restart.1 new file mode 100644 index 000000000..f8677c9c1 --- /dev/null +++ b/core/man/start-cli/start-cli-diagnostic-restart.1 @@ -0,0 +1,13 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-diagnostic-restart 1 "restart " +.SH NAME +start\-cli\-diagnostic\-restart \- Restart the server +.SH SYNOPSIS +\fBstart\-cli diagnostic restart\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Restart the server +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-diagnostic.1 b/core/man/start-cli/start-cli-diagnostic.1 new file mode 100644 index 000000000..d8b4003f7 --- /dev/null +++ b/core/man/start-cli/start-cli-diagnostic.1 @@ -0,0 +1,32 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-diagnostic 1 "diagnostic " +.SH NAME +start\-cli\-diagnostic \- Commands to display logs, restart the server, etc +.SH SYNOPSIS +\fBstart\-cli diagnostic\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands to display logs, restart the server, etc +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-diagnostic\-disk(1) +Command to remove disk from filesystem +.TP +start\-cli\-diagnostic\-error(1) +Display diagnostic error +.TP +start\-cli\-diagnostic\-kernel\-logs(1) +Display kernel logs +.TP +start\-cli\-diagnostic\-logs(1) +Display OS logs +.TP +start\-cli\-diagnostic\-rebuild(1) +Teardown and rebuild containers +.TP +start\-cli\-diagnostic\-restart(1) +Restart the server diff --git a/core/man/start-cli/start-cli-disk-list.1 b/core/man/start-cli/start-cli-disk-list.1 new file mode 100644 index 000000000..497fc21d2 --- /dev/null +++ b/core/man/start-cli/start-cli-disk-list.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-disk-list 1 "list " +.SH NAME +start\-cli\-disk\-list \- List disk information +.SH SYNOPSIS +\fBstart\-cli disk list\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +List disk information +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-disk-repair.1 b/core/man/start-cli/start-cli-disk-repair.1 new file mode 100644 index 000000000..3de37a206 --- /dev/null +++ b/core/man/start-cli/start-cli-disk-repair.1 @@ -0,0 +1,13 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-disk-repair 1 "repair " +.SH NAME +start\-cli\-disk\-repair \- Repair disk corruption +.SH SYNOPSIS +\fBstart\-cli disk repair\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Repair disk corruption +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-disk.1 b/core/man/start-cli/start-cli-disk.1 new file mode 100644 index 000000000..772eded99 --- /dev/null +++ b/core/man/start-cli/start-cli-disk.1 @@ -0,0 +1,20 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-disk 1 "disk " +.SH NAME +start\-cli\-disk \- Commands for listing disk info and repairing +.SH SYNOPSIS +\fBstart\-cli disk\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands for listing disk info and repairing +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-disk\-list(1) +List disk information +.TP +start\-cli\-disk\-repair(1) +Repair disk corruption diff --git a/core/man/start-cli/start-cli-echo.1 b/core/man/start-cli/start-cli-echo.1 new file mode 100644 index 000000000..2a2849597 --- /dev/null +++ b/core/man/start-cli/start-cli-echo.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-echo 1 "echo " +.SH NAME +start\-cli\-echo \- Echo a message back +.SH SYNOPSIS +\fBstart\-cli echo\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIMESSAGE\fR> +.SH DESCRIPTION +Echo a message back +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIMESSAGE\fR> +Message to echo back diff --git a/core/man/start-cli/start-cli-flash-os.1 b/core/man/start-cli/start-cli-flash-os.1 new file mode 100644 index 000000000..35c1c9f20 --- /dev/null +++ b/core/man/start-cli/start-cli-flash-os.1 @@ -0,0 +1,32 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-flash-os 1 "flash-os " +.SH NAME +start\-cli\-flash\-os \- Flash StartOS to a drive +.SH SYNOPSIS +\fBstart\-cli flash\-os\fR [\fB\-\-efi\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fISQUASHFS\fR> <\fIDISK\fR> +.SH DESCRIPTION +Flash StartOS to a drive +.SH OPTIONS +.TP +\fB\-\-efi\fR \fI\fR +Use EFI boot mode +.br + +.br +\fIPossible values:\fR +.RS 14 +.IP \(bu 2 +true +.IP \(bu 2 +false +.RE +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fISQUASHFS\fR> +Path to squashfs image file +.TP +<\fIDISK\fR> +Target disk for installation diff --git a/core/man/start-cli/start-cli-git-info.1 b/core/man/start-cli/start-cli-git-info.1 new file mode 100644 index 000000000..aabf46dae --- /dev/null +++ b/core/man/start-cli/start-cli-git-info.1 @@ -0,0 +1,13 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-git-info 1 "git-info " +.SH NAME +start\-cli\-git\-info \- Display the git hash of this build +.SH SYNOPSIS +\fBstart\-cli git\-info\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Display the git hash of this build +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-init-kernel-logs.1 b/core/man/start-cli/start-cli-init-kernel-logs.1 new file mode 100644 index 000000000..475f95470 --- /dev/null +++ b/core/man/start-cli/start-cli-init-kernel-logs.1 @@ -0,0 +1,28 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-init-kernel-logs 1 "kernel-logs " +.SH NAME +start\-cli\-init\-kernel\-logs \- Display kernel logs +.SH SYNOPSIS +\fBstart\-cli init kernel\-logs\fR [\fB\-l\fR|\fB\-\-limit\fR] [\fB\-c\fR|\fB\-\-cursor\fR] [\fB\-b\fR|\fB\-\-boot\fR] [\fB\-B\fR|\fB\-\-before\fR] [\fB\-f\fR|\fB\-\-follow\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Display kernel logs +.SH OPTIONS +.TP +\fB\-l\fR, \fB\-\-limit\fR \fI\fR +Maximum number of log entries +.TP +\fB\-c\fR, \fB\-\-cursor\fR \fI\fR +Start from this cursor position +.TP +\fB\-b\fR, \fB\-\-boot\fR \fI\fR +Filter logs by boot ID +.TP +\fB\-B\fR, \fB\-\-before\fR +Show logs before the cursor position +.TP +\fB\-f\fR, \fB\-\-follow\fR +Follow log output in real\-time +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-init-key.1 b/core/man/start-cli/start-cli-init-key.1 new file mode 100644 index 000000000..62e21e874 --- /dev/null +++ b/core/man/start-cli/start-cli-init-key.1 @@ -0,0 +1,13 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-init-key 1 "init-key " +.SH NAME +start\-cli\-init\-key \- Create a new developer key +.SH SYNOPSIS +\fBstart\-cli init\-key\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Create a new developer key +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-init-logs.1 b/core/man/start-cli/start-cli-init-logs.1 new file mode 100644 index 000000000..9e778406b --- /dev/null +++ b/core/man/start-cli/start-cli-init-logs.1 @@ -0,0 +1,28 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-init-logs 1 "logs " +.SH NAME +start\-cli\-init\-logs \- Display OS logs +.SH SYNOPSIS +\fBstart\-cli init logs\fR [\fB\-l\fR|\fB\-\-limit\fR] [\fB\-c\fR|\fB\-\-cursor\fR] [\fB\-b\fR|\fB\-\-boot\fR] [\fB\-B\fR|\fB\-\-before\fR] [\fB\-f\fR|\fB\-\-follow\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Display OS logs +.SH OPTIONS +.TP +\fB\-l\fR, \fB\-\-limit\fR \fI\fR +Maximum number of log entries +.TP +\fB\-c\fR, \fB\-\-cursor\fR \fI\fR +Start from this cursor position +.TP +\fB\-b\fR, \fB\-\-boot\fR \fI\fR +Filter logs by boot ID +.TP +\fB\-B\fR, \fB\-\-before\fR +Show logs before the cursor position +.TP +\fB\-f\fR, \fB\-\-follow\fR +Follow log output in real\-time +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-init-subscribe.1 b/core/man/start-cli/start-cli-init-subscribe.1 new file mode 100644 index 000000000..375e13c76 --- /dev/null +++ b/core/man/start-cli/start-cli-init-subscribe.1 @@ -0,0 +1,13 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-init-subscribe 1 "subscribe " +.SH NAME +start\-cli\-init\-subscribe \- Get initialization progress +.SH SYNOPSIS +\fBstart\-cli init subscribe\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Get initialization progress +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-init.1 b/core/man/start-cli/start-cli-init.1 new file mode 100644 index 000000000..9b05b8f2f --- /dev/null +++ b/core/man/start-cli/start-cli-init.1 @@ -0,0 +1,23 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-init 1 "init " +.SH NAME +start\-cli\-init \- Commands for initialization +.SH SYNOPSIS +\fBstart\-cli init\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands for initialization +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-init\-kernel\-logs(1) +Display kernel logs +.TP +start\-cli\-init\-logs(1) +Display OS logs +.TP +start\-cli\-init\-subscribe(1) +Get initialization progress diff --git a/core/man/start-cli/start-cli-kiosk-disable.1 b/core/man/start-cli/start-cli-kiosk-disable.1 new file mode 100644 index 000000000..9d58d9523 --- /dev/null +++ b/core/man/start-cli/start-cli-kiosk-disable.1 @@ -0,0 +1,13 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-kiosk-disable 1 "disable " +.SH NAME +start\-cli\-kiosk\-disable \- Disable kiosk mode +.SH SYNOPSIS +\fBstart\-cli kiosk disable\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Disable kiosk mode +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-kiosk-enable.1 b/core/man/start-cli/start-cli-kiosk-enable.1 new file mode 100644 index 000000000..4a49e0d15 --- /dev/null +++ b/core/man/start-cli/start-cli-kiosk-enable.1 @@ -0,0 +1,13 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-kiosk-enable 1 "enable " +.SH NAME +start\-cli\-kiosk\-enable \- Enable kiosk mode +.SH SYNOPSIS +\fBstart\-cli kiosk enable\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Enable kiosk mode +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-kiosk.1 b/core/man/start-cli/start-cli-kiosk.1 new file mode 100644 index 000000000..82fd3ac7c --- /dev/null +++ b/core/man/start-cli/start-cli-kiosk.1 @@ -0,0 +1,20 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-kiosk 1 "kiosk " +.SH NAME +start\-cli\-kiosk \- Commands for kiosk mode +.SH SYNOPSIS +\fBstart\-cli kiosk\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands for kiosk mode +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-kiosk\-disable(1) +Disable kiosk mode +.TP +start\-cli\-kiosk\-enable(1) +Enable kiosk mode diff --git a/core/man/start-cli/start-cli-net-acme-init.1 b/core/man/start-cli/start-cli-net-acme-init.1 new file mode 100644 index 000000000..44963263d --- /dev/null +++ b/core/man/start-cli/start-cli-net-acme-init.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-net-acme-init 1 "init " +.SH NAME +start\-cli\-net\-acme\-init \- Setup ACME certificate acquisition +.SH SYNOPSIS +\fBstart\-cli net acme init\fR <\fB\-\-provider\fR> [\fB\-\-contact\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Setup ACME certificate acquisition +.SH OPTIONS +.TP +\fB\-\-provider\fR \fI\fR +ACME provider identifier or url +.TP +\fB\-\-contact\fR \fI\fR +Contact email for ACME certificate authority +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-net-acme-remove.1 b/core/man/start-cli/start-cli-net-acme-remove.1 new file mode 100644 index 000000000..0dcfca138 --- /dev/null +++ b/core/man/start-cli/start-cli-net-acme-remove.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-net-acme-remove 1 "remove " +.SH NAME +start\-cli\-net\-acme\-remove \- Remove ACME certificate acquisition configuration +.SH SYNOPSIS +\fBstart\-cli net acme remove\fR <\fB\-\-provider\fR> [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Remove ACME certificate acquisition configuration +.SH OPTIONS +.TP +\fB\-\-provider\fR \fI\fR +ACME provider identifier or url +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-net-acme.1 b/core/man/start-cli/start-cli-net-acme.1 new file mode 100644 index 000000000..f1a95d1cb --- /dev/null +++ b/core/man/start-cli/start-cli-net-acme.1 @@ -0,0 +1,20 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-net-acme 1 "acme " +.SH NAME +start\-cli\-net\-acme \- Setup ACME certificate +.SH SYNOPSIS +\fBstart\-cli net acme\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Setup ACME certificate +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-net\-acme\-init(1) +Setup ACME certificate acquisition +.TP +start\-cli\-net\-acme\-remove(1) +Remove ACME certificate acquisition configuration diff --git a/core/man/start-cli/start-cli-net-dns-dump-table.1 b/core/man/start-cli/start-cli-net-dns-dump-table.1 new file mode 100644 index 000000000..94b524131 --- /dev/null +++ b/core/man/start-cli/start-cli-net-dns-dump-table.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-net-dns-dump-table 1 "dump-table " +.SH NAME +start\-cli\-net\-dns\-dump\-table \- Dump address resolution table +.SH SYNOPSIS +\fBstart\-cli net dns dump\-table\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Dump address resolution table +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-net-dns-query.1 b/core/man/start-cli/start-cli-net-dns-query.1 new file mode 100644 index 000000000..410cc5330 --- /dev/null +++ b/core/man/start-cli/start-cli-net-dns-query.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-net-dns-query 1 "query " +.SH NAME +start\-cli\-net\-dns\-query \- Test DNS configuration for a domain +.SH SYNOPSIS +\fBstart\-cli net dns query\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIFQDN\fR> +.SH DESCRIPTION +Test DNS configuration for a domain +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIFQDN\fR> +Fully qualified domain name diff --git a/core/man/start-cli/start-cli-net-dns-set-static.1 b/core/man/start-cli/start-cli-net-dns-set-static.1 new file mode 100644 index 000000000..766e921a8 --- /dev/null +++ b/core/man/start-cli/start-cli-net-dns-set-static.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-net-dns-set-static 1 "set-static " +.SH NAME +start\-cli\-net\-dns\-set\-static \- Set static DNS servers +.SH SYNOPSIS +\fBstart\-cli net dns set\-static\fR [\fB\-h\fR|\fB\-\-help\fR] [\fISERVERS\fR] +.SH DESCRIPTION +Set static DNS servers +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +[\fISERVERS\fR] +DNS servers to use diff --git a/core/man/start-cli/start-cli-net-dns.1 b/core/man/start-cli/start-cli-net-dns.1 new file mode 100644 index 000000000..c3c545460 --- /dev/null +++ b/core/man/start-cli/start-cli-net-dns.1 @@ -0,0 +1,23 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-net-dns 1 "dns " +.SH NAME +start\-cli\-net\-dns \- Manage and query DNS +.SH SYNOPSIS +\fBstart\-cli net dns\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Manage and query DNS +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-net\-dns\-dump\-table(1) +Dump address resolution table +.TP +start\-cli\-net\-dns\-query(1) +Test DNS configuration for a domain +.TP +start\-cli\-net\-dns\-set\-static(1) +Set static DNS servers diff --git a/core/man/start-cli/start-cli-net-forward-dump-table.1 b/core/man/start-cli/start-cli-net-forward-dump-table.1 new file mode 100644 index 000000000..79e4e01e5 --- /dev/null +++ b/core/man/start-cli/start-cli-net-forward-dump-table.1 @@ -0,0 +1,15 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-net-forward-dump-table 1 "dump-table " +.SH NAME +start\-cli\-net\-forward\-dump\-table +.SH SYNOPSIS +\fBstart\-cli net forward dump\-table\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-net-forward.1 b/core/man/start-cli/start-cli-net-forward.1 new file mode 100644 index 000000000..6e2108602 --- /dev/null +++ b/core/man/start-cli/start-cli-net-forward.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-net-forward 1 "forward " +.SH NAME +start\-cli\-net\-forward \- Manage port forwards +.SH SYNOPSIS +\fBstart\-cli net forward\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Manage port forwards +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-net\-forward\-dump\-table(1) diff --git a/core/man/start-cli/start-cli-net-gateway-check-dns.1 b/core/man/start-cli/start-cli-net-gateway-check-dns.1 new file mode 100644 index 000000000..6eab6c125 --- /dev/null +++ b/core/man/start-cli/start-cli-net-gateway-check-dns.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-net-gateway-check-dns 1 "check-dns " +.SH NAME +start\-cli\-net\-gateway\-check\-dns \- Check DNS configuration for a gateway +.SH SYNOPSIS +\fBstart\-cli net gateway check\-dns\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIGATEWAY\fR> +.SH DESCRIPTION +Check DNS configuration for a gateway +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIGATEWAY\fR> +Gateway identifier diff --git a/core/man/start-cli/start-cli-net-gateway-check-port.1 b/core/man/start-cli/start-cli-net-gateway-check-port.1 new file mode 100644 index 000000000..4ee5d6665 --- /dev/null +++ b/core/man/start-cli/start-cli-net-gateway-check-port.1 @@ -0,0 +1,22 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-net-gateway-check-port 1 "check-port " +.SH NAME +start\-cli\-net\-gateway\-check\-port \- about.check\-port\-reachability +.SH SYNOPSIS +\fBstart\-cli net gateway check\-port\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIPORT\fR> <\fIGATEWAY\fR> +.SH DESCRIPTION +about.check\-port\-reachability +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIPORT\fR> +help.arg.port +.TP +<\fIGATEWAY\fR> +Gateway identifier diff --git a/core/man/start-cli/start-cli-net-gateway-forget.1 b/core/man/start-cli/start-cli-net-gateway-forget.1 new file mode 100644 index 000000000..9896062f8 --- /dev/null +++ b/core/man/start-cli/start-cli-net-gateway-forget.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-net-gateway-forget 1 "forget " +.SH NAME +start\-cli\-net\-gateway\-forget \- Forget a disconnected gateway +.SH SYNOPSIS +\fBstart\-cli net gateway forget\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIGATEWAY\fR> +.SH DESCRIPTION +Forget a disconnected gateway +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIGATEWAY\fR> +Gateway identifier diff --git a/core/man/start-cli/start-cli-net-gateway-list.1 b/core/man/start-cli/start-cli-net-gateway-list.1 new file mode 100644 index 000000000..416ec3365 --- /dev/null +++ b/core/man/start-cli/start-cli-net-gateway-list.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-net-gateway-list 1 "list " +.SH NAME +start\-cli\-net\-gateway\-list \- Show gateways StartOS can listen on +.SH SYNOPSIS +\fBstart\-cli net gateway list\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Show gateways StartOS can listen on +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-net-gateway-set-default-outbound.1 b/core/man/start-cli/start-cli-net-gateway-set-default-outbound.1 new file mode 100644 index 000000000..76ee6c7ce --- /dev/null +++ b/core/man/start-cli/start-cli-net-gateway-set-default-outbound.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-net-gateway-set-default-outbound 1 "set-default-outbound " +.SH NAME +start\-cli\-net\-gateway\-set\-default\-outbound \- about.set\-default\-outbound\-gateway +.SH SYNOPSIS +\fBstart\-cli net gateway set\-default\-outbound\fR [\fB\-h\fR|\fB\-\-help\fR] [\fIGATEWAY\fR] +.SH DESCRIPTION +about.set\-default\-outbound\-gateway +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +[\fIGATEWAY\fR] +Gateway identifier diff --git a/core/man/start-cli/start-cli-net-gateway-set-name.1 b/core/man/start-cli/start-cli-net-gateway-set-name.1 new file mode 100644 index 000000000..b8ab927e2 --- /dev/null +++ b/core/man/start-cli/start-cli-net-gateway-set-name.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-net-gateway-set-name 1 "set-name " +.SH NAME +start\-cli\-net\-gateway\-set\-name \- Rename a gateway +.SH SYNOPSIS +\fBstart\-cli net gateway set\-name\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIID\fR> <\fINAME\fR> +.SH DESCRIPTION +Rename a gateway +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIID\fR> +Gateway identifier +.TP +<\fINAME\fR> +Name of the gateway diff --git a/core/man/start-cli/start-cli-net-gateway.1 b/core/man/start-cli/start-cli-net-gateway.1 new file mode 100644 index 000000000..51741dc9c --- /dev/null +++ b/core/man/start-cli/start-cli-net-gateway.1 @@ -0,0 +1,32 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-net-gateway 1 "gateway " +.SH NAME +start\-cli\-net\-gateway \- View and edit gateway configurations +.SH SYNOPSIS +\fBstart\-cli net gateway\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +View and edit gateway configurations +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-net\-gateway\-check\-dns(1) +Check DNS configuration for a gateway +.TP +start\-cli\-net\-gateway\-check\-port(1) +about.check\-port\-reachability +.TP +start\-cli\-net\-gateway\-forget(1) +Forget a disconnected gateway +.TP +start\-cli\-net\-gateway\-list(1) +Show gateways StartOS can listen on +.TP +start\-cli\-net\-gateway\-set\-default\-outbound(1) +about.set\-default\-outbound\-gateway +.TP +start\-cli\-net\-gateway\-set\-name(1) +Rename a gateway diff --git a/core/man/start-cli/start-cli-net-tunnel-add.1 b/core/man/start-cli/start-cli-net-tunnel-add.1 new file mode 100644 index 000000000..d315b28ce --- /dev/null +++ b/core/man/start-cli/start-cli-net-tunnel-add.1 @@ -0,0 +1,35 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-net-tunnel-add 1 "add " +.SH NAME +start\-cli\-net\-tunnel\-add \- Add a new tunnel +.SH SYNOPSIS +\fBstart\-cli net tunnel add\fR [\fB\-\-set\-as\-default\-outbound\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fINAME\fR> <\fICONFIG\fR> [\fIGATEWAY_TYPE\fR] +.SH DESCRIPTION +Add a new tunnel +.SH OPTIONS +.TP +\fB\-\-set\-as\-default\-outbound\fR +help.arg.set\-as\-default\-outbound +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fINAME\fR> +Tunnel name +.TP +<\fICONFIG\fR> +WireGuard configuration +.TP +[\fIGATEWAY_TYPE\fR] +help.arg.gateway\-type +.br + +.br +\fIPossible values:\fR +.RS 14 +.IP \(bu 2 +inbound\-outbound +.IP \(bu 2 +outbound\-only +.RE diff --git a/core/man/start-cli/start-cli-net-tunnel-remove.1 b/core/man/start-cli/start-cli-net-tunnel-remove.1 new file mode 100644 index 000000000..d8ba47885 --- /dev/null +++ b/core/man/start-cli/start-cli-net-tunnel-remove.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-net-tunnel-remove 1 "remove " +.SH NAME +start\-cli\-net\-tunnel\-remove \- Remove a tunnel +.SH SYNOPSIS +\fBstart\-cli net tunnel remove\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIID\fR> +.SH DESCRIPTION +Remove a tunnel +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIID\fR> +Gateway identifier diff --git a/core/man/start-cli/start-cli-net-tunnel.1 b/core/man/start-cli/start-cli-net-tunnel.1 new file mode 100644 index 000000000..fa5afdead --- /dev/null +++ b/core/man/start-cli/start-cli-net-tunnel.1 @@ -0,0 +1,20 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-net-tunnel 1 "tunnel " +.SH NAME +start\-cli\-net\-tunnel \- Manage tunnels +.SH SYNOPSIS +\fBstart\-cli net tunnel\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Manage tunnels +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-net\-tunnel\-add(1) +Add a new tunnel +.TP +start\-cli\-net\-tunnel\-remove(1) +Remove a tunnel diff --git a/core/man/start-cli/start-cli-net-vhost-add-passthrough.1 b/core/man/start-cli/start-cli-net-vhost-add-passthrough.1 new file mode 100644 index 000000000..9d6aa9892 --- /dev/null +++ b/core/man/start-cli/start-cli-net-vhost-add-passthrough.1 @@ -0,0 +1,27 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-net-vhost-add-passthrough 1 "add-passthrough " +.SH NAME +start\-cli\-net\-vhost\-add\-passthrough +.SH SYNOPSIS +\fBstart\-cli net vhost add\-passthrough\fR <\fB\-\-hostname\fR> <\fB\-\-listen\-port\fR> <\fB\-\-backend\fR> [\fB\-\-public\-gateway\fR] [\fB\-\-private\-ip\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +.SH OPTIONS +.TP +\fB\-\-hostname\fR \fI\fR + +.TP +\fB\-\-listen\-port\fR \fI\fR + +.TP +\fB\-\-backend\fR \fI\fR + +.TP +\fB\-\-public\-gateway\fR \fI\fR + +.TP +\fB\-\-private\-ip\fR \fI\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-net-vhost-dump-table.1 b/core/man/start-cli/start-cli-net-vhost-dump-table.1 new file mode 100644 index 000000000..c6e89acc7 --- /dev/null +++ b/core/man/start-cli/start-cli-net-vhost-dump-table.1 @@ -0,0 +1,15 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-net-vhost-dump-table 1 "dump-table " +.SH NAME +start\-cli\-net\-vhost\-dump\-table +.SH SYNOPSIS +\fBstart\-cli net vhost dump\-table\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-net-vhost-list-passthrough.1 b/core/man/start-cli/start-cli-net-vhost-list-passthrough.1 new file mode 100644 index 000000000..a425795a2 --- /dev/null +++ b/core/man/start-cli/start-cli-net-vhost-list-passthrough.1 @@ -0,0 +1,15 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-net-vhost-list-passthrough 1 "list-passthrough " +.SH NAME +start\-cli\-net\-vhost\-list\-passthrough +.SH SYNOPSIS +\fBstart\-cli net vhost list\-passthrough\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-net-vhost-remove-passthrough.1 b/core/man/start-cli/start-cli-net-vhost-remove-passthrough.1 new file mode 100644 index 000000000..a444e2593 --- /dev/null +++ b/core/man/start-cli/start-cli-net-vhost-remove-passthrough.1 @@ -0,0 +1,18 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-net-vhost-remove-passthrough 1 "remove-passthrough " +.SH NAME +start\-cli\-net\-vhost\-remove\-passthrough +.SH SYNOPSIS +\fBstart\-cli net vhost remove\-passthrough\fR <\fB\-\-hostname\fR> <\fB\-\-listen\-port\fR> [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +.SH OPTIONS +.TP +\fB\-\-hostname\fR \fI\fR + +.TP +\fB\-\-listen\-port\fR \fI\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-net-vhost.1 b/core/man/start-cli/start-cli-net-vhost.1 new file mode 100644 index 000000000..c977761fe --- /dev/null +++ b/core/man/start-cli/start-cli-net-vhost.1 @@ -0,0 +1,22 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-net-vhost 1 "vhost " +.SH NAME +start\-cli\-net\-vhost \- Manage SSL vhost proxy +.SH SYNOPSIS +\fBstart\-cli net vhost\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Manage SSL vhost proxy +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-net\-vhost\-add\-passthrough(1) +.TP +start\-cli\-net\-vhost\-dump\-table(1) +.TP +start\-cli\-net\-vhost\-list\-passthrough(1) +.TP +start\-cli\-net\-vhost\-remove\-passthrough(1) diff --git a/core/man/start-cli/start-cli-net.1 b/core/man/start-cli/start-cli-net.1 new file mode 100644 index 000000000..8fe2a8969 --- /dev/null +++ b/core/man/start-cli/start-cli-net.1 @@ -0,0 +1,32 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-net 1 "net " +.SH NAME +start\-cli\-net \- Network commands +.SH SYNOPSIS +\fBstart\-cli net\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Network commands +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-net\-acme(1) +Setup ACME certificate +.TP +start\-cli\-net\-dns(1) +Manage and query DNS +.TP +start\-cli\-net\-forward(1) +Manage port forwards +.TP +start\-cli\-net\-gateway(1) +View and edit gateway configurations +.TP +start\-cli\-net\-tunnel(1) +Manage tunnels +.TP +start\-cli\-net\-vhost(1) +Manage SSL vhost proxy diff --git a/core/man/start-cli/start-cli-notification-create.1 b/core/man/start-cli/start-cli-notification-create.1 new file mode 100644 index 000000000..d4bc03412 --- /dev/null +++ b/core/man/start-cli/start-cli-notification-create.1 @@ -0,0 +1,25 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-notification-create 1 "create " +.SH NAME +start\-cli\-notification\-create \- Persist a new notification +.SH SYNOPSIS +\fBstart\-cli notification create\fR [\fB\-p\fR|\fB\-\-package\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fILEVEL\fR> <\fITITLE\fR> <\fIMESSAGE\fR> +.SH DESCRIPTION +Persist a new notification +.SH OPTIONS +.TP +\fB\-p\fR, \fB\-\-package\fR \fI\fR +Package identifier +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fILEVEL\fR> +Notification severity level +.TP +<\fITITLE\fR> +Notification title +.TP +<\fIMESSAGE\fR> +Notification message content diff --git a/core/man/start-cli/start-cli-notification-list.1 b/core/man/start-cli/start-cli-notification-list.1 new file mode 100644 index 000000000..03ced50b2 --- /dev/null +++ b/core/man/start-cli/start-cli-notification-list.1 @@ -0,0 +1,22 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-notification-list 1 "list " +.SH NAME +start\-cli\-notification\-list \- List notifications +.SH SYNOPSIS +\fBstart\-cli notification list\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fIBEFORE\fR] [\fILIMIT\fR] +.SH DESCRIPTION +List notifications +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +[\fIBEFORE\fR] +Get notifications before this ID +.TP +[\fILIMIT\fR] +Maximum number of notifications to return diff --git a/core/man/start-cli/start-cli-notification-mark-seen-before.1 b/core/man/start-cli/start-cli-notification-mark-seen-before.1 new file mode 100644 index 000000000..c00a8d83a --- /dev/null +++ b/core/man/start-cli/start-cli-notification-mark-seen-before.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-notification-mark-seen-before 1 "mark-seen-before " +.SH NAME +start\-cli\-notification\-mark\-seen\-before \- Mark notifications as seen before a given ID +.SH SYNOPSIS +\fBstart\-cli notification mark\-seen\-before\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIBEFORE\fR> +.SH DESCRIPTION +Mark notifications as seen before a given ID +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIBEFORE\fR> +Get notifications before this ID diff --git a/core/man/start-cli/start-cli-notification-mark-seen.1 b/core/man/start-cli/start-cli-notification-mark-seen.1 new file mode 100644 index 000000000..d79a3fd86 --- /dev/null +++ b/core/man/start-cli/start-cli-notification-mark-seen.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-notification-mark-seen 1 "mark-seen " +.SH NAME +start\-cli\-notification\-mark\-seen \- Mark notifications as seen +.SH SYNOPSIS +\fBstart\-cli notification mark\-seen\fR [\fB\-h\fR|\fB\-\-help\fR] [\fIIDS\fR] +.SH DESCRIPTION +Mark notifications as seen +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +[\fIIDS\fR] +Notification IDs diff --git a/core/man/start-cli/start-cli-notification-mark-unseen.1 b/core/man/start-cli/start-cli-notification-mark-unseen.1 new file mode 100644 index 000000000..d71d67dbb --- /dev/null +++ b/core/man/start-cli/start-cli-notification-mark-unseen.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-notification-mark-unseen 1 "mark-unseen " +.SH NAME +start\-cli\-notification\-mark\-unseen \- Mark notifications as unseen +.SH SYNOPSIS +\fBstart\-cli notification mark\-unseen\fR [\fB\-h\fR|\fB\-\-help\fR] [\fIIDS\fR] +.SH DESCRIPTION +Mark notifications as unseen +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +[\fIIDS\fR] +Notification IDs diff --git a/core/man/start-cli/start-cli-notification-remove-before.1 b/core/man/start-cli/start-cli-notification-remove-before.1 new file mode 100644 index 000000000..8703cfba4 --- /dev/null +++ b/core/man/start-cli/start-cli-notification-remove-before.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-notification-remove-before 1 "remove-before " +.SH NAME +start\-cli\-notification\-remove\-before \- Remove notifications before a given ID +.SH SYNOPSIS +\fBstart\-cli notification remove\-before\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIBEFORE\fR> +.SH DESCRIPTION +Remove notifications before a given ID +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIBEFORE\fR> +Get notifications before this ID diff --git a/core/man/start-cli/start-cli-notification-remove.1 b/core/man/start-cli/start-cli-notification-remove.1 new file mode 100644 index 000000000..d198fd056 --- /dev/null +++ b/core/man/start-cli/start-cli-notification-remove.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-notification-remove 1 "remove " +.SH NAME +start\-cli\-notification\-remove \- Remove notification for IDs +.SH SYNOPSIS +\fBstart\-cli notification remove\fR [\fB\-h\fR|\fB\-\-help\fR] [\fIIDS\fR] +.SH DESCRIPTION +Remove notification for IDs +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +[\fIIDS\fR] +Notification IDs diff --git a/core/man/start-cli/start-cli-notification.1 b/core/man/start-cli/start-cli-notification.1 new file mode 100644 index 000000000..dfed2c598 --- /dev/null +++ b/core/man/start-cli/start-cli-notification.1 @@ -0,0 +1,35 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-notification 1 "notification " +.SH NAME +start\-cli\-notification \- Create, delete, or list notifications +.SH SYNOPSIS +\fBstart\-cli notification\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Create, delete, or list notifications +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-notification\-create(1) +Persist a new notification +.TP +start\-cli\-notification\-list(1) +List notifications +.TP +start\-cli\-notification\-mark\-seen(1) +Mark notifications as seen +.TP +start\-cli\-notification\-mark\-seen\-before(1) +Mark notifications as seen before a given ID +.TP +start\-cli\-notification\-mark\-unseen(1) +Mark notifications as unseen +.TP +start\-cli\-notification\-remove(1) +Remove notification for IDs +.TP +start\-cli\-notification\-remove\-before(1) +Remove notifications before a given ID diff --git a/core/man/start-cli/start-cli-package-action-clear-task.1 b/core/man/start-cli/start-cli-package-action-clear-task.1 new file mode 100644 index 000000000..8c2f46918 --- /dev/null +++ b/core/man/start-cli/start-cli-package-action-clear-task.1 @@ -0,0 +1,22 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-action-clear-task 1 "clear-task " +.SH NAME +start\-cli\-package\-action\-clear\-task \- Clear a service task +.SH SYNOPSIS +\fBstart\-cli package action clear\-task\fR [\fB\-\-force\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIPACKAGE_ID\fR> <\fIREPLAY_ID\fR> +.SH DESCRIPTION +Clear a service task +.SH OPTIONS +.TP +\fB\-\-force\fR +Force clear the task even if running +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIPACKAGE_ID\fR> +Package identifier +.TP +<\fIREPLAY_ID\fR> +Replay identifier for task diff --git a/core/man/start-cli/start-cli-package-action-get-input.1 b/core/man/start-cli/start-cli-package-action-get-input.1 new file mode 100644 index 000000000..0b3aa9d1b --- /dev/null +++ b/core/man/start-cli/start-cli-package-action-get-input.1 @@ -0,0 +1,22 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-action-get-input 1 "get-input " +.SH NAME +start\-cli\-package\-action\-get\-input \- Get action input specification +.SH SYNOPSIS +\fBstart\-cli package action get\-input\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIPACKAGE_ID\fR> <\fIACTION_ID\fR> +.SH DESCRIPTION +Get action input specification +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIPACKAGE_ID\fR> +Package identifier +.TP +<\fIACTION_ID\fR> +Action identifier diff --git a/core/man/start-cli/start-cli-package-action-run.1 b/core/man/start-cli/start-cli-package-action-run.1 new file mode 100644 index 000000000..81efe9aee --- /dev/null +++ b/core/man/start-cli/start-cli-package-action-run.1 @@ -0,0 +1,25 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-action-run 1 "run " +.SH NAME +start\-cli\-package\-action\-run \- Run a service action +.SH SYNOPSIS +\fBstart\-cli package action run\fR [\fB\-\-event\-id\fR] [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIPACKAGE_ID\fR> <\fIACTION_ID\fR> +.SH DESCRIPTION +Run a service action +.SH OPTIONS +.TP +\fB\-\-event\-id\fR \fI\fR +Unique event identifier +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIPACKAGE_ID\fR> +Package identifier +.TP +<\fIACTION_ID\fR> +Action identifier diff --git a/core/man/start-cli/start-cli-package-action.1 b/core/man/start-cli/start-cli-package-action.1 new file mode 100644 index 000000000..375e2ef4b --- /dev/null +++ b/core/man/start-cli/start-cli-package-action.1 @@ -0,0 +1,23 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-action 1 "action " +.SH NAME +start\-cli\-package\-action \- Commands to get action input or run an action +.SH SYNOPSIS +\fBstart\-cli package action\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands to get action input or run an action +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-package\-action\-clear\-task(1) +Clear a service task +.TP +start\-cli\-package\-action\-get\-input(1) +Get action input specification +.TP +start\-cli\-package\-action\-run(1) +Run a service action diff --git a/core/man/start-cli/start-cli-package-attach.1 b/core/man/start-cli/start-cli-package-attach.1 new file mode 100644 index 000000000..b230689bf --- /dev/null +++ b/core/man/start-cli/start-cli-package-attach.1 @@ -0,0 +1,33 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-attach 1 "attach " +.SH NAME +start\-cli\-package\-attach +.SH SYNOPSIS +\fBstart\-cli package attach\fR [\fB\-\-force\-tty\fR] [\fB\-s\fR|\fB\-\-subcontainer\fR] [\fB\-n\fR|\fB\-\-name\fR] [\fB\-u\fR|\fB\-\-user\fR] [\fB\-i\fR|\fB\-\-image\-id\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIID\fR> [\fICOMMAND\fR] +.SH DESCRIPTION +.SH OPTIONS +.TP +\fB\-\-force\-tty\fR +Force TTY mode for I/O +.TP +\fB\-s\fR, \fB\-\-subcontainer\fR \fI\fR +Name of the subcontainer +.TP +\fB\-n\fR, \fB\-\-name\fR \fI\fR +Name of the container +.TP +\fB\-u\fR, \fB\-\-user\fR \fI\fR +User name to run as +.TP +\fB\-i\fR, \fB\-\-image\-id\fR \fI\fR +Docker image identifier +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIID\fR> +Package identifier +.TP +[\fICOMMAND\fR] +Command to execute in the container diff --git a/core/man/start-cli/start-cli-package-backup-restore.1 b/core/man/start-cli/start-cli-package-backup-restore.1 new file mode 100644 index 000000000..144e74ab0 --- /dev/null +++ b/core/man/start-cli/start-cli-package-backup-restore.1 @@ -0,0 +1,22 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-backup-restore 1 "restore " +.SH NAME +start\-cli\-package\-backup\-restore \- Restore packages from backup +.SH SYNOPSIS +\fBstart\-cli package backup restore\fR [\fB\-h\fR|\fB\-\-help\fR] <\fITARGET_ID\fR> <\fIPASSWORD\fR> [\fIIDS\fR] +.SH DESCRIPTION +Restore packages from backup +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fITARGET_ID\fR> +Backup target identifier +.TP +<\fIPASSWORD\fR> +Password for backup encryption +.TP +[\fIIDS\fR] +Package identifiers diff --git a/core/man/start-cli/start-cli-package-backup.1 b/core/man/start-cli/start-cli-package-backup.1 new file mode 100644 index 000000000..02fd83765 --- /dev/null +++ b/core/man/start-cli/start-cli-package-backup.1 @@ -0,0 +1,17 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-backup 1 "backup " +.SH NAME +start\-cli\-package\-backup \- Commands for restoring package(s) from backup +.SH SYNOPSIS +\fBstart\-cli package backup\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands for restoring package(s) from backup +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-package\-backup\-restore(1) +Restore packages from backup diff --git a/core/man/start-cli/start-cli-package-cancel-install.1 b/core/man/start-cli/start-cli-package-cancel-install.1 new file mode 100644 index 000000000..33dc1c34e --- /dev/null +++ b/core/man/start-cli/start-cli-package-cancel-install.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-cancel-install 1 "cancel-install " +.SH NAME +start\-cli\-package\-cancel\-install \- Cancel an install of a package +.SH SYNOPSIS +\fBstart\-cli package cancel\-install\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIID\fR> +.SH DESCRIPTION +Cancel an install of a package +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIID\fR> +Package identifier diff --git a/core/man/start-cli/start-cli-package-host-address-domain-private-add.1 b/core/man/start-cli/start-cli-package-host-address-domain-private-add.1 new file mode 100644 index 000000000..f40a9b74c --- /dev/null +++ b/core/man/start-cli/start-cli-package-host-address-domain-private-add.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-host-address-domain-private-add 1 "add " +.SH NAME +start\-cli\-package\-host\-address\-domain\-private\-add \- Add a private domain to this host +.SH SYNOPSIS +\fBstart\-cli package host address domain private add\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIFQDN\fR> <\fIGATEWAY\fR> +.SH DESCRIPTION +Add a private domain to this host +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIFQDN\fR> +Fully qualified domain name +.TP +<\fIGATEWAY\fR> + diff --git a/core/man/start-cli/start-cli-package-host-address-domain-private-remove.1 b/core/man/start-cli/start-cli-package-host-address-domain-private-remove.1 new file mode 100644 index 000000000..090938017 --- /dev/null +++ b/core/man/start-cli/start-cli-package-host-address-domain-private-remove.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-host-address-domain-private-remove 1 "remove " +.SH NAME +start\-cli\-package\-host\-address\-domain\-private\-remove \- Remove private domain from host +.SH SYNOPSIS +\fBstart\-cli package host address domain private remove\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIFQDN\fR> +.SH DESCRIPTION +Remove private domain from host +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIFQDN\fR> +Fully qualified domain name diff --git a/core/man/start-cli/start-cli-package-host-address-domain-private.1 b/core/man/start-cli/start-cli-package-host-address-domain-private.1 new file mode 100644 index 000000000..823896bdb --- /dev/null +++ b/core/man/start-cli/start-cli-package-host-address-domain-private.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-host-address-domain-private 1 "private " +.SH NAME +start\-cli\-package\-host\-address\-domain\-private +.SH SYNOPSIS +\fBstart\-cli package host address domain private\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-package\-host\-address\-domain\-private\-add(1) +Add a private domain to this host +.TP +start\-cli\-package\-host\-address\-domain\-private\-remove(1) +Remove private domain from host diff --git a/core/man/start-cli/start-cli-package-host-address-domain-public-add.1 b/core/man/start-cli/start-cli-package-host-address-domain-public-add.1 new file mode 100644 index 000000000..b30b1e6da --- /dev/null +++ b/core/man/start-cli/start-cli-package-host-address-domain-public-add.1 @@ -0,0 +1,25 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-host-address-domain-public-add 1 "add " +.SH NAME +start\-cli\-package\-host\-address\-domain\-public\-add \- Add a public domain to this host +.SH SYNOPSIS +\fBstart\-cli package host address domain public add\fR [\fB\-\-acme\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIFQDN\fR> <\fIGATEWAY\fR> <\fIINTERNAL_PORT\fR> +.SH DESCRIPTION +Add a public domain to this host +.SH OPTIONS +.TP +\fB\-\-acme\fR \fI\fR +ACME provider identifier or url +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIFQDN\fR> +Fully qualified domain name +.TP +<\fIGATEWAY\fR> +Gateway identifier +.TP +<\fIINTERNAL_PORT\fR> +Internal port number diff --git a/core/man/start-cli/start-cli-package-host-address-domain-public-remove.1 b/core/man/start-cli/start-cli-package-host-address-domain-public-remove.1 new file mode 100644 index 000000000..3c99dd2dc --- /dev/null +++ b/core/man/start-cli/start-cli-package-host-address-domain-public-remove.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-host-address-domain-public-remove 1 "remove " +.SH NAME +start\-cli\-package\-host\-address\-domain\-public\-remove \- Remove public domain from host +.SH SYNOPSIS +\fBstart\-cli package host address domain public remove\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIFQDN\fR> +.SH DESCRIPTION +Remove public domain from host +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIFQDN\fR> +Fully qualified domain name diff --git a/core/man/start-cli/start-cli-package-host-address-domain-public.1 b/core/man/start-cli/start-cli-package-host-address-domain-public.1 new file mode 100644 index 000000000..096c50bb8 --- /dev/null +++ b/core/man/start-cli/start-cli-package-host-address-domain-public.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-host-address-domain-public 1 "public " +.SH NAME +start\-cli\-package\-host\-address\-domain\-public +.SH SYNOPSIS +\fBstart\-cli package host address domain public\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-package\-host\-address\-domain\-public\-add(1) +Add a public domain to this host +.TP +start\-cli\-package\-host\-address\-domain\-public\-remove(1) +Remove public domain from host diff --git a/core/man/start-cli/start-cli-package-host-address-domain.1 b/core/man/start-cli/start-cli-package-host-address-domain.1 new file mode 100644 index 000000000..e80a1a407 --- /dev/null +++ b/core/man/start-cli/start-cli-package-host-address-domain.1 @@ -0,0 +1,17 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-host-address-domain 1 "domain " +.SH NAME +start\-cli\-package\-host\-address\-domain +.SH SYNOPSIS +\fBstart\-cli package host address domain\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-package\-host\-address\-domain\-private(1) +.TP +start\-cli\-package\-host\-address\-domain\-public(1) diff --git a/core/man/start-cli/start-cli-package-host-address-list.1 b/core/man/start-cli/start-cli-package-host-address-list.1 new file mode 100644 index 000000000..c28cd6a47 --- /dev/null +++ b/core/man/start-cli/start-cli-package-host-address-list.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-host-address-list 1 "list " +.SH NAME +start\-cli\-package\-host\-address\-list \- List addresses for a host +.SH SYNOPSIS +\fBstart\-cli package host address list\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +List addresses for a host +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-package-host-address.1 b/core/man/start-cli/start-cli-package-host-address.1 new file mode 100644 index 000000000..3c9709fe1 --- /dev/null +++ b/core/man/start-cli/start-cli-package-host-address.1 @@ -0,0 +1,21 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-host-address 1 "address " +.SH NAME +start\-cli\-package\-host\-address +.SH SYNOPSIS +\fBstart\-cli package host address\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIHOST\fR> <\fIsubcommands\fR> +.SH DESCRIPTION +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIHOST\fR> +Host identifier +.SH SUBCOMMANDS +.TP +start\-cli\-package\-host\-address\-domain(1) +.TP +start\-cli\-package\-host\-address\-list(1) +List addresses for a host diff --git a/core/man/start-cli/start-cli-package-host-binding-list.1 b/core/man/start-cli/start-cli-package-host-binding-list.1 new file mode 100644 index 000000000..e26168089 --- /dev/null +++ b/core/man/start-cli/start-cli-package-host-binding-list.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-host-binding-list 1 "list " +.SH NAME +start\-cli\-package\-host\-binding\-list \- List bindings for a host +.SH SYNOPSIS +\fBstart\-cli package host binding list\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +List bindings for a host +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-package-host-binding-set-address-enabled.1 b/core/man/start-cli/start-cli-package-host-binding-set-address-enabled.1 new file mode 100644 index 000000000..b0cd6bb41 --- /dev/null +++ b/core/man/start-cli/start-cli-package-host-binding-set-address-enabled.1 @@ -0,0 +1,32 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-host-binding-set-address-enabled 1 "set-address-enabled " +.SH NAME +start\-cli\-package\-host\-binding\-set\-address\-enabled \- about.set\-address\-enabled\-for\-binding +.SH SYNOPSIS +\fBstart\-cli package host binding set\-address\-enabled\fR <\fB\-\-address\fR> [\fB\-\-enabled\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIINTERNAL_PORT\fR> +.SH DESCRIPTION +about.set\-address\-enabled\-for\-binding +.SH OPTIONS +.TP +\fB\-\-address\fR \fI
\fR +help.arg.address +.TP +\fB\-\-enabled\fR \fI\fR +Enable or disable this binding +.br + +.br +\fIPossible values:\fR +.RS 14 +.IP \(bu 2 +true +.IP \(bu 2 +false +.RE +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIINTERNAL_PORT\fR> +Internal port number diff --git a/core/man/start-cli/start-cli-package-host-binding.1 b/core/man/start-cli/start-cli-package-host-binding.1 new file mode 100644 index 000000000..ebdf88882 --- /dev/null +++ b/core/man/start-cli/start-cli-package-host-binding.1 @@ -0,0 +1,22 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-host-binding 1 "binding " +.SH NAME +start\-cli\-package\-host\-binding +.SH SYNOPSIS +\fBstart\-cli package host binding\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIHOST\fR> <\fIsubcommands\fR> +.SH DESCRIPTION +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIHOST\fR> +Host identifier +.SH SUBCOMMANDS +.TP +start\-cli\-package\-host\-binding\-list(1) +List bindings for a host +.TP +start\-cli\-package\-host\-binding\-set\-address\-enabled(1) +about.set\-address\-enabled\-for\-binding diff --git a/core/man/start-cli/start-cli-package-host.1 b/core/man/start-cli/start-cli-package-host.1 new file mode 100644 index 000000000..eb980510b --- /dev/null +++ b/core/man/start-cli/start-cli-package-host.1 @@ -0,0 +1,21 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-host 1 "host " +.SH NAME +start\-cli\-package\-host \- Manage network hosts for a package +.SH SYNOPSIS +\fBstart\-cli package host\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIPACKAGE\fR> <\fIsubcommands\fR> +.SH DESCRIPTION +Manage network hosts for a package +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIPACKAGE\fR> +Package identifier +.SH SUBCOMMANDS +.TP +start\-cli\-package\-host\-address(1) +.TP +start\-cli\-package\-host\-binding(1) diff --git a/core/man/start-cli/start-cli-package-install.1 b/core/man/start-cli/start-cli-package-install.1 new file mode 100644 index 000000000..023cd77f7 --- /dev/null +++ b/core/man/start-cli/start-cli-package-install.1 @@ -0,0 +1,22 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-install 1 "install " +.SH NAME +start\-cli\-package\-install \- Install a package +.SH SYNOPSIS +\fBstart\-cli package install\fR [\fB\-s\fR|\fB\-\-sideload\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fIID\fR] [\fIVERSION\fR] +.SH DESCRIPTION +Install a package +.SH OPTIONS +.TP +\fB\-s\fR, \fB\-\-sideload\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +[\fIID\fR] +Package identifier +.TP +[\fIVERSION\fR] +Version range constraint diff --git a/core/man/start-cli/start-cli-package-installed-version.1 b/core/man/start-cli/start-cli-package-installed-version.1 new file mode 100644 index 000000000..43cfadcbd --- /dev/null +++ b/core/man/start-cli/start-cli-package-installed-version.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-installed-version 1 "installed-version " +.SH NAME +start\-cli\-package\-installed\-version \- Display the installed version of a package +.SH SYNOPSIS +\fBstart\-cli package installed\-version\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIID\fR> +.SH DESCRIPTION +Display the installed version of a package +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIID\fR> +Package identifier diff --git a/core/man/start-cli/start-cli-package-list.1 b/core/man/start-cli/start-cli-package-list.1 new file mode 100644 index 000000000..279047672 --- /dev/null +++ b/core/man/start-cli/start-cli-package-list.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-list 1 "list " +.SH NAME +start\-cli\-package\-list \- List installed packages +.SH SYNOPSIS +\fBstart\-cli package list\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +List installed packages +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-package-logs.1 b/core/man/start-cli/start-cli-package-logs.1 new file mode 100644 index 000000000..dd6fb5571 --- /dev/null +++ b/core/man/start-cli/start-cli-package-logs.1 @@ -0,0 +1,31 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-logs 1 "logs " +.SH NAME +start\-cli\-package\-logs \- Display logs for a package +.SH SYNOPSIS +\fBstart\-cli package logs\fR [\fB\-l\fR|\fB\-\-limit\fR] [\fB\-c\fR|\fB\-\-cursor\fR] [\fB\-b\fR|\fB\-\-boot\fR] [\fB\-B\fR|\fB\-\-before\fR] [\fB\-f\fR|\fB\-\-follow\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIID\fR> +.SH DESCRIPTION +Display logs for a package +.SH OPTIONS +.TP +\fB\-l\fR, \fB\-\-limit\fR \fI\fR +Maximum number of log entries +.TP +\fB\-c\fR, \fB\-\-cursor\fR \fI\fR +Start from this cursor position +.TP +\fB\-b\fR, \fB\-\-boot\fR \fI\fR +Filter logs by boot ID +.TP +\fB\-B\fR, \fB\-\-before\fR +Show logs before the cursor position +.TP +\fB\-f\fR, \fB\-\-follow\fR +Follow log output in real\-time +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIID\fR> +Package identifier diff --git a/core/man/start-cli/start-cli-package-rebuild.1 b/core/man/start-cli/start-cli-package-rebuild.1 new file mode 100644 index 000000000..c7b26ce9d --- /dev/null +++ b/core/man/start-cli/start-cli-package-rebuild.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-rebuild 1 "rebuild " +.SH NAME +start\-cli\-package\-rebuild \- Rebuild service container +.SH SYNOPSIS +\fBstart\-cli package rebuild\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIID\fR> +.SH DESCRIPTION +Rebuild service container +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIID\fR> +Package identifier diff --git a/core/man/start-cli/start-cli-package-restart.1 b/core/man/start-cli/start-cli-package-restart.1 new file mode 100644 index 000000000..7582f726f --- /dev/null +++ b/core/man/start-cli/start-cli-package-restart.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-restart 1 "restart " +.SH NAME +start\-cli\-package\-restart \- Restart a service +.SH SYNOPSIS +\fBstart\-cli package restart\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIID\fR> +.SH DESCRIPTION +Restart a service +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIID\fR> +Package identifier diff --git a/core/man/start-cli/start-cli-package-set-outbound-gateway.1 b/core/man/start-cli/start-cli-package-set-outbound-gateway.1 new file mode 100644 index 000000000..57c4b7b31 --- /dev/null +++ b/core/man/start-cli/start-cli-package-set-outbound-gateway.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-set-outbound-gateway 1 "set-outbound-gateway " +.SH NAME +start\-cli\-package\-set\-outbound\-gateway \- about.set\-outbound\-gateway\-package +.SH SYNOPSIS +\fBstart\-cli package set\-outbound\-gateway\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIPACKAGE\fR> [\fIGATEWAY\fR] +.SH DESCRIPTION +about.set\-outbound\-gateway\-package +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIPACKAGE\fR> +Package identifier +.TP +[\fIGATEWAY\fR] +Gateway identifier diff --git a/core/man/start-cli/start-cli-package-start.1 b/core/man/start-cli/start-cli-package-start.1 new file mode 100644 index 000000000..0fbddfdb5 --- /dev/null +++ b/core/man/start-cli/start-cli-package-start.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-start 1 "start " +.SH NAME +start\-cli\-package\-start \- Start a service +.SH SYNOPSIS +\fBstart\-cli package start\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIID\fR> +.SH DESCRIPTION +Start a service +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIID\fR> +Package identifier diff --git a/core/man/start-cli/start-cli-package-stats.1 b/core/man/start-cli/start-cli-package-stats.1 new file mode 100644 index 000000000..9e55fe888 --- /dev/null +++ b/core/man/start-cli/start-cli-package-stats.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-stats 1 "stats " +.SH NAME +start\-cli\-package\-stats \- List LXC container information +.SH SYNOPSIS +\fBstart\-cli package stats\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +List LXC container information +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-package-stop.1 b/core/man/start-cli/start-cli-package-stop.1 new file mode 100644 index 000000000..087541683 --- /dev/null +++ b/core/man/start-cli/start-cli-package-stop.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-stop 1 "stop " +.SH NAME +start\-cli\-package\-stop \- Stop a service +.SH SYNOPSIS +\fBstart\-cli package stop\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIID\fR> +.SH DESCRIPTION +Stop a service +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIID\fR> +Package identifier diff --git a/core/man/start-cli/start-cli-package-uninstall.1 b/core/man/start-cli/start-cli-package-uninstall.1 new file mode 100644 index 000000000..2a1e69c13 --- /dev/null +++ b/core/man/start-cli/start-cli-package-uninstall.1 @@ -0,0 +1,22 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package-uninstall 1 "uninstall " +.SH NAME +start\-cli\-package\-uninstall \- Remove a package +.SH SYNOPSIS +\fBstart\-cli package uninstall\fR [\fB\-\-soft\fR] [\fB\-\-force\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIID\fR> +.SH DESCRIPTION +Remove a package +.SH OPTIONS +.TP +\fB\-\-soft\fR +Uninstall without deleting service data +.TP +\fB\-\-force\fR +Ignore errors in service uninit script +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIID\fR> +Package identifier diff --git a/core/man/start-cli/start-cli-package.1 b/core/man/start-cli/start-cli-package.1 new file mode 100644 index 000000000..894fa0b37 --- /dev/null +++ b/core/man/start-cli/start-cli-package.1 @@ -0,0 +1,61 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-package 1 "package " +.SH NAME +start\-cli\-package \- Commands related to packages +.SH SYNOPSIS +\fBstart\-cli package\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands related to packages +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-package\-action(1) +Commands to get action input or run an action +.TP +start\-cli\-package\-attach(1) +.TP +start\-cli\-package\-backup(1) +Commands for restoring package(s) from backup +.TP +start\-cli\-package\-cancel\-install(1) +Cancel an install of a package +.TP +start\-cli\-package\-host(1) +Manage network hosts for a package +.TP +start\-cli\-package\-install(1) +Install a package +.TP +start\-cli\-package\-installed\-version(1) +Display the installed version of a package +.TP +start\-cli\-package\-list(1) +List installed packages +.TP +start\-cli\-package\-logs(1) +Display logs for a package +.TP +start\-cli\-package\-rebuild(1) +Rebuild service container +.TP +start\-cli\-package\-restart(1) +Restart a service +.TP +start\-cli\-package\-set\-outbound\-gateway(1) +about.set\-outbound\-gateway\-package +.TP +start\-cli\-package\-start(1) +Start a service +.TP +start\-cli\-package\-stats(1) +List LXC container information +.TP +start\-cli\-package\-stop(1) +Stop a service +.TP +start\-cli\-package\-uninstall(1) +Remove a package diff --git a/core/man/start-cli/start-cli-pubkey.1 b/core/man/start-cli/start-cli-pubkey.1 new file mode 100644 index 000000000..5de15da8e --- /dev/null +++ b/core/man/start-cli/start-cli-pubkey.1 @@ -0,0 +1,13 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-pubkey 1 "pubkey " +.SH NAME +start\-cli\-pubkey \- Get the developer public key +.SH SYNOPSIS +\fBstart\-cli pubkey\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Get the developer public key +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-registry-admin-add.1 b/core/man/start-cli/start-cli-registry-admin-add.1 new file mode 100644 index 000000000..b96f8e407 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-admin-add.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-admin-add 1 "add " +.SH NAME +start\-cli\-registry\-admin\-add \- Add admin signer +.SH SYNOPSIS +\fBstart\-cli registry admin add\fR [\fB\-h\fR|\fB\-\-help\fR] <\fISIGNER\fR> [\fIDATABASE\fR] +.SH DESCRIPTION +Add admin signer +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fISIGNER\fR> +Signer identifier +.TP +[\fIDATABASE\fR] +Path to the database file diff --git a/core/man/start-cli/start-cli-registry-admin-list.1 b/core/man/start-cli/start-cli-registry-admin-list.1 new file mode 100644 index 000000000..5a1433140 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-admin-list.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-admin-list 1 "list " +.SH NAME +start\-cli\-registry\-admin\-list \- List admin signers +.SH SYNOPSIS +\fBstart\-cli registry admin list\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +List admin signers +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-registry-admin-remove.1 b/core/man/start-cli/start-cli-registry-admin-remove.1 new file mode 100644 index 000000000..7028f9b36 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-admin-remove.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-admin-remove 1 "remove " +.SH NAME +start\-cli\-registry\-admin\-remove \- Remove admin signer +.SH SYNOPSIS +\fBstart\-cli registry admin remove\fR [\fB\-h\fR|\fB\-\-help\fR] <\fISIGNER\fR> +.SH DESCRIPTION +Remove admin signer +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fISIGNER\fR> +Signer identifier diff --git a/core/man/start-cli/start-cli-registry-admin-signer-add.1 b/core/man/start-cli/start-cli-registry-admin-signer-add.1 new file mode 100644 index 000000000..201c97103 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-admin-signer-add.1 @@ -0,0 +1,25 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-admin-signer-add 1 "add " +.SH NAME +start\-cli\-registry\-admin\-signer\-add \- Add signer +.SH SYNOPSIS +\fBstart\-cli registry admin signer add\fR <\fB\-n\fR|\fB\-\-name\fR> [\fB\-c\fR|\fB\-\-contact\fR] [\fB\-\-key\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fIDATABASE\fR] +.SH DESCRIPTION +Add signer +.SH OPTIONS +.TP +\fB\-n\fR, \fB\-\-name\fR \fI\fR +Name of the signer +.TP +\fB\-c\fR, \fB\-\-contact\fR \fI\fR +Contact information for signer +.TP +\fB\-\-key\fR \fI\fR +Public key for signer +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +[\fIDATABASE\fR] +Path to the database file diff --git a/core/man/start-cli/start-cli-registry-admin-signer-edit.1 b/core/man/start-cli/start-cli-registry-admin-signer-edit.1 new file mode 100644 index 000000000..2d0a3f6e9 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-admin-signer-edit.1 @@ -0,0 +1,31 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-admin-signer-edit 1 "edit " +.SH NAME +start\-cli\-registry\-admin\-signer\-edit \- Edit signer information +.SH SYNOPSIS +\fBstart\-cli registry admin signer edit\fR [\fB\-n\fR|\fB\-\-set\-name\fR] [\fB\-c\fR|\fB\-\-add\-contact\fR] [\fB\-k\fR|\fB\-\-add\-key\fR] [\fB\-C\fR|\fB\-\-remove\-contact\fR] [\fB\-K\fR|\fB\-\-remove\-key\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIID\fR> +.SH DESCRIPTION +Edit signer information +.SH OPTIONS +.TP +\fB\-n\fR, \fB\-\-set\-name\fR \fI\fR +Set the signer name +.TP +\fB\-c\fR, \fB\-\-add\-contact\fR \fI\fR +Add contact information to signer +.TP +\fB\-k\fR, \fB\-\-add\-key\fR \fI\fR +Add a public key to signer +.TP +\fB\-C\fR, \fB\-\-remove\-contact\fR \fI\fR +Remove contact from signer +.TP +\fB\-K\fR, \fB\-\-remove\-key\fR \fI\fR +Remove public key from signer +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIID\fR> +Signer identifier diff --git a/core/man/start-cli/start-cli-registry-admin-signer-list.1 b/core/man/start-cli/start-cli-registry-admin-signer-list.1 new file mode 100644 index 000000000..b87068031 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-admin-signer-list.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-admin-signer-list 1 "list " +.SH NAME +start\-cli\-registry\-admin\-signer\-list \- List signers +.SH SYNOPSIS +\fBstart\-cli registry admin signer list\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +List signers +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-registry-admin-signer.1 b/core/man/start-cli/start-cli-registry-admin-signer.1 new file mode 100644 index 000000000..ad360c9d4 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-admin-signer.1 @@ -0,0 +1,23 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-admin-signer 1 "signer " +.SH NAME +start\-cli\-registry\-admin\-signer \- Commands to add or list signers +.SH SYNOPSIS +\fBstart\-cli registry admin signer\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands to add or list signers +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-registry\-admin\-signer\-add(1) +Add signer +.TP +start\-cli\-registry\-admin\-signer\-edit(1) +Edit signer information +.TP +start\-cli\-registry\-admin\-signer\-list(1) +List signers diff --git a/core/man/start-cli/start-cli-registry-admin.1 b/core/man/start-cli/start-cli-registry-admin.1 new file mode 100644 index 000000000..472313bc3 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-admin.1 @@ -0,0 +1,26 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-admin 1 "admin " +.SH NAME +start\-cli\-registry\-admin \- Commands to add or list admins or signers +.SH SYNOPSIS +\fBstart\-cli registry admin\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands to add or list admins or signers +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-registry\-admin\-add(1) +Add admin signer +.TP +start\-cli\-registry\-admin\-list(1) +List admin signers +.TP +start\-cli\-registry\-admin\-remove(1) +Remove admin signer +.TP +start\-cli\-registry\-admin\-signer(1) +Commands to add or list signers diff --git a/core/man/start-cli/start-cli-registry-db-apply.1 b/core/man/start-cli/start-cli-registry-db-apply.1 new file mode 100644 index 000000000..9d2536595 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-db-apply.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-db-apply 1 "apply " +.SH NAME +start\-cli\-registry\-db\-apply \- Update a database record +.SH SYNOPSIS +\fBstart\-cli registry db apply\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIEXPR\fR> [\fIPATH\fR] +.SH DESCRIPTION +Update a database record +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIEXPR\fR> +Database patch expression to apply +.TP +[\fIPATH\fR] +Path to the database file diff --git a/core/man/start-cli/start-cli-registry-db-dump.1 b/core/man/start-cli/start-cli-registry-db-dump.1 new file mode 100644 index 000000000..8c1e11666 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-db-dump.1 @@ -0,0 +1,22 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-db-dump 1 "dump " +.SH NAME +start\-cli\-registry\-db\-dump \- Filter and query the database +.SH SYNOPSIS +\fBstart\-cli registry db dump\fR [\fB\-p\fR|\fB\-\-pointer\fR] [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fIPATH\fR] +.SH DESCRIPTION +Filter and query the database +.SH OPTIONS +.TP +\fB\-p\fR, \fB\-\-pointer\fR \fI\fR +JSON pointer to object in database to dump +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +[\fIPATH\fR] +Path to the database file diff --git a/core/man/start-cli/start-cli-registry-db.1 b/core/man/start-cli/start-cli-registry-db.1 new file mode 100644 index 000000000..c0d4e0a2a --- /dev/null +++ b/core/man/start-cli/start-cli-registry-db.1 @@ -0,0 +1,20 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-db 1 "db " +.SH NAME +start\-cli\-registry\-db \- Commands to interact with the db i.e. dump and apply +.SH SYNOPSIS +\fBstart\-cli registry db\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands to interact with the db i.e. dump and apply +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-registry\-db\-apply(1) +Update a database record +.TP +start\-cli\-registry\-db\-dump(1) +Filter and query the database diff --git a/core/man/start-cli/start-cli-registry-index.1 b/core/man/start-cli/start-cli-registry-index.1 new file mode 100644 index 000000000..497750d4b --- /dev/null +++ b/core/man/start-cli/start-cli-registry-index.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-index 1 "index " +.SH NAME +start\-cli\-registry\-index \- List registry info and packages +.SH SYNOPSIS +\fBstart\-cli registry index\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +List registry info and packages +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-registry-info-set-icon.1 b/core/man/start-cli/start-cli-registry-info-set-icon.1 new file mode 100644 index 000000000..2cb688f5f --- /dev/null +++ b/core/man/start-cli/start-cli-registry-info-set-icon.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-info-set-icon 1 "set-icon " +.SH NAME +start\-cli\-registry\-info\-set\-icon \- Set the registry icon +.SH SYNOPSIS +\fBstart\-cli registry info set\-icon\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIICON\fR> +.SH DESCRIPTION +Set the registry icon +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIICON\fR> +Path to service icon file diff --git a/core/man/start-cli/start-cli-registry-info-set-name.1 b/core/man/start-cli/start-cli-registry-info-set-name.1 new file mode 100644 index 000000000..cc01d360f --- /dev/null +++ b/core/man/start-cli/start-cli-registry-info-set-name.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-info-set-name 1 "set-name " +.SH NAME +start\-cli\-registry\-info\-set\-name \- Set the registry name +.SH SYNOPSIS +\fBstart\-cli registry info set\-name\fR [\fB\-h\fR|\fB\-\-help\fR] <\fINAME\fR> +.SH DESCRIPTION +Set the registry name +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fINAME\fR> +Name of the registry diff --git a/core/man/start-cli/start-cli-registry-info.1 b/core/man/start-cli/start-cli-registry-info.1 new file mode 100644 index 000000000..8556dbd3b --- /dev/null +++ b/core/man/start-cli/start-cli-registry-info.1 @@ -0,0 +1,23 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-info 1 "info " +.SH NAME +start\-cli\-registry\-info \- Display registry info +.SH SYNOPSIS +\fBstart\-cli registry info\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fIsubcommands\fR] +.SH DESCRIPTION +Display registry info +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-registry\-info\-set\-icon(1) +Set the registry icon +.TP +start\-cli\-registry\-info\-set\-name(1) +Set the registry name diff --git a/core/man/start-cli/start-cli-registry-os-asset-add.1 b/core/man/start-cli/start-cli-registry-os-asset-add.1 new file mode 100644 index 000000000..34d484abc --- /dev/null +++ b/core/man/start-cli/start-cli-registry-os-asset-add.1 @@ -0,0 +1,25 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-os-asset-add 1 "add " +.SH NAME +start\-cli\-registry\-os\-asset\-add \- Add asset to registry +.SH SYNOPSIS +\fBstart\-cli registry os asset add\fR <\fB\-p\fR|\fB\-\-platform\fR> <\fB\-v\fR|\fB\-\-version\fR> [\fB\-h\fR|\fB\-\-help\fR] <\fIFILE\fR> <\fIURL\fR> +.SH DESCRIPTION +Add asset to registry +.SH OPTIONS +.TP +\fB\-p\fR, \fB\-\-platform\fR \fI\fR +Target platform identifier +.TP +\fB\-v\fR, \fB\-\-version\fR \fI\fR +StartOS version number +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIFILE\fR> +Path to the asset file +.TP +<\fIURL\fR> +URL of the asset diff --git a/core/man/start-cli/start-cli-registry-os-asset-get-img.1 b/core/man/start-cli/start-cli-registry-os-asset-get-img.1 new file mode 100644 index 000000000..d69e2f0e0 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-os-asset-get-img.1 @@ -0,0 +1,25 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-os-asset-get-img 1 "img " +.SH NAME +start\-cli\-registry\-os\-asset\-get\-img \- Download IMG file +.SH SYNOPSIS +\fBstart\-cli registry os asset get img\fR [\fB\-d\fR|\fB\-\-download\fR] [\fB\-r\fR|\fB\-\-reverify\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIVERSION\fR> <\fIPLATFORM\fR> +.SH DESCRIPTION +Download IMG file +.SH OPTIONS +.TP +\fB\-d\fR, \fB\-\-download\fR \fI\fR +Directory path to download to +.TP +\fB\-r\fR, \fB\-\-reverify\fR +Verify hash after download completes +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIVERSION\fR> +StartOS version number +.TP +<\fIPLATFORM\fR> +Target platform identifier diff --git a/core/man/start-cli/start-cli-registry-os-asset-get-iso.1 b/core/man/start-cli/start-cli-registry-os-asset-get-iso.1 new file mode 100644 index 000000000..f71128e47 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-os-asset-get-iso.1 @@ -0,0 +1,25 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-os-asset-get-iso 1 "iso " +.SH NAME +start\-cli\-registry\-os\-asset\-get\-iso \- Download ISO file +.SH SYNOPSIS +\fBstart\-cli registry os asset get iso\fR [\fB\-d\fR|\fB\-\-download\fR] [\fB\-r\fR|\fB\-\-reverify\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIVERSION\fR> <\fIPLATFORM\fR> +.SH DESCRIPTION +Download ISO file +.SH OPTIONS +.TP +\fB\-d\fR, \fB\-\-download\fR \fI\fR +Directory path to download to +.TP +\fB\-r\fR, \fB\-\-reverify\fR +Verify hash after download completes +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIVERSION\fR> +StartOS version number +.TP +<\fIPLATFORM\fR> +Target platform identifier diff --git a/core/man/start-cli/start-cli-registry-os-asset-get-squashfs.1 b/core/man/start-cli/start-cli-registry-os-asset-get-squashfs.1 new file mode 100644 index 000000000..80a4aefdd --- /dev/null +++ b/core/man/start-cli/start-cli-registry-os-asset-get-squashfs.1 @@ -0,0 +1,25 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-os-asset-get-squashfs 1 "squashfs " +.SH NAME +start\-cli\-registry\-os\-asset\-get\-squashfs \- Download squashfs file +.SH SYNOPSIS +\fBstart\-cli registry os asset get squashfs\fR [\fB\-d\fR|\fB\-\-download\fR] [\fB\-r\fR|\fB\-\-reverify\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIVERSION\fR> <\fIPLATFORM\fR> +.SH DESCRIPTION +Download squashfs file +.SH OPTIONS +.TP +\fB\-d\fR, \fB\-\-download\fR \fI\fR +Directory path to download to +.TP +\fB\-r\fR, \fB\-\-reverify\fR +Verify hash after download completes +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIVERSION\fR> +StartOS version number +.TP +<\fIPLATFORM\fR> +Target platform identifier diff --git a/core/man/start-cli/start-cli-registry-os-asset-get.1 b/core/man/start-cli/start-cli-registry-os-asset-get.1 new file mode 100644 index 000000000..4e7a4c611 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-os-asset-get.1 @@ -0,0 +1,23 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-os-asset-get 1 "get " +.SH NAME +start\-cli\-registry\-os\-asset\-get \- Commands to download image, iso, or squashfs files +.SH SYNOPSIS +\fBstart\-cli registry os asset get\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands to download image, iso, or squashfs files +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-registry\-os\-asset\-get\-img(1) +Download IMG file +.TP +start\-cli\-registry\-os\-asset\-get\-iso(1) +Download ISO file +.TP +start\-cli\-registry\-os\-asset\-get\-squashfs(1) +Download squashfs file diff --git a/core/man/start-cli/start-cli-registry-os-asset-remove.1 b/core/man/start-cli/start-cli-registry-os-asset-remove.1 new file mode 100644 index 000000000..f1bf2aacb --- /dev/null +++ b/core/man/start-cli/start-cli-registry-os-asset-remove.1 @@ -0,0 +1,12 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-os-asset-remove 1 "remove " +.SH NAME +start\-cli\-registry\-os\-asset\-remove +.SH SYNOPSIS +\fBstart\-cli registry os asset remove\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-registry-os-asset-sign.1 b/core/man/start-cli/start-cli-registry-os-asset-sign.1 new file mode 100644 index 000000000..1316e1f05 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-os-asset-sign.1 @@ -0,0 +1,22 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-os-asset-sign 1 "sign " +.SH NAME +start\-cli\-registry\-os\-asset\-sign \- Sign file and add to registry +.SH SYNOPSIS +\fBstart\-cli registry os asset sign\fR <\fB\-p\fR|\fB\-\-platform\fR> <\fB\-v\fR|\fB\-\-version\fR> [\fB\-h\fR|\fB\-\-help\fR] <\fIFILE\fR> +.SH DESCRIPTION +Sign file and add to registry +.SH OPTIONS +.TP +\fB\-p\fR, \fB\-\-platform\fR \fI\fR +Target platform identifier +.TP +\fB\-v\fR, \fB\-\-version\fR \fI\fR +StartOS version number +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIFILE\fR> +Path to the asset file diff --git a/core/man/start-cli/start-cli-registry-os-asset.1 b/core/man/start-cli/start-cli-registry-os-asset.1 new file mode 100644 index 000000000..95f6ae704 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-os-asset.1 @@ -0,0 +1,25 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-os-asset 1 "asset " +.SH NAME +start\-cli\-registry\-os\-asset \- Commands to add, sign, or get registry assets +.SH SYNOPSIS +\fBstart\-cli registry os asset\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands to add, sign, or get registry assets +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-registry\-os\-asset\-add(1) +Add asset to registry +.TP +start\-cli\-registry\-os\-asset\-get(1) +Commands to download image, iso, or squashfs files +.TP +start\-cli\-registry\-os\-asset\-remove(1) +.TP +start\-cli\-registry\-os\-asset\-sign(1) +Sign file and add to registry diff --git a/core/man/start-cli/start-cli-registry-os-index.1 b/core/man/start-cli/start-cli-registry-os-index.1 new file mode 100644 index 000000000..8ec4f1859 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-os-index.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-os-index 1 "index " +.SH NAME +start\-cli\-registry\-os\-index \- List OS versions index +.SH SYNOPSIS +\fBstart\-cli registry os index\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +List OS versions index +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-registry-os-version-add.1 b/core/man/start-cli/start-cli-registry-os-version-add.1 new file mode 100644 index 000000000..d2a3f7974 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-os-version-add.1 @@ -0,0 +1,25 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-os-version-add 1 "add " +.SH NAME +start\-cli\-registry\-os\-version\-add \- Add OS version +.SH SYNOPSIS +\fBstart\-cli registry os version add\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIVERSION\fR> <\fIHEADLINE\fR> <\fIRELEASE_NOTES\fR> <\fISOURCE_VERSION\fR> +.SH DESCRIPTION +Add OS version +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIVERSION\fR> +StartOS version number +.TP +<\fIHEADLINE\fR> +Short headline for the version +.TP +<\fIRELEASE_NOTES\fR> +Release notes for this version +.TP +<\fISOURCE_VERSION\fR> +Source version range for migration diff --git a/core/man/start-cli/start-cli-registry-os-version-get.1 b/core/man/start-cli/start-cli-registry-os-version-get.1 new file mode 100644 index 000000000..4a411b055 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-os-version-get.1 @@ -0,0 +1,28 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-os-version-get 1 "get " +.SH NAME +start\-cli\-registry\-os\-version\-get \- Get OS versions info +.SH SYNOPSIS +\fBstart\-cli registry os version get\fR [\fB\-\-src\fR] [\fB\-\-target\-version\fR] [\fB\-\-id\fR] [\fB\-\-platform\fR] [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Get OS versions info +.SH OPTIONS +.TP +\fB\-\-src\fR \fI\fR +Source version to upgrade from +.TP +\fB\-\-target\-version\fR \fI\fR +Target version range constraint +.TP +\fB\-\-id\fR \fI\fR +Unique server identifier +.TP +\fB\-\-platform\fR \fI\fR +Target platform identifier +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-registry-os-version-remove.1 b/core/man/start-cli/start-cli-registry-os-version-remove.1 new file mode 100644 index 000000000..bec6b7af1 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-os-version-remove.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-os-version-remove 1 "remove " +.SH NAME +start\-cli\-registry\-os\-version\-remove \- Remove OS version +.SH SYNOPSIS +\fBstart\-cli registry os version remove\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIVERSION\fR> +.SH DESCRIPTION +Remove OS version +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIVERSION\fR> +StartOS version number diff --git a/core/man/start-cli/start-cli-registry-os-version-signer-add.1 b/core/man/start-cli/start-cli-registry-os-version-signer-add.1 new file mode 100644 index 000000000..38baa3e36 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-os-version-signer-add.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-os-version-signer-add 1 "add " +.SH NAME +start\-cli\-registry\-os\-version\-signer\-add \- Add version signer +.SH SYNOPSIS +\fBstart\-cli registry os version signer add\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIVERSION\fR> <\fISIGNER\fR> +.SH DESCRIPTION +Add version signer +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIVERSION\fR> + +.TP +<\fISIGNER\fR> + diff --git a/core/man/start-cli/start-cli-registry-os-version-signer-list.1 b/core/man/start-cli/start-cli-registry-os-version-signer-list.1 new file mode 100644 index 000000000..3f18d1d69 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-os-version-signer-list.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-os-version-signer-list 1 "list " +.SH NAME +start\-cli\-registry\-os\-version\-signer\-list \- List version signers +.SH SYNOPSIS +\fBstart\-cli registry os version signer list\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIVERSION\fR> +.SH DESCRIPTION +List version signers +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIVERSION\fR> + diff --git a/core/man/start-cli/start-cli-registry-os-version-signer-remove.1 b/core/man/start-cli/start-cli-registry-os-version-signer-remove.1 new file mode 100644 index 000000000..2a650ff39 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-os-version-signer-remove.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-os-version-signer-remove 1 "remove " +.SH NAME +start\-cli\-registry\-os\-version\-signer\-remove \- Remove version signer +.SH SYNOPSIS +\fBstart\-cli registry os version signer remove\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIVERSION\fR> <\fISIGNER\fR> +.SH DESCRIPTION +Remove version signer +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIVERSION\fR> + +.TP +<\fISIGNER\fR> + diff --git a/core/man/start-cli/start-cli-registry-os-version-signer.1 b/core/man/start-cli/start-cli-registry-os-version-signer.1 new file mode 100644 index 000000000..764c97c94 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-os-version-signer.1 @@ -0,0 +1,23 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-os-version-signer 1 "signer " +.SH NAME +start\-cli\-registry\-os\-version\-signer \- Add, remove, and list version signers +.SH SYNOPSIS +\fBstart\-cli registry os version signer\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Add, remove, and list version signers +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-registry\-os\-version\-signer\-add(1) +Add version signer +.TP +start\-cli\-registry\-os\-version\-signer\-list(1) +List version signers +.TP +start\-cli\-registry\-os\-version\-signer\-remove(1) +Remove version signer diff --git a/core/man/start-cli/start-cli-registry-os-version.1 b/core/man/start-cli/start-cli-registry-os-version.1 new file mode 100644 index 000000000..b205e9db0 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-os-version.1 @@ -0,0 +1,26 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-os-version 1 "version " +.SH NAME +start\-cli\-registry\-os\-version \- Commands to add, remove, or list versions or version signers +.SH SYNOPSIS +\fBstart\-cli registry os version\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands to add, remove, or list versions or version signers +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-registry\-os\-version\-add(1) +Add OS version +.TP +start\-cli\-registry\-os\-version\-get(1) +Get OS versions info +.TP +start\-cli\-registry\-os\-version\-remove(1) +Remove OS version +.TP +start\-cli\-registry\-os\-version\-signer(1) +Add, remove, and list version signers diff --git a/core/man/start-cli/start-cli-registry-os.1 b/core/man/start-cli/start-cli-registry-os.1 new file mode 100644 index 000000000..1a60e9915 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-os.1 @@ -0,0 +1,23 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-os 1 "os " +.SH NAME +start\-cli\-registry\-os \- Commands related to OS assets and versions +.SH SYNOPSIS +\fBstart\-cli registry os\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands related to OS assets and versions +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-registry\-os\-asset(1) +Commands to add, sign, or get registry assets +.TP +start\-cli\-registry\-os\-index(1) +List OS versions index +.TP +start\-cli\-registry\-os\-version(1) +Commands to add, remove, or list versions or version signers diff --git a/core/man/start-cli/start-cli-registry-package-add-mirror.1 b/core/man/start-cli/start-cli-registry-package-add-mirror.1 new file mode 100644 index 000000000..56bb6d474 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-package-add-mirror.1 @@ -0,0 +1,22 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-package-add-mirror 1 "add-mirror " +.SH NAME +start\-cli\-registry\-package\-add\-mirror \- Add a mirror for an s9pk +.SH SYNOPSIS +\fBstart\-cli registry package add\-mirror\fR [\fB\-\-no\-verify\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIFILE\fR> <\fIURL\fR> +.SH DESCRIPTION +Add a mirror for an s9pk +.SH OPTIONS +.TP +\fB\-\-no\-verify\fR +Skip signature verification +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIFILE\fR> +Path to s9pk package file +.TP +<\fIURL\fR> +URL of the mirror diff --git a/core/man/start-cli/start-cli-registry-package-add.1 b/core/man/start-cli/start-cli-registry-package-add.1 new file mode 100644 index 000000000..b2f7f2538 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-package-add.1 @@ -0,0 +1,22 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-package-add 1 "add " +.SH NAME +start\-cli\-registry\-package\-add \- Add package to registry index +.SH SYNOPSIS +\fBstart\-cli registry package add\fR [\fB\-\-url\fR] [\fB\-\-no\-verify\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIFILE\fR> +.SH DESCRIPTION +Add package to registry index +.SH OPTIONS +.TP +\fB\-\-url\fR \fI\fR +URL of the package +.TP +\fB\-\-no\-verify\fR +Skip signature verification +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIFILE\fR> +Path to s9pk package file diff --git a/core/man/start-cli/start-cli-registry-package-category-add-package.1 b/core/man/start-cli/start-cli-registry-package-category-add-package.1 new file mode 100644 index 000000000..4d28f3d2f --- /dev/null +++ b/core/man/start-cli/start-cli-registry-package-category-add-package.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-package-category-add-package 1 "add-package " +.SH NAME +start\-cli\-registry\-package\-category\-add\-package \- Add a package to a category +.SH SYNOPSIS +\fBstart\-cli registry package category add\-package\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIID\fR> <\fIPACKAGE\fR> +.SH DESCRIPTION +Add a package to a category +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIID\fR> + +.TP +<\fIPACKAGE\fR> + diff --git a/core/man/start-cli/start-cli-registry-package-category-add.1 b/core/man/start-cli/start-cli-registry-package-category-add.1 new file mode 100644 index 000000000..f50e87972 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-package-category-add.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-package-category-add 1 "add " +.SH NAME +start\-cli\-registry\-package\-category\-add \- Add a category to the registry +.SH SYNOPSIS +\fBstart\-cli registry package category add\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIID\fR> <\fINAME\fR> +.SH DESCRIPTION +Add a category to the registry +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIID\fR> + +.TP +<\fINAME\fR> + diff --git a/core/man/start-cli/start-cli-registry-package-category-list.1 b/core/man/start-cli/start-cli-registry-package-category-list.1 new file mode 100644 index 000000000..2e53a90b4 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-package-category-list.1 @@ -0,0 +1,15 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-package-category-list 1 "list " +.SH NAME +start\-cli\-registry\-package\-category\-list +.SH SYNOPSIS +\fBstart\-cli registry package category list\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-registry-package-category-remove-package.1 b/core/man/start-cli/start-cli-registry-package-category-remove-package.1 new file mode 100644 index 000000000..31bb9e272 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-package-category-remove-package.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-package-category-remove-package 1 "remove-package " +.SH NAME +start\-cli\-registry\-package\-category\-remove\-package \- Remove package from category +.SH SYNOPSIS +\fBstart\-cli registry package category remove\-package\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIID\fR> <\fIPACKAGE\fR> +.SH DESCRIPTION +Remove package from category +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIID\fR> + +.TP +<\fIPACKAGE\fR> + diff --git a/core/man/start-cli/start-cli-registry-package-category-remove.1 b/core/man/start-cli/start-cli-registry-package-category-remove.1 new file mode 100644 index 000000000..ee83ef7c2 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-package-category-remove.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-package-category-remove 1 "remove " +.SH NAME +start\-cli\-registry\-package\-category\-remove \- Remove category from registry +.SH SYNOPSIS +\fBstart\-cli registry package category remove\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIID\fR> +.SH DESCRIPTION +Remove category from registry +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIID\fR> + diff --git a/core/man/start-cli/start-cli-registry-package-category.1 b/core/man/start-cli/start-cli-registry-package-category.1 new file mode 100644 index 000000000..f4304c19b --- /dev/null +++ b/core/man/start-cli/start-cli-registry-package-category.1 @@ -0,0 +1,28 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-package-category 1 "category " +.SH NAME +start\-cli\-registry\-package\-category \- Update categories in registry +.SH SYNOPSIS +\fBstart\-cli registry package category\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Update categories in registry +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-registry\-package\-category\-add(1) +Add a category to the registry +.TP +start\-cli\-registry\-package\-category\-add\-package(1) +Add a package to a category +.TP +start\-cli\-registry\-package\-category\-list(1) +.TP +start\-cli\-registry\-package\-category\-remove(1) +Remove category from registry +.TP +start\-cli\-registry\-package\-category\-remove\-package(1) +Remove package from category diff --git a/core/man/start-cli/start-cli-registry-package-download.1 b/core/man/start-cli/start-cli-registry-package-download.1 new file mode 100644 index 000000000..a229b85ad --- /dev/null +++ b/core/man/start-cli/start-cli-registry-package-download.1 @@ -0,0 +1,22 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-package-download 1 "download " +.SH NAME +start\-cli\-registry\-package\-download \- Download s9pk package +.SH SYNOPSIS +\fBstart\-cli registry package download\fR [\fB\-v\fR|\fB\-\-target\-version\fR] [\fB\-d\fR|\fB\-\-dest\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIID\fR> +.SH DESCRIPTION +Download s9pk package +.SH OPTIONS +.TP +\fB\-v\fR, \fB\-\-target\-version\fR \fI\fR +Target version range constraint +.TP +\fB\-d\fR, \fB\-\-dest\fR \fI\fR +Destination path for download +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIID\fR> +Package identifier diff --git a/core/man/start-cli/start-cli-registry-package-get.1 b/core/man/start-cli/start-cli-registry-package-get.1 new file mode 100644 index 000000000..fa176e313 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-package-get.1 @@ -0,0 +1,40 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-package-get 1 "get " +.SH NAME +start\-cli\-registry\-package\-get \- List installation candidates +.SH SYNOPSIS +\fBstart\-cli registry package get\fR [\fB\-v\fR|\fB\-\-target\-version\fR] [\fB\-\-source\-version\fR] [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fIID\fR] [\fIOTHER_VERSIONS\fR] +.SH DESCRIPTION +List installation candidates +.SH OPTIONS +.TP +\fB\-v\fR, \fB\-\-target\-version\fR \fI\fR +Target version range constraint +.TP +\fB\-\-source\-version\fR \fI\fR +Source version to upgrade from +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +[\fIID\fR] +Package identifier +.TP +[\fIOTHER_VERSIONS\fR] [default: none] +Detail level for other versions +.br + +.br +\fIPossible values:\fR +.RS 14 +.IP \(bu 2 +none +.IP \(bu 2 +short +.IP \(bu 2 +full +.RE diff --git a/core/man/start-cli/start-cli-registry-package-index.1 b/core/man/start-cli/start-cli-registry-package-index.1 new file mode 100644 index 000000000..309ba1437 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-package-index.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-package-index 1 "index " +.SH NAME +start\-cli\-registry\-package\-index \- List packages and categories +.SH SYNOPSIS +\fBstart\-cli registry package index\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +List packages and categories +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-registry-package-remove-mirror.1 b/core/man/start-cli/start-cli-registry-package-remove-mirror.1 new file mode 100644 index 000000000..fcfd1b949 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-package-remove-mirror.1 @@ -0,0 +1,22 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-package-remove-mirror 1 "remove-mirror " +.SH NAME +start\-cli\-registry\-package\-remove\-mirror \- Remove mirror package +.SH SYNOPSIS +\fBstart\-cli registry package remove\-mirror\fR <\fB\-\-url\fR> [\fB\-h\fR|\fB\-\-help\fR] <\fIID\fR> <\fIVERSION\fR> +.SH DESCRIPTION +Remove mirror package +.SH OPTIONS +.TP +\fB\-\-url\fR \fI\fR +URL of the mirror +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIID\fR> +Package identifier +.TP +<\fIVERSION\fR> +Package version diff --git a/core/man/start-cli/start-cli-registry-package-remove.1 b/core/man/start-cli/start-cli-registry-package-remove.1 new file mode 100644 index 000000000..ca3412740 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-package-remove.1 @@ -0,0 +1,22 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-package-remove 1 "remove " +.SH NAME +start\-cli\-registry\-package\-remove \- Remove package from registry +.SH SYNOPSIS +\fBstart\-cli registry package remove\fR [\fB\-\-sighash\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIID\fR> <\fIVERSION\fR> +.SH DESCRIPTION +Remove package from registry +.SH OPTIONS +.TP +\fB\-\-sighash\fR \fI\fR +Hash for signature verification +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIID\fR> +Package identifier +.TP +<\fIVERSION\fR> +Package version diff --git a/core/man/start-cli/start-cli-registry-package-signer-add.1 b/core/man/start-cli/start-cli-registry-package-signer-add.1 new file mode 100644 index 000000000..99757c6b1 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-package-signer-add.1 @@ -0,0 +1,25 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-package-signer-add 1 "add " +.SH NAME +start\-cli\-registry\-package\-signer\-add \- Add package signer +.SH SYNOPSIS +\fBstart\-cli registry package signer add\fR [\fB\-\-versions\fR] [\fB\-\-merge\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIID\fR> <\fISIGNER\fR> +.SH DESCRIPTION +Add package signer +.SH OPTIONS +.TP +\fB\-\-versions\fR \fI\fR +Version range constraint +.TP +\fB\-\-merge\fR +Merge with existing version range instead of replacing +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIID\fR> +Package identifier +.TP +<\fISIGNER\fR> +Signer identifier diff --git a/core/man/start-cli/start-cli-registry-package-signer-list.1 b/core/man/start-cli/start-cli-registry-package-signer-list.1 new file mode 100644 index 000000000..c27a61ba2 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-package-signer-list.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-package-signer-list 1 "list " +.SH NAME +start\-cli\-registry\-package\-signer\-list \- List package signers +.SH SYNOPSIS +\fBstart\-cli registry package signer list\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIID\fR> +.SH DESCRIPTION +List package signers +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIID\fR> +Package identifier diff --git a/core/man/start-cli/start-cli-registry-package-signer-remove.1 b/core/man/start-cli/start-cli-registry-package-signer-remove.1 new file mode 100644 index 000000000..ccb973964 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-package-signer-remove.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-package-signer-remove 1 "remove " +.SH NAME +start\-cli\-registry\-package\-signer\-remove \- Remove package signer +.SH SYNOPSIS +\fBstart\-cli registry package signer remove\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIID\fR> <\fISIGNER\fR> +.SH DESCRIPTION +Remove package signer +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIID\fR> +Package identifier +.TP +<\fISIGNER\fR> +Signer identifier diff --git a/core/man/start-cli/start-cli-registry-package-signer.1 b/core/man/start-cli/start-cli-registry-package-signer.1 new file mode 100644 index 000000000..f98bf213e --- /dev/null +++ b/core/man/start-cli/start-cli-registry-package-signer.1 @@ -0,0 +1,23 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-package-signer 1 "signer " +.SH NAME +start\-cli\-registry\-package\-signer \- Add, remove, and list package signers +.SH SYNOPSIS +\fBstart\-cli registry package signer\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Add, remove, and list package signers +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-registry\-package\-signer\-add(1) +Add package signer +.TP +start\-cli\-registry\-package\-signer\-list(1) +List package signers +.TP +start\-cli\-registry\-package\-signer\-remove(1) +Remove package signer diff --git a/core/man/start-cli/start-cli-registry-package.1 b/core/man/start-cli/start-cli-registry-package.1 new file mode 100644 index 000000000..6f8192643 --- /dev/null +++ b/core/man/start-cli/start-cli-registry-package.1 @@ -0,0 +1,41 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry-package 1 "package " +.SH NAME +start\-cli\-registry\-package \- Commands to index, add, or get packages +.SH SYNOPSIS +\fBstart\-cli registry package\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands to index, add, or get packages +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-registry\-package\-add(1) +Add package to registry index +.TP +start\-cli\-registry\-package\-add\-mirror(1) +Add a mirror for an s9pk +.TP +start\-cli\-registry\-package\-category(1) +Update categories in registry +.TP +start\-cli\-registry\-package\-download(1) +Download s9pk package +.TP +start\-cli\-registry\-package\-get(1) +List installation candidates +.TP +start\-cli\-registry\-package\-index(1) +List packages and categories +.TP +start\-cli\-registry\-package\-remove(1) +Remove package from registry +.TP +start\-cli\-registry\-package\-remove\-mirror(1) +Remove mirror package +.TP +start\-cli\-registry\-package\-signer(1) +Add, remove, and list package signers diff --git a/core/man/start-cli/start-cli-registry.1 b/core/man/start-cli/start-cli-registry.1 new file mode 100644 index 000000000..62952a830 --- /dev/null +++ b/core/man/start-cli/start-cli-registry.1 @@ -0,0 +1,32 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-registry 1 "registry " +.SH NAME +start\-cli\-registry \- Commands related to the registry +.SH SYNOPSIS +\fBstart\-cli registry\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands related to the registry +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-registry\-admin(1) +Commands to add or list admins or signers +.TP +start\-cli\-registry\-db(1) +Commands to interact with the db i.e. dump and apply +.TP +start\-cli\-registry\-index(1) +List registry info and packages +.TP +start\-cli\-registry\-info(1) +Display registry info +.TP +start\-cli\-registry\-os(1) +Commands related to OS assets and versions +.TP +start\-cli\-registry\-package(1) +Commands to index, add, or get packages diff --git a/core/man/start-cli/start-cli-s9pk-convert.1 b/core/man/start-cli/start-cli-s9pk-convert.1 new file mode 100644 index 000000000..4fb35556b --- /dev/null +++ b/core/man/start-cli/start-cli-s9pk-convert.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-s9pk-convert 1 "convert " +.SH NAME +start\-cli\-s9pk\-convert \- Convert an s9pk from v1 to v2 +.SH SYNOPSIS +\fBstart\-cli s9pk convert\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIS9PK\fR> +.SH DESCRIPTION +Convert an s9pk from v1 to v2 +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIS9PK\fR> +Path to s9pk package file diff --git a/core/man/start-cli/start-cli-s9pk-edit-add-image.1 b/core/man/start-cli/start-cli-s9pk-edit-add-image.1 new file mode 100644 index 000000000..ea08b5084 --- /dev/null +++ b/core/man/start-cli/start-cli-s9pk-edit-add-image.1 @@ -0,0 +1,37 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-s9pk-edit-add-image 1 "add-image " +.SH NAME +start\-cli\-s9pk\-edit\-add\-image \- Add image to s9pk +.SH SYNOPSIS +\fBstart\-cli s9pk edit add\-image\fR [\fB\-\-docker\-build\fR] [\fB\-\-dockerfile\fR] [\fB\-\-workdir\fR] [\fB\-\-docker\-tag\fR] [\fB\-\-arch\fR] [\fB\-\-emulate\-missing\-as\fR] [\fB\-\-nvidia\-container\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIID\fR> +.SH DESCRIPTION +Add image to s9pk +.SH OPTIONS +.TP +\fB\-\-docker\-build\fR +Build Docker image from Dockerfile +.TP +\fB\-\-dockerfile\fR \fI\fR +Path to Dockerfile +.TP +\fB\-\-workdir\fR \fI\fR +Working directory path +.TP +\fB\-\-docker\-tag\fR \fI\fR +Docker image tag to use +.TP +\fB\-\-arch\fR \fI\fR +Filter by CPU architecture +.TP +\fB\-\-emulate\-missing\-as\fR \fI\fR +Emulate missing architecture using this one +.TP +\fB\-\-nvidia\-container\fR +Enable NVIDIA container support +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIID\fR> +Docker image identifier diff --git a/core/man/start-cli/start-cli-s9pk-edit-manifest.1 b/core/man/start-cli/start-cli-s9pk-edit-manifest.1 new file mode 100644 index 000000000..b3146de51 --- /dev/null +++ b/core/man/start-cli/start-cli-s9pk-edit-manifest.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-s9pk-edit-manifest 1 "manifest " +.SH NAME +start\-cli\-s9pk\-edit\-manifest \- Edit s9pk manifest +.SH SYNOPSIS +\fBstart\-cli s9pk edit manifest\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIEXPRESSION\fR> +.SH DESCRIPTION +Edit s9pk manifest +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIEXPRESSION\fR> +Database patch expression to apply diff --git a/core/man/start-cli/start-cli-s9pk-edit.1 b/core/man/start-cli/start-cli-s9pk-edit.1 new file mode 100644 index 000000000..fa66f3353 --- /dev/null +++ b/core/man/start-cli/start-cli-s9pk-edit.1 @@ -0,0 +1,23 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-s9pk-edit 1 "edit " +.SH NAME +start\-cli\-s9pk\-edit \- Commands to add an image to an s9pk or edit the manifest +.SH SYNOPSIS +\fBstart\-cli s9pk edit\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIS9PK\fR> <\fIsubcommands\fR> +.SH DESCRIPTION +Commands to add an image to an s9pk or edit the manifest +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIS9PK\fR> +Path to s9pk package file +.SH SUBCOMMANDS +.TP +start\-cli\-s9pk\-edit\-add\-image(1) +Add image to s9pk +.TP +start\-cli\-s9pk\-edit\-manifest(1) +Edit s9pk manifest diff --git a/core/man/start-cli/start-cli-s9pk-inspect-cat.1 b/core/man/start-cli/start-cli-s9pk-inspect-cat.1 new file mode 100644 index 000000000..c41b83384 --- /dev/null +++ b/core/man/start-cli/start-cli-s9pk-inspect-cat.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-s9pk-inspect-cat 1 "cat " +.SH NAME +start\-cli\-s9pk\-inspect\-cat \- Display file contents from s9pk +.SH SYNOPSIS +\fBstart\-cli s9pk inspect cat\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIFILE_PATH\fR> +.SH DESCRIPTION +Display file contents from s9pk +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIFILE_PATH\fR> +Path to the file diff --git a/core/man/start-cli/start-cli-s9pk-inspect-commitment.1 b/core/man/start-cli/start-cli-s9pk-inspect-commitment.1 new file mode 100644 index 000000000..15168091a --- /dev/null +++ b/core/man/start-cli/start-cli-s9pk-inspect-commitment.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-s9pk-inspect-commitment 1 "commitment " +.SH NAME +start\-cli\-s9pk\-inspect\-commitment \- about.display\-s9pk\-root\-sighash\-and\-maxsize +.SH SYNOPSIS +\fBstart\-cli s9pk inspect commitment\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +about.display\-s9pk\-root\-sighash\-and\-maxsize +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-s9pk-inspect-file-tree.1 b/core/man/start-cli/start-cli-s9pk-inspect-file-tree.1 new file mode 100644 index 000000000..17247bd49 --- /dev/null +++ b/core/man/start-cli/start-cli-s9pk-inspect-file-tree.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-s9pk-inspect-file-tree 1 "file-tree " +.SH NAME +start\-cli\-s9pk\-inspect\-file\-tree \- Display list of paths in s9pk +.SH SYNOPSIS +\fBstart\-cli s9pk inspect file\-tree\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Display list of paths in s9pk +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-s9pk-inspect-manifest.1 b/core/man/start-cli/start-cli-s9pk-inspect-manifest.1 new file mode 100644 index 000000000..19bac61fc --- /dev/null +++ b/core/man/start-cli/start-cli-s9pk-inspect-manifest.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-s9pk-inspect-manifest 1 "manifest " +.SH NAME +start\-cli\-s9pk\-inspect\-manifest \- Display the s9pk manifest +.SH SYNOPSIS +\fBstart\-cli s9pk inspect manifest\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Display the s9pk manifest +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-s9pk-inspect.1 b/core/man/start-cli/start-cli-s9pk-inspect.1 new file mode 100644 index 000000000..ddd23c1f8 --- /dev/null +++ b/core/man/start-cli/start-cli-s9pk-inspect.1 @@ -0,0 +1,29 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-s9pk-inspect 1 "inspect " +.SH NAME +start\-cli\-s9pk\-inspect \- Commands to display file paths, file contents, or manifest +.SH SYNOPSIS +\fBstart\-cli s9pk inspect\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIS9PK\fR> <\fIsubcommands\fR> +.SH DESCRIPTION +Commands to display file paths, file contents, or manifest +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIS9PK\fR> +Path to s9pk package file +.SH SUBCOMMANDS +.TP +start\-cli\-s9pk\-inspect\-cat(1) +Display file contents from s9pk +.TP +start\-cli\-s9pk\-inspect\-commitment(1) +about.display\-s9pk\-root\-sighash\-and\-maxsize +.TP +start\-cli\-s9pk\-inspect\-file\-tree(1) +Display list of paths in s9pk +.TP +start\-cli\-s9pk\-inspect\-manifest(1) +Display the s9pk manifest diff --git a/core/man/start-cli/start-cli-s9pk-list-ingredients.1 b/core/man/start-cli/start-cli-s9pk-list-ingredients.1 new file mode 100644 index 000000000..b2e6de92f --- /dev/null +++ b/core/man/start-cli/start-cli-s9pk-list-ingredients.1 @@ -0,0 +1,37 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-s9pk-list-ingredients 1 "list-ingredients " +.SH NAME +start\-cli\-s9pk\-list\-ingredients \- List paths of package ingredients +.SH SYNOPSIS +\fBstart\-cli s9pk list\-ingredients\fR [\fB\-o\fR|\fB\-\-output\fR] [\fB\-\-javascript\fR] [\fB\-\-icon\fR] [\fB\-\-license\fR] [\fB\-\-assets\fR] [\fB\-\-no\-assets\fR] [\fB\-\-arch\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fIPATH\fR] +.SH DESCRIPTION +List paths of package ingredients +.SH OPTIONS +.TP +\fB\-o\fR, \fB\-\-output\fR \fI\fR +Output file path +.TP +\fB\-\-javascript\fR \fI\fR +Path to JavaScript file +.TP +\fB\-\-icon\fR \fI\fR +Path to service icon file +.TP +\fB\-\-license\fR \fI\fR +Path to license file +.TP +\fB\-\-assets\fR \fI\fR +Path to assets directory +.TP +\fB\-\-no\-assets\fR +Build without assets directory +.TP +\fB\-\-arch\fR \fI\fR +Filter by CPU architecture +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +[\fIPATH\fR] +Path to input file or directory diff --git a/core/man/start-cli/start-cli-s9pk-pack.1 b/core/man/start-cli/start-cli-s9pk-pack.1 new file mode 100644 index 000000000..c8d956a95 --- /dev/null +++ b/core/man/start-cli/start-cli-s9pk-pack.1 @@ -0,0 +1,37 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-s9pk-pack 1 "pack " +.SH NAME +start\-cli\-s9pk\-pack \- Package input files into a valid s9pk +.SH SYNOPSIS +\fBstart\-cli s9pk pack\fR [\fB\-o\fR|\fB\-\-output\fR] [\fB\-\-javascript\fR] [\fB\-\-icon\fR] [\fB\-\-license\fR] [\fB\-\-assets\fR] [\fB\-\-no\-assets\fR] [\fB\-\-arch\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fIPATH\fR] +.SH DESCRIPTION +Package input files into a valid s9pk +.SH OPTIONS +.TP +\fB\-o\fR, \fB\-\-output\fR \fI\fR +Output file path +.TP +\fB\-\-javascript\fR \fI\fR +Path to JavaScript file +.TP +\fB\-\-icon\fR \fI\fR +Path to service icon file +.TP +\fB\-\-license\fR \fI\fR +Path to license file +.TP +\fB\-\-assets\fR \fI\fR +Path to assets directory +.TP +\fB\-\-no\-assets\fR +Build without assets directory +.TP +\fB\-\-arch\fR \fI\fR +Filter by CPU architecture +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +[\fIPATH\fR] +Path to input file or directory diff --git a/core/man/start-cli/start-cli-s9pk-publish.1 b/core/man/start-cli/start-cli-s9pk-publish.1 new file mode 100644 index 000000000..bfdbde500 --- /dev/null +++ b/core/man/start-cli/start-cli-s9pk-publish.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-s9pk-publish 1 "publish " +.SH NAME +start\-cli\-s9pk\-publish \- Publish s9pk to S3 bucket and index on registry +.SH SYNOPSIS +\fBstart\-cli s9pk publish\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIS9PK\fR> +.SH DESCRIPTION +Publish s9pk to S3 bucket and index on registry +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIS9PK\fR> +Path to s9pk package file diff --git a/core/man/start-cli/start-cli-s9pk-select.1 b/core/man/start-cli/start-cli-s9pk-select.1 new file mode 100644 index 000000000..95a88faea --- /dev/null +++ b/core/man/start-cli/start-cli-s9pk-select.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-s9pk-select 1 "select " +.SH NAME +start\-cli\-s9pk\-select \- Select the best compatible s9pk for a target device +.SH SYNOPSIS +\fBstart\-cli s9pk select\fR [\fB\-h\fR|\fB\-\-help\fR] [\fIS9PKS\fR] +.SH DESCRIPTION +Select the best compatible s9pk for a target device +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +[\fIS9PKS\fR] +Paths to s9pk package files diff --git a/core/man/start-cli/start-cli-s9pk.1 b/core/man/start-cli/start-cli-s9pk.1 new file mode 100644 index 000000000..6b182760d --- /dev/null +++ b/core/man/start-cli/start-cli-s9pk.1 @@ -0,0 +1,35 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-s9pk 1 "s9pk " +.SH NAME +start\-cli\-s9pk \- Commands for interacting with s9pk files +.SH SYNOPSIS +\fBstart\-cli s9pk\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands for interacting with s9pk files +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-s9pk\-convert(1) +Convert an s9pk from v1 to v2 +.TP +start\-cli\-s9pk\-edit(1) +Commands to add an image to an s9pk or edit the manifest +.TP +start\-cli\-s9pk\-inspect(1) +Commands to display file paths, file contents, or manifest +.TP +start\-cli\-s9pk\-list\-ingredients(1) +List paths of package ingredients +.TP +start\-cli\-s9pk\-pack(1) +Package input files into a valid s9pk +.TP +start\-cli\-s9pk\-publish(1) +Publish s9pk to S3 bucket and index on registry +.TP +start\-cli\-s9pk\-select(1) +Select the best compatible s9pk for a target device diff --git a/core/man/start-cli/start-cli-server-clear-smtp.1 b/core/man/start-cli/start-cli-server-clear-smtp.1 new file mode 100644 index 000000000..d102ff66a --- /dev/null +++ b/core/man/start-cli/start-cli-server-clear-smtp.1 @@ -0,0 +1,13 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-clear-smtp 1 "clear-smtp " +.SH NAME +start\-cli\-server\-clear\-smtp \- Remove system smtp server and credentials +.SH SYNOPSIS +\fBstart\-cli server clear\-smtp\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Remove system smtp server and credentials +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-server-device-info.1 b/core/man/start-cli/start-cli-server-device-info.1 new file mode 100644 index 000000000..9b5177106 --- /dev/null +++ b/core/man/start-cli/start-cli-server-device-info.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-device-info 1 "device-info " +.SH NAME +start\-cli\-server\-device\-info \- about.get\-device\-info +.SH SYNOPSIS +\fBstart\-cli server device\-info\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +about.get\-device\-info +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-server-experimental-governor.1 b/core/man/start-cli/start-cli-server-experimental-governor.1 new file mode 100644 index 000000000..cf3743f9d --- /dev/null +++ b/core/man/start-cli/start-cli-server-experimental-governor.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-experimental-governor 1 "governor " +.SH NAME +start\-cli\-server\-experimental\-governor \- Show CPU governors +.SH SYNOPSIS +\fBstart\-cli server experimental governor\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fISET\fR] +.SH DESCRIPTION +Show CPU governors +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +[\fISET\fR] +CPU governor name diff --git a/core/man/start-cli/start-cli-server-experimental-zram.1 b/core/man/start-cli/start-cli-server-experimental-zram.1 new file mode 100644 index 000000000..a3472ac88 --- /dev/null +++ b/core/man/start-cli/start-cli-server-experimental-zram.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-experimental-zram 1 "zram " +.SH NAME +start\-cli\-server\-experimental\-zram \- Enable ZRAM +.SH SYNOPSIS +\fBstart\-cli server experimental zram\fR [\fB\-\-enable\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Enable ZRAM +.SH OPTIONS +.TP +\fB\-\-enable\fR +Enable zram +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-server-experimental.1 b/core/man/start-cli/start-cli-server-experimental.1 new file mode 100644 index 000000000..f9d023cf8 --- /dev/null +++ b/core/man/start-cli/start-cli-server-experimental.1 @@ -0,0 +1,20 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-experimental 1 "experimental " +.SH NAME +start\-cli\-server\-experimental \- Commands related to configuring experimental options such as zram and cpu governor +.SH SYNOPSIS +\fBstart\-cli server experimental\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands related to configuring experimental options such as zram and cpu governor +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-server\-experimental\-governor(1) +Show CPU governors +.TP +start\-cli\-server\-experimental\-zram(1) +Enable ZRAM diff --git a/core/man/start-cli/start-cli-server-host-address-domain-private-add.1 b/core/man/start-cli/start-cli-server-host-address-domain-private-add.1 new file mode 100644 index 000000000..296fa09ce --- /dev/null +++ b/core/man/start-cli/start-cli-server-host-address-domain-private-add.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-host-address-domain-private-add 1 "add " +.SH NAME +start\-cli\-server\-host\-address\-domain\-private\-add \- Add a private domain to this host +.SH SYNOPSIS +\fBstart\-cli server host address domain private add\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIFQDN\fR> <\fIGATEWAY\fR> +.SH DESCRIPTION +Add a private domain to this host +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIFQDN\fR> +Fully qualified domain name +.TP +<\fIGATEWAY\fR> + diff --git a/core/man/start-cli/start-cli-server-host-address-domain-private-remove.1 b/core/man/start-cli/start-cli-server-host-address-domain-private-remove.1 new file mode 100644 index 000000000..81e9ae57c --- /dev/null +++ b/core/man/start-cli/start-cli-server-host-address-domain-private-remove.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-host-address-domain-private-remove 1 "remove " +.SH NAME +start\-cli\-server\-host\-address\-domain\-private\-remove \- Remove private domain from host +.SH SYNOPSIS +\fBstart\-cli server host address domain private remove\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIFQDN\fR> +.SH DESCRIPTION +Remove private domain from host +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIFQDN\fR> +Fully qualified domain name diff --git a/core/man/start-cli/start-cli-server-host-address-domain-private.1 b/core/man/start-cli/start-cli-server-host-address-domain-private.1 new file mode 100644 index 000000000..dce763f63 --- /dev/null +++ b/core/man/start-cli/start-cli-server-host-address-domain-private.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-host-address-domain-private 1 "private " +.SH NAME +start\-cli\-server\-host\-address\-domain\-private +.SH SYNOPSIS +\fBstart\-cli server host address domain private\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-server\-host\-address\-domain\-private\-add(1) +Add a private domain to this host +.TP +start\-cli\-server\-host\-address\-domain\-private\-remove(1) +Remove private domain from host diff --git a/core/man/start-cli/start-cli-server-host-address-domain-public-add.1 b/core/man/start-cli/start-cli-server-host-address-domain-public-add.1 new file mode 100644 index 000000000..5b31fd5b3 --- /dev/null +++ b/core/man/start-cli/start-cli-server-host-address-domain-public-add.1 @@ -0,0 +1,25 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-host-address-domain-public-add 1 "add " +.SH NAME +start\-cli\-server\-host\-address\-domain\-public\-add \- Add a public domain to this host +.SH SYNOPSIS +\fBstart\-cli server host address domain public add\fR [\fB\-\-acme\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIFQDN\fR> <\fIGATEWAY\fR> <\fIINTERNAL_PORT\fR> +.SH DESCRIPTION +Add a public domain to this host +.SH OPTIONS +.TP +\fB\-\-acme\fR \fI\fR +ACME provider identifier or url +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIFQDN\fR> +Fully qualified domain name +.TP +<\fIGATEWAY\fR> +Gateway identifier +.TP +<\fIINTERNAL_PORT\fR> +Internal port number diff --git a/core/man/start-cli/start-cli-server-host-address-domain-public-remove.1 b/core/man/start-cli/start-cli-server-host-address-domain-public-remove.1 new file mode 100644 index 000000000..d4e4541aa --- /dev/null +++ b/core/man/start-cli/start-cli-server-host-address-domain-public-remove.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-host-address-domain-public-remove 1 "remove " +.SH NAME +start\-cli\-server\-host\-address\-domain\-public\-remove \- Remove public domain from host +.SH SYNOPSIS +\fBstart\-cli server host address domain public remove\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIFQDN\fR> +.SH DESCRIPTION +Remove public domain from host +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIFQDN\fR> +Fully qualified domain name diff --git a/core/man/start-cli/start-cli-server-host-address-domain-public.1 b/core/man/start-cli/start-cli-server-host-address-domain-public.1 new file mode 100644 index 000000000..7a29e2d8a --- /dev/null +++ b/core/man/start-cli/start-cli-server-host-address-domain-public.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-host-address-domain-public 1 "public " +.SH NAME +start\-cli\-server\-host\-address\-domain\-public +.SH SYNOPSIS +\fBstart\-cli server host address domain public\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-server\-host\-address\-domain\-public\-add(1) +Add a public domain to this host +.TP +start\-cli\-server\-host\-address\-domain\-public\-remove(1) +Remove public domain from host diff --git a/core/man/start-cli/start-cli-server-host-address-domain.1 b/core/man/start-cli/start-cli-server-host-address-domain.1 new file mode 100644 index 000000000..278424d07 --- /dev/null +++ b/core/man/start-cli/start-cli-server-host-address-domain.1 @@ -0,0 +1,17 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-host-address-domain 1 "domain " +.SH NAME +start\-cli\-server\-host\-address\-domain +.SH SYNOPSIS +\fBstart\-cli server host address domain\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-server\-host\-address\-domain\-private(1) +.TP +start\-cli\-server\-host\-address\-domain\-public(1) diff --git a/core/man/start-cli/start-cli-server-host-address-list.1 b/core/man/start-cli/start-cli-server-host-address-list.1 new file mode 100644 index 000000000..5d156d809 --- /dev/null +++ b/core/man/start-cli/start-cli-server-host-address-list.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-host-address-list 1 "list " +.SH NAME +start\-cli\-server\-host\-address\-list \- List addresses for a host +.SH SYNOPSIS +\fBstart\-cli server host address list\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +List addresses for a host +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-server-host-address.1 b/core/man/start-cli/start-cli-server-host-address.1 new file mode 100644 index 000000000..35f9a5dde --- /dev/null +++ b/core/man/start-cli/start-cli-server-host-address.1 @@ -0,0 +1,18 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-host-address 1 "address " +.SH NAME +start\-cli\-server\-host\-address +.SH SYNOPSIS +\fBstart\-cli server host address\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-server\-host\-address\-domain(1) +.TP +start\-cli\-server\-host\-address\-list(1) +List addresses for a host diff --git a/core/man/start-cli/start-cli-server-host-binding-list.1 b/core/man/start-cli/start-cli-server-host-binding-list.1 new file mode 100644 index 000000000..40a4aeeed --- /dev/null +++ b/core/man/start-cli/start-cli-server-host-binding-list.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-host-binding-list 1 "list " +.SH NAME +start\-cli\-server\-host\-binding\-list \- List bindings for a host +.SH SYNOPSIS +\fBstart\-cli server host binding list\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +List bindings for a host +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-server-host-binding-set-address-enabled.1 b/core/man/start-cli/start-cli-server-host-binding-set-address-enabled.1 new file mode 100644 index 000000000..f7e67811f --- /dev/null +++ b/core/man/start-cli/start-cli-server-host-binding-set-address-enabled.1 @@ -0,0 +1,32 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-host-binding-set-address-enabled 1 "set-address-enabled " +.SH NAME +start\-cli\-server\-host\-binding\-set\-address\-enabled \- about.set\-address\-enabled\-for\-binding +.SH SYNOPSIS +\fBstart\-cli server host binding set\-address\-enabled\fR <\fB\-\-address\fR> [\fB\-\-enabled\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIINTERNAL_PORT\fR> +.SH DESCRIPTION +about.set\-address\-enabled\-for\-binding +.SH OPTIONS +.TP +\fB\-\-address\fR \fI
\fR +help.arg.address +.TP +\fB\-\-enabled\fR \fI\fR +Enable or disable this binding +.br + +.br +\fIPossible values:\fR +.RS 14 +.IP \(bu 2 +true +.IP \(bu 2 +false +.RE +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIINTERNAL_PORT\fR> +Internal port number diff --git a/core/man/start-cli/start-cli-server-host-binding.1 b/core/man/start-cli/start-cli-server-host-binding.1 new file mode 100644 index 000000000..0a9cd3f44 --- /dev/null +++ b/core/man/start-cli/start-cli-server-host-binding.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-host-binding 1 "binding " +.SH NAME +start\-cli\-server\-host\-binding +.SH SYNOPSIS +\fBstart\-cli server host binding\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-server\-host\-binding\-list(1) +List bindings for a host +.TP +start\-cli\-server\-host\-binding\-set\-address\-enabled(1) +about.set\-address\-enabled\-for\-binding diff --git a/core/man/start-cli/start-cli-server-host.1 b/core/man/start-cli/start-cli-server-host.1 new file mode 100644 index 000000000..37e7e7320 --- /dev/null +++ b/core/man/start-cli/start-cli-server-host.1 @@ -0,0 +1,18 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-host 1 "host " +.SH NAME +start\-cli\-server\-host \- Commands for modifying the host for the system ui +.SH SYNOPSIS +\fBstart\-cli server host\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands for modifying the host for the system ui +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-server\-host\-address(1) +.TP +start\-cli\-server\-host\-binding(1) diff --git a/core/man/start-cli/start-cli-server-kernel-logs.1 b/core/man/start-cli/start-cli-server-kernel-logs.1 new file mode 100644 index 000000000..e55e695a6 --- /dev/null +++ b/core/man/start-cli/start-cli-server-kernel-logs.1 @@ -0,0 +1,28 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-kernel-logs 1 "kernel-logs " +.SH NAME +start\-cli\-server\-kernel\-logs \- Display kernel logs +.SH SYNOPSIS +\fBstart\-cli server kernel\-logs\fR [\fB\-l\fR|\fB\-\-limit\fR] [\fB\-c\fR|\fB\-\-cursor\fR] [\fB\-b\fR|\fB\-\-boot\fR] [\fB\-B\fR|\fB\-\-before\fR] [\fB\-f\fR|\fB\-\-follow\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Display kernel logs +.SH OPTIONS +.TP +\fB\-l\fR, \fB\-\-limit\fR \fI\fR +Maximum number of log entries +.TP +\fB\-c\fR, \fB\-\-cursor\fR \fI\fR +Start from this cursor position +.TP +\fB\-b\fR, \fB\-\-boot\fR \fI\fR +Filter logs by boot ID +.TP +\fB\-B\fR, \fB\-\-before\fR +Show logs before the cursor position +.TP +\fB\-f\fR, \fB\-\-follow\fR +Follow log output in real\-time +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-server-logs.1 b/core/man/start-cli/start-cli-server-logs.1 new file mode 100644 index 000000000..944675edb --- /dev/null +++ b/core/man/start-cli/start-cli-server-logs.1 @@ -0,0 +1,28 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-logs 1 "logs " +.SH NAME +start\-cli\-server\-logs \- Display OS logs +.SH SYNOPSIS +\fBstart\-cli server logs\fR [\fB\-l\fR|\fB\-\-limit\fR] [\fB\-c\fR|\fB\-\-cursor\fR] [\fB\-b\fR|\fB\-\-boot\fR] [\fB\-B\fR|\fB\-\-before\fR] [\fB\-f\fR|\fB\-\-follow\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Display OS logs +.SH OPTIONS +.TP +\fB\-l\fR, \fB\-\-limit\fR \fI\fR +Maximum number of log entries +.TP +\fB\-c\fR, \fB\-\-cursor\fR \fI\fR +Start from this cursor position +.TP +\fB\-b\fR, \fB\-\-boot\fR \fI\fR +Filter logs by boot ID +.TP +\fB\-B\fR, \fB\-\-before\fR +Show logs before the cursor position +.TP +\fB\-f\fR, \fB\-\-follow\fR +Follow log output in real\-time +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-server-metrics.1 b/core/man/start-cli/start-cli-server-metrics.1 new file mode 100644 index 000000000..0f15cf788 --- /dev/null +++ b/core/man/start-cli/start-cli-server-metrics.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-metrics 1 "metrics " +.SH NAME +start\-cli\-server\-metrics \- Display server metrics +.SH SYNOPSIS +\fBstart\-cli server metrics\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Display server metrics +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-server-rebuild.1 b/core/man/start-cli/start-cli-server-rebuild.1 new file mode 100644 index 000000000..da1f23442 --- /dev/null +++ b/core/man/start-cli/start-cli-server-rebuild.1 @@ -0,0 +1,13 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-rebuild 1 "rebuild " +.SH NAME +start\-cli\-server\-rebuild \- Teardown and rebuild containers +.SH SYNOPSIS +\fBstart\-cli server rebuild\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Teardown and rebuild containers +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-server-restart.1 b/core/man/start-cli/start-cli-server-restart.1 new file mode 100644 index 000000000..8ea7cca77 --- /dev/null +++ b/core/man/start-cli/start-cli-server-restart.1 @@ -0,0 +1,13 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-restart 1 "restart " +.SH NAME +start\-cli\-server\-restart \- Restart the server +.SH SYNOPSIS +\fBstart\-cli server restart\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Restart the server +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-server-set-echoip-urls.1 b/core/man/start-cli/start-cli-server-set-echoip-urls.1 new file mode 100644 index 000000000..f97c53cde --- /dev/null +++ b/core/man/start-cli/start-cli-server-set-echoip-urls.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-set-echoip-urls 1 "set-echoip-urls " +.SH NAME +start\-cli\-server\-set\-echoip\-urls \- Set the Echo IP service URLs +.SH SYNOPSIS +\fBstart\-cli server set\-echoip\-urls\fR [\fB\-h\fR|\fB\-\-help\fR] [\fIURLS\fR] +.SH DESCRIPTION +Set the Echo IP service URLs +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +[\fIURLS\fR] +Echo IP service URLs for external IP detection diff --git a/core/man/start-cli/start-cli-server-set-hostname.1 b/core/man/start-cli/start-cli-server-set-hostname.1 new file mode 100644 index 000000000..7500fb159 --- /dev/null +++ b/core/man/start-cli/start-cli-server-set-hostname.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-set-hostname 1 "set-hostname " +.SH NAME +start\-cli\-server\-set\-hostname \- Set the server hostname +.SH SYNOPSIS +\fBstart\-cli server set\-hostname\fR [\fB\-h\fR|\fB\-\-help\fR] [\fINAME\fR] [\fIHOSTNAME\fR] +.SH DESCRIPTION +Set the server hostname +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +[\fINAME\fR] + +.TP +[\fIHOSTNAME\fR] + diff --git a/core/man/start-cli/start-cli-server-set-keyboard.1 b/core/man/start-cli/start-cli-server-set-keyboard.1 new file mode 100644 index 000000000..764b126b9 --- /dev/null +++ b/core/man/start-cli/start-cli-server-set-keyboard.1 @@ -0,0 +1,28 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-set-keyboard 1 "set-keyboard " +.SH NAME +start\-cli\-server\-set\-keyboard \- Set the keyboard layout +.SH SYNOPSIS +\fBstart\-cli server set\-keyboard\fR [\fB\-k\fR|\fB\-\-keymap\fR] [\fB\-m\fR|\fB\-\-model\fR] [\fB\-v\fR|\fB\-\-variant\fR] [\fB\-o\fR|\fB\-\-option\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fILAYOUT\fR> +.SH DESCRIPTION +Set the keyboard layout +.SH OPTIONS +.TP +\fB\-k\fR, \fB\-\-keymap\fR \fI\fR +Console keymap for vconsole +.TP +\fB\-m\fR, \fB\-\-model\fR \fI\fR +Keyboard model +.TP +\fB\-v\fR, \fB\-\-variant\fR \fI\fR +Keyboard layout variant +.TP +\fB\-o\fR, \fB\-\-option\fR \fI\fR +Additional keyboard option +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fILAYOUT\fR> +Keyboard layout code diff --git a/core/man/start-cli/start-cli-server-set-language.1 b/core/man/start-cli/start-cli-server-set-language.1 new file mode 100644 index 000000000..6b75a20bb --- /dev/null +++ b/core/man/start-cli/start-cli-server-set-language.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-set-language 1 "set-language " +.SH NAME +start\-cli\-server\-set\-language \- Set the system language +.SH SYNOPSIS +\fBstart\-cli server set\-language\fR [\fB\-h\fR|\fB\-\-help\fR] <\fILANGUAGE\fR> +.SH DESCRIPTION +Set the system language +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fILANGUAGE\fR> +Language code diff --git a/core/man/start-cli/start-cli-server-set-smtp.1 b/core/man/start-cli/start-cli-server-set-smtp.1 new file mode 100644 index 000000000..d2f8734c2 --- /dev/null +++ b/core/man/start-cli/start-cli-server-set-smtp.1 @@ -0,0 +1,41 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-set-smtp 1 "set-smtp " +.SH NAME +start\-cli\-server\-set\-smtp \- Set SMTP configuration +.SH SYNOPSIS +\fBstart\-cli server set\-smtp\fR <\fB\-\-host\fR> <\fB\-\-port\fR> <\fB\-\-from\fR> <\fB\-\-username\fR> [\fB\-\-password\fR] <\fB\-\-security\fR> [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Set SMTP configuration +.SH OPTIONS +.TP +\fB\-\-host\fR \fI\fR +SMTP server hostname +.TP +\fB\-\-port\fR \fI\fR +SMTP server port +.TP +\fB\-\-from\fR \fI\fR +Email sender address +.TP +\fB\-\-username\fR \fI\fR +SMTP authentication username +.TP +\fB\-\-password\fR \fI\fR +SMTP authentication password +.TP +\fB\-\-security\fR \fI\fR +Connection security mode (starttls or tls) +.br + +.br +\fIPossible values:\fR +.RS 14 +.IP \(bu 2 +starttls +.IP \(bu 2 +tls +.RE +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-server-shutdown.1 b/core/man/start-cli/start-cli-server-shutdown.1 new file mode 100644 index 000000000..c3e82d5cc --- /dev/null +++ b/core/man/start-cli/start-cli-server-shutdown.1 @@ -0,0 +1,13 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-shutdown 1 "shutdown " +.SH NAME +start\-cli\-server\-shutdown \- Shutdown the server +.SH SYNOPSIS +\fBstart\-cli server shutdown\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Shutdown the server +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-server-test-smtp.1 b/core/man/start-cli/start-cli-server-test-smtp.1 new file mode 100644 index 000000000..1e7341079 --- /dev/null +++ b/core/man/start-cli/start-cli-server-test-smtp.1 @@ -0,0 +1,44 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-test-smtp 1 "test-smtp " +.SH NAME +start\-cli\-server\-test\-smtp \- Test SMTP configuration +.SH SYNOPSIS +\fBstart\-cli server test\-smtp\fR <\fB\-\-host\fR> <\fB\-\-port\fR> <\fB\-\-from\fR> <\fB\-\-to\fR> <\fB\-\-username\fR> <\fB\-\-password\fR> <\fB\-\-security\fR> [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Test SMTP configuration +.SH OPTIONS +.TP +\fB\-\-host\fR \fI\fR +SMTP server hostname +.TP +\fB\-\-port\fR \fI\fR +SMTP server port +.TP +\fB\-\-from\fR \fI\fR +Email sender address +.TP +\fB\-\-to\fR \fI\fR +Email recipient address +.TP +\fB\-\-username\fR \fI\fR +SMTP authentication username +.TP +\fB\-\-password\fR \fI\fR +SMTP authentication password +.TP +\fB\-\-security\fR \fI\fR +Connection security mode (starttls or tls) +.br + +.br +\fIPossible values:\fR +.RS 14 +.IP \(bu 2 +starttls +.IP \(bu 2 +tls +.RE +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-server-time.1 b/core/man/start-cli/start-cli-server-time.1 new file mode 100644 index 000000000..a19b71993 --- /dev/null +++ b/core/man/start-cli/start-cli-server-time.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-time 1 "time " +.SH NAME +start\-cli\-server\-time \- Display server time and uptime +.SH SYNOPSIS +\fBstart\-cli server time\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Display server time and uptime +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-server-update-firmware.1 b/core/man/start-cli/start-cli-server-update-firmware.1 new file mode 100644 index 000000000..4c463e3ed --- /dev/null +++ b/core/man/start-cli/start-cli-server-update-firmware.1 @@ -0,0 +1,13 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-update-firmware 1 "update-firmware " +.SH NAME +start\-cli\-server\-update\-firmware \- Update firmware +.SH SYNOPSIS +\fBstart\-cli server update\-firmware\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Update firmware +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-server-update.1 b/core/man/start-cli/start-cli-server-update.1 new file mode 100644 index 000000000..4f14b41a4 --- /dev/null +++ b/core/man/start-cli/start-cli-server-update.1 @@ -0,0 +1,22 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server-update 1 "update " +.SH NAME +start\-cli\-server\-update \- Check a given registry for StartOS updates and update if available +.SH SYNOPSIS +\fBstart\-cli server update\fR [\fB\-\-to\fR] [\fB\-\-no\-progress\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIREGISTRY\fR> +.SH DESCRIPTION +Check a given registry for StartOS updates and update if available +.SH OPTIONS +.TP +\fB\-\-to\fR \fI\fR +Target version for update +.TP +\fB\-\-no\-progress\fR +Disable progress display +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIREGISTRY\fR> +URL of the registry diff --git a/core/man/start-cli/start-cli-server.1 b/core/man/start-cli/start-cli-server.1 new file mode 100644 index 000000000..cc076f658 --- /dev/null +++ b/core/man/start-cli/start-cli-server.1 @@ -0,0 +1,71 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-server 1 "server " +.SH NAME +start\-cli\-server \- Commands related to the server i.e. restart, update, and shutdown +.SH SYNOPSIS +\fBstart\-cli server\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands related to the server i.e. restart, update, and shutdown +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-server\-clear\-smtp(1) +Remove system smtp server and credentials +.TP +start\-cli\-server\-device\-info(1) +about.get\-device\-info +.TP +start\-cli\-server\-experimental(1) +Commands related to configuring experimental options such as zram and cpu governor +.TP +start\-cli\-server\-host(1) +Commands for modifying the host for the system ui +.TP +start\-cli\-server\-kernel\-logs(1) +Display kernel logs +.TP +start\-cli\-server\-logs(1) +Display OS logs +.TP +start\-cli\-server\-metrics(1) +Display server metrics +.TP +start\-cli\-server\-rebuild(1) +Teardown and rebuild containers +.TP +start\-cli\-server\-restart(1) +Restart the server +.TP +start\-cli\-server\-set\-echoip\-urls(1) +Set the Echo IP service URLs +.TP +start\-cli\-server\-set\-hostname(1) +Set the server hostname +.TP +start\-cli\-server\-set\-keyboard(1) +Set the keyboard layout +.TP +start\-cli\-server\-set\-language(1) +Set the system language +.TP +start\-cli\-server\-set\-smtp(1) +Set SMTP configuration +.TP +start\-cli\-server\-shutdown(1) +Shutdown the server +.TP +start\-cli\-server\-test\-smtp(1) +Test SMTP configuration +.TP +start\-cli\-server\-time(1) +Display server time and uptime +.TP +start\-cli\-server\-update(1) +Check a given registry for StartOS updates and update if available +.TP +start\-cli\-server\-update\-firmware(1) +Update firmware diff --git a/core/man/start-cli/start-cli-setup-cifs.1 b/core/man/start-cli/start-cli-setup-cifs.1 new file mode 100644 index 000000000..4cb102d59 --- /dev/null +++ b/core/man/start-cli/start-cli-setup-cifs.1 @@ -0,0 +1,12 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-setup-cifs 1 "cifs " +.SH NAME +start\-cli\-setup\-cifs +.SH SYNOPSIS +\fBstart\-cli setup cifs\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-setup-disk.1 b/core/man/start-cli/start-cli-setup-disk.1 new file mode 100644 index 000000000..7fa73a28b --- /dev/null +++ b/core/man/start-cli/start-cli-setup-disk.1 @@ -0,0 +1,12 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-setup-disk 1 "disk " +.SH NAME +start\-cli\-setup\-disk +.SH SYNOPSIS +\fBstart\-cli setup disk\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-setup-logs.1 b/core/man/start-cli/start-cli-setup-logs.1 new file mode 100644 index 000000000..dc7e28229 --- /dev/null +++ b/core/man/start-cli/start-cli-setup-logs.1 @@ -0,0 +1,28 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-setup-logs 1 "logs " +.SH NAME +start\-cli\-setup\-logs \- Display OS logs +.SH SYNOPSIS +\fBstart\-cli setup logs\fR [\fB\-l\fR|\fB\-\-limit\fR] [\fB\-c\fR|\fB\-\-cursor\fR] [\fB\-b\fR|\fB\-\-boot\fR] [\fB\-B\fR|\fB\-\-before\fR] [\fB\-f\fR|\fB\-\-follow\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Display OS logs +.SH OPTIONS +.TP +\fB\-l\fR, \fB\-\-limit\fR \fI\fR +Maximum number of log entries +.TP +\fB\-c\fR, \fB\-\-cursor\fR \fI\fR +Start from this cursor position +.TP +\fB\-b\fR, \fB\-\-boot\fR \fI\fR +Filter logs by boot ID +.TP +\fB\-B\fR, \fB\-\-before\fR +Show logs before the cursor position +.TP +\fB\-f\fR, \fB\-\-follow\fR +Follow log output in real\-time +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-setup.1 b/core/man/start-cli/start-cli-setup.1 new file mode 100644 index 000000000..ad19491fd --- /dev/null +++ b/core/man/start-cli/start-cli-setup.1 @@ -0,0 +1,21 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-setup 1 "setup " +.SH NAME +start\-cli\-setup \- Commands related to the initial setup +.SH SYNOPSIS +\fBstart\-cli setup\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands related to the initial setup +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-setup\-cifs(1) +.TP +start\-cli\-setup\-disk(1) +.TP +start\-cli\-setup\-logs(1) +Display OS logs diff --git a/core/man/start-cli/start-cli-ssh-add.1 b/core/man/start-cli/start-cli-ssh-add.1 new file mode 100644 index 000000000..0cb2e46cf --- /dev/null +++ b/core/man/start-cli/start-cli-ssh-add.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-ssh-add 1 "add " +.SH NAME +start\-cli\-ssh\-add \- Add ssh key +.SH SYNOPSIS +\fBstart\-cli ssh add\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIKEY\fR> +.SH DESCRIPTION +Add ssh key +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIKEY\fR> +SSH public key diff --git a/core/man/start-cli/start-cli-ssh-list.1 b/core/man/start-cli/start-cli-ssh-list.1 new file mode 100644 index 000000000..9b649e9ff --- /dev/null +++ b/core/man/start-cli/start-cli-ssh-list.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-ssh-list 1 "list " +.SH NAME +start\-cli\-ssh\-list \- List SSH keys +.SH SYNOPSIS +\fBstart\-cli ssh list\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +List SSH keys +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-ssh-remove.1 b/core/man/start-cli/start-cli-ssh-remove.1 new file mode 100644 index 000000000..702d6a920 --- /dev/null +++ b/core/man/start-cli/start-cli-ssh-remove.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-ssh-remove 1 "remove " +.SH NAME +start\-cli\-ssh\-remove \- Remove an SSH key +.SH SYNOPSIS +\fBstart\-cli ssh remove\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIFINGERPRINT\fR> +.SH DESCRIPTION +Remove an SSH key +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIFINGERPRINT\fR> +SSH key fingerprint diff --git a/core/man/start-cli/start-cli-ssh.1 b/core/man/start-cli/start-cli-ssh.1 new file mode 100644 index 000000000..6f10ebc7c --- /dev/null +++ b/core/man/start-cli/start-cli-ssh.1 @@ -0,0 +1,23 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-ssh 1 "ssh " +.SH NAME +start\-cli\-ssh \- Commands for interacting with ssh keys i.e. add, delete, list +.SH SYNOPSIS +\fBstart\-cli ssh\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands for interacting with ssh keys i.e. add, delete, list +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-ssh\-add(1) +Add ssh key +.TP +start\-cli\-ssh\-list(1) +List SSH keys +.TP +start\-cli\-ssh\-remove(1) +Remove an SSH key diff --git a/core/man/start-cli/start-cli-state.1 b/core/man/start-cli/start-cli-state.1 new file mode 100644 index 000000000..39a0872c9 --- /dev/null +++ b/core/man/start-cli/start-cli-state.1 @@ -0,0 +1,13 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-state 1 "state " +.SH NAME +start\-cli\-state \- Display the current api specification +.SH SYNOPSIS +\fBstart\-cli state\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Display the current api specification +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-tunnel-auth-get-pubkey.1 b/core/man/start-cli/start-cli-tunnel-auth-get-pubkey.1 new file mode 100644 index 000000000..6eda0cf45 --- /dev/null +++ b/core/man/start-cli/start-cli-tunnel-auth-get-pubkey.1 @@ -0,0 +1,13 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-tunnel-auth-get-pubkey 1 "get-pubkey " +.SH NAME +start\-cli\-tunnel\-auth\-get\-pubkey \- Get the public key from the server +.SH SYNOPSIS +\fBstart\-cli tunnel auth get\-pubkey\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Get the public key from the server +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-tunnel-auth-key-add.1 b/core/man/start-cli/start-cli-tunnel-auth-key-add.1 new file mode 100644 index 000000000..12137fabe --- /dev/null +++ b/core/man/start-cli/start-cli-tunnel-auth-key-add.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-tunnel-auth-key-add 1 "add " +.SH NAME +start\-cli\-tunnel\-auth\-key\-add \- Add a new authorized key +.SH SYNOPSIS +\fBstart\-cli tunnel auth key add\fR [\fB\-h\fR|\fB\-\-help\fR] <\fINAME\fR> <\fIKEY\fR> +.SH DESCRIPTION +Add a new authorized key +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fINAME\fR> + +.TP +<\fIKEY\fR> + diff --git a/core/man/start-cli/start-cli-tunnel-auth-key-list.1 b/core/man/start-cli/start-cli-tunnel-auth-key-list.1 new file mode 100644 index 000000000..8026a23f1 --- /dev/null +++ b/core/man/start-cli/start-cli-tunnel-auth-key-list.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-tunnel-auth-key-list 1 "list " +.SH NAME +start\-cli\-tunnel\-auth\-key\-list \- List authorized keys +.SH SYNOPSIS +\fBstart\-cli tunnel auth key list\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +List authorized keys +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-tunnel-auth-key-remove.1 b/core/man/start-cli/start-cli-tunnel-auth-key-remove.1 new file mode 100644 index 000000000..7ce90b583 --- /dev/null +++ b/core/man/start-cli/start-cli-tunnel-auth-key-remove.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-tunnel-auth-key-remove 1 "remove " +.SH NAME +start\-cli\-tunnel\-auth\-key\-remove \- Remove authorized key +.SH SYNOPSIS +\fBstart\-cli tunnel auth key remove\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIKEY\fR> +.SH DESCRIPTION +Remove authorized key +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIKEY\fR> + diff --git a/core/man/start-cli/start-cli-tunnel-auth-key.1 b/core/man/start-cli/start-cli-tunnel-auth-key.1 new file mode 100644 index 000000000..c130b60ba --- /dev/null +++ b/core/man/start-cli/start-cli-tunnel-auth-key.1 @@ -0,0 +1,22 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-tunnel-auth-key 1 "key " +.SH NAME +start\-cli\-tunnel\-auth\-key +.SH SYNOPSIS +\fBstart\-cli tunnel auth key\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-tunnel\-auth\-key\-add(1) +Add a new authorized key +.TP +start\-cli\-tunnel\-auth\-key\-list(1) +List authorized keys +.TP +start\-cli\-tunnel\-auth\-key\-remove(1) +Remove authorized key diff --git a/core/man/start-cli/start-cli-tunnel-auth-login.1 b/core/man/start-cli/start-cli-tunnel-auth-login.1 new file mode 100644 index 000000000..51d81780a --- /dev/null +++ b/core/man/start-cli/start-cli-tunnel-auth-login.1 @@ -0,0 +1,13 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-tunnel-auth-login 1 "login " +.SH NAME +start\-cli\-tunnel\-auth\-login \- Login to a new auth session +.SH SYNOPSIS +\fBstart\-cli tunnel auth login\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Login to a new auth session +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-tunnel-auth-logout.1 b/core/man/start-cli/start-cli-tunnel-auth-logout.1 new file mode 100644 index 000000000..ec78cc38f --- /dev/null +++ b/core/man/start-cli/start-cli-tunnel-auth-logout.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-tunnel-auth-logout 1 "logout " +.SH NAME +start\-cli\-tunnel\-auth\-logout \- Logout from current auth session +.SH SYNOPSIS +\fBstart\-cli tunnel auth logout\fR [\fB\-h\fR|\fB\-\-help\fR] <\fISESSION\fR> +.SH DESCRIPTION +Logout from current auth session +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fISESSION\fR> + diff --git a/core/man/start-cli/start-cli-tunnel-auth-reset-password.1 b/core/man/start-cli/start-cli-tunnel-auth-reset-password.1 new file mode 100644 index 000000000..34f867dff --- /dev/null +++ b/core/man/start-cli/start-cli-tunnel-auth-reset-password.1 @@ -0,0 +1,13 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-tunnel-auth-reset-password 1 "reset-password " +.SH NAME +start\-cli\-tunnel\-auth\-reset\-password \- Reset user interface password +.SH SYNOPSIS +\fBstart\-cli tunnel auth reset\-password\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Reset user interface password +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-tunnel-auth-session-kill.1 b/core/man/start-cli/start-cli-tunnel-auth-session-kill.1 new file mode 100644 index 000000000..cd0d769db --- /dev/null +++ b/core/man/start-cli/start-cli-tunnel-auth-session-kill.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-tunnel-auth-session-kill 1 "kill " +.SH NAME +start\-cli\-tunnel\-auth\-session\-kill \- Terminate auth sessions +.SH SYNOPSIS +\fBstart\-cli tunnel auth session kill\fR [\fB\-h\fR|\fB\-\-help\fR] [\fIIDS\fR] +.SH DESCRIPTION +Terminate auth sessions +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +[\fIIDS\fR] +Session identifiers diff --git a/core/man/start-cli/start-cli-tunnel-auth-session-list.1 b/core/man/start-cli/start-cli-tunnel-auth-session-list.1 new file mode 100644 index 000000000..ddc58143e --- /dev/null +++ b/core/man/start-cli/start-cli-tunnel-auth-session-list.1 @@ -0,0 +1,16 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-tunnel-auth-session-list 1 "list " +.SH NAME +start\-cli\-tunnel\-auth\-session\-list \- Display all auth sessions +.SH SYNOPSIS +\fBstart\-cli tunnel auth session list\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Display all auth sessions +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-tunnel-auth-session.1 b/core/man/start-cli/start-cli-tunnel-auth-session.1 new file mode 100644 index 000000000..0b221de32 --- /dev/null +++ b/core/man/start-cli/start-cli-tunnel-auth-session.1 @@ -0,0 +1,20 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-tunnel-auth-session 1 "session " +.SH NAME +start\-cli\-tunnel\-auth\-session \- List or kill auth sessions +.SH SYNOPSIS +\fBstart\-cli tunnel auth session\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +List or kill auth sessions +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-tunnel\-auth\-session\-kill(1) +Terminate auth sessions +.TP +start\-cli\-tunnel\-auth\-session\-list(1) +Display all auth sessions diff --git a/core/man/start-cli/start-cli-tunnel-auth-set-password.1 b/core/man/start-cli/start-cli-tunnel-auth-set-password.1 new file mode 100644 index 000000000..01ef0c493 --- /dev/null +++ b/core/man/start-cli/start-cli-tunnel-auth-set-password.1 @@ -0,0 +1,13 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-tunnel-auth-set-password 1 "set-password " +.SH NAME +start\-cli\-tunnel\-auth\-set\-password \- Set user interface password +.SH SYNOPSIS +\fBstart\-cli tunnel auth set\-password\fR [\fB\-h\fR|\fB\-\-help\fR] +.SH DESCRIPTION +Set user interface password +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help diff --git a/core/man/start-cli/start-cli-tunnel-auth.1 b/core/man/start-cli/start-cli-tunnel-auth.1 new file mode 100644 index 000000000..59aa3f74f --- /dev/null +++ b/core/man/start-cli/start-cli-tunnel-auth.1 @@ -0,0 +1,34 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-tunnel-auth 1 "auth " +.SH NAME +start\-cli\-tunnel\-auth \- Add or remove authorized clients +.SH SYNOPSIS +\fBstart\-cli tunnel auth\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Add or remove authorized clients +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-tunnel\-auth\-get\-pubkey(1) +Get the public key from the server +.TP +start\-cli\-tunnel\-auth\-key(1) +.TP +start\-cli\-tunnel\-auth\-login(1) +Login to a new auth session +.TP +start\-cli\-tunnel\-auth\-logout(1) +Logout from current auth session +.TP +start\-cli\-tunnel\-auth\-reset\-password(1) +Reset user interface password +.TP +start\-cli\-tunnel\-auth\-session(1) +List or kill auth sessions +.TP +start\-cli\-tunnel\-auth\-set\-password(1) +Set user interface password diff --git a/core/man/start-cli/start-cli-tunnel-db-apply.1 b/core/man/start-cli/start-cli-tunnel-db-apply.1 new file mode 100644 index 000000000..28f9b523e --- /dev/null +++ b/core/man/start-cli/start-cli-tunnel-db-apply.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-tunnel-db-apply 1 "apply " +.SH NAME +start\-cli\-tunnel\-db\-apply \- Update a database record +.SH SYNOPSIS +\fBstart\-cli tunnel db apply\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIEXPR\fR> [\fIPATH\fR] +.SH DESCRIPTION +Update a database record +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fIEXPR\fR> +Database patch expression to apply +.TP +[\fIPATH\fR] +Path to the database file diff --git a/core/man/start-cli/start-cli-tunnel-db-dump.1 b/core/man/start-cli/start-cli-tunnel-db-dump.1 new file mode 100644 index 000000000..1b489a495 --- /dev/null +++ b/core/man/start-cli/start-cli-tunnel-db-dump.1 @@ -0,0 +1,22 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-tunnel-db-dump 1 "dump " +.SH NAME +start\-cli\-tunnel\-db\-dump \- Filter and query the database, display tables and records +.SH SYNOPSIS +\fBstart\-cli tunnel db dump\fR [\fB\-p\fR|\fB\-\-pointer\fR] [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fIPATH\fR] +.SH DESCRIPTION +Filter and query the database, display tables and records +.SH OPTIONS +.TP +\fB\-p\fR, \fB\-\-pointer\fR \fI\fR +JSON pointer to specific value +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +[\fIPATH\fR] +Path to the database file diff --git a/core/man/start-cli/start-cli-tunnel-db.1 b/core/man/start-cli/start-cli-tunnel-db.1 new file mode 100644 index 000000000..f163d0119 --- /dev/null +++ b/core/man/start-cli/start-cli-tunnel-db.1 @@ -0,0 +1,20 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-tunnel-db 1 "db " +.SH NAME +start\-cli\-tunnel\-db \- Commands to interact with the db i.e. dump and apply +.SH SYNOPSIS +\fBstart\-cli tunnel db\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Commands to interact with the db i.e. dump and apply +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-tunnel\-db\-apply(1) +Update a database record +.TP +start\-cli\-tunnel\-db\-dump(1) +Filter and query the database, display tables and records diff --git a/core/man/start-cli/start-cli-tunnel-device-add.1 b/core/man/start-cli/start-cli-tunnel-device-add.1 new file mode 100644 index 000000000..7696c1157 --- /dev/null +++ b/core/man/start-cli/start-cli-tunnel-device-add.1 @@ -0,0 +1,22 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-tunnel-device-add 1 "add " +.SH NAME +start\-cli\-tunnel\-device\-add \- Add a device to a subnet +.SH SYNOPSIS +\fBstart\-cli tunnel device add\fR [\fB\-h\fR|\fB\-\-help\fR] <\fISUBNET\fR> <\fINAME\fR> [\fIIP\fR] +.SH DESCRIPTION +Add a device to a subnet +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fISUBNET\fR> + +.TP +<\fINAME\fR> + +.TP +[\fIIP\fR] + diff --git a/core/man/start-cli/start-cli-tunnel-device-list.1 b/core/man/start-cli/start-cli-tunnel-device-list.1 new file mode 100644 index 000000000..f92f38c77 --- /dev/null +++ b/core/man/start-cli/start-cli-tunnel-device-list.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-tunnel-device-list 1 "list " +.SH NAME +start\-cli\-tunnel\-device\-list \- List devices in a subnet +.SH SYNOPSIS +\fBstart\-cli tunnel device list\fR [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fISUBNET\fR> +.SH DESCRIPTION +List devices in a subnet +.SH OPTIONS +.TP +\fB\-\-format\fR + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fISUBNET\fR> + diff --git a/core/man/start-cli/start-cli-tunnel-device-remove.1 b/core/man/start-cli/start-cli-tunnel-device-remove.1 new file mode 100644 index 000000000..f9e375b3f --- /dev/null +++ b/core/man/start-cli/start-cli-tunnel-device-remove.1 @@ -0,0 +1,19 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-tunnel-device-remove 1 "remove " +.SH NAME +start\-cli\-tunnel\-device\-remove \- Remove device from subnet +.SH SYNOPSIS +\fBstart\-cli tunnel device remove\fR [\fB\-h\fR|\fB\-\-help\fR] <\fISUBNET\fR> <\fIIP\fR> +.SH DESCRIPTION +Remove device from subnet +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fISUBNET\fR> + +.TP +<\fIIP\fR> + diff --git a/core/man/start-cli/start-cli-tunnel-device-show-config.1 b/core/man/start-cli/start-cli-tunnel-device-show-config.1 new file mode 100644 index 000000000..29ca6b371 --- /dev/null +++ b/core/man/start-cli/start-cli-tunnel-device-show-config.1 @@ -0,0 +1,22 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-tunnel-device-show-config 1 "show-config " +.SH NAME +start\-cli\-tunnel\-device\-show\-config \- Show WireGuard configuration for device +.SH SYNOPSIS +\fBstart\-cli tunnel device show\-config\fR [\fB\-h\fR|\fB\-\-help\fR] <\fISUBNET\fR> <\fIIP\fR> [\fIWAN_ADDR\fR] +.SH DESCRIPTION +Show WireGuard configuration for device +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.TP +<\fISUBNET\fR> + +.TP +<\fIIP\fR> + +.TP +[\fIWAN_ADDR\fR] + diff --git a/core/man/start-cli/start-cli-tunnel-device.1 b/core/man/start-cli/start-cli-tunnel-device.1 new file mode 100644 index 000000000..f3d469834 --- /dev/null +++ b/core/man/start-cli/start-cli-tunnel-device.1 @@ -0,0 +1,26 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-tunnel-device 1 "device " +.SH NAME +start\-cli\-tunnel\-device \- Add, remove, or list devices in subnets +.SH SYNOPSIS +\fBstart\-cli tunnel device\fR [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR> +.SH DESCRIPTION +Add, remove, or list devices in subnets +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help +.SH SUBCOMMANDS +.TP +start\-cli\-tunnel\-device\-add(1) +Add a device to a subnet +.TP +start\-cli\-tunnel\-device\-list(1) +List devices in a subnet +.TP +start\-cli\-tunnel\-device\-remove(1) +Remove device from subnet +.TP +start\-cli\-tunnel\-device\-show\-config(1) +Show WireGuard configuration for device diff --git a/core/man/start-cli/start-cli-tunnel-port-forward-add.1 b/core/man/start-cli/start-cli-tunnel-port-forward-add.1 new file mode 100644 index 000000000..14e966d87 --- /dev/null +++ b/core/man/start-cli/start-cli-tunnel-port-forward-add.1 @@ -0,0 +1,22 @@ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.TH start-cli-tunnel-port-forward-add 1 "add " +.SH NAME +start\-cli\-tunnel\-port\-forward\-add \- Add a new port forward +.SH SYNOPSIS +\fBstart\-cli tunnel port\-forward add\fR [\fB\-\-label\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fISOURCE\fR> <\fITARGET\fR> +.SH DESCRIPTION +Add a new port forward +.SH OPTIONS +.TP +\fB\-\-label\fR \fI