aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBenjamin Schlüter <bschlueter@posteo.de>2017-06-26 12:47:34 +0200
committerBenjamin Schlüter <bschlueter@posteo.de>2017-06-26 12:47:34 +0200
commitb4662aa6cbfd817a4d2b857c2ad9225053e05f59 (patch)
tree8cb126b6cbd2c1bf486bfdef4a65adc7f445a9f9
parentd30605428867e154036f0a1bddc3b2462e81062f (diff)
downloadstandardskriver-b4662aa6cbfd817a4d2b857c2ad9225053e05f59.zip
standardskriver-b4662aa6cbfd817a4d2b857c2ad9225053e05f59.tar.gz
standardskriver-b4662aa6cbfd817a4d2b857c2ad9225053e05f59.tar.bz2
standardskriver: Wrote preliminary readme for common use cases.
-rw-r--r--README.md33
1 files changed, 31 insertions, 2 deletions
diff --git a/README.md b/README.md
index d51ec91..745251e 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,32 @@
-# Standard Skriver Tool
+# Standard Skriver Tool: A tool for managing the default printer for multiple different devices.
+-----------------------
-FIXME... this is still to do... \ No newline at end of file
+The Standard Skriver Tool ('standardskriver' is norwegian for default printer) helps you define
+which printer is to be used for which device / IP / IP-range etc.
+
+In /etc/standardskriver.cfg you are able to change the defined devices and their asigned default printers.
+
+The syntax for doint this is simple and easy to manage:
+
+[settings]
+# define if standardskriver should be active
+enable = yes/no
+# defince where standardskriver should pull its machine-data from (LDAP)
+order =
+# define if standardskriver should overwrite the systems settings for default printers
+delete loptions = yes/no
+
+[machine]
+
+# example: single client (example-printer has to be defined as a known device/printer via LDAP)
+xxx.xx.x.x = example-printer
+
+# example: IP-range (maybe for a certain location in the clients network setup)
+xxx.xx.x.x/x = example-printer
+
+# example: single client via MAC-address (client MAC has to be defined in LDAP)
+aa:bb:cc:dd:ee:ff = example-printer
+
+[groups]
+
+# Here you could defince a default printer for a whole group of clients / devices \ No newline at end of file