From df42cafdec821a7a04ce62376fcaac2d55560f63 Mon Sep 17 00:00:00 2001 From: Justin Alvarez Date: Fri, 20 Oct 2023 19:20:37 -0400 Subject: [PATCH] remove title and increase header types Signed-off-by: Justin Alvarez --- cmd/finch/doc.TEMPLATE | 18 +++++++----------- docs/cmd/finch_build.md | 8 ++------ docs/cmd/finch_builder.md | 10 +++------- docs/cmd/finch_commit.md | 8 ++------ docs/cmd/finch_completion_bash.md | 8 ++------ docs/cmd/finch_completion_fish.md | 8 ++------ docs/cmd/finch_completion_powershell.md | 8 ++------ docs/cmd/finch_completion_zsh.md | 8 ++------ docs/cmd/finch_compose.md | 10 +++------- docs/cmd/finch_container.md | 10 +++------- docs/cmd/finch_cp.md | 8 ++------ docs/cmd/finch_create.md | 8 ++------ docs/cmd/finch_events.md | 8 ++------ docs/cmd/finch_exec.md | 8 ++------ docs/cmd/finch_help.md | 8 ++------ docs/cmd/finch_history.md | 8 ++------ docs/cmd/finch_image.md | 10 +++------- docs/cmd/finch_images.md | 10 +++------- docs/cmd/finch_info.md | 8 ++------ docs/cmd/finch_inspect.md | 8 ++------ docs/cmd/finch_kill.md | 8 ++------ docs/cmd/finch_load.md | 8 ++------ docs/cmd/finch_login.md | 8 ++------ docs/cmd/finch_logout.md | 8 ++------ docs/cmd/finch_logs.md | 8 ++------ docs/cmd/finch_network.md | 10 +++------- docs/cmd/finch_pause.md | 8 ++------ docs/cmd/finch_port.md | 8 ++------ docs/cmd/finch_ps.md | 8 ++------ docs/cmd/finch_pull.md | 8 ++------ docs/cmd/finch_push.md | 8 ++------ docs/cmd/finch_restart.md | 8 ++------ docs/cmd/finch_rm.md | 8 ++------ docs/cmd/finch_rmi.md | 8 ++------ docs/cmd/finch_run.md | 8 ++------ docs/cmd/finch_save.md | 8 ++------ docs/cmd/finch_start.md | 8 ++------ docs/cmd/finch_stats.md | 8 ++------ docs/cmd/finch_stop.md | 8 ++------ docs/cmd/finch_support-bundle_generate.md | 8 ++------ docs/cmd/finch_system.md | 10 +++------- docs/cmd/finch_tag.md | 8 ++------ docs/cmd/finch_top.md | 8 ++------ docs/cmd/finch_unpause.md | 8 ++------ docs/cmd/finch_update.md | 8 ++------ docs/cmd/finch_version.md | 8 ++------ docs/cmd/finch_vm_init.md | 8 ++------ docs/cmd/finch_vm_remove.md | 8 ++------ docs/cmd/finch_vm_start.md | 8 ++------ docs/cmd/finch_vm_status.md | 8 ++------ docs/cmd/finch_vm_stop.md | 8 ++------ docs/cmd/finch_volume.md | 10 +++------- docs/cmd/finch_wait.md | 8 ++------ 53 files changed, 119 insertions(+), 331 deletions(-) diff --git a/cmd/finch/doc.TEMPLATE b/cmd/finch/doc.TEMPLATE index 6aa00844f..abd394745 100644 --- a/cmd/finch/doc.TEMPLATE +++ b/cmd/finch/doc.TEMPLATE @@ -1,12 +1,8 @@ ---- -title: "{{ .CmdPath }}" ---- - -## {{ .CmdPath }} +# {{ .CmdPath }} {{if gt (len .Description) 0}}{{ .Description }} -{{end}}{{if gt (len .Properties) 0}}### Properties +{{end}}{{if gt (len .Properties) 0}}## Properties {{.Properties}} @@ -14,29 +10,29 @@ title: "{{ .CmdPath }}" {{ .Usage }} ```{{if gt (len .Aliases) 0}} -### Aliases +## Aliases {{.Aliases}} {{end}}{{if gt (len .Examples) 0}} -### Examples +## Examples {{.Examples}} {{end}}{{if gt (len .Commands) 0}} -### Commands +## Commands ```bash {{ .Commands }} ```{{end}}{{if gt (len .Options) 0}} -### Options +## Options ```bash {{ .Options }} ```{{end}}{{if gt (len .SeeAlso) 0}} -### SEE ALSO +## SEE ALSO {{ .SeeAlso }} {{end}} diff --git a/docs/cmd/finch_build.md b/docs/cmd/finch_build.md index d4b4f4127..89f9bfe71 100644 --- a/docs/cmd/finch_build.md +++ b/docs/cmd/finch_build.md @@ -1,8 +1,4 @@ ---- -title: "finch build" ---- - -## finch build +# finch build Build an image from a Dockerfile. Needs buildkitd to be running. If Dockerfile is not present and -f is not specified, it will look for Containerfile and build with it. @@ -11,7 +7,7 @@ If Dockerfile is not present and -f is not specified, it will look for Container finch build [flags] PATH ``` -### Options +## Options ```bash --build-arg stringArray Set build-time variables diff --git a/docs/cmd/finch_builder.md b/docs/cmd/finch_builder.md index 6ab987ee9..f0ac022c2 100644 --- a/docs/cmd/finch_builder.md +++ b/docs/cmd/finch_builder.md @@ -1,8 +1,4 @@ ---- -title: "finch builder" ---- - -## finch builder +# finch builder Manage builds @@ -10,7 +6,7 @@ Manage builds finch builder [flags] ``` -### Commands +## Commands ```bash build Build an image from a Dockerfile. Needs buildkitd to be running. @@ -18,7 +14,7 @@ finch builder [flags] prune Clean up BuildKit build cache ``` -### Options +## Options ```bash -h, --help help for builder diff --git a/docs/cmd/finch_commit.md b/docs/cmd/finch_commit.md index b428685ab..0cc4e557a 100644 --- a/docs/cmd/finch_commit.md +++ b/docs/cmd/finch_commit.md @@ -1,8 +1,4 @@ ---- -title: "finch commit" ---- - -## finch commit +# finch commit Create a new image from a container's changes @@ -10,7 +6,7 @@ Create a new image from a container's changes finch commit [flags] CONTAINER REPOSITORY[:TAG] ``` -### Options +## Options ```bash -a, --author string Author (e.g., "finch contributor ") diff --git a/docs/cmd/finch_completion_bash.md b/docs/cmd/finch_completion_bash.md index a0628e5e9..7fb5e5451 100644 --- a/docs/cmd/finch_completion_bash.md +++ b/docs/cmd/finch_completion_bash.md @@ -1,8 +1,4 @@ ---- -title: "finch completion bash" ---- - -## finch completion bash +# finch completion bash Generate the autocompletion script for the bash shell. @@ -21,7 +17,7 @@ To load completions for every new session, execute once: finch completion bash ``` -### Options +## Options ```bash -h, --help help for bash diff --git a/docs/cmd/finch_completion_fish.md b/docs/cmd/finch_completion_fish.md index d44095316..30e23193f 100644 --- a/docs/cmd/finch_completion_fish.md +++ b/docs/cmd/finch_completion_fish.md @@ -1,8 +1,4 @@ ---- -title: "finch completion fish" ---- - -## finch completion fish +# finch completion fish Generate the autocompletion script for the fish shell. @@ -20,7 +16,7 @@ You will need to start a new shell for this setup to take effect. finch completion fish [flags] ``` -### Options +## Options ```bash -h, --help help for fish diff --git a/docs/cmd/finch_completion_powershell.md b/docs/cmd/finch_completion_powershell.md index b10191d93..d9c4962f6 100644 --- a/docs/cmd/finch_completion_powershell.md +++ b/docs/cmd/finch_completion_powershell.md @@ -1,8 +1,4 @@ ---- -title: "finch completion powershell" ---- - -## finch completion powershell +# finch completion powershell Generate the autocompletion script for powershell. @@ -17,7 +13,7 @@ to your powershell profile. finch completion powershell [flags] ``` -### Options +## Options ```bash -h, --help help for powershell diff --git a/docs/cmd/finch_completion_zsh.md b/docs/cmd/finch_completion_zsh.md index e31c7543e..1dcfec26e 100644 --- a/docs/cmd/finch_completion_zsh.md +++ b/docs/cmd/finch_completion_zsh.md @@ -1,8 +1,4 @@ ---- -title: "finch completion zsh" ---- - -## finch completion zsh +# finch completion zsh Generate the autocompletion script for the zsh shell. @@ -23,7 +19,7 @@ To load completions for every new session, execute once: finch completion zsh [flags] ``` -### Options +## Options ```bash -h, --help help for zsh diff --git a/docs/cmd/finch_compose.md b/docs/cmd/finch_compose.md index 52ad52d80..66b5ba895 100644 --- a/docs/cmd/finch_compose.md +++ b/docs/cmd/finch_compose.md @@ -1,8 +1,4 @@ ---- -title: "finch compose" ---- - -## finch compose +# finch compose Compose @@ -10,7 +6,7 @@ Compose finch compose [flags] COMMAND ``` -### Commands +## Commands ```bash build Build or rebuild services @@ -38,7 +34,7 @@ finch compose [flags] COMMAND version Show the Compose version information ``` -### Options +## Options ```bash --env-file string Specify an alternate environment file diff --git a/docs/cmd/finch_container.md b/docs/cmd/finch_container.md index 82feb3b66..c77cced57 100644 --- a/docs/cmd/finch_container.md +++ b/docs/cmd/finch_container.md @@ -1,8 +1,4 @@ ---- -title: "finch container" ---- - -## finch container +# finch container Manage containers @@ -10,7 +6,7 @@ Manage containers finch container [flags] ``` -### Commands +## Commands ```bash attach Attach stdin, stdout, and stderr to a running container. @@ -37,7 +33,7 @@ finch container [flags] wait Block until one or more containers stop, then print their exit codes. ``` -### Options +## Options ```bash -h, --help help for container diff --git a/docs/cmd/finch_cp.md b/docs/cmd/finch_cp.md index bc7ce2338..263b2a7de 100644 --- a/docs/cmd/finch_cp.md +++ b/docs/cmd/finch_cp.md @@ -1,8 +1,4 @@ ---- -title: "finch cp" ---- - -## finch cp +# finch cp Copy files/folders between a running container and the local filesystem. This command requires 'tar' to be installed on the host (not in the container). @@ -14,7 +10,7 @@ finch cp [flags] CONTAINER:SRC_PATH DEST_PATH|- finch cp [flags] SRC_PATH|- CONTAINER:DEST_PATH ``` -### Options +## Options ```bash -L, --follow-link Always follow symbolic link in SRC_PATH. diff --git a/docs/cmd/finch_create.md b/docs/cmd/finch_create.md index f23b98a95..983ffb89f 100644 --- a/docs/cmd/finch_create.md +++ b/docs/cmd/finch_create.md @@ -1,8 +1,4 @@ ---- -title: "finch create" ---- - -## finch create +# finch create Create a new container. Optionally specify "ipfs://" or "ipns://" scheme to pull image from IPFS. @@ -10,7 +6,7 @@ Create a new container. Optionally specify "ipfs://" or "ipns://" scheme to pull finch create [flags] IMAGE [COMMAND] [ARG...] ``` -### Options +## Options ```bash --add-host strings Add a custom host-to-IP mapping (host:ip) diff --git a/docs/cmd/finch_events.md b/docs/cmd/finch_events.md index c0759bfdf..a0ab9b377 100644 --- a/docs/cmd/finch_events.md +++ b/docs/cmd/finch_events.md @@ -1,8 +1,4 @@ ---- -title: "finch events" ---- - -## finch events +# finch events Get real time events from the server @@ -10,7 +6,7 @@ Get real time events from the server finch events [flags] ``` -### Options +## Options ```bash --format string Format the output using the given Go template, e.g, '{{json .}}' diff --git a/docs/cmd/finch_exec.md b/docs/cmd/finch_exec.md index 4361fef87..3b1493ce4 100644 --- a/docs/cmd/finch_exec.md +++ b/docs/cmd/finch_exec.md @@ -1,8 +1,4 @@ ---- -title: "finch exec" ---- - -## finch exec +# finch exec Run a command in a running container @@ -10,7 +6,7 @@ Run a command in a running container finch exec [flags] CONTAINER COMMAND [ARG...] ``` -### Options +## Options ```bash -d, --detach Detached mode: run command in the background diff --git a/docs/cmd/finch_help.md b/docs/cmd/finch_help.md index f8bccccef..04ab36660 100644 --- a/docs/cmd/finch_help.md +++ b/docs/cmd/finch_help.md @@ -1,8 +1,4 @@ ---- -title: "finch help" ---- - -## finch help +# finch help Help provides help for any command in the application. Simply type finch help [path to command] for full details. @@ -11,7 +7,7 @@ Simply type finch help [path to command] for full details. finch help [command] [flags] ``` -### Options +## Options ```bash -h, --help help for help diff --git a/docs/cmd/finch_history.md b/docs/cmd/finch_history.md index 6d95253cb..5b3585bd3 100644 --- a/docs/cmd/finch_history.md +++ b/docs/cmd/finch_history.md @@ -1,8 +1,4 @@ ---- -title: "finch history" ---- - -## finch history +# finch history Show the history of an image @@ -10,7 +6,7 @@ Show the history of an image finch history [flags] IMAGE ``` -### Options +## Options ```bash -f, --format string Format the output using the given Go template, e.g, '{{json .}}' diff --git a/docs/cmd/finch_image.md b/docs/cmd/finch_image.md index bb4183624..5a81c0ee8 100644 --- a/docs/cmd/finch_image.md +++ b/docs/cmd/finch_image.md @@ -1,8 +1,4 @@ ---- -title: "finch image" ---- - -## finch image +# finch image Manage images @@ -10,7 +6,7 @@ Manage images finch image [flags] ``` -### Commands +## Commands ```bash build Build an image from a Dockerfile. Needs buildkitd to be running. @@ -29,7 +25,7 @@ finch image [flags] tag Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE ``` -### Options +## Options ```bash -h, --help help for image diff --git a/docs/cmd/finch_images.md b/docs/cmd/finch_images.md index 7ec6bace2..bc3117cf6 100644 --- a/docs/cmd/finch_images.md +++ b/docs/cmd/finch_images.md @@ -1,12 +1,8 @@ ---- -title: "finch images" ---- - -## finch images +# finch images List images -### Properties +## Properties - REPOSITORY: Repository - TAG: Tag @@ -21,7 +17,7 @@ List images finch images [flags] [REPOSITORY[:TAG]] ``` -### Options +## Options ```bash -a, --all (unimplemented yet, always true) (default true) diff --git a/docs/cmd/finch_info.md b/docs/cmd/finch_info.md index 3334459b4..653cc3e5e 100644 --- a/docs/cmd/finch_info.md +++ b/docs/cmd/finch_info.md @@ -1,8 +1,4 @@ ---- -title: "finch info" ---- - -## finch info +# finch info Display system-wide information @@ -10,7 +6,7 @@ Display system-wide information finch info [flags] ``` -### Options +## Options ```bash -f, --format string Format the output using the given Go template, e.g, '{{json .}}' diff --git a/docs/cmd/finch_inspect.md b/docs/cmd/finch_inspect.md index 440999d00..f3257e2b3 100644 --- a/docs/cmd/finch_inspect.md +++ b/docs/cmd/finch_inspect.md @@ -1,8 +1,4 @@ ---- -title: "finch inspect" ---- - -## finch inspect +# finch inspect Return low-level information on objects. @@ -10,7 +6,7 @@ Return low-level information on objects. finch inspect [flags] ``` -### Options +## Options ```bash -f, --format string Format the output using the given Go template, e.g, '{{json .}}' diff --git a/docs/cmd/finch_kill.md b/docs/cmd/finch_kill.md index 6b073dbb4..c645333fa 100644 --- a/docs/cmd/finch_kill.md +++ b/docs/cmd/finch_kill.md @@ -1,8 +1,4 @@ ---- -title: "finch kill" ---- - -## finch kill +# finch kill Kill one or more running containers @@ -10,7 +6,7 @@ Kill one or more running containers finch kill [flags] CONTAINER [CONTAINER, ...] ``` -### Options +## Options ```bash -h, --help help for kill diff --git a/docs/cmd/finch_load.md b/docs/cmd/finch_load.md index 51b18c356..d28f92219 100644 --- a/docs/cmd/finch_load.md +++ b/docs/cmd/finch_load.md @@ -1,8 +1,4 @@ ---- -title: "finch load" ---- - -## finch load +# finch load Supports both Docker Image Spec v1.2 and OCI Image Spec v1.0. @@ -10,7 +6,7 @@ Supports both Docker Image Spec v1.2 and OCI Image Spec v1.0. finch load [flags] ``` -### Options +## Options ```bash --all-platforms Import content for all platforms diff --git a/docs/cmd/finch_login.md b/docs/cmd/finch_login.md index 21383a935..2c5cea091 100644 --- a/docs/cmd/finch_login.md +++ b/docs/cmd/finch_login.md @@ -1,8 +1,4 @@ ---- -title: "finch login" ---- - -## finch login +# finch login Log in to a container registry @@ -10,7 +6,7 @@ Log in to a container registry finch login [flags] [SERVER] ``` -### Options +## Options ```bash -h, --help help for login diff --git a/docs/cmd/finch_logout.md b/docs/cmd/finch_logout.md index 3cb026552..49bb55860 100644 --- a/docs/cmd/finch_logout.md +++ b/docs/cmd/finch_logout.md @@ -1,8 +1,4 @@ ---- -title: "finch logout" ---- - -## finch logout +# finch logout Log out from a container registry @@ -10,7 +6,7 @@ Log out from a container registry finch logout [flags] [SERVER] ``` -### Options +## Options ```bash -h, --help help for logout diff --git a/docs/cmd/finch_logs.md b/docs/cmd/finch_logs.md index 606fdecc0..a5725161b 100644 --- a/docs/cmd/finch_logs.md +++ b/docs/cmd/finch_logs.md @@ -1,8 +1,4 @@ ---- -title: "finch logs" ---- - -## finch logs +# finch logs Fetch the logs of a container. @@ -15,7 +11,7 @@ The following containers are supported: finch logs [flags] CONTAINER ``` -### Options +## Options ```bash -f, --follow Follow log output diff --git a/docs/cmd/finch_network.md b/docs/cmd/finch_network.md index 9fbb576f2..e69f7c06a 100644 --- a/docs/cmd/finch_network.md +++ b/docs/cmd/finch_network.md @@ -1,8 +1,4 @@ ---- -title: "finch network" ---- - -## finch network +# finch network Manage networks @@ -10,7 +6,7 @@ Manage networks finch network [flags] ``` -### Commands +## Commands ```bash create Create a network @@ -20,7 +16,7 @@ finch network [flags] rm Remove one or more networks ``` -### Options +## Options ```bash -h, --help help for network diff --git a/docs/cmd/finch_pause.md b/docs/cmd/finch_pause.md index 9096bafd9..d7c0b35e3 100644 --- a/docs/cmd/finch_pause.md +++ b/docs/cmd/finch_pause.md @@ -1,8 +1,4 @@ ---- -title: "finch pause" ---- - -## finch pause +# finch pause Pause all processes within one or more containers @@ -10,7 +6,7 @@ Pause all processes within one or more containers finch pause [flags] CONTAINER [CONTAINER, ...] ``` -### Options +## Options ```bash -h, --help help for pause diff --git a/docs/cmd/finch_port.md b/docs/cmd/finch_port.md index 2add36cce..cc6382e6e 100644 --- a/docs/cmd/finch_port.md +++ b/docs/cmd/finch_port.md @@ -1,8 +1,4 @@ ---- -title: "finch port" ---- - -## finch port +# finch port List port mappings or a specific mapping for the container @@ -10,7 +6,7 @@ List port mappings or a specific mapping for the container finch port [flags] CONTAINER [PRIVATE_PORT[/PROTO]] ``` -### Options +## Options ```bash -h, --help help for port diff --git a/docs/cmd/finch_ps.md b/docs/cmd/finch_ps.md index 6886cbeee..076fcb269 100644 --- a/docs/cmd/finch_ps.md +++ b/docs/cmd/finch_ps.md @@ -1,8 +1,4 @@ ---- -title: "finch ps" ---- - -## finch ps +# finch ps List containers @@ -10,7 +6,7 @@ List containers finch ps [flags] ``` -### Options +## Options ```bash -a, --all Show all containers (default shows just running) diff --git a/docs/cmd/finch_pull.md b/docs/cmd/finch_pull.md index 38ef06d89..2d6a7dee9 100644 --- a/docs/cmd/finch_pull.md +++ b/docs/cmd/finch_pull.md @@ -1,8 +1,4 @@ ---- -title: "finch pull" ---- - -## finch pull +# finch pull Pull an image from a registry. Optionally specify "ipfs://" or "ipns://" scheme to pull image from IPFS. @@ -10,7 +6,7 @@ Pull an image from a registry. Optionally specify "ipfs://" or "ipns://" scheme finch pull [flags] NAME[:TAG] ``` -### Options +## Options ```bash --all-platforms Pull content for all platforms diff --git a/docs/cmd/finch_push.md b/docs/cmd/finch_push.md index 2fca75c2b..7896d8191 100644 --- a/docs/cmd/finch_push.md +++ b/docs/cmd/finch_push.md @@ -1,8 +1,4 @@ ---- -title: "finch push" ---- - -## 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,7 +6,7 @@ Push an image or a repository to a registry. Optionally specify "ipfs://" or "ip finch push [flags] NAME[:TAG] ``` -### Options +## Options ```bash --all-platforms Push content for all platforms diff --git a/docs/cmd/finch_restart.md b/docs/cmd/finch_restart.md index 3d48d02d4..d2a78d56d 100644 --- a/docs/cmd/finch_restart.md +++ b/docs/cmd/finch_restart.md @@ -1,8 +1,4 @@ ---- -title: "finch restart" ---- - -## finch restart +# finch restart Restart one or more running containers @@ -10,7 +6,7 @@ Restart one or more running containers finch restart [flags] CONTAINER [CONTAINER, ...] ``` -### Options +## Options ```bash -h, --help help for restart diff --git a/docs/cmd/finch_rm.md b/docs/cmd/finch_rm.md index bed09c443..9404ae1b3 100644 --- a/docs/cmd/finch_rm.md +++ b/docs/cmd/finch_rm.md @@ -1,8 +1,4 @@ ---- -title: "finch rm" ---- - -## finch rm +# finch rm Remove one or more containers @@ -10,7 +6,7 @@ Remove one or more containers finch rm [flags] CONTAINER [CONTAINER, ...] ``` -### Options +## Options ```bash -f, --force Force the removal of a running|paused|unknown container (uses SIGKILL) diff --git a/docs/cmd/finch_rmi.md b/docs/cmd/finch_rmi.md index 3aff10b93..3e04f6308 100644 --- a/docs/cmd/finch_rmi.md +++ b/docs/cmd/finch_rmi.md @@ -1,8 +1,4 @@ ---- -title: "finch rmi" ---- - -## finch rmi +# finch rmi Remove one or more images @@ -10,7 +6,7 @@ Remove one or more images finch rmi [flags] IMAGE [IMAGE, ...] ``` -### Options +## Options ```bash --async Asynchronous mode diff --git a/docs/cmd/finch_run.md b/docs/cmd/finch_run.md index cfa5fd75c..859471167 100644 --- a/docs/cmd/finch_run.md +++ b/docs/cmd/finch_run.md @@ -1,8 +1,4 @@ ---- -title: "finch run" ---- - -## finch run +# finch run Run a command in a new container. Optionally specify "ipfs://" or "ipns://" scheme to pull image from IPFS. @@ -10,7 +6,7 @@ Run a command in a new container. Optionally specify "ipfs://" or "ipns://" sche finch run [flags] IMAGE [COMMAND] [ARG...] ``` -### Options +## Options ```bash --add-host strings Add a custom host-to-IP mapping (host:ip) diff --git a/docs/cmd/finch_save.md b/docs/cmd/finch_save.md index ce6def61c..088a20c2e 100644 --- a/docs/cmd/finch_save.md +++ b/docs/cmd/finch_save.md @@ -1,8 +1,4 @@ ---- -title: "finch save" ---- - -## finch save +# finch save The archive implements both Docker Image Spec v1.2 and OCI Image Spec v1.0. @@ -10,7 +6,7 @@ The archive implements both Docker Image Spec v1.2 and OCI Image Spec v1.0. finch save [flags] ``` -### Options +## Options ```bash --all-platforms Export content for all platforms diff --git a/docs/cmd/finch_start.md b/docs/cmd/finch_start.md index ad498d03b..f1eb11d87 100644 --- a/docs/cmd/finch_start.md +++ b/docs/cmd/finch_start.md @@ -1,8 +1,4 @@ ---- -title: "finch start" ---- - -## finch start +# finch start Start one or more running containers @@ -10,7 +6,7 @@ Start one or more running containers finch start [flags] CONTAINER [CONTAINER, ...] ``` -### Options +## Options ```bash -a, --attach Attach STDOUT/STDERR and forward signals diff --git a/docs/cmd/finch_stats.md b/docs/cmd/finch_stats.md index 87b5bb529..b4717ca88 100644 --- a/docs/cmd/finch_stats.md +++ b/docs/cmd/finch_stats.md @@ -1,8 +1,4 @@ ---- -title: "finch stats" ---- - -## finch stats +# finch stats Display a live stream of container(s) resource usage statistics. @@ -10,7 +6,7 @@ Display a live stream of container(s) resource usage statistics. finch stats [flags] ``` -### Options +## Options ```bash -a, --all Show all containers (default shows just running) diff --git a/docs/cmd/finch_stop.md b/docs/cmd/finch_stop.md index b727d8688..bdde5d9f5 100644 --- a/docs/cmd/finch_stop.md +++ b/docs/cmd/finch_stop.md @@ -1,8 +1,4 @@ ---- -title: "finch stop" ---- - -## finch stop +# finch stop Stop one or more running containers @@ -10,7 +6,7 @@ Stop one or more running containers finch stop [flags] CONTAINER [CONTAINER, ...] ``` -### Options +## Options ```bash -h, --help help for stop diff --git a/docs/cmd/finch_support-bundle_generate.md b/docs/cmd/finch_support-bundle_generate.md index dfba58bd6..a3bc64567 100644 --- a/docs/cmd/finch_support-bundle_generate.md +++ b/docs/cmd/finch_support-bundle_generate.md @@ -1,8 +1,4 @@ ---- -title: "finch support-bundle generate" ---- - -## 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,7 +6,7 @@ Generates a collection of logs and configs that can be uploaded to a Github issu finch support-bundle generate [flags] ``` -### Options +## Options ```bash --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 diff --git a/docs/cmd/finch_system.md b/docs/cmd/finch_system.md index 66eb71ffd..303cf84a6 100644 --- a/docs/cmd/finch_system.md +++ b/docs/cmd/finch_system.md @@ -1,8 +1,4 @@ ---- -title: "finch system" ---- - -## finch system +# finch system Manage containerd @@ -10,7 +6,7 @@ Manage containerd finch system [flags] ``` -### Commands +## Commands ```bash events Get real time events from the server @@ -18,7 +14,7 @@ finch system [flags] prune Remove unused data ``` -### Options +## Options ```bash -h, --help help for system diff --git a/docs/cmd/finch_tag.md b/docs/cmd/finch_tag.md index 61583852a..5498d99b4 100644 --- a/docs/cmd/finch_tag.md +++ b/docs/cmd/finch_tag.md @@ -1,8 +1,4 @@ ---- -title: "finch tag" ---- - -## finch tag +# finch tag Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE @@ -10,7 +6,7 @@ Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE finch tag [flags] SOURCE_IMAGE[:TAG] TARGET_IMAGE[:TAG] ``` -### Options +## Options ```bash -h, --help help for tag diff --git a/docs/cmd/finch_top.md b/docs/cmd/finch_top.md index 25e2c6f4c..76cdf59be 100644 --- a/docs/cmd/finch_top.md +++ b/docs/cmd/finch_top.md @@ -1,8 +1,4 @@ ---- -title: "finch top" ---- - -## finch top +# finch top Display the running processes of a container @@ -10,7 +6,7 @@ Display the running processes of a container finch top CONTAINER [ps OPTIONS] [flags] ``` -### Options +## Options ```bash -h, --help help for top diff --git a/docs/cmd/finch_unpause.md b/docs/cmd/finch_unpause.md index 22d6abf61..aa7de0fb0 100644 --- a/docs/cmd/finch_unpause.md +++ b/docs/cmd/finch_unpause.md @@ -1,8 +1,4 @@ ---- -title: "finch unpause" ---- - -## finch unpause +# finch unpause Unpause all processes within one or more containers @@ -10,7 +6,7 @@ Unpause all processes within one or more containers finch unpause [flags] CONTAINER [CONTAINER, ...] ``` -### Options +## Options ```bash -h, --help help for unpause diff --git a/docs/cmd/finch_update.md b/docs/cmd/finch_update.md index 6eebda17d..e8b996ec9 100644 --- a/docs/cmd/finch_update.md +++ b/docs/cmd/finch_update.md @@ -1,8 +1,4 @@ ---- -title: "finch update" ---- - -## finch update +# finch update Update one or more running containers @@ -10,7 +6,7 @@ Update one or more running containers finch update [flags] CONTAINER [CONTAINER, ...] ``` -### Options +## Options ```bash --blkio-weight uint16 Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) diff --git a/docs/cmd/finch_version.md b/docs/cmd/finch_version.md index 3c8209fed..154242727 100644 --- a/docs/cmd/finch_version.md +++ b/docs/cmd/finch_version.md @@ -1,8 +1,4 @@ ---- -title: "finch version" ---- - -## finch version +# finch version Shows Finch version information @@ -10,7 +6,7 @@ Shows Finch version information finch version [flags] ``` -### Options +## Options ```bash -h, --help help for version diff --git a/docs/cmd/finch_vm_init.md b/docs/cmd/finch_vm_init.md index 0a3e7cbca..d63487076 100644 --- a/docs/cmd/finch_vm_init.md +++ b/docs/cmd/finch_vm_init.md @@ -1,8 +1,4 @@ ---- -title: "finch vm init" ---- - -## finch vm init +# finch vm init Initialize the virtual machine @@ -10,7 +6,7 @@ Initialize the virtual machine finch vm init [flags] ``` -### Options +## Options ```bash -h, --help help for init diff --git a/docs/cmd/finch_vm_remove.md b/docs/cmd/finch_vm_remove.md index 9a51e9259..7c384faba 100644 --- a/docs/cmd/finch_vm_remove.md +++ b/docs/cmd/finch_vm_remove.md @@ -1,8 +1,4 @@ ---- -title: "finch vm remove" ---- - -## finch vm remove +# finch vm remove Remove the virtual machine instance @@ -10,7 +6,7 @@ Remove the virtual machine instance finch vm remove [flags] ``` -### Options +## Options ```bash -f, --force forcibly remove finch VM diff --git a/docs/cmd/finch_vm_start.md b/docs/cmd/finch_vm_start.md index e91898dd9..1a348c35f 100644 --- a/docs/cmd/finch_vm_start.md +++ b/docs/cmd/finch_vm_start.md @@ -1,8 +1,4 @@ ---- -title: "finch vm start" ---- - -## finch vm start +# finch vm start Start the virtual machine @@ -10,7 +6,7 @@ Start the virtual machine finch vm start [flags] ``` -### Options +## Options ```bash -h, --help help for start diff --git a/docs/cmd/finch_vm_status.md b/docs/cmd/finch_vm_status.md index fca8537e9..fcc58586a 100644 --- a/docs/cmd/finch_vm_status.md +++ b/docs/cmd/finch_vm_status.md @@ -1,8 +1,4 @@ ---- -title: "finch vm status" ---- - -## finch vm status +# finch vm status Status of the virtual machine @@ -10,7 +6,7 @@ Status of the virtual machine finch vm status [flags] ``` -### Options +## Options ```bash -h, --help help for status diff --git a/docs/cmd/finch_vm_stop.md b/docs/cmd/finch_vm_stop.md index f71cfcac4..d355c3e00 100644 --- a/docs/cmd/finch_vm_stop.md +++ b/docs/cmd/finch_vm_stop.md @@ -1,8 +1,4 @@ ---- -title: "finch vm stop" ---- - -## finch vm stop +# finch vm stop Stop the virtual machine @@ -10,7 +6,7 @@ Stop the virtual machine finch vm stop [flags] ``` -### Options +## Options ```bash -f, --force forcibly stop finch VM diff --git a/docs/cmd/finch_volume.md b/docs/cmd/finch_volume.md index ba3a5075d..72c50ff1b 100644 --- a/docs/cmd/finch_volume.md +++ b/docs/cmd/finch_volume.md @@ -1,8 +1,4 @@ ---- -title: "finch volume" ---- - -## finch volume +# finch volume Manage volumes @@ -10,7 +6,7 @@ Manage volumes finch volume [flags] ``` -### Commands +## Commands ```bash create Create a volume @@ -20,7 +16,7 @@ finch volume [flags] rm Remove one or more volumes ``` -### Options +## Options ```bash -h, --help help for volume diff --git a/docs/cmd/finch_wait.md b/docs/cmd/finch_wait.md index c114628e6..ed51d42dc 100644 --- a/docs/cmd/finch_wait.md +++ b/docs/cmd/finch_wait.md @@ -1,8 +1,4 @@ ---- -title: "finch wait" ---- - -## finch wait +# finch wait Block until one or more containers stop, then print their exit codes. @@ -10,7 +6,7 @@ Block until one or more containers stop, then print their exit codes. finch wait [flags] CONTAINER [CONTAINER, ...] ``` -### Options +## Options ```bash -h, --help help for wait