more markdown formatting fixes

Author: mickem

docs/checks.md

@@ -1,11 +1,11 @@
-# Checking things
+S# Checking things
 
 Using NSClient++ is checks is also pretty straight forward in modern NSClient++ versions.
 With version 0.4.3 we switched all old checks for a new check subsystem which is more uniform as well as more powerful then the old.
 Thanks to a compatibility layer most old command should still work (but there are some snags so be ware when upgrading).
 
 Most check have what is refereed to as sensible defaults this means without arguments most checks will do "something sensible".
-This means that to get you started check_cpu will just work as-is. But when you need to do something slightly different you have to start to use the check expressions.
+This means that to get you started `check_cpu` will just work as-is. But when you need to do something slightly different you have to start to use the check expressions.
 
 It is important to note that NSClient++ has been around for a long time and the syntax for the checks has changed over time.
 There is a lot of old out dated information about there about the various old syntaxes which is: plain wrong so if you find something about max-warn, filter+ or such: just forget all about it.
@@ -34,7 +34,7 @@ check_cpu show-default
 L        cli OK: "filter=core = 'total'" "warning=load > 80" "critical=load > 90" "empty-state=ignored" "top-syntax=${status}: ${problem_list}" "ok-syntax=%(status): CPU load is ok." "detail-syntax=${time}: ${load}%" "perf-syntax=${core} ${time}"
 ```
 Now changing the default value is as simple as adding the ones you do not like with a changed option.
-Lets say you want to change warning threshold from 80 to 30 you can do so simply by taking *warn=used > 80%* changing it to the threshold you want *warn=used > 30%*.
+Lets say you want to change warning threshold from 80 to 30 you can do so simply by taking `warn=used > 80%` changing it to the threshold you want `warn=used > 30%`.
 Now add this to the command line of the old command and run that.
 
 Modified thresholds:
@@ -51,7 +51,7 @@ Just add the ones you need. On the other hand if you want to keep using an "old"
 ### What about removing default values?
 
 Sometimes you want to negate the default value by leaving it empty. This might seem impossible at first glance but you can always specify "none" for a given parameter to override the default value and revert back to an empty string.
-For instance to remove the default filter in check_cpu you would use the following command:
+For instance to remove the default filter in `check_cpu` you would use the following command:
 
 Remove filters:
 ```
@@ -62,13 +62,13 @@ L        cli  Performance data: 'total 5m'=0%;80;90 'core 0 1m'=0%;80;90 'core 1
 
 ### Implicit defaults
 
-The last thing we shall discuss here is a slight snag and this will hopefullt be made better in future version of NSClient++.
+The last thing we shall discuss here is a slight snag and this will hopefully be made better in future version of NSClient++.
 Some default values are not "default value" they are "implicit values". Now this is technically a "bug" but one which might not be fixed any time soon.
 So what does this mean?
 Well in the above command line there was *NO* option for the default times. The check returns the values for 5 seconds, 1 minute and 5 minutes.
 But where did they come from?
 Well, they are so called "implicit values" if a check does not have a given value might be used. These options are almost always related to the data set used such as time or drives or similar.
-So for instance check_drivesize will not have a default option for what to check.
+So for instance `check_drivesize` will not have a default option for what to check.
 To get around this we need simply check the key in the documentation and add it:
 
 Different timings:
@@ -84,7 +84,7 @@ And in the next few chapters we will add some deeper understanding on how the fi
 
 ## Expressions
 
-The core feature of the NSCLient++ filter and check language is an expression.
+The core feature of the NSClient++ filter and check language is an expression.
 This expression is modelled after SQL Where clauses and in essence you write an expression which is what will be used by the checks.
 
 To look at this we will start with the basics modifying warn/crit threshold checks.
@@ -124,7 +124,7 @@ The safe version of an operator is only to allow expression to be used even when
 The are identical to their unsafe versions apart from the characters used to type them.
 
 The keywords available are different for each check and you can always check the various documentation to see a list of available expression for a given check.
-For instance for check_cpu we have.
+For instance for `check_cpu` we have.
 
 Check related keywords:
 
