Skip to content

Some presentation tweaks, clarity and capitalisation changes #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Jan 9, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/6.0/en/adapters.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
</para>
<para>
You can build your own configuration adapter.
Want to know how? Have a look at the <link linkend="extending.adapter">extending phpbu section</link>
Want to know how? Have a look at the <link linkend="extending.adapter">extending PHPBU section</link>
</para>

<section id="adapters.env">
Expand Down Expand Up @@ -81,7 +81,7 @@
<indexterm><primary>dotenv</primary></indexterm>
<title>PHP config adapter "array"</title>
<para>
Adapter to use php array config files.
Adapter to use PHP array config files.
</para>

<example>
Expand Down
6 changes: 3 additions & 3 deletions src/6.0/en/check.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<title>Backup Validation</title>

<para>
You can validate your backup after creation with some simple Checks.
You can validate your backup after creation with some simple checks.
</para>

<table id="check.tables.available-checks">
Expand All @@ -22,11 +22,11 @@
<tbody>
<row>
<entry>SizeMin</entry>
<entry>Checks if the backups is at least as big as the configured size.</entry>
<entry>Checks if your backup is at least as big as the configured size.</entry>
</row>
<row>
<entry>SizeDiffPreviousPercent</entry>
<entry>Checks if your backup doesn't differ more then a configured value from the previous backup.</entry>
<entry>Checks if your backup differs more than a configured value from the previous backup.</entry>
</row>
</tbody>
</tgroup>
Expand Down
10 changes: 5 additions & 5 deletions src/6.0/en/cleanup.xml
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@

<para>
If you want to remove your synced backups as well, and you are not using the
<link linkend="sync.rsync">Rsync</link> sync with it's <literal>delete</literal> option.
Have a look at the <link linkend="cleanup.remote">remote cleanup section</link>
<link linkend="sync.rsync">Rsync</link> sync with its <literal>delete</literal> option.
Have a look at the <link linkend="cleanup.remote">remote cleanup section</link>.
</para>

<table id="cleanup.tables.available-cleanups">
<title>Supported types of cleanups:</title>
<title>Supported types of cleanup:</title>
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<thead>
<row>
Expand All @@ -38,7 +38,7 @@
<entry>Outdated</entry>
<entry>
Remove backups older than a configured time-value.
For example "2W" to delete all backup older than two weeks.
For example "2W" to delete all backups older than two weeks.
</entry>
</row>
<row>
Expand All @@ -50,7 +50,7 @@
<entry>
Keep different amount of backups for different periods of time.
For example keep all backups you made for the last 3 days, keep one for each week for the last 4 weeks,
keep one for each month for the last 6 month and one for every year for at least 3 years.
keep one for each month for the last 6 months and one for each year for at least 3 years.
</entry>
</row>
</tbody>
Expand Down
28 changes: 14 additions & 14 deletions src/6.0/en/cli.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<title>The Command-Line-Runner</title>

<para>
If you have a configuration file named <literal>phpbu.xml</literal> in your current working directory you can execute phpbu like this
If you have a configuration file named <literal>phpbu.xml</literal> in your current working directory you can execute PHPBU like this
</para>

<screen>~$ <userinput>phpbu</userinput>
Expand All @@ -18,7 +18,7 @@ OK (1 backup, 0 checks, 0 encryption, 0 syncs, 0 cleanups)</screen>
</para>

<screen>~$ <userinput>phpbu --configuration=MyConfig.xml</userinput>
phpbu 6.0.0 by Sebastian Feldmann abd Contributors.
phpbu 6.0.0 by Sebastian Feldmann and Contributors.

OK (1 backup, 0 checks, 0 encryption, 0 syncs, 0 cleanups)</screen>

Expand All @@ -40,17 +40,17 @@ OK (1 backup, 0 checks, 0 encryption, 0 syncs, 0 cleanups)</screen>
Usage: phpbu [option]

--bootstrap=<file> A "bootstrap" PHP file that is included before the backup.
--configuration=<file> A phpbu configuration file.
--configuration=<file> A PHPBU configuration file.
--colors Use colors in output.
--debug Display debugging information during backup generation.
--generate-configuration Create a new configuration skeleton.
--limit=<subset> Limit backup execution to a subset.
--simulate Perform a trial run with no changes made.
--simulate Perform a simulation run with no changes made.
-h, --help Print this usage information.
-v, --verbose Output more verbose information.
-V, --version Output version information and exit.
--version-check Check whether phpbu is up to date.
--self-update Upgrade phpbu to the latest version.]]></screen>
--version-check Check whether PHPBU is up to date.
--self-update Upgrade PHPBU to the latest version.]]></screen>

