aboutsummaryrefslogtreecommitdiffstats
path: root/roles/cups_client/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'roles/cups_client/README.md')
-rw-r--r--roles/cups_client/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/roles/cups_client/README.md b/roles/cups_client/README.md
new file mode 100644
index 0000000..9a60904
--- /dev/null
+++ b/roles/cups_client/README.md
@@ -0,0 +1,32 @@
+CUPS Client
+===========
+
+Description
+-----------
+
+The `cups_client` role configures a Linux host to print to a central CUPS server.
+
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable | Default | Description
+------------|---------|------------
+`cups_host` |   | Hostname of CUPS server
+
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- name: configure CUPS client
+ hosts: linux_desktops
+ roles:
+ - role: cups_client
+ vars:
+ cups_host: cups.example.com
+````