Browse Source

Doc update

master
Andrea Luzzardi 16 years ago
parent
commit
2554877477
6 changed files with 40 additions and 12 deletions
  1. +17
    -11
      pam_usb/doc/CONFIGURATION
  2. +6
    -0
      pam_usb/doc/FAQ
  3. +17
    -1
      pam_usb/doc/QUICKSTART
  4. BIN
      pam_usb/doc/pamusb-agent.1.gz
  5. BIN
      pam_usb/doc/pamusb-check.1.gz
  6. BIN
      pam_usb/doc/pamusb-conf.1.gz

+ 17
- 11
pam_usb/doc/CONFIGURATION View File

@ -1,8 +1,9 @@
====== Configuration ======
Configuration is done through the pamusb-conf tool, as explained in the
[[quickstart]] section. Most users don't have to manually change pamusb.conf,
however if you want to change some default settings, this document explains the
syntax of the pamusb.conf configuration file.
===== Introduction =====
@ -48,6 +49,7 @@ pamusb-agent -c /some/other/path.conf
===== Options =====
^ Name ^ Type ^ Default value ^ Description ^
@ -61,8 +63,10 @@ output) |
|
| one_time_pad | Boolean | true | Enable the use of one
time pads |
| probe_timeout | Integer | 10 | Time (in seconds) to
wait for the volume to be detected|
| probe_timeout | Time | 10s | Time to wait for the
volume to be detected|
| pad_expiration| Time | 1h | Time between pads
regeneration|
| hostname | String | Computer's hostname | Computer name. Must be
unique accross computers using the same device |
@ -129,6 +133,7 @@ SNDKXXXXXXXXXXXXXXXX |
</device>
===== Users =====
^ Name ^ Type ^ Description ^
@ -147,12 +152,12 @@ below |
<!-- When the user "scox" removes the usb device, lock the screen and pause
beep-media-player -->
<hotplug event="lock">gnome-screensaver-command --lock</hotplug>
<hotplug event="lock">beep-media-player --pause</hotplug>
<agent event="lock">gnome-screensaver-command --lock</agent>
<agent event="lock">beep-media-player --pause</agent>
<!-- Resume operations when the usb device is plugged back and authenticated -->
<hotplug event="unlock">gnome-screensaver-command --deactivate</hotplug>
<hotplug event="unlock">beep-media-player --play</hotplug>
<agent event="unlock">gnome-screensaver-command --deactivate</agent>
<agent event="unlock">beep-media-player --play</agent>
</user>
===== Services =====
@ -169,6 +174,7 @@ beep-media-player -->
===== Full example =====
This example demonstrates how to write a pam_usb configuration file and how to
@ -226,8 +232,8 @@ override the "quiet" option -->
<option name="quiet">true</option>
<!-- Agent settings, used by pamusb-agent -->
<hotplug event="lock">gnome-screensaver-command --lock</hotplug>
<hotplug event="unlock">gnome-screensaver-command --deactivate</hotplug>
<agent event="lock">gnome-screensaver-command --lock</agent>
<agent event="unlock">gnome-screensaver-command --deactivate</agent>
</user>
</users>


+ 6
- 0
pam_usb/doc/FAQ View File

@ -19,3 +19,9 @@ soon as you authenticate.
> Q: Is my USB drive compatible with pam_usb ?
>> A: About every USB flash drive will work with pam_usb.
> Q: I can't authenticate anymore, pam_usb gives me the following error: Pad
checking failed. What should I do ?
>> A: It's a machine/device synchronization issue. To get rid of that error you
have to reset the pads of your system by removing the .pamusb folder located on
your home (/root/.pamusb/, /home/foobar/.pamusb/, etc).

+ 17
- 1
pam_usb/doc/QUICKSTART View File

@ -6,6 +6,22 @@ using an older version of pam_usb.
===== Installing ====
==== Gentoo Linux ====
pam_usb 0.4.1 is currently keyword masked (~arch) on Gentoo, so you'll have to
unmask it before installing:
# echo "sys-auth/pam_usb" >> /etc/portage/package.keywords
# emerge -av ">=sys-auth/pam_usb-0.4.1"
==== Debian GNU/Linux ====
pam_usb is available on Debian testing (lenny) and unstable (sid).
# apt-get install libpam-usb pamusb-tools
==== Installing from sources ====
* Step 1: Download the latest release
* Step 2: Unpack the distribution tarball
@ -15,7 +31,7 @@ $ cd pam_usb-<version>
* Step 3: Make sure that you have installed the required dependencies
pam_usb depends on libxml2, PAM and HAL. pam_usb's tools (pamusb-agent,
pam_usb depends on libxml2, PAM, HAL and pmount. pam_usb's tools (pamusb-agent,
pamusb-conf) depends on python, python-celementtree and python-gobject.
* Step 3: Compile and install


BIN
pam_usb/doc/pamusb-agent.1.gz View File


BIN
pam_usb/doc/pamusb-check.1.gz View File


BIN
pam_usb/doc/pamusb-conf.1.gz View File


Loading…
Cancel
Save