2015-11-22 23:44:01 +02:00
|
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
|
|
<!DOCTYPE doc SYSTEM "manifest.dtd">
|
|
|
|
<doc>
|
|
|
|
<!-- System-wide variables -->
|
|
|
|
<variable-list>
|
|
|
|
<variable key="project">pgBackRest</variable>
|
2016-11-07 17:06:35 +02:00
|
|
|
<variable key="project-tagline">Reliable PostgreSQL Backup & Restore</variable>
|
2020-03-10 23:57:02 +02:00
|
|
|
<variable key="version" eval="y">use pgBackRestDoc::ProjectInfo; PROJECT_VERSION</variable>
|
2016-06-02 15:32:56 +02:00
|
|
|
<variable key="version-stable" eval="y">
|
2020-03-10 21:41:56 +02:00
|
|
|
use pgBackRestDoc::Custom::DocCustomRelease;
|
2016-06-02 15:32:56 +02:00
|
|
|
|
2020-03-10 21:41:56 +02:00
|
|
|
(new pgBackRestDoc::Custom::DocCustomRelease(
|
|
|
|
new pgBackRestDoc::Common::Doc("{[doc-path]}/xml/release.xml")))->currentStableVersion();
|
2016-06-02 15:32:56 +02:00
|
|
|
</variable>
|
2016-04-14 15:30:54 +02:00
|
|
|
<variable key="project-exe">pgbackrest</variable>
|
2015-11-22 23:44:01 +02:00
|
|
|
<variable key="project-url-root">/</variable>
|
|
|
|
<variable key="postgres">PostgreSQL</variable>
|
|
|
|
<variable key="dash">-</variable>
|
2016-05-16 23:01:48 +02:00
|
|
|
<variable key="project-logo">logo.png</variable>
|
|
|
|
<variable key="project-favicon">favicon.png</variable>
|
2015-11-22 23:44:01 +02:00
|
|
|
|
2018-12-01 19:40:01 +02:00
|
|
|
<!-- Is this a development or debug build of the docs? -->
|
|
|
|
<variable key="dev">n</variable>
|
|
|
|
<variable key="debug">n</variable>
|
|
|
|
|
2016-06-28 02:37:25 +02:00
|
|
|
<!-- Release date - static allows for reproducible builds -->
|
|
|
|
<variable key="release-date-static">n</variable>
|
2016-07-26 23:40:42 +02:00
|
|
|
<variable key="release-date" eval="y">
|
2016-06-28 02:37:25 +02:00
|
|
|
use Time::Local;
|
2020-03-10 21:41:56 +02:00
|
|
|
use pgBackRestDoc::Custom::DocCustomRelease;
|
2016-06-28 02:37:25 +02:00
|
|
|
|
|
|
|
my ($second, $minute , $hour, $mday, $month, $year) = localtime();
|
2016-07-26 23:40:42 +02:00
|
|
|
$year += 1900;
|
2016-06-28 02:37:25 +02:00
|
|
|
|
|
|
|
if ('{[release-date-static]}' eq 'y')
|
|
|
|
{
|
2020-03-10 21:41:56 +02:00
|
|
|
my $strDate = (new pgBackRestDoc::Custom::DocCustomRelease(
|
|
|
|
new pgBackRestDoc::Common::Doc("{[doc-path]}/xml/release.xml")))->releaseLast()->paramGet('date');
|
2016-06-28 02:37:25 +02:00
|
|
|
|
|
|
|
if ($strDate eq 'XXXX-XX-XX')
|
|
|
|
{
|
|
|
|
confess &log(ERROR, 'not possible to use static release dates on a dev build');
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
($year, $month, $mday) = split(/[\s.\-]+/, $strDate);
|
|
|
|
$month -= 1;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-07-26 23:40:42 +02:00
|
|
|
my @stryMonth = ('January', 'February', 'March', 'April', 'May', 'June',
|
|
|
|
'July', 'August', 'September', 'October', 'November', 'December');
|
|
|
|
|
|
|
|
$stryMonth[$month] . ' ' . $mday . ', ' . $year;
|
2016-06-28 02:37:25 +02:00
|
|
|
</variable>
|
|
|
|
|
2015-11-22 23:44:01 +02:00
|
|
|
<!-- HTML variables -->
|
|
|
|
<variable key="html-footer" eval='y'>
|
2016-07-26 23:40:42 +02:00
|
|
|
'Copyright &copy; 2015' . '-' . substr('{[release-date]}', length('{[release-date]}') - 4) .
|
2016-06-28 02:37:25 +02:00
|
|
|
', The PostgreSQL Global Development Group, <a href="{[github-url-license]}">MIT License</a>. Updated ' .
|
2016-07-26 23:40:42 +02:00
|
|
|
'{[release-date]}';
|
2016-06-28 02:37:25 +02:00
|
|
|
</variable>
|
2016-05-16 23:01:48 +02:00
|
|
|
<!-- <variable key="html-logo"><img src="{[project-logo]}"></variable> -->
|
2015-11-22 23:44:01 +02:00
|
|
|
|
|
|
|
<!-- PDF variables -->
|
2018-12-31 08:51:00 +02:00
|
|
|
<variable key="pdf-logo">{[doc-path]}/output/latex/logo</variable>
|
|
|
|
|
2018-02-21 22:30:35 +02:00
|
|
|
<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>
|
2018-12-31 08:51:00 +02:00
|
|
|
<variable key="pdf-resource-logo">cds-logo.eps</variable>
|
2018-02-21 22:30:35 +02:00
|
|
|
|
|
|
|
<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>
|
|
|
|
|
2015-11-22 23:44:01 +02:00
|
|
|
<variable key="pdf-file">CrunchyBackRest-UserGuide-{[version]}</variable>
|
|
|
|
</variable-list>
|
|
|
|
|
|
|
|
<source-list>
|
|
|
|
<source key="index"/>
|
2019-05-16 14:32:02 +02:00
|
|
|
<source key="user-guide-index"/>
|
2015-11-22 23:44:01 +02:00
|
|
|
<source key="user-guide"/>
|
2021-09-09 00:16:06 +02:00
|
|
|
<source key="help" type="custom"/>
|
2016-05-26 15:20:55 +02:00
|
|
|
<source key="release" type="custom"/>
|
2019-06-19 00:42:47 +02:00
|
|
|
<source key="faq"/>
|
2019-05-15 19:04:56 +02:00
|
|
|
<source key="metric"/>
|
2017-11-27 23:02:49 +02:00
|
|
|
<source key="coding"/>
|
2019-10-08 21:27:17 +02:00
|
|
|
<source key="contributing"/>
|
2018-12-12 20:52:23 +02:00
|
|
|
<source key="documentation"/>
|
2015-11-22 23:44:01 +02:00
|
|
|
</source-list>
|
|
|
|
|
|
|
|
<render-list>
|
|
|
|
<render type="html">
|
|
|
|
<render-source key="index" menu="Home"/>
|
2019-05-16 14:32:02 +02:00
|
|
|
<render-source key="user-guide-index" menu="User Guides"/>
|
|
|
|
<render-source key="user-guide"/>
|
2018-12-15 01:46:12 +02:00
|
|
|
<render-source key="release" menu="Releases"/>
|
2021-09-09 00:16:06 +02:00
|
|
|
<render-source key="configuration" source="help" menu="Configuration"/>
|
|
|
|
<render-source key="command" source="help" menu="Commands"/>
|
2019-06-19 00:42:47 +02:00
|
|
|
<render-source key="faq" menu="FAQ"/>
|
2019-05-15 19:04:56 +02:00
|
|
|
<render-source key="metric" menu="Metrics"/>
|
2015-11-22 23:44:01 +02:00
|
|
|
</render>
|
|
|
|
|
|
|
|
<render type="pdf" file="{[pdf-file]}">
|
|
|
|
<render-source key="user-guide"/>
|
|
|
|
</render>
|
2016-01-09 15:21:53 +02:00
|
|
|
|
|
|
|
<render type="markdown">
|
2016-04-16 17:55:23 +02:00
|
|
|
<render-source key="index" file="../../../README.md"/>
|
2017-11-27 23:02:49 +02:00
|
|
|
<render-source key="coding" file="../../../CODING.md"/>
|
2020-03-22 00:45:58 +02:00
|
|
|
|
|
|
|
<!--
|
|
|
|
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"/>
|
2018-12-12 20:52:23 +02:00
|
|
|
<render-source key="documentation" file="../../README.md"/>
|
2016-01-09 15:21:53 +02:00
|
|
|
</render>
|
2015-11-22 23:44:01 +02:00
|
|
|
</render-list>
|
|
|
|
</doc>
|