diff options
author | Ludovic Courtès <ludo@gnu.org> | 2017-03-17 09:44:08 +0100 |
---|---|---|
committer | Ludovic Courtès <ludo@gnu.org> | 2017-03-17 09:46:13 +0100 |
commit | 708b54a99252d3929b8062bc57167cc6d097a126 (patch) | |
tree | ad99c044eb22003216544d3facd1bed271080ef2 | |
parent | 54d556bdd739dc617c27eeedf9e28706e3277d0e (diff) | |
download | patches-708b54a99252d3929b8062bc57167cc6d097a126.tar patches-708b54a99252d3929b8062bc57167cc6d097a126.tar.gz |
doc: Really document 'guix pack --format'.
* doc/guix.texi (Invoking guix pack): Properly document --format.
-rw-r--r-- | doc/guix.texi | 24 |
1 files changed, 19 insertions, 5 deletions
diff --git a/doc/guix.texi b/doc/guix.texi index 93640dfba5..3db6dad5f3 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -2438,11 +2438,8 @@ guix pack -S /opt/gnu/bin=bin guile emacs geiser @noindent That way, users can happily type @file{/opt/gnu/bin/guile} and enjoy. -Alternatively, you can produce a pack in the Docker image format, as -described in -@uref{https://github.com/docker/docker/blob/master/image/spec/v1.2.md, -version 1.2 of the specification}. This is what the following command -does: +Alternatively, you can produce a pack in the Docker image format using +the following command: @example guix pack -f docker guile emacs geiser @@ -2457,6 +2454,23 @@ documentation} for more information. Several command-line options allow you to customize your pack: @table @code +@item --format=@var{format} +@itemx -f @var{format} +Produce a pack in the given @var{format}. + +The available formats are: + +@table @code +@item tarball +This is the default format. It produces a tarball containing all the +specifies binaries and symlinks. + +@item docker +This produces a tarball that follows the +@uref{https://github.com/docker/docker/blob/master/image/spec/v1.2.md, +Docker Image Specification}. +@end table + @item --system=@var{system} @itemx -s @var{system} Attempt to build for @var{system}---e.g., @code{i686-linux}---instead of |