doc/web: Updated documentation for vmm-0.6.2.
authorPascal Volk <user@localhost.localdomain.org>
Sat, 01 Feb 2014 18:18:06 +0000
changeset 706 6c369b680ab0
parent 705 9149e0249c25
child 707 19184d1265e5
doc/web: Updated documentation for vmm-0.6.2.
doc/web/source/conf.py
doc/web/source/download.rst
doc/web/source/features.rst
doc/web/source/installation/install_vmm.rst
doc/web/source/installation/postgresql_configuration.rst
doc/web/source/pgsql_set_permissionspermissions.rst
doc/web/source/release_history.rst
doc/web/source/substitutions.rst
doc/web/source/upgrade/0.5-0.6.rst
--- a/doc/web/source/conf.py	Sat Feb 01 17:12:15 2014 +0000
+++ b/doc/web/source/conf.py	Sat Feb 01 18:18:06 2014 +0000
@@ -41,7 +41,7 @@
 
 # General information about the project.
 project = u'vmm'
-copyright = u'2007 - 2012, Pascal Volk'
+copyright = u'2007 - 2014, Pascal Volk'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -50,7 +50,7 @@
 # The short X.Y version.
 version = '0.6'
 # The full version, including alpha/beta/rc tags.
-release = '0.6.1'
+release = '0.6.2'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
--- a/doc/web/source/download.rst	Sat Feb 01 17:12:15 2014 +0000
+++ b/doc/web/source/download.rst	Sat Feb 01 18:18:06 2014 +0000
@@ -10,31 +10,32 @@
 Download a gzip compressed archive
 ----------------------------------
 vmm could be downloaded from the `download page`_ at `SourceForge`_. To
-extract the downloaded archive use ``tar xzf vmm-0.6.1.tar.gz``. This will
-create the new directory :file:`vmm-0.6.1` in the current working directory.
+extract the downloaded archive use ``tar xzf vmm-0.6.2.tar.gz``. This will
+create the new directory :file:`vmm-0.6.2` in the current working directory.
 
 Verify the downloaded archive
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 If you have downloaded the archive from the download site you can
 optionally verify the integrity_ of this archive.
 In order to verify the integrity of the archive you have to download the
-corresponding signature file (:file:`vmm-0.6.1.tar.gz.sig`) too.
+corresponding signature file (:file:`vmm-0.6.2.tar.gz.sig`) too.
 The signature can be verified using GPG_ or PGP_.
-For example to check the signature of the archive :file:`vmm-0.6.1.tar.gz`
-you can execute this command ``gpg --verify vmm-0.6.1.tar.gz.sig``.
+For example to check the signature of the archive :file:`vmm-0.6.2.tar.gz`
+you can execute this command ``gpg --verify vmm-0.6.2.tar.gz.sig``.
 
-The tarball was signed by Pascal Volk (ID: CEC0904E).
+The tarball was signed by Pascal Volk (ID 0xC51139FE).
+Older releases (≦ 0.6.1) were signed with key ID 0xCEC0904E).
 You can fetch the public key from a key server using the command
-``gpg --recv-keys 0xCEC0904E``.
+``gpg --recv-keys 0xC51139FE``.
 
 Get vmm from the Mercurial repository
 -------------------------------------
 To get a tagged clone of the current vmm release from the Mercurial_
 repository use:
-``hg clone http://hg.localdomain.org/vmm/ -r vmm-0.6.1 vmm-0.6.1``.
-This will put the files into the new created directory :file:`vmm-0.6.1`.
+``hg clone http://hg.localdomain.org/vmm/ -r vmm-0.6.2 vmm-0.6.2``.
+This will put the files into the new created directory :file:`vmm-0.6.2`.
 
-When you omit the ``-r vmm-0.6.1`` option, you will get the latest changes
+When you omit the ``-r vmm-0.6.2`` option, you will get the latest changes
 from the `vmm repository`_. This code may work for you or not.
 
 Get vmm from the Git repository