@@ -161,12 +161,12 @@ Thus writing 5k is equal to writing 5120 but only for size expressions.
 
 Filtering works much like expression above except that filters define what to include in a check.
 While there are multiple filters the most common one to use is filter which defined the objects you are interested in.
-We already saw a quick example in the check_cpu command above. The default filter was:
+We already saw a quick example in the `check_cpu` command above. The default filter was:
 
-The default check_cpu filter: `"filter=core = 'total'"`
+The default `check_cpu` filter: `"filter=core = 'total'"`
 
 What this does is exclude any items which des not evaluate to false. n other words any items which does not have a core value equal to total.
-In the check_cpu command there are values for each core as well as an aggregated total value.
+In the `check_cpu` command there are values for each core as well as an aggregated total value.
 This the above only shows us the total load and the load for each individual core is never used in the check command.
 
 Writing filters work exactly like the warning and critical expression we have seen before so we wont cover that again here.
@@ -182,9 +182,9 @@ The syntax configuration is split up into three main keywords:
 -   ok-syntax
 
 The top-syntax defines the overall message whereas the detail-syntax defines how each entry is formatted.
-The actual values are similar to what we saw before in the filter and warnign/critical thresholds.
+The actual values are similar to what we saw before in the filter and warning/critical thresholds.
 
-Looking at check_cpu the default syntaxes (as we have already seen) are:
+Looking at `check_cpu` the default syntaxes (as we have already seen) are:
 ```
 top-syntax=${status}: ${problem_list}
 ok-syntax=%(status): CPU load is ok.
@@ -224,15 +224,15 @@ OK: 5m: 0%, 1m: 4%, 5s: 11%
 The difference is that with show-all all the values are shown.
 By default when we run a check only values which are bad are included in the message but if we always want to see the values we can specify show-all.
 For instance if the CPU load had been above the warning threshold we would have seen the value included in the message.
-Now show-all is not magical it only modifies the top-syntax replacing %(problem_list) with %(list).
+Now show-all is not magical it only modifies the top-syntax replacing `%(problem_list)` with `%(list)`.
 This is something you could have achieved yourself but show-all makes it simpler as well as makes intent much clearer.
 
 ## Advanced options
 
 ### Performance data configuration
 
 Performance data is something which a lot of people want to tweak and customize.
-And the simplest way to do so is using the perf-config command line options.
+And the simplest way to do so is using the `perf-config` command line options.
 This command line option is  a bit more complicated then changing filters as it is very free form.
 It works a bit like CSS style sheets where you have selectors and lists of keys and values.
 If you are not familiar with CSS it does not matter as the similarity is very brief and we will explain how they work.
@@ -245,8 +245,8 @@ L        cli CRITICAL: CRITICAL ...
 L        cli  Performance data: 'C:\ used'=213.75593GB;178.77655;201.12362;0;223.47069 'C:\ used %'=95%;79;89;0;100 'D:\ used'=400.62005GB;372.60702;419.1829;0;465.75878 'D:\ used %79;89;0;100 'E:\ used'=0B;0;0;0;0
 ```
 
-The performance data here is quite long so lets break it up into a table. To do this we can use a built in helper function in NSCLient++.
-The function format_perf will execute another command and render the performance data as the return message.
+The performance data here is quite long so lets break it up into a table. To do this we can use a built in helper function in NSClient++.
+The function `format_perf` will execute another command and render the performance data as the return message.
 
 Formatted performance data:
 ```
@@ -259,8 +259,8 @@ C:\ used      213.605 GB      178.777 201.124 223.471 0
 , E:\ used      0       B       0       0       0       0
 ```
 
-Now we can see we have several types of performance data for each drive. We have "used" and we have "used %".
-Both of these can be configured individually and the way to access them is by their "suffix" which is "used" and "used %".
+Now we can see we have several types of performance data for each drive. We have `used` and we have `used %`.
+Both of these can be configured individually and the way to access them is by their "suffix" which is `used` and `used %`.
 
 selecting based on suffix: `"perf-config=used(...) used %(...)"`
 
