summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDavid Thompson <davet@gnu.org>2015-07-01 20:32:07 -0400
committerDavid Thompson <dthompson2@worcester.edu>2015-11-01 18:20:04 -0500
commit32efa254a80672bdf5199b8e200764615a3cf68b (patch)
tree9b1b5c543352eff8b7b795ad0576f07e04ddde66 /doc
parent7c5a442091175361263ca15c50432488c5af89f6 (diff)
scripts: Add 'container' subcommand.
* guix/scripts/container.scm: New file. * guix/scripts/container/exec.scm: New file. * po/guix/POTFILES.in: Add them. * Makefile.am (MODULES): Add them. * doc/guix.texi (Invoking guix container): New section.
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi56
1 files changed, 56 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 474a56e6db8..431db5d75fe 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -144,6 +144,7 @@ Utilities
144* Invoking guix environment:: Setting up development environments. 144* Invoking guix environment:: Setting up development environments.
145* Invoking guix publish:: Sharing substitutes. 145* Invoking guix publish:: Sharing substitutes.
146* Invoking guix challenge:: Challenging substitute servers. 146* Invoking guix challenge:: Challenging substitute servers.
147* Invoking guix container:: Process isolation.
147 148
148GNU Distribution 149GNU Distribution
149 150
@@ -3583,6 +3584,7 @@ programming interface of Guix in a convenient way.
3583* Invoking guix environment:: Setting up development environments. 3584* Invoking guix environment:: Setting up development environments.
3584* Invoking guix publish:: Sharing substitutes. 3585* Invoking guix publish:: Sharing substitutes.
3585* Invoking guix challenge:: Challenging substitute servers. 3586* Invoking guix challenge:: Challenging substitute servers.
3587* Invoking guix container:: Process isolation.
3586@end menu 3588@end menu
3587 3589
3588@node Invoking guix build 3590@node Invoking guix build
@@ -5036,6 +5038,60 @@ URLs to compare to.
5036@end table 5038@end table
5037 5039
5038 5040
5041@node Invoking guix container
5042@section Invoking @command{guix container}
5043@cindex container
5044
5045@quotation Note
5046As of version @value{VERSION}, this tool is experimental. The interface
5047is subject to radical change in the future.
5048@end quotation
5049
5050The purpose of @command{guix container} is to manipulate processes
5051running within an isolated environment, commonly known as a
5052``container,'' typically created by the @command{guix environment}
5053(@pxref{Invoking guix environment}) and @command{guix system container}
5054(@pxref{Invoking guix system}) commands.
5055
5056The general syntax is:
5057
5058@example
5059guix container @var{action} @var{options}@dots{}
5060@end example
5061
5062@var{action} specifies the operation to perform with a container, and
5063@var{options} specifies the context-specific arguments for the action.
5064
5065The following actions are available:
5066
5067@table @code
5068@item exec
5069Execute a command within the context of a running container.
5070
5071The syntax is:
5072
5073@example
5074guix container exec @var{pid} @var{program} @var{arguments}@dots{}
5075@end example
5076
5077@var{pid} specifies the process ID of the running container.
5078@var{program} specifies an executable file name within the container's
5079root file system. @var{arguments} are the additional options that will
5080be passed to @var{program}.
5081
5082The following command launches an interactive login shell inside a
5083GuixSD container, started by @command{guix system container}, and whose
5084process ID is 9001:
5085
5086@example
5087guix container exec 9001 /run/current-system/profile/bin/bash --login
5088@end example
5089
5090Note that the @var{pid} cannot be the parent process of a container. It
5091must be the container's PID 1 or one of its child processes.
5092
5093@end table
5094
5039@c ********************************************************************* 5095@c *********************************************************************
5040@node GNU Distribution 5096@node GNU Distribution
5041@chapter GNU Distribution 5097@chapter GNU Distribution