diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/emacs.texi | 26 | ||||
| -rw-r--r-- | doc/guix.texi | 61 |
2 files changed, 84 insertions, 3 deletions
diff --git a/doc/emacs.texi b/doc/emacs.texi index eb470ab4ca..8020e0ace3 100644 --- a/doc/emacs.texi +++ b/doc/emacs.texi @@ -9,6 +9,7 @@ Guix convenient and fun. @menu * Initial Setup: Emacs Initial Setup. Preparing @file{~/.emacs}. * Package Management: Emacs Package Management. Managing packages and generations. +* Licenses: Emacs Licenses. Interface for licenses of Guix packages. * Popup Interface: Emacs Popup Interface. Magit-like interface for guix commands. * Prettify Mode: Emacs Prettify. Abbreviating @file{/gnu/store/@dots{}} file names. * Build Log Mode: Emacs Build Log. Highlighting Guix build logs. @@ -158,6 +159,9 @@ but cannot be found among available packages). @item M-x guix-packages-by-name Display package(s) with the specified name. +@item M-x guix-packages-by-license +Display package(s) with the specified license. + @item M-x guix-search-by-regexp Search for packages by a specified regexp. By default ``name'', ``synopsis'' and ``description'' of the packages will be searched. This @@ -355,6 +359,7 @@ emacs, The GNU Emacs Manual}) which can be used to: @item install/remove a package; @item jump to a package location; @item browse home page of a package; +@item browse license URL; @item describe packages from ``Inputs'' fields. @end itemize @@ -516,6 +521,27 @@ Various settings for ``info'' buffers. @end table +@node Emacs Licenses +@section Licenses + +If you want to browse the URL of a particular license, or to look at a +list of licenses, you may use the following commands: + +@table @kbd + +@item M-x guix-browse-license-url +Choose a license from a completion list to browse its URL using +@code{browse-url} function (@pxref{Browse-URL,,, emacs, The GNU Emacs +Manual}). + +@item M-x guix-licenses +Display a list of available licenses. You can press @kbd{@key{RET}} +there to display packages with this license in the same way as @kbd{M-x +guix-packages-by-license} would do (@pxref{Emacs Commands}). + +@end table + + @node Emacs Popup Interface @section Popup Interface diff --git a/doc/guix.texi b/doc/guix.texi index a650a55d51..a6ba9485eb 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -15,8 +15,8 @@ Copyright @copyright{} 2013, 2014 Andreas Enge@* Copyright @copyright{} 2013 Nikita Karetnikov@* Copyright @copyright{} 2015 Mathieu Lirzin@* Copyright @copyright{} 2014 Pierre-Antoine Rault@* -Copyright @copyright{} 2015 Taylan Ulrich Bayırlı/Kammer -Copyright @copyright{} 2015 Leo Famulari +Copyright @copyright{} 2015 Taylan Ulrich Bayırlı/Kammer@* +Copyright @copyright{} 2015, 2016 Leo Famulari Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or @@ -111,6 +111,7 @@ Emacs Interface * Initial Setup: Emacs Initial Setup. Preparing @file{~/.emacs}. * Package Management: Emacs Package Management. Managing packages and generations. +* Licenses: Emacs Licenses. Interface for licenses of Guix packages. * Popup Interface: Emacs Popup Interface. Magit-like interface for guix commands. * Prettify Mode: Emacs Prettify. Abbreviating @file{/gnu/store/@dots{}} file names. * Build Log Mode: Emacs Build Log. Highlighting Guix build logs. @@ -174,6 +175,7 @@ System Configuration * Initial RAM Disk:: Linux-Libre bootstrapping. * GRUB Configuration:: Configuring the boot loader. * Invoking guix system:: Instantiating a system configuration. +* Running GuixSD in a VM:: How to run GuixSD in a virtual machine. * Defining Services:: Adding new service definitions. Services @@ -5693,6 +5695,7 @@ instance to support new system services. * Initial RAM Disk:: Linux-Libre bootstrapping. * GRUB Configuration:: Configuring the boot loader. * Invoking guix system:: Instantiating a system configuration. +* Running GuixSD in a VM:: How to run GuixSD in a virtual machine. * Defining Services:: Adding new service definitions. @end menu @@ -9194,7 +9197,8 @@ in @var{file} that stands alone. Use the @option{--image-size} option to specify the size of the image. When using @code{vm-image}, the returned image is in qcow2 format, which -the QEMU emulator can efficiently use. +the QEMU emulator can efficiently use. @xref{Running GuixSD in a VM}, +for more information on how to run the image in a virtual machine. When using @code{disk-image}, a raw disk image is produced; it can be copied as is to a USB stick, for instance. Assuming @code{/dev/sdc} is @@ -9333,6 +9337,57 @@ graph} of dmd services of the operating system defined in @var{file}. @end table +@node Running GuixSD in a VM +@subsection Running GuixSD in a virtual machine + +One way to run GuixSD in a virtual machine (VM) is to build a GuixSD +virtual machine image using @command{guix system vm-image} +(@pxref{Invoking guix system}). The returned image is in qcow2 format, +which the @uref{http://qemu.org/, QEMU emulator} can efficiently use. + +To run the image in QEMU, copy it out of the store (@pxref{The Store}) +and give yourself permission to write to the copy. When invoking QEMU, +you must choose a system emulator that is suitable for your hardware +platform. Here is a minimal QEMU invocation that will boot the result +of @command{guix system vm-image} on x86_64 hardware: + +@example +$ qemu-system-x86_64 \ + -net user -net nic,model=virtio \ + -enable-kvm -m 256 /tmp/qemu-image +@end example + +Here is what each of these options means: + +@table @code +@item qemu-system-x86_64 +This specifies the hardware platform to emulate. This should match the +host. + +@item -net user +Enable the unprivileged user-mode network stack. The guest OS can +access the host but not vice versa. This is the simplest way to get the +guest OS online. If you don't choose a network stack, the boot will +fail. + +@item -net nic,model=virtio +You must create a network interface of a given model. If you don't +create a NIC, the boot will fail. Assuming your hardware platform is +x86_64, you can get a list of available NIC models by running +@command{qemu-system-x86_64 -net nic,model=help}. + +@item -enable-kvm +If your system has hardware virtualization extensions, enabling the +Linux kernel's virtual machine support (KVM) will make things run +faster. + +@item -m 256 +RAM available to the guest OS, in mebibytes. Defaults to 128@tie{}MiB, +which may be insufficent for some operations. + +@item /tmp/qemu-image +The file name of the qcow2 image. +@end table @node Defining Services @subsection Defining Services |