public/ws-vacation Changeset - r18:35ceba0b2aa9

Changeset - r18:35ceba0b2aa9

Parent rev.

Child rev.

[Not reviewed]

default

0 3 2

Wolfgang Scherer (ws) - 13 years ago 2012-03-31 14:09:22
wolfgang.scherer@gmx.de

doc/index.txt: documentation update.

5 files changed with 43 insertions and 65 deletions:

README.txt

doc/README-de.txt

doc/index.txt

doc/ws-vacation-user-t.jpg

bin+new file

doc/ws-vacation-user.jpg

bin+new file

0 comments (0 inline, 0 general)

README.txt

➞

Show inline comments

 .. -*- coding: utf-8 -*-
 .. \||<-snip->|| start
 .. Copyright (C) 2012, Wolfgang Scherer, <Wolfgang.Scherer at gmx.de>
 .. Sponsored by WIEDENMANN SEILE GMBH, http://www.wiedenmannseile.de
 ..
@@ @@ -12,7 +11,6 @@ @@
 .. no Back-Cover Texts.  A copy of the license is included in the main
 .. documentation of Wiedenmann Vacation.
 .. (progn (forward-line 1)(snip-insert-mode "rst_t.inline-comments" t))
 .. inline comments (with ws_docutils)
 .. role:: rem(span)
    :format: ''
@@ @@ -20,29 +18,22 @@ @@
    :format: html
    :raw:
 .. role:: ihtml(span)
    :format: html
 .. role:: nhtml(span)
    :format: !html
 ##################################################
 :rem:`|||:sec:|||`\ Wiedenmann Vacation
 ##################################################
 Web Front-End to Manage vacation(1) Settings
 ##################################################
 .. \||<-snap->|| skip
 :Author: `Wolfgang Scherer`_
 .. contents::
 .. \||<-snap->|| skip
 .. \||<-snap->|| include ^index-header.snip$
 ==================================================
 :rem:`|||:sec:|||`\ Installation
 ==================================================
 #. Copy the program anywhere on your harddrive.
 #. Get the sources from `ws-vacation`_ and put the program anywhere on
    your harddrive::
    >>> hg clone https://bitbucket.org/wolfmanx/ws-vacation
 #. Change alias `/vacation` in `lib/ws-vacation.conf.in`, if desired.
@@ @@ -53,23 +44,25 @@ Web Front-End to Manage vacation(1) Sett @@
    This substitutes the installation directory in the necessary places.
 #. Copy `lib/ws-vacation.conf` to `/etc/apache2/conf.d/`.
 #. Copy `lib/ws-vacation.conf` to `/etc/apache2/conf.d/`::
    >>> sudo cp lib/ws-vacation.conf /etc/apache2/conf.d/
 #. Reload the Apache server:
-   >>> rcapache2 reload.
+   >>> sudo /etc/init.d/apache2 reload.
 #. The sudo(1) setup allows the apache server to execute vacation(1)
    as any user (except root) without a password. This is activated by
    copying the file `lib/ws-vacation-sudo` into the directory
    `/etc/sudoers.d` (ubuntu):
    >>> cp lib/ws-vacation-sudo /etc/sudoers.d/ws-vacation-sudo
    >>> chmod 0440 /etc/sudoers.d/ws-vacation-sudo
    >>> sudo cp lib/ws-vacation-sudo /etc/sudoers.d/ws-vacation-sudo
    >>> sudo chmod 0440 /etc/sudoers.d/ws-vacation-sudo
    or by appending it to the file `/etc/sudoers` (older SuSE):
-   >>> cat lib/ws-vacation-sudo >>/etc/sudoers
+   >>> cat lib/ws-vacation-sudo | sudo tee /etc/sudoers
 ==================================================
 :rem:`|||:sec:|||`\ User Management
@@ @@ -79,9 +72,9 @@ The file `lib/.htpasswd` can be created @@
 An automated script is available that creates the password database
 from the system shadow(8) database. Just change into directory `lib`
-and execute (as `root`):
 and execute:
 >>> php gen_htpasswd.php
+>>> sudo php gen_htpasswd.php
 .. note:: If new users are created in the system, this step must be
    repeated to update the `.htpasswd` file.
