From 70830b1187d3d1924f38573caf8aeda2372ae84c Mon Sep 17 00:00:00 2001 From: Ludovic Courtès Date: Fri, 14 Dec 2007 19:43:47 +0100 Subject: doc: Update "Standard Library" and chapter about `skribilo-config'. * doc/user/Makefile.am (EXTRA_DIST): Rename `skribe-config.skb' to `skribilo-config.skb'. (skrflags): Add `-e' flags defining `%top-srcdir' and `%top-builddir'. * doc/user/lib.skb: Update stuff, removing references to `skribe-*' functions. Remove doc for `load-document' and `skribe-configure', both of which have become essentially useless. * doc/user/skribilo-config.skb: Updated. Actually run `skribilo-config' and get options from there. * doc/user/user.skb: Use `(ice-9 popen)' and `(ice-9 rdelim)'. Update includes. --- doc/user/skribilo-config.skb | 66 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) create mode 100644 doc/user/skribilo-config.skb (limited to 'doc/user/skribilo-config.skb') diff --git a/doc/user/skribilo-config.skb b/doc/user/skribilo-config.skb new file mode 100644 index 0000000..1016a50 --- /dev/null +++ b/doc/user/skribilo-config.skb @@ -0,0 +1,66 @@ +;;; skribilo-config.skb -- The `skribilo-config' tool +;;; +;;; Copyright 2007 Ludovic Courtès +;;; Copyright 2004 Manuel Serrano +;;; +;;; +;;; This program is free software; you can redistribute it and/or modify +;;; it under the terms of the GNU General Public License as published by +;;; the Free Software Foundation; either version 2 of the License, or +;;; (at your option) any later version. +;;; +;;; This program is distributed in the hope that it will be useful, +;;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;;; GNU General Public License for more details. +;;; +;;; You should have received a copy of the GNU General Public License +;;; along with this program; if not, write to the Free Software +;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, +;;; USA. + +;*---------------------------------------------------------------------*/ +;* The `skribilo-config' tool */ +;*---------------------------------------------------------------------*/ +(chapter :title "Getting Configuration Information" + :ident "skribilo-config" + +(index "skribilo-config") + +(p [This chapter presents ,(code "skribilo-config"), a stand-alone +program that gives information about the current configuration.]) + +;; Synopsis +(section :title "Synopsis" :number #f +(compiler-command "skribilo-config" "options")) + +;; Description +(section :title "Description" :number #f + + [The ,(code "skribilo-config") program gives information about the +Skribilo configuration, such as the module installation path, version +number, etc. The full list of supported options and their meaning is +the following:] + + (linebreak) + + (pre (let ((port (open-input-pipe (string-append %top-builddir + "/src/skribilo-config " + "--help 2>&1")))) + (let loop ((line (read-line port)) + (lines '())) + (if (eof-object? line) + (reverse! lines) + (begin + (loop (read-line port) + (cons* line "\n" lines))))))) + + [Note that the same information can be obtained through the +programming interface exposed by the ,(code [(skribilo config)]) module +(,(numref :text [see Section] :ident "config-module")).])) + + +;;; Local Variables: +;;; coding: latin-1 +;;; ispell-local-dictionary: "american" +;;; End: -- cgit v1.2.3