summaryrefslogtreecommitdiff
path: root/doc/user/skribeinfo.skb
blob: 8b4fe3f2e224f321ace049759c9d13c3c4720c53 (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
;;; skribeinfo.skb  --  The Skribeinfo compiler
;;; -*- coding: iso-8859-1 -*-
;;;
;;; Copyright 2001, 2002, 2003  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 Skribeinfo compiler                                          */
;*---------------------------------------------------------------------*/
(chapter :title "Compiling Texi documents"
(index "skribeinfo" :note "compiler")
(index "texinfo")

(p [
In this chapter we present the Skribeinfo compiler that compiles Texinfo
(texi) source files into Skribe source file.])

;; Synopsis
(section :title "SYNOPSIS" :number #f
(compiler-command "skribeinfo" "options" "input"))

;; Description
(section :title "DESCRIPTION" :number #f [
This manual page is not meant to be exhaustive. The complete documentation
for the programming language ,(bold "Skribe") can be found at the 
following ,(ref :url (skribe-url) :text "url"). This manual page only
document the ,(tt "skribeinfo")
compiler that compiles ,(bold "Texinfo") source files into ,(it "Skribe"),
source files. These Skribe files can be compiled by the ,(bold "skribe")
compiler in order to produce ,(it "HTML"), ,(it "TeX"), ,(it "Info")
or ,(it "Nroff") target files.])

;; Suffixes
(section :title "SUFFIXES" :number #f [
The ,(tt "skribe") compiler uses file suffixes in order to select amongst
its possible targets which to choose. These suffixes are:

,(description (item :key (it ".texi") [a ,(bold "Texinfo") source file.])
	      (item :key (it ".skb") [a ,(bold "Skribe") source file.])
	      (item :key (it ".sui") [a ,(it "Skribe url index") file.]))])

;; Options
(section :title "OPTIONS" :number #f [
,(compiler-options *skribeinfo-bin*)]))