diff options
author | Mike Gabriel <mike.gabriel@das-netzwerkteam.de> | 2017-06-27 11:58:13 +0200 |
---|---|---|
committer | Mike Gabriel <mike.gabriel@das-netzwerkteam.de> | 2017-06-27 11:58:13 +0200 |
commit | 1a48580f10d333587af13b414b5ff9998055b2ea (patch) | |
tree | 7ca51bc31497d49aa9361fd3cbb93bbda379c582 | |
parent | 5bc5d5c36e3db83522c2f3652f8871424682ad1b (diff) | |
download | standardskriver-1a48580f10d333587af13b414b5ff9998055b2ea.tar.gz standardskriver-1a48580f10d333587af13b414b5ff9998055b2ea.tar.bz2 standardskriver-1a48580f10d333587af13b414b5ff9998055b2ea.zip |
Rework README.md and fix various parts syntactically and content-wise.
-rw-r--r-- | README.md | 55 |
1 files changed, 38 insertions, 17 deletions
@@ -1,41 +1,62 @@ -_#_ Standard Skriver Tool: A tool for managing the default printer for multiple different devices\. ------------------------ +# Standard Skriver Tool -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. +A tool for managing the default printer for multiple different devices\. + +## Introduction + +The Standard Skriver Tool ('standardskriver' is Norwegian (i.e. Bokmal) for "default printer") helps you define +which printer is to be used for which device / IP / IP-range, user group, etc. + +## Configuration 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: +The syntax for doing this is simple and easy to manage via the configuration file ``/etc/standardskriver.cfg``: +``` [settings] -_#_ define if standardskriver should be active +# Define if standardskriver shall be active (it gets loaded via XDG autostart during +# session startup: -enable = yes/no +enable = {yes,no} -_#_ define where standardskriver should pull its machine-data from (LDAP) +# Define if groups section overrides machine section (= groups machine) or machine section +# overrides groups section. -order = +order = {machine groups | groups machine} -_#_ define if standardskriver should overwrite the systems settings for default printers +# Define if standardskriver shall remove the previous default printer, if no entry in the groups or +# machine section matches at login time. -delete loptions = yes/no +delete loptions = {yes,no} [machine] -_#_ example: single client (example-printer has to be defined as a known device/printer via LDAP) +# Example 01: single client (example-printer has to be defined as a known device/printer in CUPS): -xxx.xx.x.x = example-printer +<xxx.xx.x.x> = example-printer -_#_ example: IP-range (maybe for a certain location in the clients network setup) +# example: IP subnet (e.g. matching a pool of machines in one of the computer labs), again +# other-example-printer needs to be a well-defined CUPS print queue. -xxx.xx.x.x/x = example-printer +<xxx.xx.x.x/x> = other-example-printer -_#_ example: single client via MAC-address (client MAC has to be defined in LDAP) +# Example: Single client defined via MAC-address: aa:bb:cc:dd:ee:ff = example-printer [groups] -_#_ Here you could define a default printer for a whole group of clients / devices +# Here you can define a default printer for users based on POSIX group membership (teacher-printer +# needs to be a well-defined CUPS print queue again): + +teachers = teacher-printer +``` + +## License and Copyright + +The Standard Skriver Tool is licensed under the GPL-2+ license. + +Copyright (C) 2013, Linnea Skogtvedt <linnea@linuxavdelingen.no> +Copyright (C) 2015-2017, Mike Gabriel <mike.gabriel@das-netzwerkteam.de> |