diff options
| author | Carl Hetherington <cth@carlh.net> | 2017-07-27 13:12:12 +0100 |
|---|---|---|
| committer | Carl Hetherington <cth@carlh.net> | 2017-07-27 13:12:12 +0100 |
| commit | 28224b347dd993d635ba8a0f2e7db20130483bd4 (patch) | |
| tree | ab7c8940bfacd82b8bff270cd86eb8c172704856 /doc | |
| parent | 5209385eefbee08d19080e998c785c8efe8b84d2 (diff) | |
Add some documentation for config.xml.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/manual/Makefile | 9 | ||||
| -rw-r--r-- | doc/manual/dcpomatic.xml | 18 |
2 files changed, 24 insertions, 3 deletions
diff --git a/doc/manual/Makefile b/doc/manual/Makefile index 324c31cf3..9e74b4dff 100644 --- a/doc/manual/Makefile +++ b/doc/manual/Makefile @@ -65,11 +65,14 @@ diagrams/%.png: diagrams/%.svg diagrams/%.pdf: diagrams/%.svg inkscape -z -f $< --export-pdf $@ --export-area-drawing +config.xml: ../../src/lib/config.cc config.py + python config.py ../../src/lib/config.cc > config.xml + # # HTML # -html: $(XML) dcpomatic-html.xsl extensions-html.ent dcpomatic.css \ +html: $(XML) config.xml dcpomatic-html.xsl extensions-html.ent dcpomatic.css \ $(addprefix html/screenshots/,$(SCREENSHOTS)) \ $(subst .svg,.png,$(addprefix diagrams/,$(DIAGRAMS))) \ @@ -89,7 +92,7 @@ html: $(XML) dcpomatic-html.xsl extensions-html.ent dcpomatic.css \ # PDF # -pdf: $(XML) dcpomatic-pdf.xsl extensions-pdf.ent \ +pdf: $(XML) config.xml dcpomatic-pdf.xsl extensions-pdf.ent \ $(addprefix screenshots/,$(SCREENSHOTS)) \ $(subst .svg,.pdf,$(addprefix diagrams/,$(DIAGRAMS))) @@ -106,7 +109,7 @@ pdf: $(XML) dcpomatic-pdf.xsl extensions-pdf.ent \ # LaTeX (handy for debugging) # -tex: $(XML) dcpomatic-pdf.xsl extensions-pdf.ent +tex: $(XML) config.xml dcpomatic-pdf.xsl extensions-pdf.ent # The DocBook needs to know what file extensions to look for # for screenshots and diagrams; use the correct file to tell it. diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml index bed0242f3..bd42747de 100644 --- a/doc/manual/dcpomatic.xml +++ b/doc/manual/dcpomatic.xml @@ -3317,4 +3317,22 @@ The full details of OV and VF files are discussed in <xref linkend="sec-overlay" </chapter> +<!-- ============================================================== --> +<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en"> +<title>Configuration files</title> + +<para>Most of DCP-o-matic's configuration is stored in an XML file called <code>config.xml</code>. This is stored in different places depending on your operating system:</para> + +<itemizedlist> + <listitem>Windows: <code>c:\Users\your_user_name\AppData\Local\dcpomatic</code></listitem> + <listitem>OS X: <code>/Users/your_user_Name/Library/Preferences/com.dcpomatic/2</code></listitem> + <listitem>Linux: <code>~/.config/dcpomatic2</code></listitem> +</itemizedlist> + +<para>Possible XML tags are as follows:</para> + +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="config.xml"/> + +</chapter> + </book> |