/video-contact-sheet/trunk/dist/docs/GNUmakefile |
---|
9,116 → 9,77 |
distdir:=. |
srcdir=src |
# Since 1.13.3 the man pages are combined into a single input |
# The XHTML output contains both man pages as a side effect, while the groff |
# and PDF output are separate for each man page. TeX output was removed from |
# this makefile. |
DEFAULT=$(addprefix $(distdir)/,vcs.1 vcs.conf.5 \ |
$(addprefix vcs.man,.html .pdf) \ |
$(addprefix vcs.conf.man,.pdf) \ |
ALL=$(addprefix $(distdir)/,vcs.1 vcs.conf.5 \ |
$(addprefix vcs.man,.html .xhtml .pdf) \ |
$(addprefix vcs.conf.man,.html .xhtml .pdf) \ |
) |
EXTRA=$(addprefix $(distdir)/,vcs.man2html.html vcs.conf.man2html.html) |
ALL=$(DEFAULT) $(EXTRA) |
INTERMEDIATE=$(addprefix $(srcdir)/, \ |
$(addsuffix .tex, vcs.man vcs.conf.man) \ |
) |
ifeq ($(shell uname),FreeBSD) |
DOCBOOK_XSL:=/usr/local/share/xsl/docbook |
endif |
# Used to be "jade". |
# On Debian Sid openjade and jadetex (for pdfjadetex) are required |
JADE:=openjade |
DOCBOOK_XSL?=/usr/share/xml/docbook/stylesheet/docbook-xsl |
# Common part of command to convert docbook to man |
DOCBOOK_TO_COMMON=xsltproc -nonet \ |
DOCBOOK_TO_MAN=xsltproc -o $(distdir)/ -nonet \ |
--xinclude \ |
-param man.charmap.use.subset "0" \ |
-param make.year.ranges "1" \ |
-param make.single.year.ranges "1" |
# NOT: For manpages the output can be a directory, whereas for XHTML it can not |
DOCBOOK_TO_MAN=$(DOCBOOK_TO_COMMON) -o $(distdir)/ $(DOCBOOK_XSL)/manpages/docbook.xsl |
DOCBOOK_TO_XHTML=$(DOCBOOK_TO_COMMON) $(DOCBOOK_XSL)/xhtml/docbook.xsl |
-param make.single.year.ranges "1" \ |
$(DOCBOOK_XSL)/manpages/docbook.xsl |
default: $(DEFAULT) |
extra: $(EXTRA) |
all: $(ALL) |
env: |
@echo --- Values of Makefile variables: --- |
@echo DEFAULT: $(DEFAULT) |
@echo EXTRA: $(EXTRA) |
@echo ALL: $(ALL) |
@echo INTERMEDIATE: $(INTERMEDIATE) |
@echo DOCBOOK_XSL: $(DOCBOOK_XSL) |
@echo DOCBOOK_TO_MAN: $$ $(DOCBOOK_TO_MAN) |
@echo DOCBOOK_TO_XHTML: $$ $(DOCBOOK_TO_XHTML) |
@echo distdir: $(distdir) |
@echo srcdir: $(srcdir) |
@echo ------------------------------------- |
clean: |
$(RM) $(ALL) $(INTERMEDIATE) |
# These are both generated at once |
$(distdir)/vcs.1 $(distdir)/vcs.conf.5: $(srcdir)/vcs.man.xml |
#xmlto -o `dirname $@`/ man $< |
$(DOCBOOK_TO_MAN) "$<" |
# man2html produces output closer to man and better formatted but |
# easily broken while xsltproc produces cleaner, more robust, and |
# cross-referenced output |
# Note with both manpages combined the output is combined too |
$(distdir)/vcs.man.html: $(srcdir)/vcs.man.xml |
$(DOCBOOK_TO_XHTML) "$<" > "$@" || ( $(RM) "$@" && false ) |
@# sed post processing: |
@# add CSS link |
@# obfuscate mailto: links |
@# obfuscate emails |
@# replace groff-escaped dots ("\[char46]") |
# sed post processing: |
# add CSS link |
# obfuscate mailto: links |
# obfuscate emails |
$(distdir)/vcs.%.xhtml: $(srcdir)/vcs.%.xml |
xsltproc -nonet \ |
--xinclude \ |
-param man.charmap.use.subset "0" \ |
-param make.year.ranges "1" \ |
-param make.single.year.ranges "1" \ |
$(DOCBOOK_XSL)/xhtml/docbook.xsl \ |
"$<" > "$@" || ( $(RM) "$@" && false ) |
sed -i \ |
-e 's!</head>!<link rel="stylesheet" type="text/css" href="man.css"/></head>!' \ |
-e 's/mailto:\([[:alnum:]]*\)@\([[:alnum:]]*\)\.\([[:alpha:]]*\)/mailto:\1%40\2%2E\3/' \ |
-e 's/\([[:alnum:]]*\)@\([[:alnum:]]*\)\.\([[:alpha:]]*\)/\1\@\2\.\3/' \ |
-e 's/\\\[char46\]/./g' \ |
"$@" |
@# man2html includes the last revision date, which xsltproc does not, it |
@# seems useful to me, so I'm injecting it here |
sed -i \ |
-e 's!</h1>!</h1>$(shell grep 'Last revision' $< | head -1 \ |
| sed -e 's!.*<date>!!' \ |
-e 's!</date>.*$$!!')!' \ |
"$@" |
##### |
##### RULES SHARING RECIPES |
##### See http://stackoverflow.com/questions/11441084/makefile-with-multiples-rules-sharing-same-recipe |
##### |
# The xml.dcl file MUST be included in this order, after options and before inputs |
$(srcdir)/vcs.conf.man.tex: $(srcdir)/vcs.conf.man.xml |
cd $(srcdir) && bash flatten_settings_xml.bash > temp.xml || ( rm temp.xml && false ) |
"$(JADE)" -E0 -t tex \ |
-d /usr/share/sgml/docbook/stylesheet/dsssl/modular/print/docbook.dsl \ |
-o "$@" \ |
/usr/share/sgml/declaration/xml.dcl \ |
$(srcdir)/temp.xml || ( rm $(srcdir)/temp.xml && false ) |
$(RM) $(srcdir)/temp.xml |
# 1/2: Pre-requisites |
$(distdir)/vcs.conf.man.pdf: $(distdir)/vcs.conf.5.pdf |
$(distdir)/vcs.man.pdf: $(distdir)/vcs.1.pdf |
$(distdir)/vcs.man2html.html: $(distdir)/vcs.1 |
$(distdir)/vcs.conf.man2html.html: $(distdir)/vcs.conf.5 |
$(srcdir)/vcs.man.tex: $(srcdir)/vcs.man.xml |
"$(JADE)" -E0 -t tex \ |
-d /usr/share/sgml/docbook/stylesheet/dsssl/modular/print/docbook.dsl \ |
-o "$@" \ |
/usr/share/sgml/declaration/xml.dcl \ |
"$<" >/dev/null |
# 2/2: Common recipe |
$(distdir)/vcs.conf.man.pdf $(distdir)/vcs.man.pdf: |
mv $< $@ |
$(distdir)/vcs.%.pdf: $(srcdir)/vcs.%.tex |
pdfjadetex -output-directory $(distdir) $< |
$(RM) $(addprefix $(distdir)/vcs.$(*), .log .aux .out) |
##### |
##### / END OF RULES SHARING RECIPES |
##### |
$(distdir)/vcs.man2html.html $(distdir)/vcs.conf.man2html.html: |
@# The first two lines of man2html are HTTP headers |
@# The manpage is preprocessed to replace groff-escaped dots (\[char46]) |
sed -e 's/\\\[char46\]/\\./g' "$<" | man2html -r | sed 1,2d > "$@" |
# jade and docbook-to-man conversions don't appear to agree on what's the |
# correct structure, to avoid this here I use doclifter to convert back from |
# man to DocBook, which generates a less semantically-rich but easier to |
# process DocBook file |
$(distdir)/vcs.%.pdf: vcs.% |
doclifter < $< > temp.xml || ( $(RM) temp.xml && false ) |
db2pdf temp.xml || ( $(RM) temp.xml && false ) |
-$(RM) temp.xml |
mv temp.pdf $@ |
# Check all XML files for validity |
lint: |
# XML check |
127,8 → 88,23 |
# XHTML check |
# Use `$(MAKE) xhtml' before running `$(MAKE) $@' to |
# actually validate XHTML |
find . -type f -name '*.html' -exec bash -c "echo '[ {} ]' && tidy -utf8 -eq '{}'" \; |
find . -type f -name '*.xhtml' -exec bash -c "echo '[ {} ]' && tidy -utf8 -eq '{}'" \; |
xhtml: $(filter %.html, $(DEFAULT)) |
xhtml: $(filter %.xhtml, $(ALL)) |
.PHONY: all default extra env clean lint xhtml |
# The first two lines of man2html are HTTP headers |
$(distdir)/vcs.man.html: $(distdir)/vcs.1 |
man2html -r "$<" | sed 1,2d > "$@" |
$(distdir)/vcs.conf.man.html: $(distdir)/vcs.conf.5 |
man2html -r "$<" | sed 1,2 > "$@" |
$(distdir)/vcs.1: $(srcdir)/vcs.man.xml |
#xmlto -o `dirname $@`/ man $< |
$(DOCBOOK_TO_MAN) "$<" |
$(distdir)/vcs.conf.5: $(srcdir)/vcs.conf.man.xml |
$(DOCBOOK_TO_MAN) "$<" |
.PHONY: all clean lint xhtml |
/video-contact-sheet/trunk/dist/docs/src/vcs.conf.man.xml |
---|
0,0 → 1,212 |
<?xml version="1.0" encoding="UTF-8" ?> |
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ |
<!-- |
$Id$ |
See vcs.man.xml for comments on docbook+man handling. |
--> |
<!ENTITY firstname "Toni"> |
<!ENTITY surname "Corvera"> |
<!ENTITY fullname "&firstname; &surname;"> |
<!ENTITY email "outlyer@gmail.com"> |
<!-- Was: ENTITY title "vcs User Manual" --> |
<!ENTITY title "Video Contact Sheet *NIX"> |
<!ENTITY package "vcs.conf"> |
<!ENTITY section "5"> |
<!ENTITY emdash "—"> |
<!ENTITY equiv "≡"> |
<!ENTITY rArr "⇒"> |
<!ENTITY vcsmanpage "<citerefentry><refentrytitle>vcs</refentrytitle><manvolnum>1</manvolnum></citerefentry>"> |
<!-- |
XInclude trickery |
This voodoo is only required for the file to validate, it can be used |
by e.g. xsltproc without all of this |
Reference: http://www.sagehill.net/docbookxsl/ValidXinclude.html#XincludeDTD |
--> |
<!-- Define the xi:include and xi:fallback elements --> |
<!ELEMENT xi:include (xi:fallback?) > |
<!ATTLIST xi:include |
xmlns:xi CDATA #FIXED "http://www.w3.org/2001/XInclude" |
href CDATA #IMPLIED |
parse (xml|text) "xml" |
xpointer CDATA #IMPLIED |
encoding CDATA #IMPLIED |
accept CDATA #IMPLIED |
accept-language CDATA #IMPLIED > |
<!ELEMENT xi:fallback ANY> |
<!ATTLIST xi:fallback |
xmlns:xi CDATA #FIXED "http://www.w3.org/2001/XInclude" > |
<!-- |
Add xi:include to the list of possible children of <refsect1> |
See http://www.oasis-open.org/docbook/xml/4.5/dbhierx.mod for the DTD |
module that defines which elements are allowed inside which. |
Can't allow xi:include in arbitrary places inside <refentry> |
--> |
<!ENTITY % local.refcomponent.mix "| xi:include"> |
]><!--/!DOCTYPE--> |
<refentry lang="en-GB"> |
<refentryinfo> |
<title>&title;</title> |
<productname>&package;</productname> |
<author> |
<firstname>&firstname;</firstname> |
<surname>&surname;</surname> |
<contrib /> |
<address> |
<email>&email;</email> |
<otheraddr> |
<ulink url="http://corvera.eu./" /> |
</otheraddr> |
</address> |
</author> |
<copyright> |
<year>2007-2017</year> |
<holder>&fullname;</holder> |
</copyright> |
<legalnotice> |
<para>Permission is granted to copy, distribute and/or modify this |
document under the terms of the GNU Lesser General Public License, |
Version 2 or (at your option) any later version published by |
the Free Software Foundation.</para> |
</legalnotice> |
<releaseinfo>$Rev$</releaseinfo> |
<!--<date>$Date$</date>--> |
<date>Last revision: 2011-08-29</date> |
</refentryinfo> |
<refmeta> |
<refentrytitle>&package;</refentrytitle> |
<manvolnum>§ion;</manvolnum> |
</refmeta> |
<refnamediv> |
<refname>&package;</refname> |
<refpurpose>vcs configuration file</refpurpose> |
</refnamediv> |
<refsect1 id="description"> |
<title>DESCRIPTION</title> |
<para>This manual page describes the format and available settings |
in configuration and profile files for |
<citerefentry> |
<refentrytitle>vcs</refentrytitle> |
<manvolnum>1</manvolnum> |
</citerefentry> |
</para> |
<para>There's two types of files that follow this syntax: |
<link linkend="configfiles">configuration files</link> |
(see <xref linkend="configfiles"/>) |
and <link linkend="profiles">profiles</link> |
(see <xref linkend="profiles"/>). They'll be called collectively |
<emphasis>settings files</emphasis> in this manual page.</para> |
<para>Configuration files are meant to be loaded by default, intended to |
set user's preferred options, while |
profiles are meant to be loaded on-demand, intended to allow |
different parallel sets of settings.</para> |
</refsect1><!--/DESCRIPTION--> |
<refsect1 id="syntax"> |
<title>SYNTAX</title> |
<para>Settings files contain a series of |
<replaceable>SETTING</replaceable>=<replaceable>VALUE</replaceable> |
assignments. |
</para> |
<para>Comments can be included by preceding `<literal>#</literal>' to them.</para> |
<refsect2 id="metainfo"> |
<title>META-INFORMATION</title> |
<para>Meta-information fields can be contained in comments. |
They are written as '<literal>vcs:<replaceable>FIELDNAME</replaceable>:</literal>'.</para> |
<para>Currently supported meta-information fields:</para> |
<variablelist> |
<varlistentry> |
<term><literal>vcs:conf:</literal></term> |
<listitem><para>Marks a file as following this format.</para> |
<para>Files without this field will be rejected. |
<footnote> |
<!-- Note: \[char46] is a escaped dot for groff. |
Otherwise this paragraph's output will start a line |
with a dot, which makes groff/man interpret it as an |
inexistent macro, |
i.e. the filename won't render at all |
Reference: http://stackoverflow.com/questions/11469341/ |
--> |
<para><filename>\[char46]/vcs.conf</filename> won't be rejected if this |
field is missing, though it's preferable to include it |
to be ease moving the file to a different location or |
turning it into a profile.</para> |
</footnote> |
</para> |
</listitem> |
</varlistentry> |
<varlistentry> |
<term><literal>vcs:desc:</literal> <replaceable>DESCRIPTION</replaceable></term> |
<listitem><para>Describes this particular file's purpose, |
it is shown e.g. when listing available profiles. |
</para> |
<para>It is currently ignored for configuration files.</para> |
</listitem> |
</varlistentry> |
</variablelist> |
</refsect2><!--/META-INFORMATION--> |
<refsect2 id="syntax-example"> |
<title>SYNTAX EXAMPLE</title> |
<programlisting># vcs:conf: |
# vcs:desc: White-on-black |
bg_all=black # Black background |
fg_all=white # White foreground</programlisting> |
</refsect2><!--/SYNTAX EXAMPLE--> |
</refsect1><!--/SYNTAX--> |
<refsect1 id="configfiles"> |
<title>CONFIGURATION FILES</title> |
<para>There's three configuration files loaded by default if present, in order:</para> |
<itemizedlist> |
<listitem><para><filename>/etc/vcs.conf</filename></para></listitem> |
<listitem><para><filename><envar>${HOME}</envar>/.vcs.conf</filename></para></listitem> |
<listitem><para><filename><envar>${HOME}</envar>/vcs/vcs.conf</filename></para></listitem> |
</itemizedlist> |
<para>Every file in this list overrides the previous when it |
re-defines a setting.</para> |
<para>Configuration files can be loaded manually off of any path by using the |
<option>--config <replaceable>FILENAME</replaceable></option> option.</para> |
</refsect1><!--/CONFIGURATION FILES--> |
<refsect1 id="profiles"> |
<title>PROFILE FILES</title> |
<para>No profile is loaded by default.</para> |
<para>Profiles are searched in three possible locations, in order:</para> |
<itemizedlist id="profile-paths"> |
<listitem><para><filename class="directory"><envar>${HOME}</envar>/.vcs/profiles/</filename></para></listitem> |
<listitem><para><filename class="directory">/usr/local/share/vcs/profiles/</filename></para></listitem> |
<listitem><para><filename class="directory">/usr/share/vcs/profiles/</filename></para></listitem> |
</itemizedlist> |
<para>Only the first profile for each name will be considered. |
Profiles with the same name will be hidden.</para> |
<para><literal>$ <command>vcs --profile :list</command></literal></para> |
<para>can be used to get a list of available profiles.</para> |
<para>Profiles can only be loaded from the <link linkend="profile-paths">listed |
paths</link>.</para> |
</refsect1><!--/PROFILE FILES--> |
<refsect1> |
<title>SETTINGS</title> |
<para>This list details the available settings. Settings are listed in |
alphabetical order.</para> |
<para>A list of available settings, grouped by categories, is also kept |
online at <ulink url="http://p.outlyer.net/dox/vcs:conf_files" /></para> |
<xi:include |
xmlns:xi="http://www.w3.org/2001/XInclude" |
href="./settings.man.inc.xml" /> |
</refsect1> |
<refsect1 id="see_also"> |
<title>SEE ALSO</title> |
<para> |
<citerefentry> |
<refentrytitle>vcs</refentrytitle> |
<manvolnum>1</manvolnum> |
</citerefentry>, |
<citerefentry> |
<refentrytitle>id</refentrytitle> |
<manvolnum>1</manvolnum> |
</citerefentry> |
</para> |
</refsect1><!--/SEE ALSO--> |
</refentry> |
<!-- vim:set ts=4 et: --> |
Property changes: |
Added: svn:keywords |
+Rev Id Date |
\ No newline at end of property |
/video-contact-sheet/trunk/dist/docs/src/vcs.man.xml |
---|
1,5 → 1,5 |
<?xml version="1.0" encoding="UTF-8" ?> |
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ |
<!-- |
$Id$ |
55,49 → 55,7 |
<!ENTITY package "vcs"> |
<!ENTITY emdash "—"> |
<!ENTITY xrefinterval 'See the accepted syntax at <xref linkend="interval_format" />.'> |
<!-- for vcs.conf(5) --> |
<!ENTITY title "Video Contact Sheet *NIX"> |
<!ENTITY confpackage "vcs.conf"> |
<!ENTITY confsection "5"> |
<!ENTITY equiv "≡"> |
<!ENTITY rArr "⇒"> |
<!ENTITY vcsmanpage "<citerefentry><refentrytitle>vcs</refentrytitle><manvolnum>1</manvolnum></citerefentry>"> |
<!-- |
XInclude trickery |
This voodoo is only required for the file to validate, it can be used |
by e.g. xsltproc without all of this |
Reference: http://www.sagehill.net/docbookxsl/ValidXinclude.html#XincludeDTD |
--> |
<!-- Define the xi:include and xi:fallback elements --> |
<!ELEMENT xi:include (xi:fallback?) > |
<!ATTLIST xi:include |
xmlns:xi CDATA #FIXED "http://www.w3.org/2001/XInclude" |
href CDATA #IMPLIED |
parse (xml|text) "xml" |
xpointer CDATA #IMPLIED |
encoding CDATA #IMPLIED |
accept CDATA #IMPLIED |
accept-language CDATA #IMPLIED > |
<!ELEMENT xi:fallback ANY> |
<!ATTLIST xi:fallback |
xmlns:xi CDATA #FIXED "http://www.w3.org/2001/XInclude" > |
<!-- |
Add xi:include to the list of possible children of <refsect1> |
See http://www.oasis-open.org/docbook/xml/4.5/dbhierx.mod for the DTD |
module that defines which elements are allowed inside which. |
Can't allow xi:include in arbitrary places inside <refentry> |
--> |
<!ENTITY % local.refcomponent.mix "| xi:include"> |
]><!-- END OF DOCTYPE --> |
<reference><!-- Group of refentry's --> |
<!-- This is required by reference to validate with e.g. xmlto. |
NOTE This appears to override the title set below. --> |
<title>&title;</title> |
<!-- START OF man(1) --> |
]> |
<refentry lang="en-GB"> |
<refentryinfo> |
<title>&title;</title> |
192,7 → 150,7 |
</arg> |
</cmdsynopsis> |
</refsynopsisdiv> |
<refsect1> |
<refsect1 id="description"> |
<title>DESCRIPTION</title> |
<para><command>&package;</command> creates a preview |
image from videos in a contact sheet-like format (i.e. captures from |
877,7 → 835,7 |
might uncover bugs and produce incompatibilities unknown to the author. |
</para> |
</refsect1> |
<refsect1> |
<refsect1 id="see_also"> |
<title>SEE ALSO</title> |
<!-- In alpabetical order. --> |
<para><citerefentry> |
895,172 → 853,4 |
</citerefentry></para> |
</refsect1> |
</refentry> |
<!-- END OF vcs(1) --> |
<!-- START OF vcs.conf(5) --> |
<refentry lang="en-GB"> |
<refentryinfo> |
<title>&title;</title> |
<productname>&confpackage;</productname> |
<author> |
<firstname>&firstname;</firstname> |
<surname>&surname;</surname> |
<contrib /> |
<address> |
<email>&email;</email> |
<otheraddr> |
<ulink url="http://corvera.eu./" /> |
</otheraddr> |
</address> |
</author> |
<copyright> |
<year>2007-2017</year> |
<holder>&fullname;</holder> |
</copyright> |
<legalnotice> |
<para>Permission is granted to copy, distribute and/or modify this |
document under the terms of the GNU Lesser General Public License, |
Version 2 or (at your option) any later version published by |
the Free Software Foundation.</para> |
</legalnotice> |
<releaseinfo>$Rev$</releaseinfo> |
<!--<date>$Date$</date>--> |
<date>Last revision: 2011-08-29</date> |
</refentryinfo> |
<refmeta> |
<refentrytitle>&confpackage;</refentrytitle> |
<manvolnum>&confsection;</manvolnum> |
</refmeta> |
<refnamediv> |
<refname>&confpackage;</refname> |
<refpurpose>vcs configuration file</refpurpose> |
</refnamediv> |
<refsect1> |
<title>DESCRIPTION</title> |
<para>This manual page describes the format and available settings |
in configuration and profile files for |
<citerefentry> |
<refentrytitle>vcs</refentrytitle> |
<manvolnum>1</manvolnum> |
</citerefentry> |
</para> |
<para>There's two types of files that follow this syntax: |
<link linkend="configfiles">configuration files</link> |
(see <xref linkend="configfiles"/>) |
and <link linkend="profiles">profiles</link> |
(see <xref linkend="profiles"/>). They'll be called collectively |
<emphasis>settings files</emphasis> in this manual page.</para> |
<para>Configuration files are meant to be loaded by default, intended to |
set user's preferred options, while |
profiles are meant to be loaded on-demand, intended to allow |
different parallel sets of settings.</para> |
</refsect1><!--/DESCRIPTION--> |
<refsect1 id="syntax"> |
<title>SYNTAX</title> |
<para>Settings files contain a series of |
<replaceable>SETTING</replaceable>=<replaceable>VALUE</replaceable> |
assignments. |
</para> |
<para>Comments can be included by preceding `<literal>#</literal>' to them.</para> |
<refsect2 id="metainfo"> |
<title>META-INFORMATION</title> |
<para>Meta-information fields can be contained in comments. |
They are written as '<literal>vcs:<replaceable>FIELDNAME</replaceable>:</literal>'.</para> |
<para>Currently supported meta-information fields:</para> |
<variablelist> |
<varlistentry> |
<term><literal>vcs:conf:</literal></term> |
<listitem><para>Marks a file as following this format.</para> |
<para>Files without this field will be rejected. |
<footnote> |
<!-- Note: \[char46] is a escaped dot for groff. |
Otherwise this paragraph's output will start a line |
with a dot, which makes groff/man interpret it as an |
inexistent macro, |
i.e. the filename won't render at all |
Reference: http://stackoverflow.com/questions/11469341/ |
--> |
<para><filename>\[char46]/vcs.conf</filename> won't be rejected if this |
field is missing, though it's preferable to include it |
to be ease moving the file to a different location or |
turning it into a profile.</para> |
</footnote> |
</para> |
</listitem> |
</varlistentry> |
<varlistentry> |
<term><literal>vcs:desc:</literal> <replaceable>DESCRIPTION</replaceable></term> |
<listitem><para>Describes this particular file's purpose, |
it is shown e.g. when listing available profiles. |
</para> |
<para>It is currently ignored for configuration files.</para> |
</listitem> |
</varlistentry> |
</variablelist> |
</refsect2><!--/META-INFORMATION--> |
<refsect2 id="syntax-example"> |
<title>SYNTAX EXAMPLE</title> |
<programlisting># vcs:conf: |
# vcs:desc: White-on-black |
bg_all=black # Black background |
fg_all=white # White foreground</programlisting> |
</refsect2><!--/SYNTAX EXAMPLE--> |
</refsect1><!--/SYNTAX--> |
<refsect1 id="configfiles"> |
<title>CONFIGURATION FILES</title> |
<para>There's three configuration files loaded by default if present, in order:</para> |
<itemizedlist> |
<listitem><para><filename>/etc/vcs.conf</filename></para></listitem> |
<listitem><para><filename><envar>${HOME}</envar>/.vcs.conf</filename></para></listitem> |
<listitem><para><filename><envar>${HOME}</envar>/vcs/vcs.conf</filename></para></listitem> |
</itemizedlist> |
<para>Every file in this list overrides the previous when it |
re-defines a setting.</para> |
<para>Configuration files can be loaded manually off of any path by using the |
<option>--config <replaceable>FILENAME</replaceable></option> option.</para> |
</refsect1><!--/CONFIGURATION FILES--> |
<refsect1 id="profiles"> |
<title>PROFILE FILES</title> |
<para>No profile is loaded by default.</para> |
<para>Profiles are searched in three possible locations, in order:</para> |
<itemizedlist id="profile-paths"> |
<listitem><para><filename class="directory"><envar>${HOME}</envar>/.vcs/profiles/</filename></para></listitem> |
<listitem><para><filename class="directory">/usr/local/share/vcs/profiles/</filename></para></listitem> |
<listitem><para><filename class="directory">/usr/share/vcs/profiles/</filename></para></listitem> |
</itemizedlist> |
<para>Only the first profile for each name will be considered. |
Profiles with the same name will be hidden.</para> |
<para><literal>$ <command>vcs --profile :list</command></literal></para> |
<para>can be used to get a list of available profiles.</para> |
<para>Profiles can only be loaded from the <link linkend="profile-paths">listed |
paths</link>.</para> |
</refsect1><!--/PROFILE FILES--> |
<refsect1> |
<title>SETTINGS</title> |
<para>This list details the available settings. Settings are listed in |
alphabetical order.</para> |
<para>A list of available settings, grouped by categories, is also kept |
online at <ulink url="http://p.outlyer.net/dox/vcs:conf_files" /></para> |
<xi:include |
xmlns:xi="http://www.w3.org/2001/XInclude" |
href="./settings.man.inc.xml" /> |
</refsect1> |
<refsect1> |
<title>SEE ALSO</title> |
<para> |
<citerefentry> |
<refentrytitle>vcs</refentrytitle> |
<manvolnum>1</manvolnum> |
</citerefentry>, |
<citerefentry> |
<refentrytitle>id</refentrytitle> |
<manvolnum>1</manvolnum> |
</citerefentry> |
</para> |
</refsect1><!--/SEE ALSO--> |
</refentry> |
<!-- END OF vcs.conf(5) --> |
</reference> |
<!-- vim:set ts=4 et: --> |