Automatic Man Page Update

Signed-off-by: distrobox-docs-bot <[email protected]>
89luca89 · Jan 19, 2025 · 700241d · 700241d
1 parent 05ee385
commit 700241d
Show file tree

Hide file tree

Showing 14 changed files with 128 additions and 26 deletions.
diff --git a/man/man1/distrobox-assemble.1 b/man/man1/distrobox-assemble.1
@@ -15,7 +15,7 @@
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "DISTROBOX-ASSEMBLE" "1" "Dec 2024" "Distrobox" "User Manual"
+.TH "DISTROBOX-ASSEMBLE" "1" "Jan 2025" "Distrobox" "User Manual"
 .hy
 .SH NAME
 .IP
@@ -150,6 +150,13 @@ You can always test what distrobox \f[B]would do\f[R] by using the
 This command will only print what commands distrobox would do without
 actually running them.
 .PP
+\f[B]Clone\f[R]
+.PP
+\f[B]Disclaimer\f[R]: You need to start the container once to ensure it
+is fully initialized and created before cloning it.
+The container being copied must also be stopped before the cloning
+process can proceed.
+.PP
 \f[B]Available options\f[R]
 .PP
 This is a list of available options with the corresponding type:
@@ -217,6 +224,14 @@ T}@T{
 Which image should the container use, look here for a list
 T}
 T{
+clone
+T}@T{
+string
+T}@T{
+Name of the Distrobox container to use as the base for a new container
+(the container must be stopped).
+T}
+T{
 init_hooks
 T}@T{
 string_list
@@ -377,3 +392,39 @@ exported_bins=\[dq]/usr/bin/htop /usr/bin/git\[dq]
 exported_bins_path=\[dq]\[ti]/.local/bin\[dq]
 \f[R]
 .fi
+.PP
+\f[B]Clone example\f[R]
+.IP
+.nf
+\f[C]
+[ubuntu]
+additional_packages=\[dq]git vim tmux\[dq]
+image=ubuntu:latest
+init=false
+nvidia=false
+pull=true
+root=false
+replace=true
+start_now=true
+
+[deno_ubuntu]
+clone=ubuntu
+init=false
+nvidia=false
+pull=true
+root=false
+replace=true
+start_now=true
+pre_init_hooks=curl -fsSL https://deno.land/install.sh | sh;
+
+[bun_ubuntu]
+clone=ubuntu
+init=false
+nvidia=false
+pull=true
+root=false
+replace=true
+start_now=true
+pre_init_hooks=curl -fsSL https://bun.sh/install | bash;
+\f[R]
+.fi
diff --git a/man/man1/distrobox-compatibility.1 b/man/man1/distrobox-compatibility.1
@@ -15,7 +15,7 @@
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "DISTROBOX" "1" "Dec 2024" "Distrobox" "User Manual"
+.TH "DISTROBOX" "1" "Jan 2025" "Distrobox" "User Manual"
 .hy
 .SH COMPATIBILITY
 .PP

diff --git a/man/man1/distrobox-create.1 b/man/man1/distrobox-create.1
@@ -14,7 +14,7 @@
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "DISTROBOX-CREATE" "1" "Dec 2024" "Distrobox" "User Manual"
+.TH "DISTROBOX-CREATE" "1" "Jan 2025" "Distrobox" "User Manual"
 .hy
 .SH NAME
 .IP

diff --git a/man/man1/distrobox-enter.1 b/man/man1/distrobox-enter.1
@@ -14,7 +14,7 @@
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "DISTROBOX-ENTER" "1" "Dec 2024" "Distrobox" "User Manual"
+.TH "DISTROBOX-ENTER" "1" "Jan 2025" "Distrobox" "User Manual"
 .hy
 .SH NAME
 .IP

diff --git a/man/man1/distrobox-ephemeral.1 b/man/man1/distrobox-ephemeral.1
@@ -14,7 +14,7 @@
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "DISTROBOX-EPHEMERAL" "1" "Dec 2024" "Distrobox" "User Manual"
+.TH "DISTROBOX-EPHEMERAL" "1" "Jan 2025" "Distrobox" "User Manual"
 .hy
 .SH NAME
 .IP

diff --git a/man/man1/distrobox-export.1 b/man/man1/distrobox-export.1
@@ -14,7 +14,7 @@
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "DISTROBOX-EXPORT" "1" "Dec 2024" "Distrobox" "User Manual"
+.TH "DISTROBOX-EXPORT" "1" "Jan 2025" "Distrobox" "User Manual"
 .hy
 .SH NAME
 .IP

diff --git a/man/man1/distrobox-generate-entry.1 b/man/man1/distrobox-generate-entry.1
@@ -14,7 +14,7 @@
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "DISTROBOX-GENERATE-ENTRY" "1" "Dec 2024" "Distrobox" "User Manual"
+.TH "DISTROBOX-GENERATE-ENTRY" "1" "Jan 2025" "Distrobox" "User Manual"
 .hy
 .SH NAME
 .IP

diff --git a/man/man1/distrobox-host-exec.1 b/man/man1/distrobox-host-exec.1
@@ -14,7 +14,7 @@
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "DISTROBOX-HOST-EXEC" "1" "Dec 2024" "Distrobox" "User Manual"
+.TH "DISTROBOX-HOST-EXEC" "1" "Jan 2025" "Distrobox" "User Manual"
 .hy
 .SH NAME
 .IP

diff --git a/man/man1/distrobox-init.1 b/man/man1/distrobox-init.1
@@ -14,7 +14,7 @@
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "DISTROBOX-INIT" "1" "Dec 2024" "Distrobox" "User Manual"
+.TH "DISTROBOX-INIT" "1" "Jan 2025" "Distrobox" "User Manual"
 .hy
 .SH NAME
 .IP

diff --git a/man/man1/distrobox-list.1 b/man/man1/distrobox-list.1
@@ -14,7 +14,7 @@
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "DISTROBOX-LIST" "1" "Dec 2024" "Distrobox" "User Manual"
+.TH "DISTROBOX-LIST" "1" "Jan 2025" "Distrobox" "User Manual"
 .hy
 .SH NAME
 .IP

diff --git a/man/man1/distrobox-rm.1 b/man/man1/distrobox-rm.1
@@ -14,7 +14,7 @@
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "DISTROBOX-RM" "1" "Dec 2024" "Distrobox" "User Manual"
+.TH "DISTROBOX-RM" "1" "Jan 2025" "Distrobox" "User Manual"
 .hy
 .SH NAME
 .IP

diff --git a/man/man1/distrobox-stop.1 b/man/man1/distrobox-stop.1
@@ -14,7 +14,7 @@
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "DISTROBOX-STOP" "1" "Dec 2024" "Distrobox" "User Manual"
+.TH "DISTROBOX-STOP" "1" "Jan 2025" "Distrobox" "User Manual"
 .hy
 .SH NAME
 .IP

diff --git a/man/man1/distrobox-upgrade.1 b/man/man1/distrobox-upgrade.1
@@ -14,7 +14,7 @@
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "DISTROBOX-UPGRADE" "1" "Dec 2024" "Distrobox" "User Manual"
+.TH "DISTROBOX-UPGRADE" "1" "Jan 2025" "Distrobox" "User Manual"
 .hy
 .SH NAME
 .IP

diff --git a/man/man1/distrobox.1 b/man/man1/distrobox.1
@@ -15,7 +15,7 @@
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "DISTROBOX-ASSEMBLE" "1" "Dec 2024" "Distrobox" "User Manual"
+.TH "DISTROBOX-ASSEMBLE" "1" "Jan 2025" "Distrobox" "User Manual"
 .hy
 .SH NAME
 .IP
@@ -150,6 +150,13 @@ You can always test what distrobox \f[B]would do\f[R] by using the
 This command will only print what commands distrobox would do without
 actually running them.
 .PP
+\f[B]Clone\f[R]
+.PP
+\f[B]Disclaimer\f[R]: You need to start the container once to ensure it
+is fully initialized and created before cloning it.
+The container being copied must also be stopped before the cloning
+process can proceed.
+.PP
 \f[B]Available options\f[R]
 .PP
 This is a list of available options with the corresponding type:
@@ -217,6 +224,14 @@ T}@T{
 Which image should the container use, look here for a list
 T}
 T{
+clone
+T}@T{
+string
+T}@T{
+Name of the Distrobox container to use as the base for a new container
+(the container must be stopped).
+T}
+T{
 init_hooks
 T}@T{
 string_list
@@ -377,6 +392,42 @@ exported_bins=\[dq]/usr/bin/htop /usr/bin/git\[dq]
 exported_bins_path=\[dq]\[ti]/.local/bin\[dq]
 \f[R]
 .fi
+.PP
+\f[B]Clone example\f[R]
+.IP
+.nf
+\f[C]
+[ubuntu]
+additional_packages=\[dq]git vim tmux\[dq]
+image=ubuntu:latest
+init=false
+nvidia=false
+pull=true
+root=false
+replace=true
+start_now=true
+
+[deno_ubuntu]
+clone=ubuntu
+init=false
+nvidia=false
+pull=true
+root=false
+replace=true
+start_now=true
+pre_init_hooks=curl -fsSL https://deno.land/install.sh | sh;
+
+[bun_ubuntu]
+clone=ubuntu
+init=false
+nvidia=false
+pull=true
+root=false
+replace=true
+start_now=true
+pre_init_hooks=curl -fsSL https://bun.sh/install | bash;
+\f[R]
+.fi
 '\" t
 .\
 .\"
@@ -394,7 +445,7 @@ exported_bins_path=\[dq]\[ti]/.local/bin\[dq]
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "DISTROBOX" "1" "Dec 2024" "Distrobox" "User Manual"
+.TH "DISTROBOX" "1" "Jan 2025" "Distrobox" "User Manual"
 .hy
 .SH COMPATIBILITY
 .PP
@@ -871,7 +922,7 @@ up the integration independently from the distrobox\[cq]s own flag.
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "DISTROBOX-CREATE" "1" "Dec 2024" "Distrobox" "User Manual"
+.TH "DISTROBOX-CREATE" "1" "Jan 2025" "Distrobox" "User Manual"
 .hy
 .SH NAME
 .IP
@@ -1266,7 +1317,7 @@ Void Linux (glibc)
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "DISTROBOX-ENTER" "1" "Dec 2024" "Distrobox" "User Manual"
+.TH "DISTROBOX-ENTER" "1" "Jan 2025" "Distrobox" "User Manual"
 .hy
 .SH NAME
 .IP
@@ -1416,7 +1467,7 @@ run distrobox commands involving rootful containers using `doas'.
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "DISTROBOX-EPHEMERAL" "1" "Dec 2024" "Distrobox" "User Manual"
+.TH "DISTROBOX-EPHEMERAL" "1" "Jan 2025" "Distrobox" "User Manual"
 .hy
 .SH NAME
 .IP
@@ -1488,7 +1539,7 @@ a list of supported environment variables to use.
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "DISTROBOX-EXPORT" "1" "Dec 2024" "Distrobox" "User Manual"
+.TH "DISTROBOX-EXPORT" "1" "Jan 2025" "Distrobox" "User Manual"
 .hy
 .SH NAME
 .IP
@@ -1645,7 +1696,7 @@ option to provide a series of flags, for example:
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "DISTROBOX-GENERATE-ENTRY" "1" "Dec 2024" "Distrobox" "User Manual"
+.TH "DISTROBOX-GENERATE-ENTRY" "1" "Jan 2025" "Distrobox" "User Manual"
 .hy
 .SH NAME
 .IP
@@ -1723,7 +1774,7 @@ distrobox generate-entry container-name --delete
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "DISTROBOX-HOST-EXEC" "1" "Dec 2024" "Distrobox" "User Manual"
+.TH "DISTROBOX-HOST-EXEC" "1" "Jan 2025" "Distrobox" "User Manual"
 .hy
 .SH NAME
 .IP
@@ -1797,7 +1848,7 @@ distrobox-host-exec podman ps -a
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "DISTROBOX-INIT" "1" "Dec 2024" "Distrobox" "User Manual"
+.TH "DISTROBOX-INIT" "1" "Jan 2025" "Distrobox" "User Manual"
 .hy
 .SH NAME
 .IP
@@ -1865,7 +1916,7 @@ distrobox-init --upgrade
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "DISTROBOX-LIST" "1" "Dec 2024" "Distrobox" "User Manual"
+.TH "DISTROBOX-LIST" "1" "Jan 2025" "Distrobox" "User Manual"
 .hy
 .SH NAME
 .IP
@@ -1936,7 +1987,7 @@ DBX_SUDO_PROGRAM
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "DISTROBOX-RM" "1" "Dec 2024" "Distrobox" "User Manual"
+.TH "DISTROBOX-RM" "1" "Jan 2025" "Distrobox" "User Manual"
 .hy
 .SH NAME
 .IP
@@ -2008,7 +2059,7 @@ DBX_SUDO_PROGRAM
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "DISTROBOX-STOP" "1" "Dec 2024" "Distrobox" "User Manual"
+.TH "DISTROBOX-STOP" "1" "Jan 2025" "Distrobox" "User Manual"
 .hy
 .SH NAME
 .IP
@@ -2085,7 +2136,7 @@ DBX_SUDO_PROGRAM
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "DISTROBOX-UPGRADE" "1" "Dec 2024" "Distrobox" "User Manual"
+.TH "DISTROBOX-UPGRADE" "1" "Jan 2025" "Distrobox" "User Manual"
 .hy
 .SH NAME
 .IP