mirror of
https://github.com/pgbackrest/pgbackrest.git
synced 2024-12-14 10:13:05 +02:00
9d9c438f59
Bug Fixes: * Fixed missing variable replacements. * Removed hard-coded host names from configuration file paths. Documentation Features: * Allow command-line length to be configured using cmd-line-len param. * Added compact param to allow CSS to be embedded in HTML file. * Added pretty param to produce HTML with proper indenting. * Only generate HTML menu when required and don't require index page. * Assign numbers to sections by default. * VM mount points are now optional.
97 lines
4.0 KiB
XML
97 lines
4.0 KiB
XML
<?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 & Restore</variable>
|
|
<variable key="version" eval="y">use pgBackRest::Version; BACKREST_VERSION</variable>
|
|
<variable key="version-stable" eval="y">
|
|
use BackRestDoc::Custom::DocCustomRelease;
|
|
|
|
(new BackRestDoc::Custom::DocCustomRelease(
|
|
new BackRestDoc::Common::Doc("{[doc-path]}/xml/release.xml")))->currentStableVersion();
|
|
</variable>
|
|
<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>
|
|
|
|
<!-- Release date - static allows for reproducible builds -->
|
|
<variable key="release-date-static">n</variable>
|
|
<variable key="release-date" eval="y">
|
|
use Time::Local;
|
|
use BackRestDoc::Custom::DocCustomRelease;
|
|
|
|
my ($second, $minute , $hour, $mday, $month, $year) = localtime();
|
|
$year += 1900;
|
|
|
|
if ('{[release-date-static]}' eq 'y')
|
|
{
|
|
my $strDate = (new BackRestDoc::Custom::DocCustomRelease(
|
|
new BackRestDoc::Common::Doc("{[doc-path]}/xml/release.xml")))->releaseLast()->paramGet('date');
|
|
|
|
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;
|
|
}
|
|
}
|
|
|
|
my @stryMonth = ('January', 'February', 'March', 'April', 'May', 'June',
|
|
'July', 'August', 'September', 'October', 'November', 'December');
|
|
|
|
$stryMonth[$month] . ' ' . $mday . ', ' . $year;
|
|
</variable>
|
|
|
|
<!-- Logo locations -->
|
|
<variable key="logo">{[doc-path]}/output/latex/logo</variable>
|
|
|
|
<!-- HTML variables -->
|
|
<variable key="html-footer" eval='y'>
|
|
'Copyright &copy; 2015' . '-' . substr('{[release-date]}', length('{[release-date]}') - 4) .
|
|
', The PostgreSQL Global Development Group, <a href="{[github-url-license]}">MIT License</a>. Updated ' .
|
|
'{[release-date]}';
|
|
</variable>
|
|
<!-- <variable key="html-logo"><img src="{[project-logo]}"></variable> -->
|
|
|
|
<!-- PDF variables -->
|
|
<variable key="pdf-title">{[project]} User Guide</variable>
|
|
<variable key="pdf-subtitle">Open Source PostgreSQL Backup and Restore Utility</variable>
|
|
<variable key="pdf-file">CrunchyBackRest-UserGuide-{[version]}</variable>
|
|
</variable-list>
|
|
|
|
<source-list>
|
|
<source key="index"/>
|
|
<source key="user-guide"/>
|
|
<source key="reference" type="custom"/>
|
|
<source key="release" type="custom"/>
|
|
<source key="test"/>
|
|
</source-list>
|
|
|
|
<render-list>
|
|
<render type="html">
|
|
<render-source key="index" menu="Home"/>
|
|
<render-source key="user-guide" menu="User Guide"/>
|
|
<render-source key="configuration" source="reference" menu="Configuration"/>
|
|
<render-source key="command" source="reference" menu="Commands"/>
|
|
<render-source key="release" menu="Releases"/>
|
|
</render>
|
|
|
|
<render type="pdf" file="{[pdf-file]}">
|
|
<render-source key="user-guide"/>
|
|
</render>
|
|
|
|
<render type="markdown">
|
|
<render-source key="index" file="../../../README.md"/>
|
|
<render-source key="test" file="../../../test/README.md"/>
|
|
</render>
|
|
</render-list>
|
|
</doc>
|