]> granicus.if.org Git - icinga2/commitdiff
Fix typos in the documentation
authorSimon Ruderich <simon@ruderich.org>
Fri, 20 Nov 2015 14:57:16 +0000 (15:57 +0100)
committerGunnar Beutner <gunnar@beutner.name>
Fri, 20 Nov 2015 15:10:35 +0000 (16:10 +0100)
fixes #10692

Signed-off-by: Gunnar Beutner <gunnar@beutner.name>
doc/17-upgrading-icinga-2.md
doc/22-migrating-from-icinga-1x.md
doc/3-monitoring-basics.md
doc/4-configuring-icinga-2.md
doc/5-advanced-topics.md
doc/7-icinga-template-library.md
doc/8-cli-commands.md
doc/9-icinga2-api.md

index c967450571af284e405c8edb9603d5a9451a4b4d..005d01f6cdc80b90c77ba38b7feb9eb2cbef5f06 100644 (file)
@@ -12,7 +12,7 @@ If you're upgrading an existing Icinga 2 instance you should check the
 >
 > If there isn't an upgrade file for your current version available there's nothing to do.
 
-Apply all database schema upgrade files incrementially.
+Apply all database schema upgrade files incrementally.
 
     # mysql -u root -p icinga < /usr/share/icinga2-ido-mysql/schema/upgrade/<version>.sql
 
@@ -27,7 +27,7 @@ the *upgrade* directory:
     2.0.2.sql  2.1.0.sql 2.2.0.sql 2.3.0.sql
 
 There are two new upgrade files called `2.1.0.sql`, `2.2.0.sql` and `2.3.0.sql`
-which must be applied incrementially to your IDO database.
+which must be applied incrementally to your IDO database.
 
 ## <a id="upgrading-postgresql-db"></a> Upgrading the PostgreSQL database
 
@@ -38,7 +38,7 @@ If you're updating an existing Icinga 2 instance you should check the
 >
 > If there isn't an upgrade file for your current version available there's nothing to do.
 
-Apply all database schema upgrade files incrementially.
+Apply all database schema upgrade files incrementally.
 
     # export PGPASSWORD=icinga
     # psql -U icinga -d icinga < /usr/share/icinga2-ido-pgsql/schema/upgrade/<version>.sql
@@ -53,4 +53,4 @@ the *upgrade* directory:
     2.0.2.sql  2.1.0.sql 2.2.0.sql 2.3.0.sql
 
 There are two new upgrade files called `2.1.0.sql`, `2.2.0.sql` and `2.3.0.sql`
-which must be applied incrementially to your IDO database.
+which must be applied incrementally to your IDO database.
index c6e742f444b7b5727c8319e2ec402aa5532abc1b..aacfe247188d0f7673e4ac074f0dc54fdcdf3383 100644 (file)
@@ -1184,7 +1184,7 @@ Icinga 2 doesn't support non-persistent comments.
 Unlike in Icinga 1.x there are three different command types in Icinga 2:
 `CheckCommand`, `NotificationCommand`, and `EventCommand`.
 
-For example in Icinga 1.x it is possible to accidently use a notification
+For example in Icinga 1.x it is possible to accidentally use a notification
 command as an event handler which might cause problems depending on which
 runtime macros are used in the notification command.
 
@@ -1356,7 +1356,7 @@ is as follows:
 
 The flapping value is then compared to the low and high flapping thresholds.
 
-The algorithm used in Icinga 2 does not store the past states but calculcates the flapping
+The algorithm used in Icinga 2 does not store the past states but calculates the flapping
 threshold from a single value based on counters and half-life values. Icinga 2 compares
 the value with a single flapping threshold configuration attribute.
 
index 6cad4c0f41144178fc2b27da17e854175b83c30b..a39a8215f16e75e11bd35b1eb1af6c7315474d76 100644 (file)
@@ -672,7 +672,7 @@ with many interfaces (services). The following requirements/problems apply:
 * Each interface service check should be named with a prefix and a name defined in your host object (which could be generated from your CMDB, etc)
 * Each interface has its own vlan tag
 * Some interfaces have QoS enabled