<variablelist>

Expand Down Expand Up @@ -115,7 +115,7 @@ Usage: phpbu [option]
<term><literal>--simulate</literal></term>
<listitem>
<para>
Execute phpbu without actually executing any backup, check, encryption, sync or cleanup task.
Execute PHPBU without actually executing any backup, check, encryption, sync or cleanup task.
See the <link linkend="cli.simulation">simulation section</link> for details.
</para>
</listitem>
Expand All @@ -133,9 +133,9 @@ Usage: phpbu [option]
<title>Simulation</title>

<para>
In order to check what actions phpbu would perform, phpbu supports a simulation mode where no backup is actually created and no
sync and cleanup tasks are executed. In simulation mode, phpbu will show you, what it would have done, if it would
not have been a simulation run. You will get detailed output, which enables you to track every action phpbu
In order to check what actions PHPBU would perform, PHPBU supports a simulation mode where no backup is actually created and no
sync and cleanup tasks are executed. In simulation mode, PHPBU will show you, what it would have done, if it would
not have been a simulation run. You will get detailed output, which enables you to track every action PHPBU
would have performed.
</para>
<para>
Expand All @@ -145,12 +145,12 @@ Usage: phpbu [option]
<caution>
<title>Warning</title>
<para>
If phpbu has to use any kind of credentials executing a binary, like for example the
<literal>mysqldump</literal> command, this credentials will maybe displayed in the simulation output.
If PHPBU has to use any kind of credentials executing a binary, like for example the
<literal>mysqldump</literal> command, these credentials will be displayed in the simulation output.
</para>
</caution>
<para>
If you are extending phpbu, you can support simulation as well. You can find detailed information on this
If you are extending PHPBU, you can support simulation as well. You can find detailed information on this
in <xref linkend="extending-phpbu"/>.
</para>
</section>
Expand All @@ -172,7 +172,7 @@ Usage: phpbu [option]
<caution>
<title>Warning</title>
<para>
If you don't define explicit backup names, phpbu will use the source type as backup name as fallback.
If you don't define explicit backup names, PHPBU will use the source type as backup name as fallback.
</para>
</caution>
</section>
Expand Down
30 changes: 17 additions & 13 deletions src/6.0/en/configuration.xml
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
<entry>filename</entry>
<entry>no</entry>
<entry>null</entry>
<entry>Include a php file to extend PHPBU</entry>
<entry>Include a PHP file to extend PHPBU</entry>
</row>
<row>
<entry>verbose</entry>
Expand Down Expand Up @@ -145,7 +145,7 @@
<entry>true | false</entry>
<entry>no</entry>
<entry>false</entry>
<entry>Tells if the execution of phpbu will be stopped if this backup fails.</entry>
<entry>Indicates if the execution of PHPBU should be stopped if this backup fails.</entry>
</row>
</tbody>
</tgroup>
Expand Down Expand Up @@ -281,7 +281,7 @@
<title><![CDATA[<crypt>]]></title>

<para>
Specifies what kind of encryption should be used to encrypt the backup.
Specifies what type of encryption should be used to encrypt the backup.
</para>

<table id="configuration.xml.elements.tables.crypt">
Expand Down Expand Up @@ -309,7 +309,7 @@
<entry>true | false</entry>
<entry>no</entry>
<entry>false</entry>
<entry>You can still execute the encryption, even of some failure occurred.</entry>
<entry>You can still execute the encryption, even if failure(s) occurred.</entry>
</row>
</tbody>
</tgroup>
Expand Down Expand Up @@ -350,7 +350,7 @@
<entry>true | false</entry>
<entry>no</entry>
<entry>false</entry>
<entry>You can still execute the sync, even of some failure occurred.</entry>
<entry>You can still execute the sync, even if failure(s) occurred.</entry>
</row>
</tbody>
</tgroup>
Expand Down Expand Up @@ -391,7 +391,7 @@
<entry>true | false</entry>
<entry>no</entry>
<entry>-</entry>
<entry>You can still execute the cleanup, even of some failure occurred.</entry>
<entry>You can still execute the cleanup, even if failure(s) occurred.</entry>
</row>
</tbody>
</tgroup>
Expand Down Expand Up @@ -514,25 +514,25 @@
Adapters are used to include configuration settings from other configuration sources.
</para>
<para>
So with adapters you don't have to put your passwords into your phpbu configuration file.
So with adapters you don't have to put your passwords into your PHPBU configuration file.
Instead you can use environment variables or .env configuration files.
</para>

<para>
And this ist how it works:
And this is how it works:
You add an adapter to your phpbu configuration like shown in the examples below.
You have to choose a <literal>type</literal> and a <literal>name</literal>. The name is completely up to you, but you are not allowed
to use colons.
With this done you can now reference your configured adapter for any option value in your phpbu configuration like this.
With this done you can now reference your configured adapter for any option value in your PHPBU configuration like this.
</para>

<para>
<literal>:adapter:my-chosen-adapter-name:path.to.value:</literal>
</para>

<para>
The keyword <literal>adapter</literal> tells phpbu that this option value should be received from an adapter,
followed by a <literal>colon</literal>, followed by your chosen <literal>adapter name</literal> so phpbu knows which adapter to use,
The keyword <literal>adapter</literal> tells PHPBU that this option value should be received from an adapter,
followed by a <literal>colon</literal>, followed by your chosen <literal>adapter name</literal> so PHPBU knows which adapter to use,
followed by a <literal>colon</literal>, followed by the identifier for your value.
The identifier could be the name of a environment variable or a "path" through an configuration array like this
"db.mysql.username" completely depending on the adapter implementation.
Expand All @@ -554,7 +554,7 @@
</example>

<para>
For a list of available adapters and a more detailed documentation check out the <link linkend="adapters">adapter section</link>.
For a list of available adapters and detailed documentation check out the <link linkend="adapters">adapter section</link>.
</para>

<example>
Expand Down Expand Up @@ -623,7 +623,7 @@
<indexterm><primary>schedule</primary></indexterm>
<title>Schedule backups</title>
<para>
Scheduling your backups is not part of phpbu. Nevertheless here is an example how to do
Scheduling your backups is not part of PHPBU. Nevertheless here is an example how to do
it with <ulink url="https://de.wikipedia.org/wiki/Cron">Cron</ulink>. Adding one of the following lines
to your crontab will execute your backup every morning at 3:10 AM.
</para>
Expand All @@ -642,6 +642,10 @@

# alternatively you can specify the full path
#10 3 * * * /home/user/bin/phpbu.phar --configuration=/var/www/my-backup/phpbu.xml

# some systems require the full path to the PHP CLI binary
#10 3 * * * /etc/php/sbin/php /home/user/bin/phpbu.phar --configuration=/var/www/my-backup/phpbu.xml

</programlisting>
</example>
</section>
Expand Down
2 changes: 1 addition & 1 deletion src/6.0/en/crypt.xml
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@
<entry>boolean</entry>
<entry>no</entry>
<entry>false</entry>
<entry>Don't remove the uncrypted backup.</entry>
<entry>Don't remove the unencrypted backup.</entry>
</row>
<row>
<entry>pathToOpenSSL</entry>
Expand Down
10 changes: 5 additions & 5 deletions src/6.0/en/extending-phpbu.xml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
</example>

<para>
For this to work your class Acme\MySource hast to implement
For this to work your class Acme\MySource has to implement
the <literal>phpbu\App\Backup\Source</literal> Interface.
After registering your Source you can use <literal>mysource</literal> as source-type
within your XML or JSON configuration like this.
Expand All @@ -49,8 +49,8 @@

<para>
If the alias is already taken this will throw an Exception.
You can force phpbu to overwrite any previously registered class using the $force Parameter.
Even the phpbu sources could be replaced with custom implementations.
You can force PHPBU to overwrite any previously registered class using the $force parameter.
Even the PHPBU sources could be replaced with custom implementations.
</para>

<example>
Expand All @@ -67,13 +67,13 @@ phpbu\App\Factory::register('source', 'mysqldump', '\\Acme\\MyMysqldump', true);
<title>Executing and simulating</title>

<para>
If you are extending phpbu you have two options. The first is to simply implement the execution interface. This way
If you are extending PHPBU you have two options. The first is to simply implement the execution interface. This way
you can execute your own Source, Check, Crypt, Sync or Cleanup tasks. The second option is to implement the
respective <literal>Simulator</literal> interface. Choosing this option you not only have to implement the execution
part but rather implement a simulation part as well.
</para>
<para>
Simulation is supported out of the box for every implementation, but choosing option two enables you to add
Simulation is supported out of the box for every implementation, but choosing option two allows you to add
viable information about the actions you perform in your code within a simulation run.
</para>

Expand Down
2 changes: 1 addition & 1 deletion src/6.0/en/installation.xml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@

<para>
The easiest way to install PHPBU is to download a <ulink
url="http://php.net/phar">PHP Archive (PHAR)</ulink> that has all required
url="http://php.net/phar">PHP Archive (PHAR)</ulink> that has all the required
dependencies of PHPBU bundled in a single file.
</para>

Expand Down
Loading