1
0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2024-12-12 10:04:14 +02:00
pgbackrest/doc/manifest.xml

127 lines
5.6 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE doc SYSTEM "manifest.dtd">
<doc>
<!-- System-wide variables -->
<variable-list>
<variable key="project">pgBackRest</variable>
<variable key="project-tagline">Reliable PostgreSQL Backup &amp; Restore</variable>
<variable key="version" eval="y">use pgBackRestDoc::ProjectInfo; PROJECT_VERSION</variable>
<variable key="version-stable" eval="y">
use pgBackRestDoc::Custom::DocCustomRelease;
(new pgBackRestDoc::Custom::DocCustomRelease(
new pgBackRestDoc::Common::Doc("{[doc-path]}/xml/release.xml")))->currentStableVersion();
</variable>
New simpler configuration and consistent project/exe/path naming. * The repo-path option now always refers to the repository where backups and archive are stored, whether local or remote, so the repo-remote-path option has been removed. The new spool-path option can be used to define a location for queueing WAL segments when archiving asynchronously. Otherwise, a local repository is no longer required. * Implemented a new config format which should be far simpler to use. See the User Guide and Configuration Reference for details but for a simple configuration all options can now be placed in the stanza section. Options that are shared between stanzas can be placed in the [global] section. More complex configurations can still make use of command sections though this should be a rare use case. * The default configuration filename is now pgbackrest.conf instead of pg_backrest.conf. This was done for consistency with other naming changes but also to prevent old config files from being loaded accidentally. * The default repository name was changed from /var/lib/backup to /var/lib/pgbackrest. * Lock files are now stored in /tmp/pgbackrest by default. These days /run/pgbackrest would be the preferred location but that would require init scripts which are not part of this release. The lock-path option can be used to configure the lock directory. * Log files are now stored in /var/log/pgbackrest by default and no longer have the date appended so they can be managed with logrotate. The log-path option can be used to configure the lock directory. * Executable filename changed from pg_backrest to pgbackrest.
2016-04-14 15:30:54 +02:00
<variable key="project-exe">pgbackrest</variable>
<variable key="project-url-root">/</variable>
<variable key="postgres">PostgreSQL</variable>
<variable key="dash">-</variable>
<variable key="project-logo">logo.png</variable>
<variable key="project-favicon">favicon.png</variable>
<!-- Is this a development or debug build of the docs? -->
<variable key="dev">n</variable>
<variable key="debug">n</variable>
<!-- Release date - static allows for reproducible builds -->
<variable key="release-date-static">n</variable>
<variable key="release-date" eval="y">
use Time::Local;
use pgBackRestDoc::Custom::DocCustomRelease;
my ($second, $minute , $hour, $mday, $month, $year) = localtime();
$year += 1900;
if ('{[release-date-static]}' eq 'y')
{
my $strDate = (new pgBackRestDoc::Custom::DocCustomRelease(
new pgBackRestDoc::Common::Doc("{[doc-path]}/xml/release.xml")))->releaseLast()->paramGet('date');
if ($strDate eq 'XXXX-XX-XX')
{
confess &amp;log(ERROR, 'not possible to use static release dates on a dev build');
}
else
{
($year, $month, $mday) = split(/[\s.\-]+/, $strDate);
$month -= 1;
}
}
my @stryMonth = ('January', 'February', 'March', 'April', 'May', 'June',
'July', 'August', 'September', 'October', 'November', 'December');
$stryMonth[$month] . ' ' . $mday . ', ' . $year;
</variable>
<!-- HTML variables -->
<variable key="html-footer" eval='y'>
'Copyright &amp;copy; 2015' . '-' . substr('{[release-date]}', length('{[release-date]}') - 4) .
', The PostgreSQL Global Development Group, &lt;a href="{[github-url-license]}">MIT License&lt;/a>. Updated ' .
'{[release-date]}';
</variable>
<!-- <variable key="html-logo">&lt;img src=&quot;{[project-logo]}&quot;&gt;</variable> -->
<!-- PDF variables -->
<variable key="pdf-logo">{[doc-path]}/output/latex/logo</variable>
<variable key="pdf-title1">{[project]} User Guide</variable>
<variable key="pdf-title2">Open Source PostgreSQL Backup and Restore Utility</variable>
<variable key="pdf-title3">Version {[version]}</variable>
<variable key="pdf-organization">Crunchy Data Solutions, Inc.</variable>
<variable key="pdf-resource-logo">cds-logo.eps</variable>
<variable key='pdf-footer-left'>{[pdf-title1]}\\{[pdf-title3]}</variable>
<variable key='pdf-footer-center'>\ \\-\ \thepage\ -</variable>
<variable key='pdf-footer-right'>{[pdf-organization]}\\\today</variable>
<variable key="pdf-file">CrunchyBackRest-UserGuide-{[version]}</variable>
</variable-list>
<source-list>
<source key="index"/>
<source key="user-guide-index"/>
<source key="user-guide"/>
<source key="help" type="custom"/>
<source key="release" type="custom"/>
<source key="faq"/>
<source key="metric"/>
2017-11-27 23:02:49 +02:00
<source key="coding"/>
<source key="contributing"/>
<source key="documentation"/>
</source-list>
<render-list>
<render type="html">
<render-source key="index" menu="Home"/>
<render-source key="user-guide-index" menu="User Guides"/>
<render-source key="user-guide"/>
<render-source key="release" menu="Releases"/>
<render-source key="configuration" source="help" menu="Configuration"/>
<render-source key="command" source="help" menu="Commands"/>
<render-source key="faq" menu="FAQ"/>
<render-source key="metric" menu="Metrics"/>
</render>
<render type="pdf" file="{[pdf-file]}">
<render-source key="user-guide"/>
</render>
<render type="markdown">
<render-source key="index" file="../../../README.md"/>
2017-11-27 23:02:49 +02:00
<render-source key="coding" file="../../../CODING.md"/>
<!--
Building the contributing document has some special requirements because it runs Docker in Docker so the repo path
must align on the host and all Docker containers. Run `pgbackrest/doc/doc.pl` from within the home directory of
the user that will do the doc build, e.g. `home/vagrant`. If the repo is not located directly in the home
directory, e.g. `/home/vagrant/pgbackrest`, then a symlink may be used,
e.g. `ln -s /path/to/repo /home/vagrant/pgbackrest`.
-->
<render-source key="contributing" file="../../../CONTRIBUTING.md"/>
<render-source key="documentation" file="../../README.md"/>
</render>
</render-list>
</doc>