/
config.in
1176 lines (1085 loc) · 38.4 KB
/
config.in
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
###########################
# DAPS configuration file #
###########################
#
# Copyright (C) 2012-2020 SUSE Software Solutions Germany GmbH
#
# Author:
# Frank Sundermeyer <fsundermeyer at opensuse dot org>
#
#------------------------------------------------------------
# Syntax
# The following works:
#
# KEY=VALUE
# KEY = VALUE
# KEY = VALUE # comment
# KEY = "VALUE1 VALUE2"
# KEY = 'VALUE1 VALUE2'
# KEY = 'VALUE1 VALUE2' #comment
#
# The following rules apply:
#
# * escape-character will be removed: \# becomes #
# ** if you need escapes, use \\\: \\\# becomes \#
# Example: "c:\\\windows\\\foo" becomes c:\windows\foo
#
# * When not quoting values, leading spaces will be cut
# * Each KEY/Value pair should to be on a single line
# ** using \ for continuation works; leading spaces on the second line
# are not cut
#
# * comments on the same line will be cut
# * comment characters (#) in values are not supported !!!
# ** the value will be cut at the first occurrence of #
# ** \\\# is supported and will be transferred to \#
#
# Concatenating values:
#
# It is possible to add additional VALUES to an already existing
# KEY with the "+=" notation. This is e. g. useful to increase
# readability when VALUE is rather log:
#
# XSLTPARAM = '--stringparam "foo=bar"'
# XSLTPARAM += '--stringparam "baz=foo"
#
# The same rules as for regular KEY/VALUE pairs apply
#
#------------------------------------------------------------
# Customizing:
#
# Override any setting below in
# $HOME/.config/daps/dapsrc (also see section "Syntax" above)
# or on the command line
#------------------------------------------------------------
#
# The environment is set up using the following hierarchy
# (command line always wins)
#
# 1. Command line
# 2. DC-file
# 3. $HOME/.config/daps/.dapsrc (user config file)
# 4. $DAPSROOT/etc/config
## Key: ADOC_FAILURE_LEVEL
## -----------------------
## Description: AsciiDoctor error level on which DAPS will exit
## when processing adoc files
## Type: String
## VALUE: FATAL|ERROR|WARN|INFO (empty value not allowed)
## Default: WARN
#
# By default, AsciiDoctor only returns != 0 on FATAL errors. However, when
# converting to DocBook, errors of the level WARN usually prevent from
# generating valid DocBook. Therefore DAPS sets the failure level to WARN and
# therefore exits on AsciiDoctor error levels FATAL, ERROR, and WARN.
#
# It is recommended to keep the default. If required, override it in a DC-file
#
ADOC_FAILURE_LEVEL="WARN"
## Key: ADOC_POST
## --------------------
## Description: Do post-processing on AsciiDoctor-generated XML?
## Type: yesno
## Default: "no"
#
# If set to "yes", the DocBook XML asciidoctor produces
# will be processed again by a stylesheet defined with ADOC_POST_STYLE
# Only valid for AsciiDoc sources
#
# See also: ADOC_POST_STYLE
#
# Set this value in a DC-file
#
ADOC_POST="no"
## Key: ADOC_POST_STYLE
## --------------------
## Description: Path to the stylesheet for post-processing the DocBook
## XML AsciiDoctor produces
## Type: path to stylesheet
## Default: "@pkgdatadir@/daps-xslt/asciidoc/postprocess.xsl"
#
# This stylesheet will be applied to the DocBook file produced from adoc
# by asciidoctor (build/.adoc/*.xml). The result will be written
# to build/.profiled/noprofile/ and be used for further processing. Use
# this if you need to change the DocBook file. Make sure it produces
# valid DocBook.
# The stylesheet will only be applied if you set ADOC_POST to "yes"
#
# By default, this value is set to a stylesheet DAPS ships. It only does
# minimal changes. It is suggested to keep the system-wide value and to
# only overwrite this in a DC-file or in ~/.config/dapsrc
#
# See also: ADOC_POST
#
ADOC_POST_STYLE="@pkgdatadir@/daps-xslt/asciidoc/postprocess.xsl"
## Key: ADOC_SET
## --------------------
## Description: Convert multipart AsciiDoc book into set?
## Type: yesno
## Default: "no"
#
# If set to "yes", the DocBook XML asciidoctor produces
# will be processed again by a stylesheet defined with ADOC_SET_STYLE
# and turned into a DocBook set. This requires an AsciiDoc multipart book.
# Only valid for AsciiDoc sources
#
# See also: ADOC_SET_STYLE
#
# Set this value in a DC-file
ADOC_SET="no"
## Key: ADOC_SET_STYLE
## --------------------
## Description: Path to the stylesheet that creates a DocBook set from
## an AsciiDoc multipart book
## Type: path to stylesheet
## Default: "@pkgdatadir@/daps-xslt/asciidoc/setify.xsl"
#
# This stylesheet will be applied to the DocBook file produced from adoc
# by asciidoctor (build/.adoc/*.xml). The result will be written
# to build/.adoc/ and be used for profiling.
#
# By default, this value is set to a stylesheet DAPS ships. There should
# be no need to overwrite this default.
#
ADOC_SET_STYLE="@pkgdatadir@/daps-xslt/asciidoc/setify.xsl"
## Key: ADOC_TYPE
## --------------------
## Description: Document type that will be generated when processing
## an AsciiDoc document
## adoc to DocBook5
## Type: String
## Default: article
#
# Valid values: article, book, manpage
#
# NOTE: Same option as you would set by --doctype with asciidoctor
# Do not use "inline" as it will not work with
# DAPS. Setting "manpage" requires manpage-specific content,
# otherwise processing the source will fail.
# This setting will override the :doctype: definition in the
# AsciiDoc source document
#
ADOC_TYPE="article"
## Key: ALWAYS_REBUILD
## ----------------------
## Description: Always rebuild all files even when up-to-date versions exist
## Type: yesno
## Default: "yes"
#
# DAPS uses GNU make to generate all files. make keeps track of files and
# dependencies and only rebuilds files if necessary (when their dependencies
# have changed). This saves time, especially with large projects that have a
# lot of images.
# If consecutive builds take a very long time, try setting this to "no"
# (preferably in the DC-file or in ~/.config/daps/dapsrc)
# A "no" can be overwritten with --force on the command line at any time.
#
ALWAYS_REBUILD="yes"
## Key: ASSEMBLY_LANG
## --------------------
## Description: Language of a DocBook assembly file
## Type: language code, lowercase, either e.g. en or en_us
## Default: en
#
# NOTE: The DocBook Stylesehets (5.2 beta) creating a bigfile from an
# assembly have a bug and do not transfer the xml:lang attribute
# to the bigfile. Use this value to specify the language in a DC-file.
# By default "en" is assumed.
# This will be removed once the DocBook stylesheets are fixed
#
ASSEMBLY_LANG="en"
## Key: BUILD_DIR
## ----------------------
## Description: Build directory where all daps generated files will go
## Type: Path to directory (without a trailing slash)
## Default: ""
#
# Allows to completely separate the output daps generates from the sources
# If not set it is automatically resolved to $PRJ_DIR/build/$BOOK
BUILD_DIR=""
## Key: CB_OPTIONS
## ------------------------
## Description: Command line options for /usr/bin/checkbot
## Type: String
## Default: "--dontwarn \"(301|302|902)\" --sleep 0 --timeout 60"
#
#
# Also see 'man 1 checkbot'. Do not change unless you really know what you do.
#
CB_OPTIONS="--dontwarn \"(301|302|902)\" --sleep 0 --timeout 60"
## Key: COLOR
## ------------------
## Description: Colored output?
## Type: yesno
## Default: "yes"
#
# By default errors, results, warnings and certain info messages are printed
# in color using bash color codes. In cron jobs and scripts you probably want to
# turn off this behavior by setting COLOR to "no"
#
COLOR="yes"
## Key: CONF_PREFIX
## ------------------------
## Description: Common prefix for all doc config files
## Type: String
## Default: "DC-"
#
# Also see OUTPUTNAME
#
CONF_PREFIX="DC-"
## Key: CONVERT_OPTS_JPG
## -------------------------
## Description: Command line options for "convert" to convert color JPGs
## to grayscale
## Type: String
## Default: "-type grayscale"
#
# Do not change unless you really know what you do.
#
CONVERT_OPTS_JPG="-type grayscale"
## Key: CONVERT_OPTS_PNG
## -------------------------
## Description: Command line options for "convert" to convert color PNGs
## to grayscale
## Type: String
## Default: "-type grayscale -colors 256"
#
# Do not change unless you really know what you do.
#
CONVERT_OPTS_PNG="-type grayscale -colors 256"
## Key: DIA_OPTIONS
## -------------------------
## Description: Command line options for dia to convert DIA to SVG
## Type: String
## Default: "-t cairo-svg"
#
# Do not change unless you really know what you do.
#
DIA_OPTIONS="-t cairo-svg"
## Key: DOCBOOK4_PROFILE_URN
## -------------------------
## Description: URN to a DocBook 4 profiling stylesheet
## Type: URN
## Default: "urn:x-daps:xslt:profiling:docbook45-profile.xsl"
#
# URN to a stylesheet used to profile DocBook 4 content. The stylesheet
# should match the DocBook version you are using, see comments below for
# possible values
#
#
#DOCBOOK4_PROFILE_URN="urn:x-daps:xslt:profiling:docbook41-profile.xsl"
#DOCBOOK4_PROFILE_URN="urn:x-daps:xslt:profiling:docbook42-profile.xsl"
#DOCBOOK4_PROFILE_URN="urn:x-daps:xslt:profiling:docbook43-profile.xsl"
#DOCBOOK4_PROFILE_URN="urn:x-daps:xslt:profiling:docbook44-profile.xsl"
DOCBOOK4_PROFILE_URN="urn:x-daps:xslt:profiling:docbook45-profile.xsl"
## Key: DOCBOOK4_STYLE_URI
## ------------------
## Description: URI to DocBook 4 stylesheets
## Type: URI
## Default: "http://docbook.sourceforge.net/release/xsl/current/"
#
# URI to the DocBook 4 stylesheets that can be resolved by xmlcatalog
# There should be no need to change this entry
# Note:
# URI _must_ end with a "/", otherwise it will not be resolved on Ubuntu
# WARNING:
# This value needs to point to the original DocBook stylesheets. It will
# ensure that there always is a fallback in case the stylesheets specified
# elsewhere do not provide the requested output format. These styles are
# also used to generate text output. Only change if the default value
# cannot be resolved by xmlcatalog.
#
DOCBOOK4_STYLE_URI="http://docbook.sourceforge.net/release/xsl/current/"
## Key: DOCBOOK5_PROFILE_URN
## -------------------------
## Description: URN to a DocBook 5 profiling stylesheet
## Type: URN
## Default: "urn:x-daps:xslt:profiling:docbook51-profile.xsl"
#
# URN to a stylesheet used to profile DocBook 5 content. The stylesheet
# should match the DocBook version you are using, see comments below for
# possible values
#
#
#DOCBOOK5_PROFILE_URN="urn:x-daps:xslt:profiling:docbook50-profile.xsl"
DOCBOOK5_PROFILE_URN="urn:x-daps:xslt:profiling:docbook51-profile.xsl"
## Key: DOCBOOK5_RNG_URI
## ------------------
## Description: URI to DocBook 5 Relax NG schema
## Type: URI
## Default: "http://docbook.org/xml/@db5version@/rng/docbook.rng"
#
# URI to the DocBook 5 Relax NG schema that can be resolved by xmlcatalog
# There should be no need to change this entry
# In case you use a git checkout the DB5 version will be masked with
# \@db5version\@. This string will automatically be replaced with "5.1" if
# DocBook 5.1 is installed, otherwise it will be set to "5.0"
# If you do not like this, replace the value with one of the commented lines
#
#DOCBOOK5_RNG_URI="http://docbook.org/xml/5.0/rng/docbookxi.rng"
#DOCBOOK5_RNG_URI="http://docbook.org/xml/5.1/rng/docbookxi.rng"
DOCBOOK5_RNG_URI="http://docbook.org/xml/@db5version@/rng/docbookxi.rng"
## Key: DOCBOOK5_STYLE_URI
## ------------------
## Description: URI to DocBook 5 stylesheets
## Type: URI
## Default: "http://docbook.sourceforge.net/release/xsl-ns/current/"
#
# URI to the DocBook 5 stylesheets that can be resolved by xmlcatalog
# There should be no need to change this entry
# Note:
# URI _must_ end with a "/", otherwise it will not be resolved on Ubuntu
#
# WARNING:
# This value needs to point to the original DocBook stylesheets. It will
# ensure that there always is a fallback in case the stylesheets specified
# elsewhere do not provide the requested output format. These styles are
# also used to generate text output. Only change if the default value
# cannot be resolved by xmlcatalog.
#
DOCBOOK5_STYLE_URI="http://docbook.sourceforge.net/release/xsl-ns/current/"
## Key: DRAFT
## ------------------
## Description: Print "DRAFT" watermarks in HTML or PDF builds
## Type: yesno
## Default: "no"
#
# Turns on DRAFT watermarks in PDF or HTML builds when set to "yes"
# Is ignored for any other output format and has no effect on profiling.
# This value can be set to "yes" using the -d switch on the command line
# Also see COMMENTS and REMARKS
#
DRAFT="no"
## Key: DRAFT_STR
## ----------------------
## Description: String to be appended to file/directory names when draft
## is turned on
## Type: String
## Default: "_draft"
#
#
DRAFT_STR="_draft"
## Key: EPUB_CHECK
## ------------------------
## Description: Check generated EPUB file with epubcheck
## Type: yesno
## Default: "no"
#
# Useful to find errors within an EPUB file when developing stylesheets
#
EPUBCHECK="no"
## Key: EPUB_CSS
## ------------------------
## Description: Absolute path to CSS file for EPUB builds
## Type: Path to file
## Default: ""
#
EPUB_CSS=""
## Key: FALLBACK_STYLEROOT
## ----------------------
## Description: Fallback styleroot directory.
## Type: Path to directory (without a trailing slash)
## Default: ""
#
# When having specified custom stylesheets with STYLEROOT, the fallback
# for styles not specified in the custom STYLEROOT are the DocBook stylesheets
# Specify an alternative fallback with this option. Useful if you have a
# fork of e.g. your custom FO stylesheets. When setting STYLEROOT to this
# for directory that only has FO styles, HTML versions of that document would
# be build with the DocBook stylesheets. Setting FALLBACK_STYLEROOT to the
# directory containing your original custom stylesheets (which also have
# HTML stylesheets) will create HTML versions with your custom styles. The
# DocBook stylesheets remain as a last fallback resort.
#
# This option is ignored when not specifying STYLEROOT at the same time.
# Also see STYLEROOT
#
FALLBACK_STYLEROOT=""
## Key: FOP_CONFIG_FILE
## -----------------------
## Description: Configuration file for the FOP PDF formatter
## Type: Path
## Default: ""
#
# Specify an XML config file for FOP. A template is available in
# @sysconfdir@/daps/fop/fop-daps.xml
# Also see FORMATTER, FOP-*
#
FOP_CONFIG_FILE="@sysconfdir@/daps/fop/fop-daps.xml"
## Key: FOP_CMD_OPTIONS
## -----------------------
## Description: Command line options for the FOP PDF formatter
## Type: String
## Default: ""
#
# Specify command line options for the FOP formatter.
# Also see FORMATTER, FOP-*
#
FOP_CMD_OPTIONS=""
## Key: FOP_JAVA_FLAGS
## ----------------------------
## Description: Additional java properties for running fop
## Type: String (-D<prop>)
## Default: ""
#
FOP_JAVA_FLAGS=""
## Key: FOP_JAVA_JARS
## ---------------------------
## Description: Additional Jars for running fop
## Type: String
## Default: ""
#
FOP_JAVA_JARS=""
## Key: FOP_JAVA_OPTIONS
## ------------------------------
## Description: Additional java options for running fop
## Type: String (-X<option>), see java -X for help
## Default: ""
#
FOP_JAVA_OPTIONS=""
## Key: FOP_WRAPPER
## -----------------------
## Description: Wrapper script for the FOP PDF formatter
## Type: PATH to script
## Default: "@pkgdatadir@/libexec/daps-fop""
#
# Optional wrapper script for calling fop. If set to "fop", it will run
# the first fop executable found in your path (usually this will be
# /usr/bin/fop)
#
# The default will probably not work on Debian/Ubuntu, since they
# use a different way to set Java options. Setting up a custom wrapper
# script for Ubuntu/Debian might be needed (not tested)
#
FOP_WRAPPER="@pkgdatadir@/libexec/daps-fop"
## Key: FORMATTER
## --------------------
## Description: Specify the PDF formatter to use
## Type: String (fop,xep)
## Default: "fop"
#
# Specify which PDF formatter to use. Currently only fop or xep are supported
# Also see FOP_*, XEP_*
#
FORMATTER="fop"
## Key: GZIP_MAN
## ------------------
## Description: Compress man pages with gzip
## Type: yesno
## Default: "yes"
#
# By default man pages created with the "man" target will be compressed with
# gzip
#
GZIP_MAN="yes"
## Key: HTML5
## ------------------------
## Description: Use XHTML5 instead of XHTML1 for HTML output
## Type: yesno
## Default: no
#
HTML5="no"
## Key: HTML_CSS
## ------------------------
## Description: Absolute path to CSS file for HTML builds
## Type: Path to file
## Default: ""
#
HTML_CSS=""
## Key: IMG_VIEWER
## ------------------------
## Description: Image viewer to be used with target getimages
## Type: String
## Default: ""
#
# Command (gpicview) or full path (/usr/bin/gpicview) to an image viewer
#
IMG_VIEWER=""
## Key: IMG_SRC_DIR_DEFAULT
## --------------------------------
## Description: Default path to the directory that holds the image source
## files.
## Type: Relative path to directory (without a trailing slash),
## Path needs to be relative to the project directory ($PRJ_DIR)
## Default: images/src
#
# If you want to change it on a book or project level, use the DC-file
# and add a value for IMG_SRC_DIR. For a per build option us
# --imgsrcdir with daps
# If you want to change a global default change here
#
# IMPORTANT:
# This value will only be taken into account
# * if IMG_SRC_DIR was not defined on the command line or a DC-file
# AND
# * if IMG_SRC_DIR was not set (see above)
# AND
# * the given directory exists (if not, will be ignored)
#
IMG_SRC_DIR_DEFAULT="images/src"
## Key: INK_OPTIONS
## ------------------------
## Description: Command line options for Inkscape >= 1.0 to convert SVG to PNG
## Type: String
## Default: ""
#
# Do not change unless you really know what you do.
# For Inkscape >= 1.0 only, do not use the old command line switches!
#
INK_OPTIONS=""
## Key: JING_FLAGS
## ------------------------
## Description: Flags for jing
## Type: String, whitespace-separated
## Default: ""
#
# The default flag enables jing to follow xi:includes
# Do not change unless you really know what you do.
#
JING_FLAGS=""
## Key: JING_JAVA_FLAGS
## ----------------------------
## Description: Additional java properties for running jing
## Type: String (-D<prop>)
## Default: "-Dorg.apache.xerces.xni.parser.XMLParserConfiguration=org.apache.xerces.parsers.XIncludeParserConfiguration"
#
JING_JAVA_FLAGS="-Dorg.apache.xerces.xni.parser.XMLParserConfiguration=org.apache.xerces.parsers.XIncludeParserConfiguration"
## Key: JING_JAVA_JARS
## ---------------------------
## Description: Additional Jars for running jing
## Type: String
## Default: ""
#
JING_JAVA_JARS=""
## Key: JING_JAVA_OPTIONS
## ------------------------------
## Description: Additional java options for running jing
## Type: String (-X<option>), see java -X for help
## Default: ""
#
JING_JAVA_OPTIONS=""
## Key: JING_WRAPPER
## -------------------------
## Description: Wrapper script for Jing
## Type: PATH to script
## Default: "@pkgdatadir@/libexec/daps-jing"
#
# Optional wrapper script for calling jing. If set to "jing", it will run
# the first jing executable found in your path (usually this will be
# /usr/bin/jing)
#
# The default will probably not work on Debian/Ubuntu, since they
# use a different way to set Java options. Setting up a custom wrapper
# script for Ubuntu/Debian might be needed (not tested)
#
# Also see JING_*
#
JING_WRAPPER="@pkgdatadir@/libexec/daps-jing"
## Key: MAIN
## -----------------
## Description: Filename of the set/book defining XML file
## Type: filename (filename only, no absolute path)
## Default: ""
#
# Name of the MAIN XML file. Mandatory.
# This value is usually set in a book specific DC-file.
#
MAIN=""
## Key: META
## --------------------
## Description: Print meta information in HTML and PDF builds
## Type: yesno
## Default: "no"
#
# Adds the file name of the source file below section titles in HTML output.
# Useful for proofreading.
# Implies that remarks are turned on.
# This value can be set to "yes" using the -m switch on the command line
# Also see REMARKS
#
META="no"
## Key: META_STR
## ----------------------
## Description: String to be appended to file/directory names when meta
## is turned on
## Type: String
## Default: "_meta"
#
#
META_STR="_meta"
# Key: OUTPUTNAME
## --------------------
## Description: Custom name for generated files
## Type: String
## Default: ""
#
# By default the directory/filenames will be generated by stripping the
# CONF_PREFIX from the DC-file's name. Use this setting to choose a custom
# name.
# This value is usually set in a book specific DC-file.
# ATTENTION: Do not specify this value in a global config file if you generate
# more than a single book, otherwise previous book builds will
# always be overwritten by a new build
#
OUTPUTNAME=""
## Key: PDFNAME
## --------------------
## Deprecated. Use OUTPUTNAME instead (see there)
## Key: PROFARCH
## ---------------------
## Description: Profiling values for the attribute arch=""
## Type: String (e.g. i386, x86_64)
## Default: ""
#
# This value is usually set in a book specific DC-file.
#
PROFARCH=""
## Key: PROFCONDITION
## ---------------------------
## Description: Profiling values for the attribute condition=""
## Type: String
## Default: ""
#
# This value is usually set in a book specific DC-file.
#
PROFCONDITION=""
## Key: PROFILE_URN
## ---------------------------
## Description: URN for profiling stylesheet
## Type: urn (String)
## Default: ""
#
# In order to use profiling, the urn to a profiling stylesheet _either_ has
# to be specified in the header of the main file ($MAIN) via <?xml-stylesheet/>
# or via this variable. Valid urns can be found in the DAPS installation
# directory in etc/catalog.xml
PROFILE_URN=""
## Key: PROFOS
## -------------------
## Description: Profiling values for the attribute os=""
## Type: String
## Default: ""
#
# This value is usually set in a book specific DC-file.
#
PROFOS=""
## Key: PROFOUTPUTFORMAT
## -------------------
## Description: Profiling values for the attribute outputformat=""
## Type: String
## Default: ""
#
# This value is usually set in a book specific DC-file.
#
PROFOUTPUTFORMAT=""
## Key: PROFVENDOR
## -----------------------
## Description: Profiling values for the attribute vendor=""
## Type: String
## Default: ""
#
# This value is usually set in a book specific DC-file.
#
PROFVENDOR=""
## Key: REMARK
## -------------------
## Description: Generate books with remarks?
## Type: yesno
## Default: "no"
#
# By default remarks are ignored when generating books. Set this parameter to
# "yes" to include remarks. Useful for proofreading.
# This value can be set to "yes" using the -r switch on the command line
# Also see COMMENTS and DRAFT
#
REMARKS="no"
## Key: REMARKS_STR
## ------------------------
## Description: String to be appended to file/directory names when remarks
## are turned on
## Type: String
## Default: "_remarks"
#
REMARK_STR="_remarks"
## Key: ROOTID
## -------------------
## Description: ID of the book/chapter/etc. to generate
## Type: String (must be a valid id from the set defined in MAIN)
## Default: ""
#
# When not set, the complete book defined in MAIN is build. If MAIN defines a
# set of several books, you need to specify the id of a book (<book id="">) in
# order to build the single book. daps also supports building single
# articles, parts, and chapters.
# This value is usually set in a book specific DC-file and can also be set
# using the command line switch --rootid=""
#
ROOTID=""
## Key: SPELL_CHECKER
## ----------------------
## Description: Spellchecker application to use
## Type: Name of the spellchecker's binary
## Default: DAPS performs a lookup for aspell and hunspell. If only one
## of these packages is installed, it will be used automatically.
## If both are installed, hunspell will be used.
## If you want to force using one of the two spellcheckers,
## specify it here.
##
SPELL_CHECKER=""
## Key: SPELL_EXTRA_DICT
## ----------------------
## Description: Additional dictionary for spell checker
## Type: Absolute path to dictionary
## Default: ""
#
# Refer to the aspell / hunspell documentation on how to build custom
# dictionaries (the process differs for each spell checker)
#
# NOTE:Differences between aspell and hunspell
# aspell:
# An extra dictionary for aspell can reside anywhere in the
# file system and you need to specify the absolute path to
# this directory with SPELL_EXTRA_DICT or with --extra-dict
# hunspell:
# An extra dictionary for hunspell needs to reside in
# hunspell's search path (check with hunspell -D) and needs
# to be specified with the file's base name only:
# Example: /usr/share/hunspell/en_US-suse-doc.dic => en_US-suse-doc
# If you specify a non-existing dictionary or if it
# cannot be found by hunspell, it will silently be ignored
#
# Specify an additional (custom) dictionary (will always be used in
# addition to the default dictionary for the given language)
#
SPELL_EXTRA_DICT=""
## Key: SPELL_LANG
## ----------------------
## Description: Language for spell checker
## Type: String
## Default: ""
#
# NOTE: Language to use for spellchecker.
# aspell:
# It uses the same format as the
# LANG environmental variable: It consists of the two letter ISO 639
# language code (e.g. 'en' for English) and an optional two letter
# ISO 3166 country code after an underscore (e.g. en_GB for British
# English). Make sure the respective dictionary for aspell is installed.
# By default, DAPS tries to get the language from the "lang" attribute
# of the MAIN file.
# hunspell:
# Consists of the two letter ISO 639 (e.g. 'en' for English) and a
# mandatory two letter ISO 3166 country code after an underscore
# (e.g. en_GB for British English)
# In case the language is not specified with --lang or SPELL_LANG,
# the value from the xml:lang attribute of the MAIN file will be
# used in case it complies with the format. If not, spellcheck will
# abort and ask for the language.
#
SPELL_LANG=""
## Key: SPELL_SKIP_TAGS
## ----------------------
## Description: list of DocBook XML tags which content should _not_ be
## spell-checked. Only works with aspell (hunspell does not
## support this).
## Type: List
## Default: "author command email envar filename firstname guimenu \
## keycap literal option package remark screen surname \
## systemitem tag ulink varname xref"
#
SPELL_SKIP_TAGS="author command email envar filename firstname guimenu keycap literal option package remark replaceable screen surname systemitem tag ulink varname xref"
## Key: SRC_DIR
## ----------------------
## Description: Path to the directory that holds the doc source files.
## Type: Relative path to directory (without a trailing slash),
## path needs to be relative to the project directory ($PRJ_DIR)
## Default: Depends on the format of the MAIN file; if it is an XML file
## (incl. an assembly) it will default to "xml", for
## ASCIIDoc to "adoc"
#
# If changed, allows to have several source subdirectories in your project
# directory, so you can better organize your files. In such a case this value
# is supposed to be set in the doc-config files (DC-files).
# Example directory structure:
#
# $PRJ_DIR/
# |- book1/
# |- xml/
# |- MAIN-book1.xml
# |- ...
# |- book2/
# | -xml/
# |- MAIN-book2.xml
# |- ...
# |- DC-book1
# |- DC-book2
#
# DC-book1 would contain SRC_DIR="book1/xml"
# DC-book2 would contain SRC_DIR="book2/xml"
#
SRC_DIR=""
## Key: STATIC_DIR
## -------------------
## Description: Custom static/ directory containing CSS and JS files
## as well as images referenced from the CSS file and
## the stylesheets
## Type: Path to directory (without a trailing slash)
## Default: ""
#
#
# If present, DAPS uses a directory <STYLEROOT>/static hosting CSS and JS
# files as well as images reference from the stylesheets and copies it to
# the resulting HTML directory. This variable allows to permanently set a
# custom directory.
# To be set in the DC file or via command line with --statdir.
#
# See also STYLEROOT, FALLBACK_STYLEROOT
#
STATIC_DIR=""
## Key: STRUCTID
## ---------------------
## Description: ID of a DocBook Assemly structure
## Type: String (must be a valid structure id from the assembly)
## Default: ""
#
# DocBook assemblies allow to define different structures in a single
# assembly file. Each structure can be identified by a unique ID.
# To build a specific structure you need to specify the respective ID,
# otherwise the first structure defined in the assembly file will be build.
#
# To be set in the DC-file only.
# Only valid when building from assemblies, will otherwise be silently
# ignored.
#
STRUCTID=""
## Key: STYLEDEVEL
## -------------------
## Description: Custom stylesheets directory for development purposes.
## Type: Path to directory (without a trailing slash)
## Default: ""
#
#
# By default, daps uses the DocBook stylesheets to create output. If you are
# developing your own set of stylesheets, you may want to set STYLEDEVEL in
# ~/.config/daps/dapsrc. If set STYLEDEVEL _always_ takes precedence over
# STYLEROOT!
# You may also want to set FALLBACK_STYLEROOT alongside with STYLEDEVEL
#
# See also STYLEROOT, FALLBACK_STYLEROOT
#
# Do NOT use unless you really know what you are doing.
#
STYLEDEVEL=""
## Key: STYLEROOT
## -------------------
## Description: Custom stylesheets directory.
## Type: Path to directory (without a trailing slash)
## Default: ""
#
# By default, daps uses the DocBook stylesheets to create output. If you have
# your own set of stylesheets, specify the absolute path to the stylesheet
# directory here. The DocBook stylesheets will be used as a fallback in case
# styles are not defined for all output formats.
#
# See also: FALLBACK_STYLEROOT
#
STYLEROOT=""
## Key: TXT_IGNORE_STYLEROOT
## ---------------------------------
## Description: Ignore styleroot and rather use the original DocBook
## stylesheets for text output?
## Type: yesno
## Default: "no"
#
# Text output is generated by creating a single file HTML page parsing
# the result with w3m. This ensures that e.g. tables are properly
# displayed in the .txt file. Default is to use the stylesheets provided
# via STYLEROOT or --styleroot to build the HTML. Set this option to
# "yes" to ignore the STYLEROOT and to use the original DocBook
# stylesheets instead.
#
# NOTE: This will also work if STYLEROOT points to the original
# DocBook stylesheets.
#
# See also: TXT_PARAMS
#
TXT_IGNORE_STYLEROOT="no"
## Key: TXT_PARAMS
## -------------------
## Description: XSL parameters for text file generation
## Type: string
## Default: '--param="generate.permalinks=0" --param="section.autolabel=1" --param="section.label.includes.component.label=2"'
#
# Text output is generated by creating a single file HTML page parsing
# the result with w3m. This ensures that e.g. tables are properly
# displayed in the .txt file. This configuration option can be used to set
# custom XSL parameters - the HTML stylesheets are not necessarily
# configured in a way that is suitable for text output.
# The default value for TXT_PARAMS turns on labeling and makes sure
# admonitions have a text label. Other parameters turn off stuff that is
# of no use in text output.
# For a reference of all HTML parameters refer to
# http://docbook.sourceforge.net/release/xsl/current/doc/html/index.html