-* Additional attributes such as `display_name` or `notes, `notes_url` and `action_url` must be
+* Additional attributes such as `display_name` or `notes`, `notes_url` and `action_url` must be
 dynamically generated
 
 
@@ -810,7 +810,7 @@ inherited custom attributes:
     # icinga2 daemon -C
     # icinga2 object list --type Service --name *catalyst*
 
-Object 'cisco-catalyst-6509-34!if-GigabitEthernet0/2' of type 'Service':
+    Object 'cisco-catalyst-6509-34!if-GigabitEthernet0/2' of type 'Service':
     ......
       * vars
         % = modified in '/etc/icinga2/conf.d/iftraffic.conf', lines 59:3-59:26
@@ -969,7 +969,7 @@ to a group based on their attributes:
     }
 
 In this example all hosts with the `vars` attribute `mssql_port`
-will be added as members to the host group `mssql`. However, all `*internal`
+will be added as members to the host group `mssql`. However, all `\*internal`
 hosts or with the `test_server` attribute set to `true` are not added to this
 group.
 
index a4635e420bd7aa31d736c8821ed5b6ae5d86ee0e..998d73924b862ab3d35b20bf7b2ad49eca733c18 100644 (file)
@@ -382,7 +382,6 @@ The idea is simple: Your host in [hosts.conf](4-configuring-icinga-2.md#hosts-co
 Remember the example from [hosts.conf](4-configuring-icinga-2.md#hosts-conf):
 
     ...
-
       /* Define disks and attributes for service apply rules in `services.conf`. */
       vars.disks["disk"] = {
         /* No parameters. */
index eefa3fad41ce230d03c729881ed8d4977aecc3cf..fc08c563dc094d5e7cf15015acf1053d07fa8483 100644 (file)
@@ -6,7 +6,7 @@ can safely skip over things you're not interested in.
 ## <a id="downtimes"></a> Downtimes
 
 Downtimes can be scheduled for planned server maintenance or
-any other targetted service outage you are aware of in advance.
+any other targeted service outage you are aware of in advance.
 
 Downtimes will suppress any notifications, and may trigger other
 downtimes too. If the downtime was set by accident, or the duration
@@ -66,7 +66,7 @@ This is optional when scheduling a downtime. If there is already a downtime
 scheduled for a future maintenance, the current downtime can be triggered by
 that downtime. This renders useful if you have scheduled a host downtime and
 are now scheduling a child host's downtime getting triggered by the parent
-downtime on NOT-OK state change.
+downtime on `NOT-OK` state change.
 
 ### <a id="recurring-downtimes"></a> Recurring Downtimes
 
@@ -98,7 +98,7 @@ Example:
 Comments can be added at runtime and are persistent over restarts. You can
 add useful information for others on repeating incidents (for example
 "last time syslog at 100% cpu on 17.10.2013 due to stale nfs mount") which
-is primarly accessible using web interfaces.
+is primarily accessible using web interfaces.
 
 Adding and deleting comment actions are possible through the external command pipe
 provided with the `ExternalCommandListener` configuration. The caller must
@@ -140,7 +140,7 @@ configuration attributes for `Notification` and `User` objects.
 
 > **Note**
 >
-> If you are familar with Icinga 1.x - these time period definitions
+> If you are familiar with Icinga 1.x - these time period definitions
 > are called `legacy timeperiods` in Icinga 2.
 >
 > An Icinga 2 legacy timeperiod requires the `ITL` provided template
@@ -234,10 +234,10 @@ inside the `icinga2.log` file depending in your log severity
 ### <a id="use-functions-command-arguments-setif"></a> Use Functions in Command Arguments set_if
 
 The `set_if` attribute inside the command arguments definition in the
-[CheckCommand object definition](6-object-types.md#objecttype-checkcommand) is primarly used to
+[CheckCommand object definition](6-object-types.md#objecttype-checkcommand) is primarily used to
 evaluate whether the command parameter should be set or not.
 
-By default you can evaluate runtime macros for their existance, and if the result is not an empty
+By default you can evaluate runtime macros for their existence, and if the result is not an empty
 string the command parameter is passed. This becomes fairly complicated when want to evaluate
 multiple conditions and attributes.
 
@@ -489,7 +489,7 @@ If the freshness checks are invalid, a new check is executed defined by the
 ## <a id="check-flapping"></a> Check Flapping
 
 The flapping algorithm used in Icinga 2 does not store the past states but
-calculcates the flapping threshold from a single value based on counters and
+calculates the flapping threshold from a single value based on counters and
 half-life values. Icinga 2 compares the value with a single flapping threshold
 configuration attribute named `flapping_threshold`.
 
index 588617ac078fb47e919fb351733eff92b0710f65..b3227a865747a523a887391b5d5b19eac04a0e75 100644 (file)
@@ -223,7 +223,7 @@ disk_local             | **Optional.** Only check local filesystems. May be true
 disk_stat_remote_fs    | **Optional.** Only check local filesystems against thresholds. Yet call stat on remote filesystems to test if they are accessible (e.g. to detect Stale NFS Handles). Myy be true or false
 disk_mountpoint        | **Optional.** Display the mountpoint instead of the partition. May be true or false.
 disk_megabytes         | **Optional.** Same as --units MB. May be true or false.
-disk_all               | **Optional.** Explicitly select all paths. This is equivalent to -R '.*'. May be true or false.
+disk_all               | **Optional.** Explicitly select all paths. This is equivalent to -R '.\*'. May be true or false.
 disk_eregi_path        | **Optional.** Case insensitive regular expression for path/partition (may be repeated).
 disk_ereg_path         | **Optional.** Regular expression for path or partition (may be repeated).
 disk_ignore_eregi_path | **Optional.** Regular expression to ignore selected path/partition (case insensitive) (may be repeated).
@@ -510,7 +510,7 @@ Name            | Description
 ----------------|--------------
 ldap_address    | **Optional.** Host name, IP Address, or unix socket (must be an absolute path). Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
 ldap_port       | **Optional.** Port number. Defaults to 389.
-ldap_attr      | **Optional.** LDAP attribute to search for (default: "(objectclass=*)"
+ldap_attr      | **Optional.** LDAP attribute to search for (default: "(objectclass=\*)"
 ldap_base       | **Required.** LDAP base (eg. ou=myunit,o=myorg,c=at).
 ldap_bind       | **Optional.** LDAP bind DN (if required).
 ldap_pass       | **Optional.** LDAP password (if required).
@@ -1514,7 +1514,7 @@ snmp_authprotocol       | **Optional.** SNMP version 3 authentication protocol.
 snmp_privpass           | **Required.** SNMP version 3 priv password. No value defined as default..
 snmp_warn               | **Optional.** The warning threshold.
 snmp_crit               | **Optional.** The critical threshold.
-snmp_process_name       | **Optional.** Name of the process (regexp). No trailing slash!. Defaults to ".*".
+snmp_process_name       | **Optional.** Name of the process (regexp). No trailing slash!. Defaults to ".\*".
 snmp_perf               | **Optional.** Enable perfdata values. Defaults to true.
 snmp_timeout            | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
 
@@ -1758,7 +1758,7 @@ ipmi_config_file                 | **Optional.** Path to the FreeIPMI configurat
 ipmi_username                    | **Optional.** The IPMI username.
 ipmi_password                    | **Optional.** The IPMI password.
 ipmi_privilege_level             | **Optional.** The IPMI privilege level of the IPMI user.
-ipmi_backward_compatibility_mode | **Optional.** Enable backward compatibility mode, useful for FreeIPMI 0.5.* (this omits FreeIPMI options "--quiet-cache" and "--sdr-cache-recreate").
+ipmi_backward_compatibility_mode | **Optional.** Enable backward compatibility mode, useful for FreeIPMI 0.5.\* (this omits FreeIPMI options "--quiet-cache" and "--sdr-cache-recreate").
 ipmi_sensor_type                 | **Optional.** Limit sensors to query based on IPMI sensor type. Examples for IPMI sensor types are 'Fan', 'Temperature' and 'Voltage'.
 ipmi_exclude_sensor_id           | **Optional.** Exclude sensor matching ipmi_sensor_id.
 ipmi_sensor_id                   | **Optional.** Include sensor matching ipmi_sensor_id.
@@ -2058,8 +2058,8 @@ Name         | Description
 mem_used     | **Optional.** Tell the plugin to check for used memory in opposite of **mem_free**. Must specify one of these as true.
 mem_free     | **Optional.** Tell the plugin to check for free memory in opposite of **mem_used**. Must specify one of these as true.
 mem_cache    | **Optional.** If set to true plugin will count cache as free memory. Defaults to false.
-mem_warning  | **Required.** Specifiy the warning threshold as number interpreted as percent.
-mem_critical | **Required.** Specifiy the critical threshold as number interpreted as percent.
+mem_warning  | **Required.** Specify the warning threshold as number interpreted as percent.
+mem_critical | **Required.** Specify the critical threshold as number interpreted as percent.
 
 #### <a id="plugin-contrib-command-running-kernel"></a> running_kernel
 
index 0ec471bfdbeaaf63cf21bd9e0493ffeb39459b21..e17b419cf32b5134b652e21fa10ea7b70fa2a407 100644 (file)
@@ -628,7 +628,7 @@ Or manually passing the `-C` argument:
 >
 > `# icinga2 daemon -C`
 
-If you encouter errors during configuration validation, please make sure
+If you encounter errors during configuration validation, please make sure
 to read the [troubleshooting](16-troubleshooting.md#troubleshooting) chapter.
 
 You can also use the [CLI command](8-cli-commands.md#cli-command-object) `icinga2 object list`
index bbbfbf931d6680058b42d1200d42153414c50745..d8ce9211fca734aeefe3acd9675fe0e45c8c8c73 100644 (file)
@@ -211,7 +211,7 @@ Available permissions for specific URL endpoints:
   events/&lt;type&gt;           | /v1/events    | No
   console                       | /v1/console   | No
 
-The required actions or types can be replaced by using a wildcard match ("*").
+The required actions or types can be replaced by using a wildcard match ("\*").
 
 ### <a id="icinga2-api-parameters"></a> Parameters