@@ -314,15 +314,15 @@ Now this is not what we expected: right?
 Why did the 5:ages get back? End even worse why were they renamed "c:".
 The reason for this is simple. Selection is done on multiple levels. We match (in the following order)
 
-1.  <prefix>.<object>.<suffix>
-2.  <prefix>.<object>
-3.  <object>.<suffix>
-4.  <prefix>
-5.  <suffix>
-6.  <object>
+1.  `prefix.object.suffix`
+2.  `prefix.object`
+3.  `object.suffix`
+4.  `prefix`
+5.  `suffix`
+6.  `object`
 
 So what are the various suffixes and prefixes?
-Well in the case of check_drivesize they are:
+Well in the case of `check_drivesize` they are:
 
 | Value    | Prefix | Object | Suffix |
 |----------|--------|--------|--------|
@@ -333,7 +333,7 @@ Well in the case of check_drivesize they are:
 
 So using "used" as a stand along selector is a bit bad since we match BOTH used and used %.
 And usually this is fine, setting the unit for %:s does not change anything and thus "it works".
-If we want to differentiate between them we need to use a dot notation syntax which looks like this: <prefix>.<object>.<suffix>.
+If we want to differentiate between them we need to use a dot notation syntax which looks like this: `<prefix>.<object>.<suffix>`.
 As we saw above they are tried in various combination so leaving out something should get us a broader selection.
 
 Correct selection:

docs/faq.md

@@ -6,9 +6,9 @@ NSCP has a built-in "test and debug" mode that you can activate with the followi
 
 What this does is two things.
 
-1. it starts the daemon as "usual" with the same configuration and such.
-2. it enables debug logging and logs to the console.
-   This makes it quite easy to see what is going on and why things go wrong.
+1.  it starts the daemon as "usual" with the same configuration and such.
+2.  it enables debug logging and logs to the console.
+    This makes it quite easy to see what is going on and why things go wrong.
 
 
 ## 1.2 MSI or ZIP installation?
@@ -23,19 +23,19 @@ The MSI is the preferred way to install NSClient++ and will work much better the
 - Second thing to check is whether the servers' performance counters working?
   Sometimes the performance counters end up broken and need to be rebuilt there is a command to validate performance counters: `nscp sys --validate`
 