--- a/doc/web/source/features.rst	Sat Feb 01 17:12:15 2014 +0000
+++ b/doc/web/source/features.rst	Sat Feb 01 18:18:06 2014 +0000
@@ -5,7 +5,7 @@
 General features
 ----------------
  ‣ Unicode/UTF-8 capable (input/storage/output)
- ‣ supports IDN_
+ ‣ supports IDN_ (also ccTLDs/ccIDNs and 'new' gTLDs)
  ‣ supports the mailbox format Maildir_ and Dovecot's own high-performance
    mailbox formats single- and multi-\ dbox_
  ‣ configurable basic mailbox structure, including sub-mailboxes
--- a/doc/web/source/installation/install_vmm.rst	Sat Feb 01 17:12:15 2014 +0000
+++ b/doc/web/source/installation/install_vmm.rst	Sat Feb 01 18:18:06 2014 +0000
@@ -2,19 +2,19 @@
 Installing vmm
 ==============
 After you've prepared everything, it's time to install vmm.
-Change into the :file:`vmm-0.6.1` directory an execute the
+Change into the :file:`vmm-0.6.2` directory an execute the
 :file:`install.sh` script.
 You can adjust the installation prefix by modifying line 8 of the script.
 
 .. code-block:: console
 
- root@host:~# cd /path/to/vmm-0.6.1
- root@host:/path/to/vmm-0.6.1# ./install.sh
+ root@host:~# cd /path/to/vmm-0.6.2
+ root@host:/path/to/vmm-0.6.2# ./install.sh
 
  Don't forget to edit /usr/local/etc/vmm.cfg - or run: vmm cf
  and /etc/postfix/pgsql-*.cf files.
 
- root@host:/path/to/vmm-0.6.1#
+ root@host:/path/to/vmm-0.6.2#
 
 pgsql-\*.cf files
 -----------------
--- a/doc/web/source/installation/postgresql_configuration.rst	Sat Feb 01 17:12:15 2014 +0000
+++ b/doc/web/source/installation/postgresql_configuration.rst	Sat Feb 01 18:18:06 2014 +0000
@@ -98,14 +98,14 @@
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 .. code-block:: postgresql-console
 
- mailsys=> \i /path/to/vmm-0.6.1/pgsql/create_tables-dovecot-1.2.x.pgsql
+ mailsys=> \i /path/to/vmm-0.6.2/pgsql/create_tables-dovecot-1.2.x.pgsql
  mailsys=> \q
 
 Dovecot v1.0.x/v1.1.x
 ^^^^^^^^^^^^^^^^^^^^^
 .. code-block:: postgresql-console
 
- mailsys=> \i /path/to/vmm-0.6.1/pgsql/create_tables.pgsql
+ mailsys=> \i /path/to/vmm-0.6.2/pgsql/create_tables.pgsql
  mailsys=> \q
 
 Set database permissions
--- a/doc/web/source/pgsql_set_permissionspermissions.rst	Sat Feb 01 17:12:15 2014 +0000
+++ b/doc/web/source/pgsql_set_permissionspermissions.rst	Sat Feb 01 18:18:06 2014 +0000
@@ -3,7 +3,7 @@
 
 .. code-block:: console
 
- user@host:~$ python /path/to/vmm-0.6.1/pgsql/set-permissions.py -h
+ user@host:~$ python /path/to/vmm-0.6.2/pgsql/set-permissions.py -h
  Usage: set-permissions.py OPTIONS
  
  Set permissions for Dovecot and Postfix in the vmm database.
@@ -27,7 +27,7 @@
    -M USER, --postfix=USER
                          Database user name of the Postfix (MTA)  database
                          user. Default: postfix
- user@host:~$ python /path/to/vmm-0.6.1/pgsql/set-permissions.py -a -H 127.0.0.1 -U vmm
+ user@host:~$ python /path/to/vmm-0.6.2/pgsql/set-permissions.py -a -H 127.0.0.1 -U vmm
  Password: 
  user@host:~$ 
 
