summary refs log tree commit diff
path: root/doc/guix.texi
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2013-02-01 13:16:27 +0100
committerLudovic Courtès <ludo@gnu.org>2013-02-01 13:16:41 +0100
commit299112d36e872d98896bf8dec281c34d9adad06e (patch)
tree5642b1b322758f1e9919c93a89e793fad181ab81 /doc/guix.texi
parentaa92cf980cab9f085df11c79c4b27d2b8b0d88aa (diff)
downloadguix-299112d36e872d98896bf8dec281c34d9adad06e.tar.gz
guix-package: Report `--search' matches in recutils format.
* guix/ui.scm (fill-paragraph, string->recutils, package->recutils): New
  procedures.
* guix-package.in (guix-package)[process-query]: Use `package->recutils'
  to display package meta-data.
* tests/guix-package.sh: Adjust test.
* tests/ui.scm: New file.
* Makefile.am (TESTS): Add it.
* doc/guix.texi (Invoking guix-package): Adjust `--search'
  documentation, and give an example.
Diffstat (limited to 'doc/guix.texi')
-rw-r--r--doc/guix.texi17
1 files changed, 14 insertions, 3 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 410e6fa37c..3fee24db50 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -546,10 +546,21 @@ availability of packages:
 @item --search=@var{regexp}
 @itemx -s @var{regexp}
 List the available packages whose synopsis or description matches
-@var{regexp}.
+@var{regexp}.  Print all the meta-data of matching packages in
+@code{recutils} format (@pxref{Top, GNU recutils databases,, recutils,
+GNU recutils manual}).
 
-For each package, print the following items, separated by tabs: its
-name, version, and the source location of its definition.
+This allows specific fields to be extracted using the @command{recsel}
+command, for instance:
+
+@example
+$ guix-package -s malloc | recsel -p name,version
+name: glibc
+version: 2.17
+
+name: libgc
+version: 7.2alpha6
+@end example
 
 @item --list-installed[=@var{regexp}]
 @itemx -I [@var{regexp}]