@@ @@ -105,20 +98,6 @@ also the default vacation(1) message tex @@
 The HTML header and footer can be modified in `lib/templates.php`.
 .. ==================================================
 .. :rem:`|||:sec:|||`\ Footnotes
 .. ==================================================
 :html:`<hr>`
 .. \[#]
 .. ==================================================
 .. :rem:`|||:sec:|||`\ References
 .. ==================================================
 .. \||<-snap->|| include ^index-footer.snip$
 :rem:`|||:sec:|||`\ **Copyright**
 Copyright (C) 2012, Wolfgang Scherer, <sw@wiedenmann-seile.de>.
@@ @@ -146,9 +125,8 @@ Sponsored by `Wiedenmann-Seile GmbH`_. @@
 .. _`GNU Free Documentation License`: README-GFDL.html
 .. _`GNU General Public License`: README-COPYING.html
 .. _`Wiedenmann-Seile GmbH`: http://www.wiedenmannseile.de
 .. _`Wolfgang Scherer`: sw@wiedenmann-seile.de
 .. \||<-snip->|| stop
 .. _`Wolfgang Scherer`: mailto:sw@wiedenmann-seile.de
 .. _`ws-vacation`: https://bitbucket.org/wolfmanx/ws-vacation
 .. ==================================================
 .. :rem:`|||:sec:|||`\ END

doc/README-de.txt

➞

Show inline comments

 .. -*- coding: utf-8 -*-
 .. \||<-snip->|| start
 .. Copyright (C) 2012, Wolfgang Scherer, <Wolfgang.Scherer at gmx.de>
 .. Sponsored by WIEDENMANN SEILE GMBH, http://www.wiedenmannseile.de
 ..
@@ @@ -30,18 +29,20 @@ @@
 ##################################################
 Web Front-End zur Verwaltung von vacation(1)
 ##################################################
 .. \||<-snap->|| skip
 :Author: `Wolfgang Scherer`_
 .. contents::
 .. \||<-snap->|| skip
 .. \||<-snap->|| include ^index-header.snip$
 ==================================================
 :rem:`|||:sec:|||`\ Installation
 ==================================================
 #. Quellcode von `ws-vacation`_ holen und das Programm irgendwo auf
    der Festplatte ablegen::
    >>> hg clone https://bitbucket.org/wolfmanx/ws-vacation
 #. Alias `/vacation` in `lib/ws-vacation.conf.in` ändern, falls
    gewünscht.
@@ @@ -55,21 +56,23 @@ Web Front-End zur Verwaltung von vacatio @@
 #. Datei `lib/ws-vacation.conf` nach `/etc/apache2/conf.d/` kopieren.
    >>> sudo cp lib/ws-vacation.conf /etc/apache2/conf.d/
 #. Apache server neu laden:
-   >>> rcapache2 reload.
+   >>> sudo /etc/init.d/apache2 reload.
 #. Damit der WWW-Prozess das vacation(1)-Kommando als beliebiger
    Benutzer (außer `root`) ausführen kann, muss die Datei
    `lib/ws-vacation-sudo` in das Verzeichnis `/etc/sudoers.d` kopiert
    werden (ubuntu):
    >>> cp lib/ws-vacation-sudo /etc/sudoers.d/ws-vacation-sudo
    >>> chmod 0440 /etc/sudoers.d/ws-vacation-sudo
    >>> sudo cp lib/ws-vacation-sudo /etc/sudoers.d/ws-vacation-sudo
    >>> sudo chmod 0440 /etc/sudoers.d/ws-vacation-sudo
    oder an die Datei `/etc/sudoers` angehängt werden (SuSE):
-   >>> cat lib/ws-vacation-sudo >>/etc/sudoers
+   >>> cat lib/ws-vacation-sudo | sudo tee /etc/sudoers
 ==================================================
 :rem:`|||:sec:|||`\ Benutzerverwaltung
@@ @@ -78,7 +81,7 @@ Web Front-End zur Verwaltung von vacatio @@
 Für die Erstellung der Benutzer und Passwörter, im Unterverzeichnis
 `lib` als `root` folgendes ausführen:
 >>> php gen_htpasswd.php
+>>> sudo php gen_htpasswd.php
 .. note:: Wenn neue Benutzer auf dem System angelegt werden, muss das
    entsprechend wiederholt werden.
 HTML Kopf- und Fußabschnitt sind in der Datei `lib/templates.php`.
 .. ==================================================
 .. :rem:`|||:sec:|||`\ Footnotes
 .. ==================================================
 :html:`<hr>`
 .. \[#]
 .. ==================================================
 .. :rem:`|||:sec:|||`\ References
 .. ==================================================
 .. \||<-snap->|| include ^index-footer.snip$
 :rem:`|||:sec:|||`\ **Copyright**
 Copyright (C) 2012, Wolfgang Scherer, <sw@wiedenmann-seile.de>.
@@ @@ -143,8 +132,7 @@ Sponsored by `Wiedenmann-Seile GmbH`_. @@
 .. _`GNU General Public License`: README-COPYING.html
 .. _`Wiedenmann-Seile GmbH`: http://www.wiedenmannseile.de
 .. _`Wolfgang Scherer`: sw@wiedenmann-seile.de
 .. \||<-snip->|| stop
 .. _`ws-vacation`: https://bitbucket.org/wolfmanx/ws-vacation
 .. ==================================================
 .. :rem:`|||:sec:|||`\ END

doc/index.txt

➞

Show inline comments

@@ @@ -58,7 +58,17 @@ deleted. @@
 :rem:`|||:sec:|||`\ Screenshot
 ==================================================
 |screenshot|_
 ============= =======================================================
 |imageuser|_  Regular user interface:
 	      - the user cannot be changed
 	      - the link to the manual is omitted
 |imageadmin|_ Administrator interface.
 	      - the user can be selected
 	      - a link to the administrator manual is shown
 ============= =======================================================
 ==================================================
 :rem:`|||:sec:|||`\ Features
@@ @@ -105,8 +115,10 @@ See the `Administrator Manual`_ for inst @@
 .. :rem:`|||:sec:|||`\ References
 .. ==================================================
 .. |screenshot|  image:: ws-vacation-t.jpg
 .. _screenshot: ws-vacation.jpg
 .. |imageuser|  image:: ws-vacation-user-t.jpg
 .. _imageuser: ws-vacation-user.jpg
 .. |imageadmin|  image:: ws-vacation-t.jpg
 .. _imageadmin: ws-vacation.jpg
 .. _`Administrator Manual`: README.html
 .. _`ws-vacation`: https://bitbucket.org/wolfmanx/ws-vacation

doc/ws-vacation-user-t.jpg

➞

Show inline comments

		new file 100644
		binary diff not shown

Show images

doc/ws-vacation-user.jpg

➞

Show inline comments

		new file 100644
		binary diff not shown

Show images

0 comments (0 inline, 0 general)