diff --git a/README.md b/README.md index dbe59b2f385b84d58ac634529cc0b2b046c33228..a3d0a8408462c69a934412a512f011797f55aae9 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,8 @@ Script for installing faculty printers on Linux via Samba print server. ## Advantages -- You can print on WiFi using Samba. (With unauthenticated IPP printing you are allowed to only print via Ethernet cable.) -- You can add a FI printer to your existing CUPS instance. This way, you don’t have to switch configurations. +- You can print on Wi-Fi using Samba. (With unauthenticated IPP printing you are allowed to only print via Ethernet cable.) +- You can add a FI printer to your existing CUPS instance (e.g. if you already have your own local printer). This way, you don’t have to switch configurations. - You don’t need to have the same login on your computer as your faculty login. @@ -14,7 +14,7 @@ Script for installing faculty printers on Linux via Samba print server. - Printers have to be installed one by one. - Password will be stored at `/etc/cups/printers.conf` in plain text format. -- This is not the preferred way of printing on FI. (Preferred way is via Kerberos.) +- This is not the preferred way of printing on FI. (The preferred way is via Kerberos.) ## Pre-requirements @@ -22,31 +22,31 @@ Script for installing faculty printers on Linux via Samba print server. - root access (or sudo) - running local [CUPS](https://www.cups.org/) print server - Samba client (`smbclient`) -- Cron system for automatic update +- Cron system for automatic updating ### Warning -If you are printing with unauthenticated IPP or Kerberized IPP, you will have to remove client configuration file for CUPS, which is located at `/etc/cups/client.conf`. +If you are printing via unauthenticated IPP or Kerberized IPP, you will have to remove the client configuration file for CUPS, which is located at `/etc/cups/client.conf`. ## Usage -Usage: `./install.pl (--cron|[--usage] <printer-name>)` , where `<printer-name>` is a valid printer name. If supplied `--usage` script will only update drivers. Passing `--cron` will only prompt user for cron installation. +Usage: `./install.pl {--cron | [--usage] <printer-name>}` , where `<printer-name>` is a valid printer name. If supplied `--usage`, the script will only update the drivers. Passing `--cron` will only prompt user for cron installation. -For example, to install printer `lj2b` run +For example, to install the printer `lj2b`, run ```shell ./install.pl lj2b ``` -After running the script, you will be prompted for you faculty login(username and password) and for cron installation if not already installed. +After running the script, you will be prompted for your faculty credentials (the faculty username and the faculty password) and for cron installation if not already installed. -You may be prompted for faculty login once again on the first print job depending on your distribution. +You may be prompted for the faculty credentials once again on the first print job, depending on your distribution. -### Available printers +### Supported printers -Currently available printers: +Currently supported printers: - copy2a - copy3a @@ -63,11 +63,10 @@ Currently available printers: - lj4p - lj5c -#### Currently not supported printers +At the moment, copy4b and copy5b are not supported. -At the moment copy4b and copy5b are not supported. - -You can find out more information on <https://www.fi.muni.cz/tech/unix/print.html>. +You can find out more information about printing in general +at <https://www.fi.muni.cz/tech/unix/print.html>. ## Repository structure