Browse Source

README edited online with Bitbucket

Spiros Ioannou 9 years ago
parent
commit
c75a158ebd
1 changed files with 12 additions and 11 deletions
  1. 12 11
      README

+ 12 - 11
README

@@ -1,9 +1,10 @@
-runcached (Run Cached)
-------------------------------------------------------------------------------
+# runcached (Run Cached)
+
 Execute commands while caching their output for subsequent calls. 
 Execute commands while caching their output for subsequent calls. 
 Command output will be cached for <cacheperiod> seconds and "replayed" for 
 Command output will be cached for <cacheperiod> seconds and "replayed" for 
 any subsequent calls. Original exit status will also be emulated.
 any subsequent calls. Original exit status will also be emulated.
 
 
+## Details
 After cacheperiod has expired, command will be re-executed and a new result 
 After cacheperiod has expired, command will be re-executed and a new result 
 will be cached. 
 will be cached. 
 Cache data is tied to the command and arguments executed and the 
 Cache data is tied to the command and arguments executed and the 
@@ -16,26 +17,26 @@ run only once for each cacheperiod.
 Implementation is provided in 3 languages, python, C, BASH. Of course the BASH version is not really suggested but it works.
 Implementation is provided in 3 languages, python, C, BASH. Of course the BASH version is not really suggested but it works.
 
 
 
 
-Usage:
-======
-Python:
+## Usage
+
+### Python
 runcached.py [-c cacheperiod] <command to execute with args>
 runcached.py [-c cacheperiod] <command to execute with args>
 
 
-C:
+### C
 runcached [-c cacheperiod] <command to execute with args>
 runcached [-c cacheperiod] <command to execute with args>
 
 
-Bash
+### Bash
 runcached.sh  <command to execute with args>
 runcached.sh  <command to execute with args>
 
 
 
 
 
 
-Examples:
-========
+## Examples
+
 
 
-Example 1) Run the date command. Produce a new "date" every 5 seconds.
+### Example 1:  Run the date command. Produce a new "date" every 5 seconds.
 runcached.py -c 5 date
 runcached.py -c 5 date
 
 
-Example 2) Zabbix userparameter which can be called multiple times , but actually executes only once every 20 seconds. 
+### Example 2: Zabbix userparameter which can be called multiple times , but actually executes only once every 20 seconds. 
 Query multiple parameters of mysql at the same time, without re-running the query.
 Query multiple parameters of mysql at the same time, without re-running the query.