From c06d3d06395ee4efcf24f24e6213b9870e013dcd Mon Sep 17 00:00:00 2001 From: Justin Alvarez Date: Fri, 20 Oct 2023 12:41:28 -0400 Subject: [PATCH] fix mdlint Signed-off-by: Justin Alvarez --- cmd/finch/doc.TEMPLATE.md | 9 ++++++--- docs/cmd/finch_build.md | 2 ++ docs/cmd/finch_builder.md | 3 +++ docs/cmd/finch_commit.md | 2 ++ docs/cmd/finch_completion_bash.md | 2 ++ docs/cmd/finch_completion_fish.md | 2 ++ docs/cmd/finch_completion_powershell.md | 2 ++ docs/cmd/finch_completion_zsh.md | 2 ++ docs/cmd/finch_compose.md | 3 +++ docs/cmd/finch_container.md | 3 +++ docs/cmd/finch_cp.md | 2 ++ docs/cmd/finch_create.md | 2 ++ docs/cmd/finch_events.md | 2 ++ docs/cmd/finch_exec.md | 2 ++ docs/cmd/finch_help.md | 2 ++ docs/cmd/finch_history.md | 2 ++ docs/cmd/finch_image.md | 3 +++ docs/cmd/finch_images.md | 3 +++ docs/cmd/finch_info.md | 2 ++ docs/cmd/finch_inspect.md | 2 ++ docs/cmd/finch_kill.md | 2 ++ docs/cmd/finch_load.md | 2 ++ docs/cmd/finch_login.md | 2 ++ docs/cmd/finch_logout.md | 2 ++ docs/cmd/finch_logs.md | 2 ++ docs/cmd/finch_network.md | 3 +++ docs/cmd/finch_pause.md | 2 ++ docs/cmd/finch_port.md | 2 ++ docs/cmd/finch_ps.md | 2 ++ docs/cmd/finch_pull.md | 2 ++ docs/cmd/finch_push.md | 2 ++ docs/cmd/finch_restart.md | 2 ++ docs/cmd/finch_rm.md | 2 ++ docs/cmd/finch_rmi.md | 2 ++ docs/cmd/finch_run.md | 2 ++ docs/cmd/finch_save.md | 2 ++ docs/cmd/finch_start.md | 2 ++ docs/cmd/finch_stats.md | 2 ++ docs/cmd/finch_stop.md | 2 ++ docs/cmd/finch_support-bundle_generate.md | 2 ++ docs/cmd/finch_system.md | 3 +++ docs/cmd/finch_tag.md | 2 ++ docs/cmd/finch_top.md | 2 ++ docs/cmd/finch_unpause.md | 2 ++ docs/cmd/finch_update.md | 2 ++ docs/cmd/finch_version.md | 2 ++ docs/cmd/finch_vm_init.md | 2 ++ docs/cmd/finch_vm_remove.md | 2 ++ docs/cmd/finch_vm_start.md | 2 ++ docs/cmd/finch_vm_status.md | 2 ++ docs/cmd/finch_vm_stop.md | 2 ++ docs/cmd/finch_volume.md | 3 +++ docs/cmd/finch_wait.md | 2 ++ 53 files changed, 118 insertions(+), 3 deletions(-) diff --git a/cmd/finch/doc.TEMPLATE.md b/cmd/finch/doc.TEMPLATE.md index 48f1be131..74540aa6d 100644 --- a/cmd/finch/doc.TEMPLATE.md +++ b/cmd/finch/doc.TEMPLATE.md @@ -1,13 +1,12 @@ --- title: "{{ .CmdPath }}" --- + ## {{ .CmdPath }}{{if gt (len .Description) 0}} {{ .Description }} -{{end}} - -{{if gt (len .Properties) 0}}### Properties +{{end}}{{if gt (len .Properties) 0}}### Properties {{.Properties}} @@ -16,19 +15,23 @@ title: "{{ .CmdPath }}" ```{{if gt (len .Aliases) 0}} ### Aliases + {{.Aliases}} {{end}}{{if gt (len .Examples) 0}} ### Examples + {{.Examples}} {{end}}{{if gt (len .Commands) 0}} ### Commands + ``` {{ .Commands }} ```{{end}}{{if gt (len .Options) 0}} ### Options + ``` {{ .Options }} ```{{end}}{{if gt (len .SeeAlso) 0}} diff --git a/docs/cmd/finch_build.md b/docs/cmd/finch_build.md index 101c06dd9..d55b1ccca 100644 --- a/docs/cmd/finch_build.md +++ b/docs/cmd/finch_build.md @@ -1,6 +1,7 @@ --- title: "finch build" --- + ## finch build Build an image from a Dockerfile. Needs buildkitd to be running. @@ -11,6 +12,7 @@ finch build [flags] PATH ``` ### Options + ``` --build-arg stringArray Set build-time variables --buildkit-host string BuildKit address [$BUILDKIT_HOST] (default "unix:///run/buildkit/buildkitd.sock") diff --git a/docs/cmd/finch_builder.md b/docs/cmd/finch_builder.md index 3dddea16e..0c36817c0 100644 --- a/docs/cmd/finch_builder.md +++ b/docs/cmd/finch_builder.md @@ -1,6 +1,7 @@ --- title: "finch builder" --- + ## finch builder Manage builds @@ -10,6 +11,7 @@ finch builder [flags] ``` ### Commands + ``` build Build an image from a Dockerfile. Needs buildkitd to be running. debug Debug Dockerfile @@ -17,6 +19,7 @@ finch builder [flags] ``` ### Options + ``` -h, --help help for builder ``` diff --git a/docs/cmd/finch_commit.md b/docs/cmd/finch_commit.md index 4e889d4a2..8fa30ccac 100644 --- a/docs/cmd/finch_commit.md +++ b/docs/cmd/finch_commit.md @@ -1,6 +1,7 @@ --- title: "finch commit" --- + ## finch commit Create a new image from a container's changes @@ -10,6 +11,7 @@ finch commit [flags] CONTAINER REPOSITORY[:TAG] ``` ### Options + ``` -a, --author string Author (e.g., "finch contributor ") -c, --change stringArray Apply Dockerfile instruction to the created image (supported directives: [CMD, ENTRYPOINT]) diff --git a/docs/cmd/finch_completion_bash.md b/docs/cmd/finch_completion_bash.md index f6d75eacb..50e287309 100644 --- a/docs/cmd/finch_completion_bash.md +++ b/docs/cmd/finch_completion_bash.md @@ -1,6 +1,7 @@ --- title: "finch completion bash" --- + ## finch completion bash Generate the autocompletion script for the bash shell. @@ -21,6 +22,7 @@ To load completions for every new session, execute once: ``` ### Options + ``` -h, --help help for bash --no-descriptions disable completion descriptions diff --git a/docs/cmd/finch_completion_fish.md b/docs/cmd/finch_completion_fish.md index 854c0481b..2d4872e3e 100644 --- a/docs/cmd/finch_completion_fish.md +++ b/docs/cmd/finch_completion_fish.md @@ -1,6 +1,7 @@ --- title: "finch completion fish" --- + ## finch completion fish Generate the autocompletion script for the fish shell. @@ -20,6 +21,7 @@ You will need to start a new shell for this setup to take effect. ``` ### Options + ``` -h, --help help for fish --no-descriptions disable completion descriptions diff --git a/docs/cmd/finch_completion_powershell.md b/docs/cmd/finch_completion_powershell.md index e28138b28..d4d899575 100644 --- a/docs/cmd/finch_completion_powershell.md +++ b/docs/cmd/finch_completion_powershell.md @@ -1,6 +1,7 @@ --- title: "finch completion powershell" --- + ## finch completion powershell Generate the autocompletion script for powershell. @@ -17,6 +18,7 @@ to your powershell profile. ``` ### Options + ``` -h, --help help for powershell --no-descriptions disable completion descriptions diff --git a/docs/cmd/finch_completion_zsh.md b/docs/cmd/finch_completion_zsh.md index d1dd6e4d1..cd69f7675 100644 --- a/docs/cmd/finch_completion_zsh.md +++ b/docs/cmd/finch_completion_zsh.md @@ -1,6 +1,7 @@ --- title: "finch completion zsh" --- + ## finch completion zsh Generate the autocompletion script for the zsh shell. @@ -23,6 +24,7 @@ To load completions for every new session, execute once: ``` ### Options + ``` -h, --help help for zsh --no-descriptions disable completion descriptions diff --git a/docs/cmd/finch_compose.md b/docs/cmd/finch_compose.md index 9a4eefd1e..d652240a0 100644 --- a/docs/cmd/finch_compose.md +++ b/docs/cmd/finch_compose.md @@ -1,6 +1,7 @@ --- title: "finch compose" --- + ## finch compose Compose @@ -10,6 +11,7 @@ finch compose [flags] COMMAND ``` ### Commands + ``` build Build or rebuild services config Validate and view the Compose file @@ -37,6 +39,7 @@ finch compose [flags] COMMAND ``` ### Options + ``` --env-file string Specify an alternate environment file -f, --f stringArray Alias of --file diff --git a/docs/cmd/finch_container.md b/docs/cmd/finch_container.md index bee0536da..f7a69da78 100644 --- a/docs/cmd/finch_container.md +++ b/docs/cmd/finch_container.md @@ -1,6 +1,7 @@ --- title: "finch container" --- + ## finch container Manage containers @@ -10,6 +11,7 @@ finch container [flags] ``` ### Commands + ``` attach Attach stdin, stdout, and stderr to a running container. commit Create a new image from a container's changes @@ -36,6 +38,7 @@ finch container [flags] ``` ### Options + ``` -h, --help help for container ``` diff --git a/docs/cmd/finch_cp.md b/docs/cmd/finch_cp.md index 10dd823dc..37e3e699a 100644 --- a/docs/cmd/finch_cp.md +++ b/docs/cmd/finch_cp.md @@ -1,6 +1,7 @@ --- title: "finch cp" --- + ## finch cp Copy files/folders between a running container and the local filesystem. @@ -14,6 +15,7 @@ finch cp [flags] CONTAINER:SRC_PATH DEST_PATH|- ``` ### Options + ``` -L, --follow-link Always follow symbolic link in SRC_PATH. -h, --help help for cp diff --git a/docs/cmd/finch_create.md b/docs/cmd/finch_create.md index 9c0fd2585..7b896fb6b 100644 --- a/docs/cmd/finch_create.md +++ b/docs/cmd/finch_create.md @@ -1,6 +1,7 @@ --- title: "finch create" --- + ## finch create Create a new container. Optionally specify "ipfs://" or "ipns://" scheme to pull image from IPFS. @@ -10,6 +11,7 @@ finch create [flags] IMAGE [COMMAND] [ARG...] ``` ### Options + ``` --add-host strings Add a custom host-to-IP mapping (host:ip) --blkio-weight uint16 Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) diff --git a/docs/cmd/finch_events.md b/docs/cmd/finch_events.md index d4df03517..ff692cb45 100644 --- a/docs/cmd/finch_events.md +++ b/docs/cmd/finch_events.md @@ -1,6 +1,7 @@ --- title: "finch events" --- + ## finch events Get real time events from the server @@ -10,6 +11,7 @@ finch events [flags] ``` ### Options + ``` --format string Format the output using the given Go template, e.g, '{{json .}}' -h, --help help for events diff --git a/docs/cmd/finch_exec.md b/docs/cmd/finch_exec.md index 970d53582..c71dea488 100644 --- a/docs/cmd/finch_exec.md +++ b/docs/cmd/finch_exec.md @@ -1,6 +1,7 @@ --- title: "finch exec" --- + ## finch exec Run a command in a running container @@ -10,6 +11,7 @@ finch exec [flags] CONTAINER COMMAND [ARG...] ``` ### Options + ``` -d, --detach Detached mode: run command in the background -e, --env stringArray Set environment variables diff --git a/docs/cmd/finch_help.md b/docs/cmd/finch_help.md index f5c2eab8b..8be87b125 100644 --- a/docs/cmd/finch_help.md +++ b/docs/cmd/finch_help.md @@ -1,6 +1,7 @@ --- title: "finch help" --- + ## finch help Help provides help for any command in the application. @@ -11,6 +12,7 @@ Simply type finch help [path to command] for full details. ``` ### Options + ``` -h, --help help for help ``` diff --git a/docs/cmd/finch_history.md b/docs/cmd/finch_history.md index cbef21d69..be4dc3509 100644 --- a/docs/cmd/finch_history.md +++ b/docs/cmd/finch_history.md @@ -1,6 +1,7 @@ --- title: "finch history" --- + ## finch history Show the history of an image @@ -10,6 +11,7 @@ finch history [flags] IMAGE ``` ### Options + ``` -f, --format string Format the output using the given Go template, e.g, '{{json .}}' -h, --help help for history diff --git a/docs/cmd/finch_image.md b/docs/cmd/finch_image.md index 932c6bde4..7a3b1c3ea 100644 --- a/docs/cmd/finch_image.md +++ b/docs/cmd/finch_image.md @@ -1,6 +1,7 @@ --- title: "finch image" --- + ## finch image Manage images @@ -10,6 +11,7 @@ finch image [flags] ``` ### Commands + ``` build Build an image from a Dockerfile. Needs buildkitd to be running. convert convert an image @@ -28,6 +30,7 @@ finch image [flags] ``` ### Options + ``` -h, --help help for image ``` diff --git a/docs/cmd/finch_images.md b/docs/cmd/finch_images.md index 3a11e68d1..798253aaa 100644 --- a/docs/cmd/finch_images.md +++ b/docs/cmd/finch_images.md @@ -1,11 +1,13 @@ --- title: "finch images" --- + ## finch images List images ### Properties + - REPOSITORY: Repository - TAG: Tag - NAME: Name of the image, --names for skip parsing as repository and tag. @@ -20,6 +22,7 @@ finch images [flags] [REPOSITORY[:TAG]] ``` ### Options + ``` -a, --all (unimplemented yet, always true) (default true) --digests Show digests (compatible with Docker, unlike ID) diff --git a/docs/cmd/finch_info.md b/docs/cmd/finch_info.md index 1d4dab6aa..a6b96b399 100644 --- a/docs/cmd/finch_info.md +++ b/docs/cmd/finch_info.md @@ -1,6 +1,7 @@ --- title: "finch info" --- + ## finch info Display system-wide information @@ -10,6 +11,7 @@ finch info [flags] ``` ### Options + ``` -f, --format string Format the output using the given Go template, e.g, '{{json .}}' -h, --help help for info diff --git a/docs/cmd/finch_inspect.md b/docs/cmd/finch_inspect.md index 40cf06a28..aa9d87bd7 100644 --- a/docs/cmd/finch_inspect.md +++ b/docs/cmd/finch_inspect.md @@ -1,6 +1,7 @@ --- title: "finch inspect" --- + ## finch inspect Return low-level information on objects. @@ -10,6 +11,7 @@ finch inspect [flags] ``` ### Options + ``` -f, --format string Format the output using the given Go template, e.g, '{{json .}}' -h, --help help for inspect diff --git a/docs/cmd/finch_kill.md b/docs/cmd/finch_kill.md index 82345fff7..10f5c3e5e 100644 --- a/docs/cmd/finch_kill.md +++ b/docs/cmd/finch_kill.md @@ -1,6 +1,7 @@ --- title: "finch kill" --- + ## finch kill Kill one or more running containers @@ -10,6 +11,7 @@ finch kill [flags] CONTAINER [CONTAINER, ...] ``` ### Options + ``` -h, --help help for kill -s, --signal string Signal to send to the container (default "KILL") diff --git a/docs/cmd/finch_load.md b/docs/cmd/finch_load.md index fe044d04b..ee50be592 100644 --- a/docs/cmd/finch_load.md +++ b/docs/cmd/finch_load.md @@ -1,6 +1,7 @@ --- title: "finch load" --- + ## finch load Supports both Docker Image Spec v1.2 and OCI Image Spec v1.0. @@ -10,6 +11,7 @@ finch load [flags] ``` ### Options + ``` --all-platforms Import content for all platforms -h, --help help for load diff --git a/docs/cmd/finch_login.md b/docs/cmd/finch_login.md index 0ec907e76..9e73414cb 100644 --- a/docs/cmd/finch_login.md +++ b/docs/cmd/finch_login.md @@ -1,6 +1,7 @@ --- title: "finch login" --- + ## finch login Log in to a container registry @@ -10,6 +11,7 @@ finch login [flags] [SERVER] ``` ### Options + ``` -h, --help help for login -p, --password string Password diff --git a/docs/cmd/finch_logout.md b/docs/cmd/finch_logout.md index 6e6ccafd5..2cd697845 100644 --- a/docs/cmd/finch_logout.md +++ b/docs/cmd/finch_logout.md @@ -1,6 +1,7 @@ --- title: "finch logout" --- + ## finch logout Log out from a container registry @@ -10,6 +11,7 @@ finch logout [flags] [SERVER] ``` ### Options + ``` -h, --help help for logout ``` diff --git a/docs/cmd/finch_logs.md b/docs/cmd/finch_logs.md index a31275353..d466786a6 100644 --- a/docs/cmd/finch_logs.md +++ b/docs/cmd/finch_logs.md @@ -1,6 +1,7 @@ --- title: "finch logs" --- + ## finch logs Fetch the logs of a container. @@ -15,6 +16,7 @@ finch logs [flags] CONTAINER ``` ### Options + ``` -f, --follow Follow log output -h, --help help for logs diff --git a/docs/cmd/finch_network.md b/docs/cmd/finch_network.md index 1a3d04670..cb8f11241 100644 --- a/docs/cmd/finch_network.md +++ b/docs/cmd/finch_network.md @@ -1,6 +1,7 @@ --- title: "finch network" --- + ## finch network Manage networks @@ -10,6 +11,7 @@ finch network [flags] ``` ### Commands + ``` create Create a network inspect Display detailed information on one or more networks @@ -19,6 +21,7 @@ finch network [flags] ``` ### Options + ``` -h, --help help for network ``` diff --git a/docs/cmd/finch_pause.md b/docs/cmd/finch_pause.md index 518bd72bc..80834df58 100644 --- a/docs/cmd/finch_pause.md +++ b/docs/cmd/finch_pause.md @@ -1,6 +1,7 @@ --- title: "finch pause" --- + ## finch pause Pause all processes within one or more containers @@ -10,6 +11,7 @@ finch pause [flags] CONTAINER [CONTAINER, ...] ``` ### Options + ``` -h, --help help for pause ``` diff --git a/docs/cmd/finch_port.md b/docs/cmd/finch_port.md index 7011764ac..afb7384d3 100644 --- a/docs/cmd/finch_port.md +++ b/docs/cmd/finch_port.md @@ -1,6 +1,7 @@ --- title: "finch port" --- + ## finch port List port mappings or a specific mapping for the container @@ -10,6 +11,7 @@ finch port [flags] CONTAINER [PRIVATE_PORT[/PROTO]] ``` ### Options + ``` -h, --help help for port ``` diff --git a/docs/cmd/finch_ps.md b/docs/cmd/finch_ps.md index 2fbfe2414..ac6ea4055 100644 --- a/docs/cmd/finch_ps.md +++ b/docs/cmd/finch_ps.md @@ -1,6 +1,7 @@ --- title: "finch ps" --- + ## finch ps List containers @@ -10,6 +11,7 @@ finch ps [flags] ``` ### Options + ``` -a, --all Show all containers (default shows just running) -f, --filter strings Filter matches containers based on given conditions diff --git a/docs/cmd/finch_pull.md b/docs/cmd/finch_pull.md index 9a66b87f1..ad135d142 100644 --- a/docs/cmd/finch_pull.md +++ b/docs/cmd/finch_pull.md @@ -1,6 +1,7 @@ --- title: "finch pull" --- + ## finch pull Pull an image from a registry. Optionally specify "ipfs://" or "ipns://" scheme to pull image from IPFS. @@ -10,6 +11,7 @@ finch pull [flags] NAME[:TAG] ``` ### Options + ``` --all-platforms Pull content for all platforms --cosign-certificate-identity string The identity expected in a valid Fulcio certificate for --verify=cosign. Valid values include email address, DNS names, IP addresses, and URIs. Either --cosign-certificate-identity or --cosign-certificate-identity-regexp must be set for keyless flows diff --git a/docs/cmd/finch_push.md b/docs/cmd/finch_push.md index 75736c20d..155599c5c 100644 --- a/docs/cmd/finch_push.md +++ b/docs/cmd/finch_push.md @@ -1,6 +1,7 @@ --- title: "finch push" --- + ## finch push Push an image or a repository to a registry. Optionally specify "ipfs://" or "ipns://" scheme to push image to IPFS. @@ -10,6 +11,7 @@ finch push [flags] NAME[:TAG] ``` ### Options + ``` --all-platforms Push content for all platforms --allow-nondistributable-artifacts Allow pushing images with non-distributable blobs diff --git a/docs/cmd/finch_restart.md b/docs/cmd/finch_restart.md index ccd69ebda..7ee5d6d3a 100644 --- a/docs/cmd/finch_restart.md +++ b/docs/cmd/finch_restart.md @@ -1,6 +1,7 @@ --- title: "finch restart" --- + ## finch restart Restart one or more running containers @@ -10,6 +11,7 @@ finch restart [flags] CONTAINER [CONTAINER, ...] ``` ### Options + ``` -h, --help help for restart -t, --time uint Seconds to wait for stop before killing it (default 10) diff --git a/docs/cmd/finch_rm.md b/docs/cmd/finch_rm.md index 0bfb91589..9d79121d5 100644 --- a/docs/cmd/finch_rm.md +++ b/docs/cmd/finch_rm.md @@ -1,6 +1,7 @@ --- title: "finch rm" --- + ## finch rm Remove one or more containers @@ -10,6 +11,7 @@ finch rm [flags] CONTAINER [CONTAINER, ...] ``` ### Options + ``` -f, --force Force the removal of a running|paused|unknown container (uses SIGKILL) -h, --help help for rm diff --git a/docs/cmd/finch_rmi.md b/docs/cmd/finch_rmi.md index a48a0a07e..d38edebdb 100644 --- a/docs/cmd/finch_rmi.md +++ b/docs/cmd/finch_rmi.md @@ -1,6 +1,7 @@ --- title: "finch rmi" --- + ## finch rmi Remove one or more images @@ -10,6 +11,7 @@ finch rmi [flags] IMAGE [IMAGE, ...] ``` ### Options + ``` --async Asynchronous mode -f, --force Force removal of the image diff --git a/docs/cmd/finch_run.md b/docs/cmd/finch_run.md index 15f1570a3..af3b6460e 100644 --- a/docs/cmd/finch_run.md +++ b/docs/cmd/finch_run.md @@ -1,6 +1,7 @@ --- title: "finch run" --- + ## finch run Run a command in a new container. Optionally specify "ipfs://" or "ipns://" scheme to pull image from IPFS. @@ -10,6 +11,7 @@ finch run [flags] IMAGE [COMMAND] [ARG...] ``` ### Options + ``` --add-host strings Add a custom host-to-IP mapping (host:ip) --blkio-weight uint16 Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) diff --git a/docs/cmd/finch_save.md b/docs/cmd/finch_save.md index d9af9af84..17ef3bec0 100644 --- a/docs/cmd/finch_save.md +++ b/docs/cmd/finch_save.md @@ -1,6 +1,7 @@ --- title: "finch save" --- + ## finch save The archive implements both Docker Image Spec v1.2 and OCI Image Spec v1.0. @@ -10,6 +11,7 @@ finch save [flags] ``` ### Options + ``` --all-platforms Export content for all platforms -h, --help help for save diff --git a/docs/cmd/finch_start.md b/docs/cmd/finch_start.md index fe9fe15fd..a9dc69bf5 100644 --- a/docs/cmd/finch_start.md +++ b/docs/cmd/finch_start.md @@ -1,6 +1,7 @@ --- title: "finch start" --- + ## finch start Start one or more running containers @@ -10,6 +11,7 @@ finch start [flags] CONTAINER [CONTAINER, ...] ``` ### Options + ``` -a, --attach Attach STDOUT/STDERR and forward signals --detach-keys string Override the default detach keys (default "ctrl-p,ctrl-q") diff --git a/docs/cmd/finch_stats.md b/docs/cmd/finch_stats.md index 9d6b47c5a..0f92337bf 100644 --- a/docs/cmd/finch_stats.md +++ b/docs/cmd/finch_stats.md @@ -1,6 +1,7 @@ --- title: "finch stats" --- + ## finch stats Display a live stream of container(s) resource usage statistics. @@ -10,6 +11,7 @@ finch stats [flags] ``` ### Options + ``` -a, --all Show all containers (default shows just running) --format string Pretty-print images using a Go template, e.g, '{{json .}}' diff --git a/docs/cmd/finch_stop.md b/docs/cmd/finch_stop.md index 9c9bb119a..d54f96ad2 100644 --- a/docs/cmd/finch_stop.md +++ b/docs/cmd/finch_stop.md @@ -1,6 +1,7 @@ --- title: "finch stop" --- + ## finch stop Stop one or more running containers @@ -10,6 +11,7 @@ finch stop [flags] CONTAINER [CONTAINER, ...] ``` ### Options + ``` -h, --help help for stop -t, --time int Seconds to wait before sending a SIGKILL (default 10) diff --git a/docs/cmd/finch_support-bundle_generate.md b/docs/cmd/finch_support-bundle_generate.md index f4470e8fb..353404fb3 100644 --- a/docs/cmd/finch_support-bundle_generate.md +++ b/docs/cmd/finch_support-bundle_generate.md @@ -1,6 +1,7 @@ --- title: "finch support-bundle generate" --- + ## finch support-bundle generate Generates a collection of logs and configs that can be uploaded to a Github issue to help debug issues. @@ -10,6 +11,7 @@ Generates a collection of logs and configs that can be uploaded to a Github issu ``` ### Options + ``` --exclude stringArray files to exclude from the support bundle. if you specify a base name, all files matching that base name will be excluded. if you specify an absolute or relative path, only exact matches will be excluded -h, --help help for generate diff --git a/docs/cmd/finch_system.md b/docs/cmd/finch_system.md index e9ef646ea..c2f120f07 100644 --- a/docs/cmd/finch_system.md +++ b/docs/cmd/finch_system.md @@ -1,6 +1,7 @@ --- title: "finch system" --- + ## finch system Manage containerd @@ -10,6 +11,7 @@ finch system [flags] ``` ### Commands + ``` events Get real time events from the server info Display system-wide information @@ -17,6 +19,7 @@ finch system [flags] ``` ### Options + ``` -h, --help help for system ``` diff --git a/docs/cmd/finch_tag.md b/docs/cmd/finch_tag.md index 81e4f347f..2cb4b1934 100644 --- a/docs/cmd/finch_tag.md +++ b/docs/cmd/finch_tag.md @@ -1,6 +1,7 @@ --- title: "finch tag" --- + ## finch tag Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE @@ -10,6 +11,7 @@ finch tag [flags] SOURCE_IMAGE[:TAG] TARGET_IMAGE[:TAG] ``` ### Options + ``` -h, --help help for tag ``` diff --git a/docs/cmd/finch_top.md b/docs/cmd/finch_top.md index cddf61bf6..e2b31d23d 100644 --- a/docs/cmd/finch_top.md +++ b/docs/cmd/finch_top.md @@ -1,6 +1,7 @@ --- title: "finch top" --- + ## finch top Display the running processes of a container @@ -10,6 +11,7 @@ finch top CONTAINER [ps OPTIONS] [flags] ``` ### Options + ``` -h, --help help for top ``` diff --git a/docs/cmd/finch_unpause.md b/docs/cmd/finch_unpause.md index e3d9b1382..391ac4d0f 100644 --- a/docs/cmd/finch_unpause.md +++ b/docs/cmd/finch_unpause.md @@ -1,6 +1,7 @@ --- title: "finch unpause" --- + ## finch unpause Unpause all processes within one or more containers @@ -10,6 +11,7 @@ finch unpause [flags] CONTAINER [CONTAINER, ...] ``` ### Options + ``` -h, --help help for unpause ``` diff --git a/docs/cmd/finch_update.md b/docs/cmd/finch_update.md index b13427b97..1879e3f0f 100644 --- a/docs/cmd/finch_update.md +++ b/docs/cmd/finch_update.md @@ -1,6 +1,7 @@ --- title: "finch update" --- + ## finch update Update one or more running containers @@ -10,6 +11,7 @@ finch update [flags] CONTAINER [CONTAINER, ...] ``` ### Options + ``` --blkio-weight uint16 Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) --cpu-period uint Limit CPU CFS (Completely Fair Scheduler) period diff --git a/docs/cmd/finch_version.md b/docs/cmd/finch_version.md index 7261a8605..39cd9a438 100644 --- a/docs/cmd/finch_version.md +++ b/docs/cmd/finch_version.md @@ -1,6 +1,7 @@ --- title: "finch version" --- + ## finch version Shows Finch version information @@ -10,6 +11,7 @@ Shows Finch version information ``` ### Options + ``` -h, --help help for version ``` diff --git a/docs/cmd/finch_vm_init.md b/docs/cmd/finch_vm_init.md index 232141d72..e273d160d 100644 --- a/docs/cmd/finch_vm_init.md +++ b/docs/cmd/finch_vm_init.md @@ -1,6 +1,7 @@ --- title: "finch vm init" --- + ## finch vm init Initialize the virtual machine @@ -10,6 +11,7 @@ Initialize the virtual machine ``` ### Options + ``` -h, --help help for init ``` diff --git a/docs/cmd/finch_vm_remove.md b/docs/cmd/finch_vm_remove.md index 8ee73973f..8423d0239 100644 --- a/docs/cmd/finch_vm_remove.md +++ b/docs/cmd/finch_vm_remove.md @@ -1,6 +1,7 @@ --- title: "finch vm remove" --- + ## finch vm remove Remove the virtual machine instance @@ -10,6 +11,7 @@ Remove the virtual machine instance ``` ### Options + ``` -f, --force forcibly remove finch VM -h, --help help for remove diff --git a/docs/cmd/finch_vm_start.md b/docs/cmd/finch_vm_start.md index dcf3a6ea6..3fb9bbdbc 100644 --- a/docs/cmd/finch_vm_start.md +++ b/docs/cmd/finch_vm_start.md @@ -1,6 +1,7 @@ --- title: "finch vm start" --- + ## finch vm start Start the virtual machine @@ -10,6 +11,7 @@ Start the virtual machine ``` ### Options + ``` -h, --help help for start ``` diff --git a/docs/cmd/finch_vm_status.md b/docs/cmd/finch_vm_status.md index 342c4b46a..73a46d852 100644 --- a/docs/cmd/finch_vm_status.md +++ b/docs/cmd/finch_vm_status.md @@ -1,6 +1,7 @@ --- title: "finch vm status" --- + ## finch vm status Status of the virtual machine @@ -10,6 +11,7 @@ Status of the virtual machine ``` ### Options + ``` -h, --help help for status ``` diff --git a/docs/cmd/finch_vm_stop.md b/docs/cmd/finch_vm_stop.md index 1722e968f..7eaed00bf 100644 --- a/docs/cmd/finch_vm_stop.md +++ b/docs/cmd/finch_vm_stop.md @@ -1,6 +1,7 @@ --- title: "finch vm stop" --- + ## finch vm stop Stop the virtual machine @@ -10,6 +11,7 @@ Stop the virtual machine ``` ### Options + ``` -f, --force forcibly stop finch VM -h, --help help for stop diff --git a/docs/cmd/finch_volume.md b/docs/cmd/finch_volume.md index 0734da547..44a22dfe9 100644 --- a/docs/cmd/finch_volume.md +++ b/docs/cmd/finch_volume.md @@ -1,6 +1,7 @@ --- title: "finch volume" --- + ## finch volume Manage volumes @@ -10,6 +11,7 @@ finch volume [flags] ``` ### Commands + ``` create Create a volume inspect Display detailed information on one or more volumes @@ -19,6 +21,7 @@ finch volume [flags] ``` ### Options + ``` -h, --help help for volume ``` diff --git a/docs/cmd/finch_wait.md b/docs/cmd/finch_wait.md index 705746ef1..299a65248 100644 --- a/docs/cmd/finch_wait.md +++ b/docs/cmd/finch_wait.md @@ -1,6 +1,7 @@ --- title: "finch wait" --- + ## finch wait Block until one or more containers stop, then print their exit codes. @@ -10,6 +11,7 @@ finch wait [flags] CONTAINER [CONTAINER, ...] ``` ### Options + ``` -h, --help help for wait ```