--- a/doc/web/source/release_history.rst	Sat Feb 01 17:12:15 2014 +0000
+++ b/doc/web/source/release_history.rst	Sat Feb 01 18:18:06 2014 +0000
@@ -5,6 +5,7 @@
 =========== ============ ======================================================
 Version     Release Date Download URL
 =========== ============ ======================================================
+vmm-0.6.2   Feb 01 2014  https://sourceforge.net/projects/vmm/files/vmm/0.6.2
 vmm-0.6.1   Oct 03 2012  https://sourceforge.net/projects/vmm/files/vmm/0.6.1
 vmm-0.6.0   Jun 28 2012  https://sourceforge.net/projects/vmm/files/vmm/0.6.0
 vmm-0.5.2   Sep 09 2009  https://sourceforge.net/projects/vmm/files/vmm/0.5.2
--- a/doc/web/source/substitutions.rst	Sat Feb 01 17:12:15 2014 +0000
+++ b/doc/web/source/substitutions.rst	Sat Feb 01 18:18:06 2014 +0000
@@ -1,4 +1,4 @@
-.. |curr_vers_rel_date| replace:: The most current version of vmm is 0.6.1,
- released on 03 October 2012.
+.. |curr_vers_rel_date| replace:: The most current version of vmm is 0.6.2,
+ released on 01 February 2014.
 .. |rel_hist| replace:: Older releases are listed in the :doc:`release_history`.
 
--- a/doc/web/source/upgrade/0.5-0.6.rst	Sat Feb 01 17:12:15 2014 +0000
+++ b/doc/web/source/upgrade/0.5-0.6.rst	Sat Feb 01 18:18:06 2014 +0000
@@ -50,14 +50,14 @@
 """"""""""""""""""""""""""""
 .. code-block:: postgresql-console
 
- mailsys=> \i /path/to/vmm-0.6.1/pgsql/update_tables_0.5.x-0.6-dovecot-1.2.x.pgsql
+ mailsys=> \i /path/to/vmm-0.6.2/pgsql/update_tables_0.5.x-0.6-dovecot-1.2.x.pgsql
  mailsys=> \q
 
 Dovecot v1.0.x/v1.1.x
 """""""""""""""""""""
 .. code-block:: postgresql-console
 
- mailsys=> \i /path/to/vmm-0.6.1/pgsql/update_tables_0.5.x-0.6.pgsql
+ mailsys=> \i /path/to/vmm-0.6.2/pgsql/update_tables_0.5.x-0.6.pgsql
  mailsys=> \q
 
 .. _set-database-permissions:
@@ -74,7 +74,7 @@
    So you have to adjust all your ``postfix/pgsql-*.cf`` files and also your
    ``/etc/dovecot/dovecot-sql.conf`` or ``/etc/dovecot/dovecot-sql.conf.ext``.
 
-   See the `vmm-0.6.1/postfix/pgsql-*.cf` files and
+   See the `vmm-0.6.2/postfix/pgsql-*.cf` files and
    :ref:`Dovecot configuration <dovecot-sql-conf-ext>`/`dovecot-sql.conf.ext`
    or :ref:`Dovecot configuration <dovecot-sql-conf>`/`dovecot-sql-conf`.
 
@@ -94,8 +94,8 @@
 
 .. code-block:: console
 
- root@host:~# cd /path/to/vmm-0.6.1
- root@host:/path/to/vmm-0.6.1# ./upgrade.sh
+ root@host:~# cd /path/to/vmm-0.6.2
+ root@host:/path/to/vmm-0.6.2# ./upgrade.sh
  Please have a look at your configuration: /usr/local/etc/vmm.cfg
  This are your Modified/Renamed/New settings:
  R   account.delete_directory = false
@@ -178,6 +178,11 @@
 ^^^^^^^^^^^
 Execute the :file:`upgrade.sh`, in order to install the updated code.
 
+Upgrading from vmm-0.6.1
+------------------------
+If you have already installed vmm-6.0.1, simply execute the
+:file:`upgrade.sh` script.
+
 Upgrade to Dovecot ≧ v1.2.beta2
 -------------------------------
 When you are upgrading your old Dovecot (< v.1.2.beta2) to a newer version,