aboutsummaryrefslogtreecommitdiff
path: root/doc/user/skribilo-config.skb
blob: 682102ed4e41bb1b8d63643ae15ef5067b67021b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
;;; skribilo-config.skb  --  The `skribilo-config' tool
;;; -*- coding: iso-8859-1 -*-
;;;
;;; Copyright 2007, 2008, 2009  Ludovic Court�s <ludo@gnu.org>
;;; Copyright 2004  Manuel Serrano
;;;
;;;
;;; This file is part of Skribilo.
;;;
;;; Skribilo 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 3 of the License, or
;;; (at your option) any later version.
;;;
;;; Skribilo 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 Skribilo.  If not, see <http://www.gnu.org/licenses/>.

;*---------------------------------------------------------------------*/
;*    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
         :info-node "skribilo-config Synopsis"

(compiler-command "skribilo-config" "options"))

;; Description
(section :title "Description" :number #f
         :info-node "skribilo-config Description"
   
   (p [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)
		(tt (string-concatenate-reverse lines))
		(begin
		   (loop (read-line port)
		         (cons* line "\n" lines))))))))
   
  (p [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:
;;; ispell-local-dictionary: "american"
;;; End: