More doc improvements in mysqldump-secure.conf

Author: djvdorp

etc/mysqldump-secure.conf

@@ -20,8 +20,8 @@
 # 2. If you remove the variable, mysqldump-secure will error
 #    to stderr and abort.
 #
-# The above described behavior is a security mechanism for critical
-# configurations. For example if you have removed the directive that
+# The above-described behavior is a security mechanism for critical
+# configurations. For example, if you have removed the directive that
 # sets whether or not to encrypt the backups, then it is not sure
 # whether or not you are paranoid about your data and mysqldump-secure
 # will abort immediately until you have told it correctly whether or
@@ -78,7 +78,7 @@ DUMP_FILE_PRE="$(date '+%Y-%m-%d')_$(date '+%H-%M')__"
 #
 # NOTE: The file is directly written with this permission (via umask)
 #       instead of applying chmod afterwards. This makes sure that there are no
-#       race-conditions during the dump that someone can view the contens before the
+#       race-conditions during the dump that someone can view the contents before the
 #       chmod changes.
 #
 # Default value: "0400"
@@ -105,7 +105,7 @@ DUMP_FILE_CHMOD="0400"
 #       Instead use a *.cnf file with a host, user and password combination.
 #
 # NOTE: No other default *.cnf files will be included for connections/dumping.
-#       This is the only file that will be read my mysqldump-secure.
+#       This is the only file that will be read by mysqldump-secure.
 #
 # NOTE: Only host, user, pass, port and socket directives are allowed.
 #       All other options are specified in this configuration file.
@@ -126,7 +126,7 @@ MYSQL_CNF_FILE="/etc/mysqldump-secure.cnf"
 ############################################################
 
 # If this is set to true, an SSL connection is required and
-# the program will abort, if the connection is not secured.
+# the program will abort if the connection is not secured.
 #
 # Turn it on to force SSL and die for plain connections.
 # Turn it off, to do plain-text connection (e.g.: from localhost)
@@ -177,7 +177,7 @@ MYSQL_SSL_CA_PEM="/path/to/ca.pem"
 
 #
 # By default, all existing mysql databases will be backed up
-# without having to explicitly specifying them.
+# without having to explicitly specify them.
 #
 # You can however fine-adjust it by ignoring certain databases
 # from the backup procedure below.
@@ -194,7 +194,7 @@ MYSQL_SSL_CA_PEM="/path/to/ca.pem"
 # You can ignore all databases here and explicitly only require
 # the ones you actually want to dump.
 # If you ignore 'mysql' and require 'mysql',
-# it wil be back-upped.
+# it will be back-upped.
 #
 # Note:
 # -----
@@ -214,23 +214,23 @@ IGNORE="information_schema performance_schema"
 
 
 
-# Opt-in check (Require)
+# Opt-in check (require)
 #
 # A space-separated list of databases that are explicitly required.
 #
 # If any of the specified required databases is not existent
 # the script will generate an error after finishing (stderr, exit code and inside the logfile).
 #
 # Additionally, this information is also used by the nagios plugin and will automatically
-# throw an error in nagios when any of the below specified databases were not found and/or not dumped.
+# throw an error in nagios when any of the below-specified databases were not found and/or not dumped.
 #
 # NOTE: The here specified databases are not guaranteed to be dumped,
 #       because they might not even exist, it is rather
 #       a method of letting you know, that they could not be dumped.
 #
 # NOTE: Use this to overwrite any ignored databases.
 #       You could for example ignore all databases and only
-#       require the once you desire here.
+#       require the ones you desire here.
 #
 # Default value: "" <-- do not require anything
 REQUIRE="mysql"
@@ -325,14 +325,14 @@ MYSQL_OPTS_QUICK_MIN_SIZE=200
 
 
 #
-# Case 1: Only InnoDB tables inside current DB
+# Case 1: Only InnoDB tables inside the current DB
 #
 # If the current dumped database only contains InnoDB tables,
 # this database is then dumped with the '--single-transaction' option.
 #
 # With this option turned on, all tables inside this database will be dumped consistently.
 # If there was any INSERT, ALTER (or other changes on the tables during the period of backup
-# by another program/process), these changes will not go into dump and you will end up
+# by another program/process), these changes will not go into the dump and you will end up
 # with a fully consistent dump from the time it was started doing the backup.
 #
 # If however the current database contains at least one table which is not using the InnoDB
@@ -343,7 +343,7 @@ MYSQL_OPTS_QUICK_MIN_SIZE=200
 # It is safe and recommended to leave this option turned on!
 #
 # Note:
-# Again, this applies only to databases which only have InnoDB tables.
+# Again, this applies only to databases that only have InnoDB tables.
 #
 # Values:
 # -------
@@ -368,13 +368,13 @@ CONSISTENT_DUMP_ONLY_INNODB=1
 # However, every INSERT, ALTER (or other changing sql function) to tables inside this database
 # will be blocked (and queued) for the time of the dump.
 # So if you have a web application for example that is receiving lots of INSERTs, choose a time
-# with least visitors, because the application will be blocked during the backup time.
+# with the least visitors, because the application will be blocked during the backup time.
 #
 #
-# Solution 1: Convert all your databases to InnoDB
+# Solution 1: Convert all your databases to InnoDB.
 #   --> and ignore this option
 #
-# Solution 2: Choose a time where less or no changes to that database are expected
+# Solution 2: Choose a time when less or no changes to that database are expected.
 #   --> and set   CONSISTENT_DUMP_OTHERS=1
 #
 # Solution 3: Turn off this feature and live without consistent dumps.
@@ -412,13 +412,13 @@ CONSISTENT_DUMP_NO_INNODB=1
 # However, every INSERT, ALTER (or other changing sql function) to tables inside this database
 # will be blocked (and queued) for the time of the dump.
 # So if you have a web application for example that is receiving lots of INSERTs, choose a time
-# with least visitors, because the current dumped database will be read-only
+# with the least visitors, because the current dumped database will be read-only
 # (but all queries are queued) during the backup time.
 #
-# Solution 1: Convert all your tables in your databases to InnoDB
+# Solution 1: Convert all your tables in your databases to InnoDB.
 #   --> and ignore this option
 #
-# Solution 2: Choose a time where less or no changes to that database are expected
+# Solution 2: Choose a time where less or no changes to that database are expected.
 #   --> and set   CONSISTENT_DUMP_OTHERS=1
 #
 # Solution 3: Use a Master/Slave setup and always backup from slave
@@ -509,14 +509,14 @@ COMPRESS=1
 # NOTE: No default values can be provided and the program will simply
 #       disable compression if those variables are not set.
 #       If you set them wrongly dumps might now be written to disk correctly.
-#       Nevertheless, every error on writing or the compression process will
+#       Nevertheless, every error during writing or the compression process will
 #       be outputted.
 
 
 #
 # Choose a compression preset below.
 #
-# NOTE: Last turned on preset will be effective.
+# NOTE: Last turned-on preset will be effective.
 #       (It is a shell script and variables will be overwritten
 #       by the last specified value)
 #
@@ -580,7 +580,7 @@ COMPRESS_EXT="gz"
 # * Create public/private key pair
 #    openssl req -x509 -nodes -newkey rsa:2048 -keyout mysqldump-secure.priv.pem -out mysqldump-secure.pub.pem
 #
-# * How to enccrypt? (pubkey)
+# * How to encrypt? (pubkey)
 #    openssl smime -encrypt -binary -text -aes256 -in file.txt -out file.txt.enc" -outform DER mysqldump-secure.pub.pem
 #
 # * How to decrypt? (privkey)
@@ -629,7 +629,7 @@ OPENSSL_PUBKEY_PEM="/etc/mysqldump-secure.pub.pem"
 #
 # NOTE: Only applicable if ENCRYPT = 1
 #
-# Must be valid openssl encryption algorithm
+# Must be a valid openssl encryption algorithm
 #
 # Default value: "-aes256"
 OPENSSL_ALGO_ARG="-aes256"
@@ -685,7 +685,7 @@ DELETE_METHOD="tmpwatch"
 # tmpwatch/tmpreader will not be able to delete those files, unless you
 # specify to force it via -f (--force)
 #
-# From manpage:
+# From its manpage:
 # Remove files even if EUID doesn’t have write access.
 # Normally, files owned by the current EUID, with no write bit set are not removed.
 DELETE_FORCE=0
@@ -798,7 +798,7 @@ DUMP_FILE_INFO=1
 # This should normally not be changed as /tmp
 # is the default on most systems.
 #
-# The tmp folder is used to store files which hold stderr as well as
+# The tmp folder is used to store files that hold stderr as well as
 # stdout of mysqldump, openssl and the used compression tool.
 #
 # All tmp files will be deleted at the end of every run.