SF.net SVN: gar:[23404] csw/mgar/pkg/opencsw-manual/trunk
wahwah at users.sourceforge.net
wahwah at users.sourceforge.net
Sun Apr 13 02:31:31 CEST 2014
Revision: 23404
http://sourceforge.net/p/gar/code/23404
Author: wahwah
Date: 2014-04-13 00:31:29 +0000 (Sun, 13 Apr 2014)
Log Message:
-----------
/home/maciej/opencsw/opencsw-manual/trunk: Documentation updates; 2 pages moved from wordpress
Modified Paths:
--------------
csw/mgar/pkg/opencsw-manual/trunk/Makefile
csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/getting-started.rst
csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/index.rst
csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/installation-en-masse.rst
csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/introduction.rst
csw/mgar/pkg/opencsw-manual/trunk/files/for-developers/index.rst
csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/catalog-format.rst
Added Paths:
-----------
csw/mgar/pkg/opencsw-manual/trunk/files/fdl-1.3.txt
csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/faq.rst
csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/setup.rst
csw/mgar/pkg/opencsw-manual/trunk/files/for-developers/linking.rst
csw/mgar/pkg/opencsw-manual/trunk/files/for-developers/upstream.rst
Removed Paths:
-------------
csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/configuring-services.rst
Modified: csw/mgar/pkg/opencsw-manual/trunk/Makefile
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/Makefile 2014-04-12 20:29:57 UTC (rev 23403)
+++ csw/mgar/pkg/opencsw-manual/trunk/Makefile 2014-04-13 00:31:29 UTC (rev 23404)
@@ -49,17 +49,17 @@
rsync -rv $(WORKSRC)/_build/html/ $(DESTDIR)$(docdir)/$(CATALOGNAME_CSWopencsw-manual)
@$(MAKECOOKIE)
-post-install-modulated: copy-to-web
+post-install: copy-to-web
@$(MAKECOOKIE)
# define HTDOCS such as to be possible to install anywhere:
copy-to-web: HTDOCS = $(HOME)/public_html
copy-to-web:
- if echo $(DESTDIR) | grep global; then :; else \
+ if echo $(DESTDIR) | grep global >/dev/null; then :; else \
if [ -d $(HTDOCS)/opencsw-manual ]; then \
- rsync -rv $(DESTDIR)$(docdir)/$(CATALOGNAME_CSWopencsw-manual)/ \
+ rsync -rv --delete $(DESTDIR)$(docdir)/$(CATALOGNAME_CSWopencsw-manual)/ \
$(HTDOCS)/opencsw-manual; \
- fi \
+ fi; \
fi
.PHONY: copy-to-web
Added: csw/mgar/pkg/opencsw-manual/trunk/files/fdl-1.3.txt
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/fdl-1.3.txt (rev 0)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/fdl-1.3.txt 2014-04-13 00:31:29 UTC (rev 23404)
@@ -0,0 +1,451 @@
+
+ GNU Free Documentation License
+ Version 1.3, 3 November 2008
+
+
+ Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
+ <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+0. PREAMBLE
+
+The purpose of this License is to make a manual, textbook, or other
+functional and useful document "free" in the sense of freedom: to
+assure everyone the effective freedom to copy and redistribute it,
+with or without modifying it, either commercially or noncommercially.
+Secondarily, this License preserves for the author and publisher a way
+to get credit for their work, while not being considered responsible
+for modifications made by others.
+
+This License is a kind of "copyleft", which means that derivative
+works of the document must themselves be free in the same sense. It
+complements the GNU General Public License, which is a copyleft
+license designed for free software.
+
+We have designed this License in order to use it for manuals for free
+software, because free software needs free documentation: a free
+program should come with manuals providing the same freedoms that the
+software does. But this License is not limited to software manuals;
+it can be used for any textual work, regardless of subject matter or
+whether it is published as a printed book. We recommend this License
+principally for works whose purpose is instruction or reference.
+
+
+1. APPLICABILITY AND DEFINITIONS
+
+This License applies to any manual or other work, in any medium, that
+contains a notice placed by the copyright holder saying it can be
+distributed under the terms of this License. Such a notice grants a
+world-wide, royalty-free license, unlimited in duration, to use that
+work under the conditions stated herein. The "Document", below,
+refers to any such manual or work. Any member of the public is a
+licensee, and is addressed as "you". You accept the license if you
+copy, modify or distribute the work in a way requiring permission
+under copyright law.
+
+A "Modified Version" of the Document means any work containing the
+Document or a portion of it, either copied verbatim, or with
+modifications and/or translated into another language.
+
+A "Secondary Section" is a named appendix or a front-matter section of
+the Document that deals exclusively with the relationship of the
+publishers or authors of the Document to the Document's overall
+subject (or to related matters) and contains nothing that could fall
+directly within that overall subject. (Thus, if the Document is in
+part a textbook of mathematics, a Secondary Section may not explain
+any mathematics.) The relationship could be a matter of historical
+connection with the subject or with related matters, or of legal,
+commercial, philosophical, ethical or political position regarding
+them.
+
+The "Invariant Sections" are certain Secondary Sections whose titles
+are designated, as being those of Invariant Sections, in the notice
+that says that the Document is released under this License. If a
+section does not fit the above definition of Secondary then it is not
+allowed to be designated as Invariant. The Document may contain zero
+Invariant Sections. If the Document does not identify any Invariant
+Sections then there are none.
+
+The "Cover Texts" are certain short passages of text that are listed,
+as Front-Cover Texts or Back-Cover Texts, in the notice that says that
+the Document is released under this License. A Front-Cover Text may
+be at most 5 words, and a Back-Cover Text may be at most 25 words.
+
+A "Transparent" copy of the Document means a machine-readable copy,
+represented in a format whose specification is available to the
+general public, that is suitable for revising the document
+straightforwardly with generic text editors or (for images composed of
+pixels) generic paint programs or (for drawings) some widely available
+drawing editor, and that is suitable for input to text formatters or
+for automatic translation to a variety of formats suitable for input
+to text formatters. A copy made in an otherwise Transparent file
+format whose markup, or absence of markup, has been arranged to thwart
+or discourage subsequent modification by readers is not Transparent.
+An image format is not Transparent if used for any substantial amount
+of text. A copy that is not "Transparent" is called "Opaque".
+
+Examples of suitable formats for Transparent copies include plain
+ASCII without markup, Texinfo input format, LaTeX input format, SGML
+or XML using a publicly available DTD, and standard-conforming simple
+HTML, PostScript or PDF designed for human modification. Examples of
+transparent image formats include PNG, XCF and JPG. Opaque formats
+include proprietary formats that can be read and edited only by
+proprietary word processors, SGML or XML for which the DTD and/or
+processing tools are not generally available, and the
+machine-generated HTML, PostScript or PDF produced by some word
+processors for output purposes only.
+
+The "Title Page" means, for a printed book, the title page itself,
+plus such following pages as are needed to hold, legibly, the material
+this License requires to appear in the title page. For works in
+formats which do not have any title page as such, "Title Page" means
+the text near the most prominent appearance of the work's title,
+preceding the beginning of the body of the text.
+
+The "publisher" means any person or entity that distributes copies of
+the Document to the public.
+
+A section "Entitled XYZ" means a named subunit of the Document whose
+title either is precisely XYZ or contains XYZ in parentheses following
+text that translates XYZ in another language. (Here XYZ stands for a
+specific section name mentioned below, such as "Acknowledgements",
+"Dedications", "Endorsements", or "History".) To "Preserve the Title"
+of such a section when you modify the Document means that it remains a
+section "Entitled XYZ" according to this definition.
+
+The Document may include Warranty Disclaimers next to the notice which
+states that this License applies to the Document. These Warranty
+Disclaimers are considered to be included by reference in this
+License, but only as regards disclaiming warranties: any other
+implication that these Warranty Disclaimers may have is void and has
+no effect on the meaning of this License.
+
+2. VERBATIM COPYING
+
+You may copy and distribute the Document in any medium, either
+commercially or noncommercially, provided that this License, the
+copyright notices, and the license notice saying this License applies
+to the Document are reproduced in all copies, and that you add no
+other conditions whatsoever to those of this License. You may not use
+technical measures to obstruct or control the reading or further
+copying of the copies you make or distribute. However, you may accept
+compensation in exchange for copies. If you distribute a large enough
+number of copies you must also follow the conditions in section 3.
+
+You may also lend copies, under the same conditions stated above, and
+you may publicly display copies.
+
+
+3. COPYING IN QUANTITY
+
+If you publish printed copies (or copies in media that commonly have
+printed covers) of the Document, numbering more than 100, and the
+Document's license notice requires Cover Texts, you must enclose the
+copies in covers that carry, clearly and legibly, all these Cover
+Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
+the back cover. Both covers must also clearly and legibly identify
+you as the publisher of these copies. The front cover must present
+the full title with all words of the title equally prominent and
+visible. You may add other material on the covers in addition.
+Copying with changes limited to the covers, as long as they preserve
+the title of the Document and satisfy these conditions, can be treated
+as verbatim copying in other respects.
+
+If the required texts for either cover are too voluminous to fit
+legibly, you should put the first ones listed (as many as fit
+reasonably) on the actual cover, and continue the rest onto adjacent
+pages.
+
+If you publish or distribute Opaque copies of the Document numbering
+more than 100, you must either include a machine-readable Transparent
+copy along with each Opaque copy, or state in or with each Opaque copy
+a computer-network location from which the general network-using
+public has access to download using public-standard network protocols
+a complete Transparent copy of the Document, free of added material.
+If you use the latter option, you must take reasonably prudent steps,
+when you begin distribution of Opaque copies in quantity, to ensure
+that this Transparent copy will remain thus accessible at the stated
+location until at least one year after the last time you distribute an
+Opaque copy (directly or through your agents or retailers) of that
+edition to the public.
+
+It is requested, but not required, that you contact the authors of the
+Document well before redistributing any large number of copies, to
+give them a chance to provide you with an updated version of the
+Document.
+
+
+4. MODIFICATIONS
+
+You may copy and distribute a Modified Version of the Document under
+the conditions of sections 2 and 3 above, provided that you release
+the Modified Version under precisely this License, with the Modified
+Version filling the role of the Document, thus licensing distribution
+and modification of the Modified Version to whoever possesses a copy
+of it. In addition, you must do these things in the Modified Version:
+
+A. Use in the Title Page (and on the covers, if any) a title distinct
+ from that of the Document, and from those of previous versions
+ (which should, if there were any, be listed in the History section
+ of the Document). You may use the same title as a previous version
+ if the original publisher of that version gives permission.
+B. List on the Title Page, as authors, one or more persons or entities
+ responsible for authorship of the modifications in the Modified
+ Version, together with at least five of the principal authors of the
+ Document (all of its principal authors, if it has fewer than five),
+ unless they release you from this requirement.
+C. State on the Title page the name of the publisher of the
+ Modified Version, as the publisher.
+D. Preserve all the copyright notices of the Document.
+E. Add an appropriate copyright notice for your modifications
+ adjacent to the other copyright notices.
+F. Include, immediately after the copyright notices, a license notice
+ giving the public permission to use the Modified Version under the
+ terms of this License, in the form shown in the Addendum below.
+G. Preserve in that license notice the full lists of Invariant Sections
+ and required Cover Texts given in the Document's license notice.
+H. Include an unaltered copy of this License.
+I. Preserve the section Entitled "History", Preserve its Title, and add
+ to it an item stating at least the title, year, new authors, and
+ publisher of the Modified Version as given on the Title Page. If
+ there is no section Entitled "History" in the Document, create one
+ stating the title, year, authors, and publisher of the Document as
+ given on its Title Page, then add an item describing the Modified
+ Version as stated in the previous sentence.
+J. Preserve the network location, if any, given in the Document for
+ public access to a Transparent copy of the Document, and likewise
+ the network locations given in the Document for previous versions
+ it was based on. These may be placed in the "History" section.
+ You may omit a network location for a work that was published at
+ least four years before the Document itself, or if the original
+ publisher of the version it refers to gives permission.
+K. For any section Entitled "Acknowledgements" or "Dedications",
+ Preserve the Title of the section, and preserve in the section all
+ the substance and tone of each of the contributor acknowledgements
+ and/or dedications given therein.
+L. Preserve all the Invariant Sections of the Document,
+ unaltered in their text and in their titles. Section numbers
+ or the equivalent are not considered part of the section titles.
+M. Delete any section Entitled "Endorsements". Such a section
+ may not be included in the Modified Version.
+N. Do not retitle any existing section to be Entitled "Endorsements"
+ or to conflict in title with any Invariant Section.
+O. Preserve any Warranty Disclaimers.
+
+If the Modified Version includes new front-matter sections or
+appendices that qualify as Secondary Sections and contain no material
+copied from the Document, you may at your option designate some or all
+of these sections as invariant. To do this, add their titles to the
+list of Invariant Sections in the Modified Version's license notice.
+These titles must be distinct from any other section titles.
+
+You may add a section Entitled "Endorsements", provided it contains
+nothing but endorsements of your Modified Version by various
+parties--for example, statements of peer review or that the text has
+been approved by an organization as the authoritative definition of a
+standard.
+
+You may add a passage of up to five words as a Front-Cover Text, and a
+passage of up to 25 words as a Back-Cover Text, to the end of the list
+of Cover Texts in the Modified Version. Only one passage of
+Front-Cover Text and one of Back-Cover Text may be added by (or
+through arrangements made by) any one entity. If the Document already
+includes a cover text for the same cover, previously added by you or
+by arrangement made by the same entity you are acting on behalf of,
+you may not add another; but you may replace the old one, on explicit
+permission from the previous publisher that added the old one.
+
+The author(s) and publisher(s) of the Document do not by this License
+give permission to use their names for publicity for or to assert or
+imply endorsement of any Modified Version.
+
+
+5. COMBINING DOCUMENTS
+
+You may combine the Document with other documents released under this
+License, under the terms defined in section 4 above for modified
+versions, provided that you include in the combination all of the
+Invariant Sections of all of the original documents, unmodified, and
+list them all as Invariant Sections of your combined work in its
+license notice, and that you preserve all their Warranty Disclaimers.
+
+The combined work need only contain one copy of this License, and
+multiple identical Invariant Sections may be replaced with a single
+copy. If there are multiple Invariant Sections with the same name but
+different contents, make the title of each such section unique by
+adding at the end of it, in parentheses, the name of the original
+author or publisher of that section if known, or else a unique number.
+Make the same adjustment to the section titles in the list of
+Invariant Sections in the license notice of the combined work.
+
+In the combination, you must combine any sections Entitled "History"
+in the various original documents, forming one section Entitled
+"History"; likewise combine any sections Entitled "Acknowledgements",
+and any sections Entitled "Dedications". You must delete all sections
+Entitled "Endorsements".
+
+
+6. COLLECTIONS OF DOCUMENTS
+
+You may make a collection consisting of the Document and other
+documents released under this License, and replace the individual
+copies of this License in the various documents with a single copy
+that is included in the collection, provided that you follow the rules
+of this License for verbatim copying of each of the documents in all
+other respects.
+
+You may extract a single document from such a collection, and
+distribute it individually under this License, provided you insert a
+copy of this License into the extracted document, and follow this
+License in all other respects regarding verbatim copying of that
+document.
+
+
+7. AGGREGATION WITH INDEPENDENT WORKS
+
+A compilation of the Document or its derivatives with other separate
+and independent documents or works, in or on a volume of a storage or
+distribution medium, is called an "aggregate" if the copyright
+resulting from the compilation is not used to limit the legal rights
+of the compilation's users beyond what the individual works permit.
+When the Document is included in an aggregate, this License does not
+apply to the other works in the aggregate which are not themselves
+derivative works of the Document.
+
+If the Cover Text requirement of section 3 is applicable to these
+copies of the Document, then if the Document is less than one half of
+the entire aggregate, the Document's Cover Texts may be placed on
+covers that bracket the Document within the aggregate, or the
+electronic equivalent of covers if the Document is in electronic form.
+Otherwise they must appear on printed covers that bracket the whole
+aggregate.
+
+
+8. TRANSLATION
+
+Translation is considered a kind of modification, so you may
+distribute translations of the Document under the terms of section 4.
+Replacing Invariant Sections with translations requires special
+permission from their copyright holders, but you may include
+translations of some or all Invariant Sections in addition to the
+original versions of these Invariant Sections. You may include a
+translation of this License, and all the license notices in the
+Document, and any Warranty Disclaimers, provided that you also include
+the original English version of this License and the original versions
+of those notices and disclaimers. In case of a disagreement between
+the translation and the original version of this License or a notice
+or disclaimer, the original version will prevail.
+
+If a section in the Document is Entitled "Acknowledgements",
+"Dedications", or "History", the requirement (section 4) to Preserve
+its Title (section 1) will typically require changing the actual
+title.
+
+
+9. TERMINATION
+
+You may not copy, modify, sublicense, or distribute the Document
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense, or distribute it is void, and
+will automatically terminate your rights under this License.
+
+However, if you cease all violation of this License, then your license
+from a particular copyright holder is reinstated (a) provisionally,
+unless and until the copyright holder explicitly and finally
+terminates your license, and (b) permanently, if the copyright holder
+fails to notify you of the violation by some reasonable means prior to
+60 days after the cessation.
+
+Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, receipt of a copy of some or all of the same material does
+not give you any rights to use it.
+
+
+10. FUTURE REVISIONS OF THIS LICENSE
+
+The Free Software Foundation may publish new, revised versions of the
+GNU Free Documentation License from time to time. Such new versions
+will be similar in spirit to the present version, but may differ in
+detail to address new problems or concerns. See
+http://www.gnu.org/copyleft/.
+
+Each version of the License is given a distinguishing version number.
+If the Document specifies that a particular numbered version of this
+License "or any later version" applies to it, you have the option of
+following the terms and conditions either of that specified version or
+of any later version that has been published (not as a draft) by the
+Free Software Foundation. If the Document does not specify a version
+number of this License, you may choose any version ever published (not
+as a draft) by the Free Software Foundation. If the Document
+specifies that a proxy can decide which future versions of this
+License can be used, that proxy's public statement of acceptance of a
+version permanently authorizes you to choose that version for the
+Document.
+
+11. RELICENSING
+
+"Massive Multiauthor Collaboration Site" (or "MMC Site") means any
+World Wide Web server that publishes copyrightable works and also
+provides prominent facilities for anybody to edit those works. A
+public wiki that anybody can edit is an example of such a server. A
+"Massive Multiauthor Collaboration" (or "MMC") contained in the site
+means any set of copyrightable works thus published on the MMC site.
+
+"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0
+license published by Creative Commons Corporation, a not-for-profit
+corporation with a principal place of business in San Francisco,
+California, as well as future copyleft versions of that license
+published by that same organization.
+
+"Incorporate" means to publish or republish a Document, in whole or in
+part, as part of another Document.
+
+An MMC is "eligible for relicensing" if it is licensed under this
+License, and if all works that were first published under this License
+somewhere other than this MMC, and subsequently incorporated in whole or
+in part into the MMC, (1) had no cover texts or invariant sections, and
+(2) were thus incorporated prior to November 1, 2008.
+
+The operator of an MMC Site may republish an MMC contained in the site
+under CC-BY-SA on the same site at any time before August 1, 2009,
+provided the MMC is eligible for relicensing.
+
+
+ADDENDUM: How to use this License for your documents
+
+To use this License in a document you have written, include a copy of
+the License in the document and put the following copyright and
+license notices just after the title page:
+
+ Copyright (c) YEAR YOUR NAME.
+ Permission is granted to copy, distribute and/or modify this document
+ under the terms of the GNU Free Documentation License, Version 1.3
+ or any later version published by the Free Software Foundation;
+ with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
+ A copy of the license is included in the section entitled "GNU
+ Free Documentation License".
+
+If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
+replace the "with...Texts." line with this:
+
+ with the Invariant Sections being LIST THEIR TITLES, with the
+ Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
+
+If you have Invariant Sections without Cover Texts, or some other
+combination of the three, merge those two alternatives to suit the
+situation.
+
+If your document contains nontrivial examples of program code, we
+recommend releasing these examples in parallel under your choice of
+free software license, such as the GNU General Public License,
+to permit their use in free software.
Deleted: csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/configuring-services.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/configuring-services.rst 2014-04-12 20:29:57 UTC (rev 23403)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/configuring-services.rst 2014-04-13 00:31:29 UTC (rev 23404)
@@ -1,46 +0,0 @@
-====================
-Configuring services
-====================
-
-/etc/opt/csw vs. /opt/csw/etc
------------------------------
-
-There are two locations where configuration files are stored. This may look
-confusing at first, the reason is that we try to support both sparse zones and
-full zones as good as possible. Remember that in a sparse root environment
-``/opt`` is shared from the global zone. As a rule of thumb configuration files
-which are specific to a zone are kept in ``/etc/opt/csw`` which is also
-generally preferred (these are in fact most of the configuration files),
-whereas ``/opt/csw/etc`` is used for configuration files which are globally
-set. Some packages honour both locations, where the global ``/opt/csw/etc`` is
-read first and can be customized by ``/etc/opt/csw``, but this is specific to
-the package as not all upstream software allows this easily.
-
-There are some exceptions like Apache, where the configuration files are
-historically in ``/opt/csw/apache2/etc``, but these are likely to go away some
-time.
-
-pkgutil
-+++++++
-
-``pkgutil`` can use **two** configuration files:
-
-- ``/etc/opt/csw/pkgutil.conf``
-- ``/opt/csw/etc/pkgutil.conf``
-
-This may seem confusing, the reason why there are two is that it is possible to
-run OpenCSW in a sparse root environment where ``/opt`` is not writable. In
-this scenario you use configurations in ``/opt/csw/etc`` for global settings
-and ``/etc/opt/csw`` for zone-specific setting. Both ``pkgutil.conf`` are
-identical on installation with all configuration options commented out, so you
-can just pick one for now. As a rule of thumb it is recommended to prefer the
-more prominent ``/etc/opt/csw``.
-
-preserveconf
-------------
-
-Configuration files are usually shipped as template with a `.CSW` suffix which
-is copied during installation to the native name without the suffix. This file
-is meant to be user-adjustable. On package deinstallation or update the
-template is deinstalled whereas the configuration file without suffix is kept
-unless it hasn't been modified.
Added: csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/faq.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/faq.rst (rev 0)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/faq.rst 2014-04-13 00:31:29 UTC (rev 23404)
@@ -0,0 +1,80 @@
+--------------------------
+Frequently Asked Questions
+--------------------------
+
+Are services started by default?
+================================
+
+By default, services are started upon package installation. You can change that
+by `disabling SMF in csw.conf`_.
+
+.. _disabling SMF in csw.conf:
+ http://wiki.opencsw.org/cswclassutils-package#toc10
+
+If you disable service startup by default, and you are using OpenSSH from
+OpenCSW, and you upgrade the openssh package, the ssh service will not be
+started by default, locking you out of the system. Make sure you make an
+additional entry telling the SSH service to start automatically.
+
+How can I install CSW packages in a location other than ``/opt/csw``?
+=====================================================================
+
+OpenCSW packages are not relocatable, so you can't install them in a location
+other than /opt/csw. Even if the packages were relocatable from the package
+system point of view, there are usually paths hard-coded within the packaged
+applications that point to and rely on /opt/csw (for libraries, configuration
+files, data files and such). Relocating such applications is
+application-specific.
+
+How can I transfer packages to a computer without an Internet connection?
+=========================================================================
+
+Have a look at pkgutil's ``--download``, ``--stream``, and ``--target``
+options. You can download packages for a specific platform with all
+dependencies into one big file in order to transfer and install them on another
+computer.
+
+Why do packages go by two names (e.g. CSWftype2 and freetype2)?
+===============================================================
+
+There are two names associated with every piece of software that we ship: a
+package name (a.k.a. pkgname, or pkginst) and a catalog name. The package name
+is used by the underlying Solaris SVR4 package management tools (pkgadd, pkgrm,
+pkginfo), needs to fit historical limits (32 characters), and is sometimes
+cryptically condensed. The catalog name has no significance to Solaris itself,
+and is used by pkgutil and in package catalogs.
+
+Why not use third party dependencies?
+=====================================
+
+Problems with declaring SUNW and SFW packages as dependencies are:
+
+* pkgutil can't download and install them, so declaring them as dependencies
+ won't help during installation
+* they often contain old versions of software (or libraries), while OpenCSW
+ package need newer versions
+* OpenCSW packages must be installable on multiple Solaris versions; a package
+ built for Solaris 9 will also install on Solaris 10. In many cases, the
+ required shared libraries are in packages of different names, e.g. 64-bit
+ version of libfoo.so.1 might be in SUNWfoo on Solaris 10 and SUNWfoox on
+ Solaris 9.
+
+Where are the Solaris 10 version of a package I'm looking at?
+=============================================================
+
+As of April 2014 most packages are built for Solaris 10, but since it's
+possible to install a Solaris 9 package on Solaris 10, we take advantage of
+that fact and put Solaris 9 packages in Solaris 10 catalogs.
+
+There are cases where a package can benefit from features specific to Solaris
+10, and we create separate Solaris 9 and Solaris 10 package builds.
+
+Are the binaries compiled for advanced Instruction Set Architectures?
+=====================================================================
+
+Binaries are compiled for basic ISAs. In most cases, performance is not
+significantly improved by compiling for advanced ISAs. For those cases where
+it is, we usually provide cpu-optimized libraries.
+
+If you know of a specific binary that would benefit from cpu-specific
+optimizations, feel free to contact this package's maintainer and ask about it.
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-04-12 20:29:57 UTC (rev 23403)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/getting-started.rst 2014-04-13 00:31:29 UTC (rev 23404)
@@ -10,59 +10,35 @@
.. _pkgutil: http://pkgutil.net
-Solaris 10
-^^^^^^^^^^
+Step 1: pkgutil
+===============
+You can use ``pkgadd`` to download and install it from http in one step::
-On a Solaris 10 system, you can use the capacity of ``pkgadd`` to download
-and install it via http in one step::
-
pkgadd -d http://get.opencsw.org/now
-You may need to specify a proxy with ``-x <proxy>:<port>``, be aware that there are
-known issues with Squid and possibly other proxies.
+You may need to specify a proxy with ``-x <proxy>:<port>``, be aware that there
+are known issues with Squid and possibly other proxies. Also, ``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::
-Solaris 8 and 9
-^^^^^^^^^^^^^^^
-
-On Solaris 8 and 9 (or 10 if you have issues with the above ``pkgadd``) you
-need to download the package manually (e.g. using wget) and then install it::
-
wget http://mirror.opencsw.org/opencsw/pkgutil.pkg
pkgadd -d pkgutil.pkg all
-You can now start installing packages. For a list of available packages use::
+.. NOTE::
+ Solaris 9 is on its way to deprecation. Solaris 9 catalogs get very few
+ package updates.
- /opt/csw/bin/pkgutil -a
+.. NOTE::
+ Solaris 8 does not get any updates any more. As of April 2014, only the dublin release contains Solaris 8 packages.
-For easy access to OpenCSW programs, put ``/opt/csw/bin`` in front of
-``PATH``, and ``/opt/csw/share/man`` in front of ``MANPATH``. On
-Solaris 10, you can do that by editing the ``/etc/default/login``
-file, uncomment the ``PATH`` and ``SUPATH`` variables definition,
-adjust the values as required and log out and back in.
-As the list is quite long and you probably have an idea what you are looking for the
-list can be fuzzy-matched with::
+Skip to :ref:`Step 2: installing packages <getting-started-installing-packages>`.
- root# pkgutil -a vim
- common package catalog size
- gvim CSWgvim 7.3.055,REV=2010.11.25 1.1 MB
- vim CSWvim 7.3.055,REV=2010.11.25 1002.2 KB
- vimrt CSWvimrt 7.3.055,REV=2010.11.25 7.3 MB
+Optional: Selecting your package source
+=======================================
-Lets just go ahead and try one::
-
- root# pkgutil -y -i vim
- ...
- root# vim
-
-Voila! You have installed your first package!
-
-
----------------------------------------------
-Selecting your mirror and the catalog release
----------------------------------------------
-
Now that you are about to install lots of stuff it may be a good time to select
one of the mirrors from ``mirror.opencsw.org`` close to you. The official
mirrors are listed at::
@@ -89,11 +65,12 @@
On the next catalog update with ``pkgutil -U`` the catalogs are pulled from the new mirror.
+Skip to :ref:`Step 2: installing packages <getting-started-installing-packages>`.
--------------------------------------
-Setting up cryptographic 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
@@ -150,17 +127,30 @@
Nothing to do.
...
--------------------------------
-Installing other basic packages
--------------------------------
+.. _getting-started-installing-packages:
-Installing the following packages is optional but recommended to have
-a coherent stack:
+Step 2: installing packages
+===========================
-* gzip
-* coreutils
-* wget
+You can now start installing packages. For a list of available packages use::
-Finally, installing the ``gnulinks`` package and putting the
-``/opt/csw/gnu`` value in the front of the list contained by the
-``PATH`` variable, gives priority to basic utilities supplied by us.
+ /opt/csw/bin/pkgutil -a
+
+As the list is quite long and you probably have an idea what you are looking for the
+list can be fuzzy-matched with::
+
+ root# /opt/csw/bin/pkgutil -a vim
+ common package catalog size
+ gvim CSWgvim 7.3.055,REV=2010.11.25 1.1 MB
+ vim CSWvim 7.3.055,REV=2010.11.25 1002.2 KB
+ vimrt CSWvimrt 7.3.055,REV=2010.11.25 7.3 MB
+
+Let's go ahead and try installing one::
+
+ root# /opt/csw/bin/pkgutil -y -i vim
+ ...
+ root# /opt/csw/bin/vim
+
+Voila! You have installed your first package!
+
+Continue to :ref:`Full setup <installation-full-setup>`.
Modified: csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/index.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/index.rst 2014-04-12 20:29:57 UTC (rev 23403)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/index.rst 2014-04-13 00:31:29 UTC (rev 23404)
@@ -1,19 +1,15 @@
-==========================
-OpenCSW for Administrators
-==========================
+============================
+OpenCSW for System Engineers
+============================
-A user's manual for people who manage Solaris systems with OpenCSW packages.
+User's manual for people who manage Solaris systems and use OpenCSW packages.
.. toctree::
:maxdepth: 1
introduction
getting-started
+ setup
installation-en-masse
- configuring-services
mirror-setup
-
-.. [#dagosscrapbook]
- `Dago's Scrapbook`_
-.. _Dago's Scrapbook:
- http://sourceforge.net/apps/trac/gar/wiki/DagosScrapbook
+ faq
Modified: csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/installation-en-masse.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/installation-en-masse.rst 2014-04-12 20:29:57 UTC (rev 23403)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/installation-en-masse.rst 2014-04-13 00:31:29 UTC (rev 23404)
@@ -2,31 +2,10 @@
Installing packages en masse
============================
---------------------
-Package dependencies
---------------------
+---------------------------------------------------
+Installing on a host without an Internet connection
+---------------------------------------------------
-The OpenCSW packages have been compiled to allow easy forward migration and
-crossgrades/mixing between SPARC and x86_64 CPUs. That means the same version of the
-package is available for Solaris 10 and 11 for both SPARC and x86. There are
-some exceptions where the software is absolutely not available or has a version
-mismatch (e.g. acroread). To allow this, there are usually no dependencies on
-SUNW packages. This sometimes leads to large dependency chains (and people
-thinking of OpenCSW packages as bloated) but that is the price to pay for
-the interoperability and we feel that in times of ever growing disks the
-flexibility is worth more than the saved bytes.
-
-Package dependencies are modeled in the OpenCSW catalogs to allow automatic
-dependency resolution via pkgutil. To view the current dependencies for a
-package you can use::
-
- pkgutil --deptree <pkg>
-
-
---------------------------------------------------------------
-Creating a .pkg file for a host without an Internet connection
---------------------------------------------------------------
-
If you need to install a package with multiple dependencies on a host with no
Internet access, you can use ``pkgutil`` to prepare a ``.pkg`` file with the
whole dependency chain. This is much easier than copying dependencies one by
@@ -46,6 +25,16 @@
The resulting package stream will be placed in the ``~/.pkgutil/packages``
directory.
-This topic is also `discussed`_ on the community site.
+This topic is also `discussed on the community site`_.
-.. _discussed: http://www.opencsw.org/community/questions/92/installing-without-a-direct-internet-access
+.. _discussed on the community site: http://www.opencsw.org/community/questions/92/installing-without-a-direct-internet-access
+
+-----------------
+Large deployments
+-----------------
+
+To manage package across multiple hosts, you can use a configuration management
+system like puppet, see `Andy Botting's blog post`_ for an example.
+
+.. _Andy Botting's blog post:
+ http://www.andybotting.com/using-pkgutil-on-solaris-with-puppet-for-easy-package-management
Modified: csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/introduction.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/introduction.rst 2014-04-12 20:29:57 UTC (rev 23403)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/introduction.rst 2014-04-13 00:31:29 UTC (rev 23404)
@@ -1,17 +1,48 @@
-------------
-Introduction
-------------
+---------------------------
+Introduction to the project
+---------------------------
-The world of open source is big. Although Solaris releases do contain the
-software companion disc, there's always more projects out there that can't
-fit there.
+The world of open source is big. Solaris releases do contain the software
+companion disc which contains a number of precompiled packages with open source
+software, but you will almost always need a piece of software that is missing
+from the companion disc, or isn't up to date enough.
-OpenCSW fills this gap by providing binary packages, together with their build
-recipes. The packages can be installed comfortably with automatic dependency
-resolution, and require root access to the machine. If you want to compile and
-build packages on your own, the build recipes are available for all packages
-too.
+OpenCSW fills this gap by providing binary packages and the corresponding build
+recipes. Installing our packages is easy: you can install a package with all
+dependencies with a single command.
-Solaris 10 is fully supported. Solaris 8 and 9 only get best effort support
-level. As of January 2012, Solaris 8 catalogs do not get any updates, and
-Solaris 9 catalogs only get some amount of updates.
+If you want to build your own packages, build recipes for our package are
+available in the `source code repository`_.
+
+The OpenCSW packages have been compiled to allow easy forward migration and
+crossgrades/mixing between SPARC and x86_64 CPUs. That means the same version
+of each package is available for Solaris 10 and 11, for both SPARC and Intel
+architectures. There are some exceptions, where the software is not available
+for one of the architectures, or has a version mismatch (e.g. acroread).
+
+For more information, you can watch our `project overview video`_ (1h).
+
+
+Support for different Solaris versions
+======================================
+
+As of April 2014:
+
+* Solaris 11 – can use OpenCSW packages thanks to the backward binary compatibility
+* Solaris 10 – is the main focus
+* Solaris 9 – best effort, occasional updates
+* Solaris 8 – no package updates at all
+
+Mailing lists
+=============
+
+We suggest subscribing to our low traffic `announce list`_.
+
+.. _announce list:
+ https://lists.opencsw.org/mailman/listinfo/announce
+
+.. _source code repository:
+ https://sourceforge.net/p/gar/code/HEAD/tree/
+
+.. _project overview video:
+ http://youtu.be/Qmv5tvHEf4Q
Added: csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/setup.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/setup.rst (rev 0)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/setup.rst 2014-04-13 00:31:29 UTC (rev 23404)
@@ -0,0 +1,102 @@
+.. _installation-full-setup:
+
+----------
+Full setup
+----------
+
+Optional: A few basic packages
+==============================
+
+Installing the following packages is optional but recommended:
+
+* gzip
+* coreutils
+* wget
+
+Finally, installing the ``gnulinks`` package and putting the
+``/opt/csw/gnu`` value in the front of the list contained by the
+``PATH`` variable, gives priority to basic utilities supplied by us.
+
+PATH
+====
+
+For easy access to OpenCSW programs, put ``/opt/csw/bin`` in front of ``PATH``,
+and ``/opt/csw/share/man`` in front of ``MANPATH``. On Solaris 10, you can do
+that by editing the ``/etc/default/login`` file, uncomment the ``PATH`` and
+``SUPATH`` variables definition, adjust the values as required and log out and
+back in.
+
+
+Gotcha: LD_LIBRARY_PATH
+=======================
+
+LD_LIBRARY_PATH is an environment variable which can be used to make the
+dynamic linker look for shared libraries in specific places. It is not
+necessary to set it for OpenCSW binaries. All of them are built with the ``-R``
+flag, so each binary itself knows where to look for the shared objects.
+
+You do not need to set ``LD_LIBRARY_PATH`` system-wide; and if you do, you will
+likely break your system, even to the point of locking yourself out. Some of
+the library names clash between ``/usr/lib`` and ``/opt/csw/lib``, and if you
+run the Solaris openssh daemon with ``LD_LIBRARY_PATH`` set to
+``/opt/csw/lib``, ``/usr/lib/ssh/sshd`` will try to load libcrypto from
+``/opt/csw/lib`` and fail.
+
+
+Upgrading packages
+==================
+
+You need to take care to keep your packages up to date. It doesn't happen
+automatically out of the box. To upgrade packages, run::
+
+ pkgutil -U -u -y
+
+To automate this process across multiple hosts, you can use a configuration
+management system like puppet.
+
+
+/etc/opt/csw vs. /opt/csw/etc
+=============================
+
+There are two locations where configuration files are stored. This may look
+confusing at first, the reason is that we try to support both sparse zones and
+full zones as good as possible. Remember that in a sparse root environment
+``/opt`` is shared from the global zone. As a rule of thumb configuration files
+which are specific to a zone are kept in ``/etc/opt/csw`` which is also
+generally preferred (these are in fact most of the configuration files),
+whereas ``/opt/csw/etc`` is used for configuration files which are globally
+set. Some packages honour both locations, where the global ``/opt/csw/etc`` is
+read first and can be customized by ``/etc/opt/csw``, but this is specific to
+the package as not all upstream software allows this easily.
+
+There are some exceptions like Apache, where the configuration files are
+historically in ``/opt/csw/apache2/etc``, but these are likely to go away some
+time.
+
+
+pkgutil
+=======
+
+``pkgutil`` can use **two** configuration files:
+
+- ``/etc/opt/csw/pkgutil.conf``
+- ``/opt/csw/etc/pkgutil.conf``
+
+This may seem confusing, the reason why there are two is that it is possible to
+run OpenCSW in a sparse root environment where ``/opt`` is not writable. In
+this scenario you use configurations in ``/opt/csw/etc`` for global settings
+and ``/etc/opt/csw`` for zone-specific setting. Both ``pkgutil.conf`` are
+identical on installation with all configuration options commented out, so you
+can just pick one for now. As a rule of thumb it is recommended to prefer the
+more prominent ``/etc/opt/csw``.
+
+
+preserveconf
+============
+
+Configuration files are usually shipped as template with a ``.CSW`` suffix
+which is copied during installation to the native name without the suffix. This
+file is meant to be user-adjustable. On package deinstallation or update the
+template is deinstalled whereas the configuration file without suffix is kept
+unless it hasn't been modified.
+
Modified: csw/mgar/pkg/opencsw-manual/trunk/files/for-developers/index.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-developers/index.rst 2014-04-12 20:29:57 UTC (rev 23403)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-developers/index.rst 2014-04-13 00:31:29 UTC (rev 23404)
@@ -5,36 +5,8 @@
This is a manual for developers who want to build own software, using
tools and libraries provided by OpenCSW.
-.. _linking against OpenCSW libraries:
+.. toctree::
+ :maxdepth: 1
-Linking against OpenCSW libraries
-=================================
-
-To build own software against libraries distributed by OpenCSW, install the
-relevant ``*_dev`` packages. They contain the header files, and ``*.so``
-symlinks necessary during linking.
-
-When building againt OpenCSW software, aside from setting the ``PATH``
-correctly, these flags will typically make it work::
-
- CPPFLAGS="-I/opt/csw/include"
- LDFLAGS="-L/opt/csw/lib -R/opt/csw/lib"
- PKG_CONFIG_PATH="/opt/csw/lib/pkgconfig"
-
-If you're building a 64-bit binary, use these::
-
- CPPFLAGS="-I/opt/csw/include"
- LDFLAGS="-L/opt/csw/lib/64 -R/opt/csw/lib/64"
- PKG_CONFIG_PATH="/opt/csw/lib/64/pkgconfig"
-
-64-bit libraries live in the ``/opt/csw/lib/sparcv9`` and/or
-``/opt/csw/lib/amd64`` directories. The ``/opt/csw/lib/64`` path is
-a symlink to a chosen architecture subdirectory. For example, on SPARC
-``/opt/csw/lib/64`` is a symlink to ``/opt/csw/lib/sparcv9``. All
-binaries compiled with the ``-R/opt/csw/lib/64`` flag will try to look
-at that path and find their libraries.
-
-
-.. _LD_LIBRARY_PATH - just say no:
- https://blogs.oracle.com/rie/entry/tt_ld_library_path_tt
-
+ linking
+ upstream
Added: csw/mgar/pkg/opencsw-manual/trunk/files/for-developers/linking.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-developers/linking.rst (rev 0)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-developers/linking.rst 2014-04-13 00:31:29 UTC (rev 23404)
@@ -0,0 +1,32 @@
+.. _linking against OpenCSW libraries:
+
+Linking against OpenCSW libraries
+=================================
+
+To build own software against libraries distributed by OpenCSW, install the
+relevant ``*_dev`` packages. They contain the header files, and ``*.so``
+symlinks necessary during linking.
+
+When building againt OpenCSW software, aside from setting the ``PATH``
+correctly, these flags will typically make it work::
+
+ CPPFLAGS="-I/opt/csw/include"
+ LDFLAGS="-L/opt/csw/lib -R/opt/csw/lib"
+ PKG_CONFIG_PATH="/opt/csw/lib/pkgconfig"
+
+If you're building a 64-bit binary, use these::
+
+ CPPFLAGS="-I/opt/csw/include"
+ LDFLAGS="-L/opt/csw/lib/64 -R/opt/csw/lib/64"
+ PKG_CONFIG_PATH="/opt/csw/lib/64/pkgconfig"
+
+64-bit libraries live in the ``/opt/csw/lib/sparcv9`` and/or
+``/opt/csw/lib/amd64`` directories. The ``/opt/csw/lib/64`` path is
+a symlink to a chosen architecture subdirectory. For example, on SPARC
+``/opt/csw/lib/64`` is a symlink to ``/opt/csw/lib/sparcv9``. All
+binaries compiled with the ``-R/opt/csw/lib/64`` flag will try to look
+at that path and find their libraries.
+
+
+.. _LD_LIBRARY_PATH - just say no:
+ https://blogs.oracle.com/rie/entry/tt_ld_library_path_tt
Added: csw/mgar/pkg/opencsw-manual/trunk/files/for-developers/upstream.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-developers/upstream.rst (rev 0)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-developers/upstream.rst 2014-04-13 00:31:29 UTC (rev 23404)
@@ -0,0 +1,4 @@
+Bugs/issues filed by OpenCSW maintainers
+========================================
+
+OpenCSW maintainers
Modified: csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/catalog-format.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/catalog-format.rst 2014-04-12 20:29:57 UTC (rev 23403)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/catalog-format.rst 2014-04-13 00:31:29 UTC (rev 23404)
@@ -2,7 +2,7 @@
Catalog format
--------------
-Catalog format in short::
+Space separated fields::
common version package file md5 size dependencies category i-dependencies
@@ -10,17 +10,32 @@
bind 9.4.2,REV=2008.07.09_rev=p1 CSWbind bind-9.4.2,REV=2008.07.09_rev=p1-SunOS5.8-sparc-CSW.pkg.gz f68df57fcf54bfd37304b79d6f7eeacc 2954112 CSWcommon|CSWosslrt net none
-Each field is space separated, the dependencies field can be split with
-the pipe char, like in the example above with two dependencies. The same
-goes for the category and incompatible dependencies fields.
+The format of the ``dependencies`` and ``i-dependencies`` fields::
-A package can only occur once in the catalog, meaning that both package
-names and catalog names must be unique in a catalog.
+1. When the list is empty: ``none``
+2. When the list is non-empty, pipe-separated list of pkginst names:
+ ``CSWfoo|CSWbar``
+A package can only occur once in the catalog, meaning that both package names
+(pkginst) and catalog names must be unique in a catalog.
+
The catalog may have to be extended to support more features like if
there's a source package available. In that case extra fields should be
added to the end so not to break existing tools.
+Signatures
+==========
+
+A catalog file can be signed with gpg, cleartext style, with the signature
+embedded in the file.
+
+CREATIONDATE
+============
+
+The first line can contain::
+
+ # CREATIONDATE 2014-03-16T08:39:58Z
+
See also:
* `Building a catalog`_
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