SF.net SVN: gar:[24506] csw/mgar/pkg/opencsw-manual/trunk

wahwah at users.sourceforge.net wahwah at users.sourceforge.net
Tue Dec 23 19:16:43 CET 2014


Revision: 24506
          http://sourceforge.net/p/gar/code/24506
Author:   wahwah
Date:     2014-12-23 18:16:43 +0000 (Tue, 23 Dec 2014)
Log Message:
-----------
opencsw-manual/trunk: Simplified 'getting started', additional content moved to separate pages.

Modified Paths:
--------------
    csw/mgar/pkg/opencsw-manual/trunk/Makefile
    csw/mgar/pkg/opencsw-manual/trunk/files/check.sh
    csw/mgar/pkg/opencsw-manual/trunk/files/conf.py
    csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/getting-started.rst

Added Paths:
-----------
    csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/getting-started-optional-steps.rst
    csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/setup-behind-proxy.rst
    csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/setup-old-versions.rst

Modified: csw/mgar/pkg/opencsw-manual/trunk/Makefile
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/Makefile	2014-12-23 10:02:43 UTC (rev 24505)
+++ csw/mgar/pkg/opencsw-manual/trunk/Makefile	2014-12-23 18:16:43 UTC (rev 24506)
@@ -30,7 +30,7 @@
 
 BUILD_DEP_PKGS += CSWpy-sphinx
 BUILD_DEP_PKGS += CSWrsync
-BUILD_DEP_PKGS += CSWpysetuptools
+BUILD_DEP_PKGS += CSWpy-setuptools
 
 # This is a documentation package, so references to /usr are fine.
 CHECKPKG_OVERRIDES_CSWopencsw-manual += file-with-bad-content

Modified: csw/mgar/pkg/opencsw-manual/trunk/files/check.sh
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/check.sh	2014-12-23 10:02:43 UTC (rev 24505)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/check.sh	2014-12-23 18:16:43 UTC (rev 24506)
@@ -11,7 +11,9 @@
 if [[ "${DATESTAMP_CONF}" != "${DATESTAMP_CLOCK}" ]]; then
   echo >&2
   echo >&2 '*****'
-  echo >&2 "Please update the version setting in conf.py to ${DATESTAMP_CLOCK}"
+  echo >&2 "Please update the version setting in trunk/files/conf.py to ${DATESTAMP_CLOCK}"
+  echo >&2 'and run "mgar clean package"'
+  echo >&2 'or "mgar clean install copy-to-web" for testing'
   echo >&2 '*****'
   echo >&2
   exit 1

Modified: csw/mgar/pkg/opencsw-manual/trunk/files/conf.py
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/conf.py	2014-12-23 10:02:43 UTC (rev 24505)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/conf.py	2014-12-23 18:16:43 UTC (rev 24506)
@@ -48,9 +48,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.2014.04'
+version = '0.2014.12'
 # The full version, including alpha/beta/rc tags.
-release = '0.2014.04'
+release = '0.2014.12'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

