From 9c9fbf06d640ab413845df42652222b5f1ac9f37 Mon Sep 17 00:00:00 2001 From: yunielrc87 Date: Wed, 6 Sep 2023 17:12:13 -0400 Subject: [PATCH] fix(install): install man pages from docs directory --- Makefile | 7 +- doc/usr/share/man/man1/vedv-builder-build.1 | 56 +++++++++++ doc/usr/share/man/man1/vedv-builder.1 | 44 +++++++++ doc/usr/share/man/man1/vedv-container-copy.1 | 56 +++++++++++ .../share/man/man1/vedv-container-create.1 | 60 ++++++++++++ .../share/man/man1/vedv-container-eports.1 | 43 +++++++++ doc/usr/share/man/man1/vedv-container-exec.1 | 66 +++++++++++++ doc/usr/share/man/man1/vedv-container-kill.1 | 40 ++++++++ doc/usr/share/man/man1/vedv-container-list.1 | 46 ++++++++++ doc/usr/share/man/man1/vedv-container-login.1 | 49 ++++++++++ doc/usr/share/man/man1/vedv-container-ports.1 | 43 +++++++++ .../share/man/man1/vedv-container-remove.1 | 46 ++++++++++ .../share/man/man1/vedv-container-restart.1 | 43 +++++++++ doc/usr/share/man/man1/vedv-container-start.1 | 46 ++++++++++ doc/usr/share/man/man1/vedv-container-stop.1 | 43 +++++++++ doc/usr/share/man/man1/vedv-container.1 | 82 +++++++++++++++++ doc/usr/share/man/man1/vedv-container.1.md | 92 ------------------- doc/usr/share/man/man1/vedv-image-build.1 | 56 +++++++++++ doc/usr/share/man/man1/vedv-image-eports.1 | 43 +++++++++ doc/usr/share/man/man1/vedv-image-export.1 | 50 ++++++++++ doc/usr/share/man/man1/vedv-image-from-url.1 | 51 ++++++++++ doc/usr/share/man/man1/vedv-image-import.1 | 54 +++++++++++ doc/usr/share/man/man1/vedv-image-list.1 | 39 ++++++++ doc/usr/share/man/man1/vedv-image-pull.1 | 50 ++++++++++ doc/usr/share/man/man1/vedv-image-push-link.1 | 54 +++++++++++ doc/usr/share/man/man1/vedv-image-push.1 | 48 ++++++++++ .../share/man/man1/vedv-image-remove-cache.1 | 36 ++++++++ doc/usr/share/man/man1/vedv-image-remove.1 | 46 ++++++++++ doc/usr/share/man/man1/vedv-image.1 | 77 ++++++++++++++++ .../man/man1/vedv-registry-cache-clean.1 | 40 ++++++++ doc/usr/share/man/man1/vedv-registry-pull.1 | 50 ++++++++++ .../share/man/man1/vedv-registry-push-link.1 | 55 +++++++++++ doc/usr/share/man/man1/vedv-registry-push.1 | 48 ++++++++++ doc/usr/share/man/man1/vedv-registry.1 | 54 +++++++++++ doc/usr/share/man/man1/vedv.1 | 53 +++++++++++ doc/usr/share/man/man1/vedv.1.md | 57 ------------ install | 10 +- tools/gen-manpages | 13 ++- 38 files changed, 1689 insertions(+), 157 deletions(-) create mode 100644 doc/usr/share/man/man1/vedv-builder-build.1 create mode 100644 doc/usr/share/man/man1/vedv-builder.1 create mode 100644 doc/usr/share/man/man1/vedv-container-copy.1 create mode 100644 doc/usr/share/man/man1/vedv-container-create.1 create mode 100644 doc/usr/share/man/man1/vedv-container-eports.1 create mode 100644 doc/usr/share/man/man1/vedv-container-exec.1 create mode 100644 doc/usr/share/man/man1/vedv-container-kill.1 create mode 100644 doc/usr/share/man/man1/vedv-container-list.1 create mode 100644 doc/usr/share/man/man1/vedv-container-login.1 create mode 100644 doc/usr/share/man/man1/vedv-container-ports.1 create mode 100644 doc/usr/share/man/man1/vedv-container-remove.1 create mode 100644 doc/usr/share/man/man1/vedv-container-restart.1 create mode 100644 doc/usr/share/man/man1/vedv-container-start.1 create mode 100644 doc/usr/share/man/man1/vedv-container-stop.1 create mode 100644 doc/usr/share/man/man1/vedv-container.1 delete mode 100644 doc/usr/share/man/man1/vedv-container.1.md create mode 100644 doc/usr/share/man/man1/vedv-image-build.1 create mode 100644 doc/usr/share/man/man1/vedv-image-eports.1 create mode 100644 doc/usr/share/man/man1/vedv-image-export.1 create mode 100644 doc/usr/share/man/man1/vedv-image-from-url.1 create mode 100644 doc/usr/share/man/man1/vedv-image-import.1 create mode 100644 doc/usr/share/man/man1/vedv-image-list.1 create mode 100644 doc/usr/share/man/man1/vedv-image-pull.1 create mode 100644 doc/usr/share/man/man1/vedv-image-push-link.1 create mode 100644 doc/usr/share/man/man1/vedv-image-push.1 create mode 100644 doc/usr/share/man/man1/vedv-image-remove-cache.1 create mode 100644 doc/usr/share/man/man1/vedv-image-remove.1 create mode 100644 doc/usr/share/man/man1/vedv-image.1 create mode 100644 doc/usr/share/man/man1/vedv-registry-cache-clean.1 create mode 100644 doc/usr/share/man/man1/vedv-registry-pull.1 create mode 100644 doc/usr/share/man/man1/vedv-registry-push-link.1 create mode 100644 doc/usr/share/man/man1/vedv-registry-push.1 create mode 100644 doc/usr/share/man/man1/vedv-registry.1 create mode 100644 doc/usr/share/man/man1/vedv.1 delete mode 100644 doc/usr/share/man/man1/vedv.1.md diff --git a/Makefile b/Makefile index 32712b2..da617c7 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,7 @@ +SHELL=/bin/bash + # grep -Po '^\S+(?=:)' Makefile | tr '\n' ' ' -.PHONY: install uninstall configure configure-ci commit test-unit test-integration test-functional test-all test-all-ci test-suite test-tag test-name gen-manpages untested registry-dev-setup registry-dev-stop registry-dev-destroy registry-dev-start registry-dev-status registry-dev-ssh registry-prod-setup +.PHONY: install install-deps-manjaro install-deps-ubuntu uninstall configure configure-ci commit test-unit test-integration test-functional test-all test-all-ci test-suite test-tag test-name gen-manpages untested registry-dev-setup registry-dev-stop registry-dev-destroy registry-dev-start registry-dev-status registry-dev-ssh registry-prod-setup install: # OPTIONAL ENV VARS: DESTDIR @@ -54,8 +56,7 @@ test-name: ./tools/bats --filter '$(n)' $(u) gen-manpages: - # MANDATORY ENV VAR: DIR - ./tools/gen-manpages + DIR="$${DIR:-doc/usr/share/man/man1}" GZIP="$${GZIP:-false}" ./tools/gen-manpages untested: ./tools/untested $(f) diff --git a/doc/usr/share/man/man1/vedv-builder-build.1 b/doc/usr/share/man/man1/vedv-builder-build.1 new file mode 100644 index 0000000..019b617 --- /dev/null +++ b/doc/usr/share/man/man1/vedv-builder-build.1 @@ -0,0 +1,56 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-builder-build" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-builder-build - Build an image from a Vedvfile +.SH SYNOPSIS +.PP +vedv builder build [FLAGS] [OPTIONS] VEDVFILE +.SH DESCRIPTION +.PP +Build an image from a Vedvfile +.SH ALIASES +.PP +vedv image build +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show the help +.TP +\f[V]--force\f[R] +Force the build removing the image containers +.TP +\f[V]--no-cache\f[R] +Do not use cache when building the image +.TP +\f[V]--no-wait\f[R] +It will not wait for the image to stop after build +.SH OPTIONS +.TP +\f[V]-n, --name \f[R] +Image name +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-builder diff --git a/doc/usr/share/man/man1/vedv-builder.1 b/doc/usr/share/man/man1/vedv-builder.1 new file mode 100644 index 0000000..80f581f --- /dev/null +++ b/doc/usr/share/man/man1/vedv-builder.1 @@ -0,0 +1,44 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-builder" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-builder - Build an image +.SH SYNOPSIS +.PP +vedv builder COMMAND +.SH DESCRIPTION +.PP +Build an image +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show this help +.SH COMMANDS +.TP +\f[V]build\f[R] +Build an image from a Vedvfile +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-builder-build(1) diff --git a/doc/usr/share/man/man1/vedv-container-copy.1 b/doc/usr/share/man/man1/vedv-container-copy.1 new file mode 100644 index 0000000..07b260a --- /dev/null +++ b/doc/usr/share/man/man1/vedv-container-copy.1 @@ -0,0 +1,56 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-container-copy" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-container-copy - Copy files from local filesystem to a container +.SH SYNOPSIS +.PP +vedv container copy [FLAGS] [OPTIONS] CONTAINER LOCAL_SRC CONTAINER_DEST +.SH DESCRIPTION +.PP +Copy files from local filesystem to a container +.SH ALIASES +.PP +cp, copy +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show help +.TP +\f[V]-r, --root\f[R] +Copy as root user +.SH OPTIONS +.TP +\f[V]-u, --user \f[R] +Copy as specific user +.TP +\f[V]--chown \f[R] +Change owner of copied files +.TP +\f[V]--chmod \f[R] +Change mode of copied files +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-container diff --git a/doc/usr/share/man/man1/vedv-container-create.1 b/doc/usr/share/man/man1/vedv-container-create.1 new file mode 100644 index 0000000..fd18e83 --- /dev/null +++ b/doc/usr/share/man/man1/vedv-container-create.1 @@ -0,0 +1,60 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-container-create" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-container-create - Create a new container +.SH SYNOPSIS +.PP +vedv container create [FLAGS] [OPTIONS] IMAGE_NAME|URL|FILE|FQN +.SH DESCRIPTION +.PP +Create a new container +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show help +.TP +\f[V]-s, --standalone\f[R] +Create a standalone container +.TP +\f[V]-P, --publish-all\f[R] +Publish all exposed ports to random ports +.SH OPTIONS +.TP +\f[V]-n, --name \f[R] +Assign a name to the container +.TP +\f[V]-p, --publish :\[rs][/proto\[rs]]\f[R] +Publish a container\[cq]s port(s) to the host. +proto is tcp or udp (default tcp) +.TP +\f[V]-c, --cpus \f[R] +Number of CPUs +.TP +\f[V]-m, --memory \f[R] +Memory capacity +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-container diff --git a/doc/usr/share/man/man1/vedv-container-eports.1 b/doc/usr/share/man/man1/vedv-container-eports.1 new file mode 100644 index 0000000..e355726 --- /dev/null +++ b/doc/usr/share/man/man1/vedv-container-eports.1 @@ -0,0 +1,43 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-container-eports" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-container-eports - List exposed ports for the container +.SH SYNOPSIS +.PP +vedv container list-exposed-ports CONTAINER +.SH DESCRIPTION +.PP +List exposed ports for the container +.SH ALIASES +.PP +eports, list-exposed-ports +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show help +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-container diff --git a/doc/usr/share/man/man1/vedv-container-exec.1 b/doc/usr/share/man/man1/vedv-container-exec.1 new file mode 100644 index 0000000..b712cf1 --- /dev/null +++ b/doc/usr/share/man/man1/vedv-container-exec.1 @@ -0,0 +1,66 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-container-exec" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-container-exec - Execute a command in a container +.SH SYNOPSIS +.PP +vedv container exec [FLAGS] [OPTIONS] CONTAINER COMMAND1 [COMMAND2] +\&... +.PP +vedv container exec [FLAGS] [OPTIONS] CONTAINER <\f[R] +Working directory for command +.TP +\f[V]-e, --env\f[R] +.TP +\f[V]-s, --shell\f[R] +shell to use for command +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-container diff --git a/doc/usr/share/man/man1/vedv-container-kill.1 b/doc/usr/share/man/man1/vedv-container-kill.1 new file mode 100644 index 0000000..9fde1ae --- /dev/null +++ b/doc/usr/share/man/man1/vedv-container-kill.1 @@ -0,0 +1,40 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-container-kill" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-container-kill - Kill one or more running containers +.SH SYNOPSIS +.PP +vedv container kill [FLAGS] CONTAINER [CONTAINER\&...] +.SH DESCRIPTION +.PP +Kill one or more running containers +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show help +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-container diff --git a/doc/usr/share/man/man1/vedv-container-list.1 b/doc/usr/share/man/man1/vedv-container-list.1 new file mode 100644 index 0000000..ab17154 --- /dev/null +++ b/doc/usr/share/man/man1/vedv-container-list.1 @@ -0,0 +1,46 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-container-list" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-container-list - List containers +.SH SYNOPSIS +.PP +vedv container ls [FLAGS] [CONTAINER PARTIAL NAME] +.SH DESCRIPTION +.PP +List containers +.SH ALIASES +.PP +ls, ps, list +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show help +.TP +\f[V]-a, --all\f[R] +Show all containers (default shows just running) +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-container diff --git a/doc/usr/share/man/man1/vedv-container-login.1 b/doc/usr/share/man/man1/vedv-container-login.1 new file mode 100644 index 0000000..74aa7b8 --- /dev/null +++ b/doc/usr/share/man/man1/vedv-container-login.1 @@ -0,0 +1,49 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-container-login" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-container-login - Login to a container +.SH SYNOPSIS +.PP +vedv container login [FLAGS] [OPTIONS] CONTAINER +.SH DESCRIPTION +.PP +Login to a container +.SH ALIASES +.PP +login, connect +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show help +.TP +\f[V]-r, --root\f[R] +Login as root +.SH OPTIONS +.TP +\f[V]-u, --user login as user\f[R] +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-container diff --git a/doc/usr/share/man/man1/vedv-container-ports.1 b/doc/usr/share/man/man1/vedv-container-ports.1 new file mode 100644 index 0000000..6f6d42b --- /dev/null +++ b/doc/usr/share/man/man1/vedv-container-ports.1 @@ -0,0 +1,43 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-container-ports" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-container-ports - List port mappings for the container +.SH SYNOPSIS +.PP +vedv container ports CONTAINER +.SH DESCRIPTION +.PP +List port mappings for the container +.SH ALIASES +.PP +ports, list-ports +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show help +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-container diff --git a/doc/usr/share/man/man1/vedv-container-remove.1 b/doc/usr/share/man/man1/vedv-container-remove.1 new file mode 100644 index 0000000..bf538e2 --- /dev/null +++ b/doc/usr/share/man/man1/vedv-container-remove.1 @@ -0,0 +1,46 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-container-remove" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-container-remove - Remove one or more running containers +.SH SYNOPSIS +.PP +vedv container rm [FLAGS] CONTAINER [CONTAINER\&...] +.SH DESCRIPTION +.PP +Remove one or more running containers +.SH ALIASES +.PP +rm, remove +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show help +.TP +\f[V]--force\f[R] +Force remove +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-container diff --git a/doc/usr/share/man/man1/vedv-container-restart.1 b/doc/usr/share/man/man1/vedv-container-restart.1 new file mode 100644 index 0000000..9e58c45 --- /dev/null +++ b/doc/usr/share/man/man1/vedv-container-restart.1 @@ -0,0 +1,43 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-container-restart" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-container-restart - Restart one or more started containers +.SH SYNOPSIS +.PP +vedv container restart [FLAGS] CONTAINER [CONTAINER\&...] +.SH DESCRIPTION +.PP +Restart one or more started containers +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show help +.TP +\f[V]-w, --wait\f[R] +Wait for SSH +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-container diff --git a/doc/usr/share/man/man1/vedv-container-start.1 b/doc/usr/share/man/man1/vedv-container-start.1 new file mode 100644 index 0000000..ef3d315 --- /dev/null +++ b/doc/usr/share/man/man1/vedv-container-start.1 @@ -0,0 +1,46 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-container-start" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-container-start - Start one or more stopped containers +.SH SYNOPSIS +.PP +vedv container start [FLAGS] CONTAINER [CONTAINER\&...] +.SH DESCRIPTION +.PP +Start one or more stopped containers +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show help +.TP +\f[V]-w, --wait\f[R] +Wait for SSH +.TP +\f[V]--show\f[R] +Show container gui on supported desktop platforms +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-container diff --git a/doc/usr/share/man/man1/vedv-container-stop.1 b/doc/usr/share/man/man1/vedv-container-stop.1 new file mode 100644 index 0000000..a50a8b7 --- /dev/null +++ b/doc/usr/share/man/man1/vedv-container-stop.1 @@ -0,0 +1,43 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-container-stop" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-container-stop - Stop one or more running containers +.SH SYNOPSIS +.PP +vedv container stop [FLAGS] CONTAINER [CONTAINER\&...] +.SH DESCRIPTION +.PP +Stop one or more running containers +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show help +.TP +\f[V]--no-save\f[R] +Do not save state +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-container diff --git a/doc/usr/share/man/man1/vedv-container.1 b/doc/usr/share/man/man1/vedv-container.1 new file mode 100644 index 0000000..0193611 --- /dev/null +++ b/doc/usr/share/man/man1/vedv-container.1 @@ -0,0 +1,82 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-container" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-container - Manage containers +.SH SYNOPSIS +.PP +vedv container COMMAND +.SH DESCRIPTION +.PP +Manage containers +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show this help +.SH COMMANDS +.TP +\f[V]create\f[R] +Create a new container +.TP +\f[V]start\f[R] +Start one or more containers +.TP +\f[V]remove\f[R] +Remove one or more containers +.TP +\f[V]stop\f[R] +Stop one or more containers +.TP +\f[V]restart\f[R] +Restart one or more containers +.TP +\f[V]kill\f[R] +Kill one or more running containers +.TP +\f[V]list\f[R] +List containers +.TP +\f[V]login\f[R] +Login to a container +.TP +\f[V]exec\f[R] +Execute a command in a container +.TP +\f[V]copy\f[R] +Copy files from local filesystem to a container +.TP +\f[V]ports\f[R] +List port mappings for the container +.TP +\f[V]eports\f[R] +List exposed ports for the container +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-container-create(1), vedv-container-start(1), +vedv-container-remove(1), vedv-container-stop(1), +vedv-container-restart(1), vedv-container-kill(1), +vedv-container-list(1), vedv-container-login(1), vedv-container-exec(1), +vedv-container-copy(1), vedv-container-ports(1), +vedv-container-eports(1) diff --git a/doc/usr/share/man/man1/vedv-container.1.md b/doc/usr/share/man/man1/vedv-container.1.md deleted file mode 100644 index fbb0c9d..0000000 --- a/doc/usr/share/man/man1/vedv-container.1.md +++ /dev/null @@ -1,92 +0,0 @@ -% vedv(1) | Vedv User Manuals - -NAME -==== - -vedv-container - Manage containers - -SYNOPSIS -======== - -`vedv container COMMAND` - -DESCRIPTION -=========== - -Manage containers - -FLAGS -===== - -`-h, --help` - -: Show the help - -Management Commands -=================== - -`create` - -: Create a new container - -`start` - -: Start one or more containers - -`remove` - -: Remove one or more containers - -`stop` - -: Stop one or more containers - -`restart` - -: Restart one or more containers - -`kill` - -: Kill one or more running containers - -`list` - -: List containers - -`login` - -: Login to a container - -`exec` - -: Execute a command in a container - -`copy` - -: Copy files from local filesystem to a container - -`ports` - -: List port mappings for the container - -`eports` - -: List exposed ports for the container - -AUTHOR -====== - -Written by Yuniel Roque Cardenas - -REPORTING BUGS -============== - -Report bugs at - -SEE ALSO -======== - -vedv-container-create(1), vedv-container-start(1), vedv-container-remove(1), -vedv-container-stop(1), vedv-container-restart(1), vedv-container-kill(1), -vedv-container-list(1), vedv-container-login(1), vedv-container-exec(1), -vedv-container-copy(1), vedv-container-ports(1), vedv-container-eports(1) diff --git a/doc/usr/share/man/man1/vedv-image-build.1 b/doc/usr/share/man/man1/vedv-image-build.1 new file mode 100644 index 0000000..128fc1b --- /dev/null +++ b/doc/usr/share/man/man1/vedv-image-build.1 @@ -0,0 +1,56 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-image-build" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-image-build - Build an image from a Vedvfile +.SH SYNOPSIS +.PP +vedv image build [FLAGS] [OPTIONS] VEDVFILE +.SH DESCRIPTION +.PP +Build an image from a Vedvfile +.SH ALIASES +.PP +vedv builder build +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show the help +.TP +\f[V]--force\f[R] +Force the build removing the image containers +.TP +\f[V]--no-cache\f[R] +Do not use cache when building the image +.TP +\f[V]--no-wait\f[R] +It will not wait for the image to stop after build +.SH OPTIONS +.TP +\f[V]-n, --name \f[R] +Image name +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-image diff --git a/doc/usr/share/man/man1/vedv-image-eports.1 b/doc/usr/share/man/man1/vedv-image-eports.1 new file mode 100644 index 0000000..f3217f6 --- /dev/null +++ b/doc/usr/share/man/man1/vedv-image-eports.1 @@ -0,0 +1,43 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-image-eports" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-image-eports - List exposed ports for the image +.SH SYNOPSIS +.PP +vedv image list-exposed-ports IMAGE +.SH DESCRIPTION +.PP +List exposed ports for the image +.SH ALIASES +.PP +eports, list-exposed-ports +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show help +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-image diff --git a/doc/usr/share/man/man1/vedv-image-export.1 b/doc/usr/share/man/man1/vedv-image-export.1 new file mode 100644 index 0000000..856a479 --- /dev/null +++ b/doc/usr/share/man/man1/vedv-image-export.1 @@ -0,0 +1,50 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-image-export" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-image-export - Export an image to a file +.SH SYNOPSIS +.PP +vedv image export [FLAGS] [OPTIONS] IMAGE FILE.ova +.SH DESCRIPTION +.PP +Export an image to a file +.SH ALIASES +.PP +export, to-file +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show help +.SH OPTIONS +.TP +\f[V]--no-checksum\f[R] +Do not create a checksum file +.TP +\f[V]--no-change-password do not change password on image export to the\f[R] +default one +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-image diff --git a/doc/usr/share/man/man1/vedv-image-from-url.1 b/doc/usr/share/man/man1/vedv-image-from-url.1 new file mode 100644 index 0000000..0375140 --- /dev/null +++ b/doc/usr/share/man/man1/vedv-image-from-url.1 @@ -0,0 +1,51 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-image-from-url" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-image-from-url - Import an image from a url +.SH SYNOPSIS +.PP +vedv image from-url [FLAGS] [OPTIONS] URL +.SH DESCRIPTION +.PP +Import an image from a url +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show help +.TP +\f[V]--check\f[R] +The checksum is downloaded from the same url as the image suffixed with +\&.sha256sum +.SH OPTIONS +.TP +\f[V]-n, --name \f[R] +Image name +.TP +\f[V]--checksum-url download the checksum from the URL and check it using\f[R] +sha256sum algorithm. +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-image-from diff --git a/doc/usr/share/man/man1/vedv-image-import.1 b/doc/usr/share/man/man1/vedv-image-import.1 new file mode 100644 index 0000000..66a8c61 --- /dev/null +++ b/doc/usr/share/man/man1/vedv-image-import.1 @@ -0,0 +1,54 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-image-import" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-image-import - Import an image from a file +.SH SYNOPSIS +.PP +vedv image import [FLAGS] [OPTIONS] IMAGE_FILE.ova +.SH DESCRIPTION +.PP +Import an image from a file +.SH ALIASES +.PP +import, from-file +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show help +.TP +\f[V]--check\f[R] +The checksum is readed from a file with the same name as the image file +and the extension .sha256sum. +.SH OPTIONS +.TP +\f[V]-n, --name \f[R] +Image name +.TP +\f[V]--check-file \f[R] +Read the checksum from the FILE and check it using sha256sum algorithm. +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-image diff --git a/doc/usr/share/man/man1/vedv-image-list.1 b/doc/usr/share/man/man1/vedv-image-list.1 new file mode 100644 index 0000000..90355d8 --- /dev/null +++ b/doc/usr/share/man/man1/vedv-image-list.1 @@ -0,0 +1,39 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-image-list" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-image-list - List images +.SH SYNOPSIS +.PP +vedv image ls +.SH DESCRIPTION +.PP +List images +.SH ALIASES +.PP +ls, list +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-image diff --git a/doc/usr/share/man/man1/vedv-image-pull.1 b/doc/usr/share/man/man1/vedv-image-pull.1 new file mode 100644 index 0000000..956b3fd --- /dev/null +++ b/doc/usr/share/man/man1/vedv-image-pull.1 @@ -0,0 +1,50 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-image-pull" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-image-pull - Download an image from the registry +.SH SYNOPSIS +.PP +vedv image pull [FLAGS] [OPTIONS] [DOMAIN/]USER\[at]COLLECTION/NAME +.SH DESCRIPTION +.PP +Download an image from the registry +.SH ALIASES +.PP +vedv registry pull +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show help +.TP +\f[V]--no-cache\f[R] +Do not use cache when downloading the image +.SH OPTIONS +.TP +\f[V]-n, --name \f[R] +Image name +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-image diff --git a/doc/usr/share/man/man1/vedv-image-push-link.1 b/doc/usr/share/man/man1/vedv-image-push-link.1 new file mode 100644 index 0000000..2df596e --- /dev/null +++ b/doc/usr/share/man/man1/vedv-image-push-link.1 @@ -0,0 +1,54 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-image-push-link" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-image-push-link - Upload an image link to a registry +.SH SYNOPSIS +.PP +vedv image push-link [FLAGS] OPTIONS [DOMAIN/]USER\[at]COLLECTION/NAME +.SH DESCRIPTION +.PP +Upload an image link to a registry +.SH ALIASES +.PP +vedv registry push-link +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show help +.SH MANDATORY OPTIONS +.TP +\f[V]--image-address
\f[R] +Image address. +The address format depends on the storage service, see below for more +information: gdrive (file >100mb): gdrive-big=, +gdrive (file <=100mb): gdrive-small=, onedrive: +onedrive=, http: http= +.TP +\f[V]--checksum-address
\f[R] +Checksum address +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-image-push diff --git a/doc/usr/share/man/man1/vedv-image-push.1 b/doc/usr/share/man/man1/vedv-image-push.1 new file mode 100644 index 0000000..79fca2c --- /dev/null +++ b/doc/usr/share/man/man1/vedv-image-push.1 @@ -0,0 +1,48 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-image-push" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-image-push - Upload an image to a registry +.SH SYNOPSIS +.PP +vedv image push [FLAGS] [OPTIONS] [DOMAIN/]USER\[at]COLLECTION/NAME +.SH DESCRIPTION +.PP +Upload an image to a registry +.SH ALIASES +.PP +vedv registry push +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show help +.SH OPTIONS +.TP +\f[V]-n, --name \f[R] +Name of the image that will be pushed to the registry, if not specified, +the name on fqn will be used +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-image diff --git a/doc/usr/share/man/man1/vedv-image-remove-cache.1 b/doc/usr/share/man/man1/vedv-image-remove-cache.1 new file mode 100644 index 0000000..2be8bda --- /dev/null +++ b/doc/usr/share/man/man1/vedv-image-remove-cache.1 @@ -0,0 +1,36 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-image-remove-cache" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-image-remove-cache - Remove unused cache images +.SH SYNOPSIS +.PP +vedv image remove-cache +.SH DESCRIPTION +.PP +Remove unused cache images +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-image-remove diff --git a/doc/usr/share/man/man1/vedv-image-remove.1 b/doc/usr/share/man/man1/vedv-image-remove.1 new file mode 100644 index 0000000..af92bf7 --- /dev/null +++ b/doc/usr/share/man/man1/vedv-image-remove.1 @@ -0,0 +1,46 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-image-remove" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-image-remove - Remove one or more images +.SH SYNOPSIS +.PP +vedv image rm [FLAGS] IMAGE [IMAGE\&...] +.SH DESCRIPTION +.PP +Remove one or more images +.SH ALIASES +.PP +rm, remove +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show help +.TP +\f[V]--force\f[R] +Force remove +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-image diff --git a/doc/usr/share/man/man1/vedv-image.1 b/doc/usr/share/man/man1/vedv-image.1 new file mode 100644 index 0000000..717327f --- /dev/null +++ b/doc/usr/share/man/man1/vedv-image.1 @@ -0,0 +1,77 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-image" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-image - Manage images +.SH SYNOPSIS +.PP +vedv image COMMAND +.SH DESCRIPTION +.PP +Manage images +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show this help +.SH COMMANDS +.TP +\f[V]import\f[R] +Import an image from a file +.TP +\f[V]export\f[R] +Export an image to a file +.TP +\f[V]from-url\f[R] +Import an image from a url +.TP +\f[V]build\f[R] +Build an image from a Vedvfile +.TP +\f[V]pull\f[R] +Download an image from the registry +.TP +\f[V]push\f[R] +Upload an image to a registry +.TP +\f[V]push-link\f[R] +Upload an image link to a registry +.TP +\f[V]list\f[R] +List images +.TP +\f[V]remove\f[R] +Remove one or more images +.TP +\f[V]remove-cache\f[R] +Remove unused cache images +.TP +\f[V]eports\f[R] +List exposed ports for the image +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-image-import(1), vedv-image-export(1), vedv-image-from-url(1), +vedv-image-build(1), vedv-image-pull(1), vedv-image-push(1), +vedv-image-push-link(1), vedv-image-list(1), vedv-image-remove(1), +vedv-image-remove-cache(1), vedv-image-eports(1) diff --git a/doc/usr/share/man/man1/vedv-registry-cache-clean.1 b/doc/usr/share/man/man1/vedv-registry-cache-clean.1 new file mode 100644 index 0000000..cd8e3ac --- /dev/null +++ b/doc/usr/share/man/man1/vedv-registry-cache-clean.1 @@ -0,0 +1,40 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-registry-cache-clean" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-registry-cache-clean - clean the registry cache +.SH SYNOPSIS +.PP +vedv registry cache-clean +.SH DESCRIPTION +.PP +clean the registry cache +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show help +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-registry-cache diff --git a/doc/usr/share/man/man1/vedv-registry-pull.1 b/doc/usr/share/man/man1/vedv-registry-pull.1 new file mode 100644 index 0000000..4c7fdad --- /dev/null +++ b/doc/usr/share/man/man1/vedv-registry-pull.1 @@ -0,0 +1,50 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-registry-pull" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-registry-pull - Download an image from the registry +.SH SYNOPSIS +.PP +vedv registry pull [FLAGS] [OPTIONS] [DOMAIN/]USER\[at]COLLECTION/NAME +.SH DESCRIPTION +.PP +Download an image from the registry +.SH ALIASES +.PP +vedv image pull +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show help +.TP +\f[V]--no-cache\f[R] +Do not use cache when downloading the image +.SH OPTIONS +.TP +\f[V]-n, --name \f[R] +Image name +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-registry diff --git a/doc/usr/share/man/man1/vedv-registry-push-link.1 b/doc/usr/share/man/man1/vedv-registry-push-link.1 new file mode 100644 index 0000000..1b542e7 --- /dev/null +++ b/doc/usr/share/man/man1/vedv-registry-push-link.1 @@ -0,0 +1,55 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-registry-push-link" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-registry-push-link - Upload an image link to a registry +.SH SYNOPSIS +.PP +vedv registry push-link [FLAGS] OPTIONS +[DOMAIN/]USER\[at]COLLECTION/NAME +.SH DESCRIPTION +.PP +Upload an image link to a registry +.SH ALIASES +.PP +vedv image push-link +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show help +.SH MANDATORY OPTIONS +.TP +\f[V]--image-address
\f[R] +Image address. +The address format depends on the storage service, see below for more +information: gdrive (file >100mb): gdrive-big=, +gdrive (file <=100mb): gdrive-small=, onedrive: +onedrive=, http: http= +.TP +\f[V]--checksum-address
\f[R] +Checksum address +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-registry-push diff --git a/doc/usr/share/man/man1/vedv-registry-push.1 b/doc/usr/share/man/man1/vedv-registry-push.1 new file mode 100644 index 0000000..6c9de67 --- /dev/null +++ b/doc/usr/share/man/man1/vedv-registry-push.1 @@ -0,0 +1,48 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-registry-push" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-registry-push - Upload an image to a registry +.SH SYNOPSIS +.PP +vedv registry push [FLAGS] [OPTIONS] [DOMAIN/]USER\[at]COLLECTION/NAME +.SH DESCRIPTION +.PP +Upload an image to a registry +.SH ALIASES +.PP +vedv image pull +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show help +.SH OPTIONS +.TP +\f[V]-n, --name \f[R] +Name of the image that will be pushed to the registry, if not specified, +the name on fqn will be used +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-registry diff --git a/doc/usr/share/man/man1/vedv-registry.1 b/doc/usr/share/man/man1/vedv-registry.1 new file mode 100644 index 0000000..ead4259 --- /dev/null +++ b/doc/usr/share/man/man1/vedv-registry.1 @@ -0,0 +1,54 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv-registry" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv-registry - Manage registry +.SH SYNOPSIS +.PP +vedv registry COMMAND +.SH DESCRIPTION +.PP +Manage registry +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show this help +.SH COMMANDS +.TP +\f[V]pull\f[R] +Download an image from the registry +.TP +\f[V]push\f[R] +Upload an image to a registry +.TP +\f[V]push-link\f[R] +Upload an image link to a registry +.TP +\f[V]cache-clean\f[R] +Clean the registry cache +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-registry-pull(1), vedv-registry-push(1), +vedv-registry-push-link(1), vedv-registry-cache-clean(1) diff --git a/doc/usr/share/man/man1/vedv.1 b/doc/usr/share/man/man1/vedv.1 new file mode 100644 index 0000000..c8d62fa --- /dev/null +++ b/doc/usr/share/man/man1/vedv.1 @@ -0,0 +1,53 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "vedv" "1" "" "" "Vedv User Manuals" +.hy +.SH NAME +.PP +vedv - A tool for developing in a secure and reproducible environment +.SH SYNOPSIS +.PP +vedv COMMAND +.SH DESCRIPTION +.PP +A tool for developing in a secure and reproducible environment +.SH FLAGS +.TP +\f[V]-h, --help\f[R] +Show this help +.SH MANAGEMENT COMMANDS +.TP +\f[V]container\f[R] +Manage containers +.TP +\f[V]image\f[R] +Manage images +.TP +\f[V]builder\f[R] +Manage builder +.TP +\f[V]registry\f[R] +Manage registry +.SH AUTHOR +.PP +Written by Yuniel Roque Cardenas +.SH REPORTING BUGS +.PP +Report bugs at +.SH SEE ALSO +.PP +vedv-container(1),vedv-image(1),vedv-builder(1),vedv-registry(1) diff --git a/doc/usr/share/man/man1/vedv.1.md b/doc/usr/share/man/man1/vedv.1.md deleted file mode 100644 index 307822a..0000000 --- a/doc/usr/share/man/man1/vedv.1.md +++ /dev/null @@ -1,57 +0,0 @@ -% vedv(1) | Vedv User Manuals - -NAME -==== - -vedv - A tool for developing in a secure and reproducible environment - -SYNOPSIS -======== - -`vedv COMMAND` - -DESCRIPTION -=========== - -A tool for developing applications in a secure and reproducible environment using virtual machines with a Docker-like flavor. - -FLAGS -===== - -`-h, --help` - -: Show the help - -Management Commands -=================== - -`container` - -: Manage containers - -`image` - -: Manage images - -`builder` - -: Manage builder - -`registry` - -: Manage registry - -AUTHOR -====== - -Written by Yuniel Roque Cardenas - -REPORTING BUGS -============== - -Report bugs at - -SEE ALSO -======== - -vedv-container(1), vedv-image(1), vedv-builder(1), vedv-registry(1) diff --git a/install b/install index 859ba22..cfa8b24 100755 --- a/install +++ b/install @@ -28,10 +28,16 @@ chmod -v 755 "${DESTDIR}/usr/lib/vedv/components/builder/__bin/vedvfile-parser" # MANDATORY ENV VAR: DIR export DIR="$(mktemp -d)" -./tools/gen-manpages mkdir -p "${DESTDIR}/usr/share/man/man1" -cp -v "${DIR}/"*.gz "${DESTDIR}/usr/share/man/man1" + +( + cd doc/usr/share/man/man1 + + for f in vedv*.1; do + gzip -v -c "$f" >"${DESTDIR}/usr/share/man/man1/${f}.gz" + done +) echo '' echo '>> INSTALLED SUCCESSFULLY' diff --git a/tools/gen-manpages b/tools/gen-manpages index 50f0871..3a9b012 100755 --- a/tools/gen-manpages +++ b/tools/gen-manpages @@ -9,6 +9,7 @@ cd "$(dirname "${BASH_SOURCE[0]}")/.." # ENVIRONMENT VARIABLES readonly DIR +readonly GZIP="${GZIP:-false}" if [[ ! -d "$DIR" ]]; then echo "Directory '${DIR}' does not exist" >&2 @@ -17,10 +18,16 @@ fi save_man_page() { local -r _cmd="$1" - local -r file_name="$(sed -E 's/\s+/-/g' <<<"$_cmd").1.gz" + local -r file_name="$(sed -E 's/\s+/-/g' <<<"$_cmd").1" - CMD="$_cmd" tools/help2md | - pandoc -s -f markdown -t man - | gzip >"${DIR}/${file_name}" + if [[ "$GZIP" == true ]]; then + CMD="$_cmd" tools/help2md | + pandoc -s -f markdown -t man - | + gzip >"${DIR}/${file_name}.gz" + else + CMD="$_cmd" tools/help2md | + pandoc -s -f markdown -t man - -o "${DIR}/${file_name}" + fi }