-For details: Microsoft KB: http://support.microsoft.com/kb/300956 essentially you need to use the `lodctr /R` command.
+For details: Microsoft KB: [http://support.microsoft.com/kb/300956](http://support.microsoft.com/kb/300956) essentially you need to use the `lodctr /R` command.
 
 ## 1.4 Bind failed
 
 Usually this is due to running more then once instance of NSClient++ or possibly running another program that uses the same port.
 
-- Make sure you don't have any other instance NSClient++ started.
-- Check if the port is in use (`netstat -a` look for LISTENING)
+-   Make sure you don't have any other instance NSClient++ started.
+-   Check if the port is in use (`netstat -a` look for LISTENING)
 
 ## 1.5 EventlogBuffer is too small
 
 !!! note
-    This has been fixed in 0.4.3 and is no longer required
+    This has been changed in 0.4.3 and is no longer required
 
 This is because you have one or more entries in your event-log which are larger then the "default buffer size of 64k". The best way to fix this is to increase the buffer used.
 
@@ -47,7 +47,7 @@ buffer_size=128000
 ## 1.6 System Tray does not work
 
 !!! note
-    System tray is currently disabled and will be added back at some point
+    System tray was removed in 0.4.0.
 
 ## 1.7 I get <insert random error from Nagios here>
 
@@ -65,11 +65,11 @@ net start nscp
 
 Please check and include this information before you submit questions and/or bug reports.
 
-## 1.8 High CPU load and check_eventlog
+## 1.8 High CPU load and `check_eventlog`
 
 Some people experience high CPU load when checking the event log this can usually be resolved using the new command line option scan-range setting it to the time region you want to check
 
-`CheckEventLog ... scan-range=12h ...`
+`check_eventlog ... scan-range=12h ...`
 
 ## 1.9 Return code of 139 is out of bounds
 
@@ -145,12 +145,12 @@ allow nasty characters=true
 
 To not use nasty characters you can replace man y of them in built-in commands:
 
-|Expression|Replacement|
-|----------|-----------|
-|    >     |    gt     |
-|   <      |    lt     |
-|   '      |  str(...) |
-|  ${..}   |    %(..)  |
+| Expression | Replacement |
+|------------|-------------|
+| >          | gt          |
+| <          | lt          |
+| '          | str(...)    |
+| ${..}      | %(..)       |
 
 
 # 3. Versions
@@ -166,7 +166,7 @@ In generally do NOT fix issues in several years old versions.
 
 # 4. Network
 
-## 4.1 Rejected connection from: <ip address here>
+## 4.1 Rejected connection from: your IP address here
 
 This is due to invalid configuration.
 One important thing you '''NEED''' to configure is which hosts are allowed to connect. If this configuration is missing or invalid you will get the following error:
@@ -193,34 +193,34 @@ The Nagios server timeout will fire after exactly 60 seconds but the script time
 
 If your command takes 60 seconds you need to set the timeouts like this:
 
-**1. Script timeout: 60s**
+### 1. Script timeout: 60s
 
 ```
 [/settings/external scripts/wrappings]
 vbs = cscript.exe //T:120 //NoLogo scripts\\lib\\wrapper.vbs %SCRIPT% %ARGS%
 ```   
 
-**2. External script timeout: 65 seconds**
+### 2. External script timeout: 65 seconds
 
 ```
 [/settings/external scripts]
 timeout = 65
 ```
 
-**3. NRPE/server timeout: 70s**
+### 3. NRPE/server timeout: 70s
 
 ```
 [settings/NPRE/server]
 timeout = 70
 ```
 
-**4. check_nrpe timeout: 75s**
+### 4. check_nrpe timeout: 75s
 
 ```
 check_nrpe -t 75
 ```
 
-**5. Nagios service check timeout: 80s**
+### 5. Nagios service check timeout: 80s
 
 ```
 service_check_timeout=80
@@ -239,10 +239,10 @@ level = info
 max size = 2048000
 ```
 
-## 5.2 What's the difference between CheckFoo and check_foo
+## 5.2 What's the difference between `CheckFoo` and `check_foo`
 
-In older version of NSClient++ (pre 0.4.1) there were only CheckFoo type commands so they where called CheckCPU CheckMem CheckProcess etc etc...
-In 0.4.2 we introduced a new set of commands which were more generic and similar and they are called check_cpu check_memory check_process etc etc..
+In older version of NSClient++ (pre 0.4.1) there were only `CheckFoo` type commands so they where called `CheckCPU` `CheckMem` `CheckProcess` etc etc...
+In 0.4.2 we introduced a new set of commands which were more generic and similar and they are called `check_cpu` `check_memory` `check_process` etc etc..
 The previous ones are only for compatibility and will eventually be removed from NSClient++.
 Currently they are about 90% compatible which means some things will not work as before and some commands are not even present anymore.
 
@@ -252,7 +252,7 @@ Currently they are about 90% compatible which means some things will not work as
 ## 5.3 I use check_nt and...
 
 Check_nt is NOT a good protocol and is considered abandon-ware as noone updates the check_nt command any longer. NSClient++ supports it only for legacy reasons.
-There is generally no reason to use check_nt as check_nrpe and check_nscp can achieve the same thing.
+There is generally no reason to use `check_nt` as `check_nrpe` and `check_nscp` can achieve the same thing.
 
 ## 5.4 MEMUSE reports the wrong value
 
@@ -296,7 +296,7 @@ ssl = true
 insecure = true
 ```
 
-If you instead opt to use the more secure standard SSL approach used in NSClient++ you can easily install NSClient++ on a linux system as well.
+If you instead opt to use the more secure standard SSL approach used in NSClient++ you can easily install NSClient++ on a Linux system as well.
 
 
 # 8. My question is not here?