Added: csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/getting-started-optional-steps.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/getting-started-optional-steps.rst	                        (rev 0)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/getting-started-optional-steps.rst	2014-12-23 18:16:43 UTC (rev 24506)
@@ -0,0 +1,107 @@
+.. _getting-started-optional-steps:
+
+-------------------------------
+Getting started, optional steps
+-------------------------------
+
+.. _selecting-catalog-release:
+
+Optional: Selecting the catalog release
+=======================================
+
+By default, ``pkgutil`` is configured to use the ``testing`` catalog.  See
+:ref:`catalog releases <catalog-releases>` for information on releases.
+
+You might want change it to ``unstable`` on your development hosts to catch any
+issues before they hit the ``testing`` catalog. Or you can switch it to
+``stable`` if you want no updates (except for new stable releases).
+
+You can verify the setting with ``pkgutil -V`` ::
+
+  ...
+  maxpkglist              10000 (default: 10000)
+  mirror                  http://mirror.opencsw.org/opencsw/unstable
+                          (default: http://mirror.opencsw.org/opencsw/unstable)
+  noncsw                  false (default: false)
+  ...
+
+On the next catalog update with ``pkgutil -U`` the catalogs indexes are
+downloaded from the new mirror.
+
+.. _setting-up-cryptograhic-verification:
+
+Optional: Cryptographic verification
+====================================
+
+The catalog is signed with PGP and it is a good idea to set up your system to
+verify the integrity of the catalog. As the catalog itself contains hashes for
+all packages in the catalog this ensures you actually install the packages
+which were officially released. First you need to install ``cswpki`` (of course
+with pkgutil!)::
+
+  pkgutil -y -i cswpki
+
+Then you need to import the public key::
+
+  root# cswpki --import
+
+The current fingerprint looks like this::
+
+  # gpg --homedir=/var/opt/csw/pki/ --fingerprint board at opencsw.org
+  pub   1024D/9306CC77 2011-08-31
+        Key fingerprint = 4DCE 3C80 AAB2 CAB1 E60C  9A3C 05F4 2D66 9306 CC77
+  uid                  OpenCSW catalog signing <board at opencsw.org>
+  sub   2048g/971EDE93 2011-08-31
+
+You may also trust the key once you verified the fingerprint::
+
+  root# gpg --homedir=/var/opt/csw/pki --edit-key board at opencsw.org trust
+
+Now everything is in place for enabling security in ``pkgutil``. Edit the ``/etc/opt/csw/pkgutil.conf``
+and uncomment the two lines with ``use_gpg`` and ``use_md5`` so they look like this::
+
+  use_gpg=true
+  use_md5=true
+
+You can verify that it worked with ``pkgutil -V``::
+
+  root at login [login]:/etc/opt/csw > pkgutil -V
+  ...
+  show_current            true (default: true)
+  stop_on_hook_soft_error not set (default: false)
+  use_gpg                 true (default: false)
+  use_md5                 true (default: false)
+  wgetopts                not set (default: none)
+
+On the next ``pkgutil -U`` you should see a catalog integrity verification wit ``gpg``::
+
+  ...
+  Checking integrity of /var/opt/csw/pkgutil/catalog.mirror_opencsw_current_sparc_5.10 with gpg.
+  gpg: Signature made Thu Oct 03 00:32:57 2013 CEST using DSA key ID 9306CC77
+  gpg: Good signature from "OpenCSW catalog signing <board at opencsw.org>"
+  gpg: WARNING: This key is not certified with a trusted signature!
+  gpg:          There is no indication that the signature belongs to the owner.
+  Primary key fingerprint: 4DCE 3C80 AAB2 CAB1 E60C  9A3C 05F4 2D66 9306 CC77
+  Looking for packages that can be upgraded ...
+  Solving needed dependencies ...
+  Solving dependency order ...
+  
+  Nothing to do.
+  ...
+
+.. _selecting-mirror:
+
+Optional: Selecting your mirror
+===============================
+
+For faster downloads, you can select a mirror geographically close to you.
+
+  http://www.opencsw.org/get-it/mirrors/
+
+Please uncomment the line with ``mirror`` in ``/etc/opt/csw/pkgutil.conf``
+so it looks similar to this with the URL replaced by the mirror you picked::
+
+  mirror=http://mirror.opencsw.org/opencsw/unstable
+
+
+Continue to :ref:`Full setup <installation-full-setup>`.

Modified: csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/getting-started.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/getting-started.rst	2014-12-23 10:02:43 UTC (rev 24505)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/getting-started.rst	2014-12-23 18:16:43 UTC (rev 24506)
@@ -4,138 +4,24 @@
 Getting started
 ---------------
 
+Solaris 10 and Solaris 11:
+
 ::
 
   pkgadd -d http://get.opencsw.org/now
   /opt/csw/bin/pkgutil -U
   /opt/csw/bin/pkgutil -a vim
   /opt/csw/bin/pkgutil -y -i vim
+  /opt/csw/bin/vim
 
 Done!
 
-Skip to :ref:`selecting your mirror <selecting-mirror>`.
+Additional, exceptional and/or optional steps:
 
+- :ref:`selecting a local mirror <selecting-mirror>`
+- :ref:`setting up cryptographic verification <setting-up-cryptograhic-verification>`
+- :ref:`selecting the catalog release <selecting-catalog-release>`
+- :ref:`older Solaris versions <old-solaris>`
+- :ref:`behind a HTTP proxy <setup-behind-proxy>`
 
-Behind a proxy
-==============
-
-You may need to specify a proxy with ``-x <proxy>:<port>``, be aware that there
-are known issues with Squid and possibly other proxies::
-
-  pkgadd -x myproxy:3128 -d http://get.opencsw.org/now
-
-Solaris 8 or 9
-==============
-
-``pkgadd`` on Solaris 8 and 9 does not support installation directly via http. In such case
-you need to download pkgutil with a separate tool like wget, and install it
-from disk::
-
-  wget http://mirror.opencsw.org/opencsw/pkgutil.pkg
-  pkgadd -d pkgutil.pkg all
-
-.. NOTE::
-   Solaris 9 is on its way to deprecation. Solaris 9 catalogs get very few
-   package updates.
-
-.. NOTE::
-   Solaris 8 does not get any updates any more. As of April 2014, only the dublin release contains Solaris 8 packages. 
-
-.. _selecting-mirror:
-
-Optional: Selecting your mirror
-===============================
-
-For faster downloads, you can select a mirror geographically close to you.
-
-  http://www.opencsw.org/get-it/mirrors/
-
-Please uncomment the line with ``mirror`` in ``/etc/opt/csw/pkgutil.conf``
-so it looks similar to this with the URL replaced by the mirror you picked::
-
-  mirror=http://mirror.opencsw.org/opencsw/unstable
-
-
-Optional: Selecting the catalog release
-=======================================
-
-By default, ``pkgutil`` is configured to use the ``testing`` catalog.  See
-:ref:`catalog releases <catalog-releases>` for information on releases.
-
-You might want change it to ``unstable`` on your development hosts to catch any
-issues before they hit the ``testing`` catalog. Or you can switch it to
-``stable`` if you want no updates (except for new stable releases).
-
-You can verify the setting with ``pkgutil -V`` ::
-
-  ...
-  maxpkglist              10000 (default: 10000)
-  mirror                  http://mirror.opencsw.org/opencsw/unstable
-                          (default: http://mirror.opencsw.org/opencsw/unstable)
-  noncsw                  false (default: false)
-  ...
-
-On the next catalog update with ``pkgutil -U`` the catalogs indexes are
-downloaded from the new mirror.
-
-
-Optional: Cryptographic verification
-====================================
-
-The catalog is signed with PGP and it is a good idea to set up your system to
-verify the integrity of the catalog. As the catalog itself contains hashes for
-all packages in the catalog this ensures you actually install the packages
-which were officially released. First you need to install ``cswpki`` (of course
-with pkgutil!)::
-
-  pkgutil -y -i cswpki
-
-Then you need to import the public key::
-
-  root# cswpki --import
-
-The current fingerprint looks like this::
-
-  # gpg --homedir=/var/opt/csw/pki/ --fingerprint board at opencsw.org
-  pub   1024D/9306CC77 2011-08-31
-        Key fingerprint = 4DCE 3C80 AAB2 CAB1 E60C  9A3C 05F4 2D66 9306 CC77
-  uid                  OpenCSW catalog signing <board at opencsw.org>
-  sub   2048g/971EDE93 2011-08-31
-
-You may also trust the key once you verified the fingerprint::
-
-  root# gpg --homedir=/var/opt/csw/pki --edit-key board at opencsw.org trust
-
-Now everything is in place for enabling security in ``pkgutil``. Edit the ``/etc/opt/csw/pkgutil.conf``
-and uncomment the two lines with ``use_gpg`` and ``use_md5`` so they look like this::
-
-  use_gpg=true
-  use_md5=true
-
-You can verify that it worked with ``pkgutil -V``::
-
-  root at login [login]:/etc/opt/csw > pkgutil -V
-  ...
-  show_current            true (default: true)
-  stop_on_hook_soft_error not set (default: false)
-  use_gpg                 true (default: false)
-  use_md5                 true (default: false)
-  wgetopts                not set (default: none)
-
-On the next ``pkgutil -U`` you should see a catalog integrity verification wit ``gpg``::
-
-  ...
-  Checking integrity of /var/opt/csw/pkgutil/catalog.mirror_opencsw_current_sparc_5.10 with gpg.
-  gpg: Signature made Thu Oct 03 00:32:57 2013 CEST using DSA key ID 9306CC77
-  gpg: Good signature from "OpenCSW catalog signing <board at opencsw.org>"
-  gpg: WARNING: This key is not certified with a trusted signature!
-  gpg:          There is no indication that the signature belongs to the owner.
-  Primary key fingerprint: 4DCE 3C80 AAB2 CAB1 E60C  9A3C 05F4 2D66 9306 CC77
-  Looking for packages that can be upgraded ...
-  Solving needed dependencies ...
-  Solving dependency order ...
-  
-  Nothing to do.
-  ...
-
 Continue to :ref:`Full setup <installation-full-setup>`.

Added: csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/setup-behind-proxy.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/setup-behind-proxy.rst	                        (rev 0)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/setup-behind-proxy.rst	2014-12-23 18:16:43 UTC (rev 24506)
@@ -0,0 +1,19 @@
+.. _setup-behind-proxy:
+
+Behind a proxy
+==============
+
+You may need to specify a proxy with ``-x <proxy>:<port>``, be aware that there
+are known issues with Squid and possibly other proxies::
+
+  pkgadd -x myproxy:3128 -d http://get.opencsw.org/now
+
+Proxy with a password
+=====================
+
+You will need to configure ``/etc/opt/csw/wgetrc``::
+
+  proxy_user=<user>
+  proxy_password=<password>
+
+Continue to :ref:`Full setup <installation-full-setup>`.

Added: csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/setup-old-versions.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/setup-old-versions.rst	                        (rev 0)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/setup-old-versions.rst	2014-12-23 18:16:43 UTC (rev 24506)
@@ -0,0 +1,20 @@
+.. _old-solaris:
+
+Solaris 8 or 9
+==============
+
+.. NOTE::
+   OpenCSW no longer offers catalogs for Solaris 8.
+
+.. NOTE::
+   Solaris 9 is on its way to deprecation. Solaris 9 catalogs get very few
+   package updates.
+
+``pkgadd`` on Solaris 8 and 9 does not support installation directly via http. In such case
+you need to download pkgutil with a separate tool like wget, and install it
+from disk::
+
+  wget http://mirror.opencsw.org/opencsw/pkgutil.pkg
+  pkgadd -d pkgutil.pkg all
+
+Continue to :ref:`Full setup <installation-full-setup>`.

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.



More information about the devel mailing list