Skip to content

Commit

Permalink
fix(install): install man pages from docs directory
Browse files Browse the repository at this point in the history
  • Loading branch information
yunielrc committed Sep 6, 2023
1 parent 96ba2cd commit 9c9fbf0
Show file tree
Hide file tree
Showing 38 changed files with 1,689 additions and 157 deletions.
7 changes: 4 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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)
Expand Down
56 changes: 56 additions & 0 deletions doc/usr/share/man/man1/vedv-builder-build.1
Original file line number Diff line number Diff line change
@@ -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 <name>\f[R]
Image name
.SH AUTHOR
.PP
Written by Yuniel Roque Cardenas <https://github.com/yunielrc>
.SH REPORTING BUGS
.PP
Report bugs at <https://github.com/yunielrc/vedv/issues>
.SH SEE ALSO
.PP
vedv-builder
44 changes: 44 additions & 0 deletions doc/usr/share/man/man1/vedv-builder.1
Original file line number Diff line number Diff line change
@@ -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 <https://github.com/yunielrc>
.SH REPORTING BUGS
.PP
Report bugs at <https://github.com/yunielrc/vedv/issues>
.SH SEE ALSO
.PP
vedv-builder-build(1)
56 changes: 56 additions & 0 deletions doc/usr/share/man/man1/vedv-container-copy.1
Original file line number Diff line number Diff line change
@@ -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 <user>\f[R]
Copy as specific user
.TP
\f[V]--chown <user:group>\f[R]
Change owner of copied files
.TP
\f[V]--chmod <mode>\f[R]
Change mode of copied files
.SH AUTHOR
.PP
Written by Yuniel Roque Cardenas <https://github.com/yunielrc>
.SH REPORTING BUGS
.PP
Report bugs at <https://github.com/yunielrc/vedv/issues>
.SH SEE ALSO
.PP
vedv-container
60 changes: 60 additions & 0 deletions doc/usr/share/man/man1/vedv-container-create.1
Original file line number Diff line number Diff line change
@@ -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 <name>\f[R]
Assign a name to the container
.TP
\f[V]-p, --publish <host-port>:<port>\[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 <cpus>\f[R]
Number of CPUs
.TP
\f[V]-m, --memory <memory>\f[R]
Memory capacity
.SH AUTHOR
.PP
Written by Yuniel Roque Cardenas <https://github.com/yunielrc>
.SH REPORTING BUGS
.PP
Report bugs at <https://github.com/yunielrc/vedv/issues>
.SH SEE ALSO
.PP
vedv-container
43 changes: 43 additions & 0 deletions doc/usr/share/man/man1/vedv-container-eports.1
Original file line number Diff line number Diff line change
@@ -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 <https://github.com/yunielrc>
.SH REPORTING BUGS
.PP
Report bugs at <https://github.com/yunielrc/vedv/issues>
.SH SEE ALSO
.PP
vedv-container
66 changes: 66 additions & 0 deletions doc/usr/share/man/man1/vedv-container-exec.1
Original file line number Diff line number Diff line change
@@ -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 <<EOF
.PP
COMMAND1
.PP
[COMMAND2]
.PP
\&...
.PP
EOF
.SH DESCRIPTION
.PP
Execute a command in a container
.SH FLAGS
.TP
\f[V]-h, --help\f[R]
Show help
.TP
\f[V]-r, --root\f[R]
Execute command as root user
.SH OPTIONS
.TP
\f[V]-u, --user\f[R]
execute command as specific user
.TP
\f[V]-w, --workdir <dir>\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 <https://github.com/yunielrc>
.SH REPORTING BUGS
.PP
Report bugs at <https://github.com/yunielrc/vedv/issues>
.SH SEE ALSO
.PP
vedv-container
40 changes: 40 additions & 0 deletions doc/usr/share/man/man1/vedv-container-kill.1
Original file line number Diff line number Diff line change
@@ -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 <https://github.com/yunielrc>
.SH REPORTING BUGS
.PP
Report bugs at <https://github.com/yunielrc/vedv/issues>
.SH SEE ALSO
.PP
vedv-container
Loading

0 comments on commit 9c9fbf0

Please sign in to comment.