[Lunar-commits] <lunar> Man-page updates

Stefan Wold ratler at lunar-linux.org
Sun Jun 7 10:28:46 CEST 2009 

commit 39689d8f089b8ab5d66267765785d75172c6b580
Author: Stefan Wold <ratler at lunar-linux.org>
Date:   Sun Jun 7 10:28:46 2009 +0200

    Man-page updates
    
    * Moved moonbase.1 to the proper section man5
    * Minor tweaks in some of the other man-pages (section change of moonbase)
---
 usr/share/man/man1/lvu.1      |   13 ++++-
 usr/share/man/man1/moonbase.1 |  131 ----------------------------------------
 usr/share/man/man5/moonbase.5 |  133 +++++++++++++++++++++++++++++++++++++++++
 usr/share/man/man8/lcrash.8   |    2 +-
 usr/share/man/man8/lin.8      |    2 +-
 usr/share/man/man8/lunar.8    |    2 +-
 6 files changed, 147 insertions(+), 136 deletions(-)

diff --git a/usr/share/man/man1/lvu.1 b/usr/share/man/man1/lvu.1
index 52688e4..6c6087d 100644
--- a/usr/share/man/man1/lvu.1
+++ b/usr/share/man/man1/lvu.1
@@ -1,4 +1,4 @@
-.TH "LVU" "1" "August 2003" "Lunar Linux" "LUNAR"
+.TH "LVU" "1" "June 2009" "Lunar Linux" "LUNAR"
 .SH "NAME"
 lvu \- query/view lunar package management information
 .SH "SYNOPSIS"
@@ -33,6 +33,9 @@ from <path/file>
 installed [module]
 .PP
 .B lvu
+conflicts
+.PP
+.B lvu
 held|exiled|expired
 .PP
 .B lvu
@@ -142,6 +145,10 @@ display the modules that this module's ELF binary files actually links to
 .IP 
 used to determine what files were installed by a module and where those files are located
 .PP
+.B conflicts
+.IP
+display modules with conflicting files
+.PP
 .B held
 .IP
 display held modules
@@ -293,10 +300,12 @@ Converted to Lunar by Terry Chan 03/23/2002
 Edited and new functions added by Chuck Mead 05/21/2002
 .PP
 Updated again by Terry Chan 08/08/2003
+.PP
+Updated by Stefan Wold 06/07/2009
 .SH "REPORTING BUGS"
 Report bugs to <maintainer at lunar\-linux.org>
 .SH "SEE ALSO"
-lunar(8), lin(8), lrm(8), lget(8), moonbase(1)
+lunar(8), lin(8), lrm(8), lget(8), moonbase(5)
 .SH "WARRANTY"
 This is free software with ABSOLUTELY NO WARRANTY
 
diff --git a/usr/share/man/man1/moonbase.1 b/usr/share/man/man1/moonbase.1
deleted file mode 100644
index 3fbe7c6..0000000
--- a/usr/share/man/man1/moonbase.1
+++ /dev/null
@@ -1,131 +0,0 @@
-.TH MOONBASE "1" "August 2003" "Lunar Linux" LUNAR
-.SH NAME
-moonbase \- the software catalog for the Lunar-Linux distribution
-.SH COPYRIGHT
-.if n moonbase(1) is Copyright (C) 2002-2003 Terry Chan with portions copyrighted by previous authors 2001-2002
-.if t moonbase(1) is Copyright \(co 2002-2003 Terry Chan with portions copyrighted by previous authors 2001-2002
-.SH "DESCRIPTION"
-The software catalog is a list of software modules (simply referred to
-as "modules") divided into sections. Each module contains one
-or more description files. Description files contain such information as
-module name, version, URL, directory information, etc. Other description files provide unpacking, compilation, installation, and tracking instructions. One section in the 
-software catalog of particular interest is PROFILES. Profiles are
-groups of modules. With profiles you can automatically install predefined or
-custom-built module sets using a single command.
-.SH "SUMMARY"
-The moonbase is found under /var/lib/lunar. The top level of directories
-are the section names. The directories under the section names are the
-modules. Each module directory will have a BASH description file called
-DETAILS and optionally contain one or more of the following description files:
-CONFIGURE, DEPENDS, CONFLICTS, PRE_BUILD, BUILD, POST_BUILD, POST_INSTALL, POST_REMOVE.
-If a description file does not exist in the module directory then a set of default
-description instructions are used. The default instructions for each description
-file can be found in /var/lib/lunar/functions/*.lunar.
-.SH "DETAILS"
-\fBPROFILES\fR
-.PP
-Each profile contains a simplified DETAILS file: profile name, version, and
-description. Profiles are effectively just a DEPEND file with a list of
-modules to be installed. 
-.PP
-\fBDESCRIPTION FILES\fR
-.PP
-A typical source code installation might look like this (assume the
-application is called foo):
-.IP
-step 1) find the URL and download the tarball
-.IP
-step 2) tar xvfz foo-1.00.tar.gz
-.IP
-step 3) cd foo
-.IP
-step 4) less README (perhaps you skip this step?)
-.IP
-step 5) less INSTALL (... and this one?)
-.IP
-step 6) ./configure
-.IP
-step 7) make
-.IP
-step 8) make install
-.PP
-.PP
-Here is a breakdown of the description files and how they relate to the above
-installation procedure:
-.PP
-\fBDETAILS\fR
-.IP
-This file is required and describes the URL for step 1. It also contains version information,
-module name, source name, source directory, and a description of the module.
-.PP
-\fBCONFIGURE\fR
-.IP
-The configure script.
-.PP
-\fBDEPENDS\fR
-.IP
-This file contains a list of other modules upon which the module depends.
-If dependencies are turned on then the modules listed are installed in order
-prior to installing module.
-.PP
-.PP
-\fBCONFLICTS\fR
-.IP
-Contains a list of modules that conflict with this module. Use sparingly. A good example of a reasonable
-use is when you have two modules in the moonbase that are the same but one is patched. eg apache and apache-mod_ssl
-.PP
-\fBPRE_BUILD\fR
-.IP
-This describes the unpacking process as performed in step 2. The default PRE_BUILD will work for
-tarballs with gzip or bzip2 compression.
-.PP
-\fBBUILD\fR
-.IP
-This describes the compilation and installation processes as performed in steps 6-8. If the
-software module compiles and installs using these 3 steps then the default
-BUILD can be used. 
-.PP
-\fBPOST_BUILD\fR
-.IP
-The default POST_BUILD simply calls the software tracking script. 
-.PP
-\fBPOST_INSTALL\fR
-.IP
-There is no default POST_INSTALL. If no POST_INSTALL is present in the
-module directory then no operations are performed in this step. Normally
-used to start daemons or extra cleanup or install default configuration files,
-after the module is ready to execute.
-.PP
-\fBPOST_REMOVE\fR
-.IP
-This is called, if present, after removing the module. See lrm(8).
-.PP
-.SH "NOTES"
-The best way to learn the software catalog is to examine some of the
-description files yourself. Most software catalog entries are simple. For
-example try looking under /var/lib/lunar/moonbase/editors/emacs.
-If however you want to look at a very unusual, but much more complex example look at
-/var/lib/lunar/moonbase/x11/xfree86. To understand how the software
-catalog works, it is also important to look at /var/lib/lunar/functions/*.lunar and
-examine the functions default_pre_build, default_build, and default_post_build.
-.SH "AUTHOR"
-Kyle Sallee
-.PP
-Updated Thomas Stewart 01/15/2002
-.PP
-Converted to Lunar by Terry Chan 03/23/2002
-.PP
-Updated by Terry Chan 5/22/2002
-.PP
-Updated by Terry Chan 8/08/2003
-.PP
-.SH "REPORTING BUGS"
-.PP
-Report bugs to <maintainer at lunar-linux.org>
-.SH "SEE ALSO"
-lunar(8), lin(8), lrm(8), lvu(1), lget(8)
-.PP
-.SH "WARRANTY"
-.PP
-This is free software with ABSOLUTELY NO WARRANTY
-
diff --git a/usr/share/man/man5/moonbase.5 b/usr/share/man/man5/moonbase.5
new file mode 100644
index 0000000..4fd6096
--- /dev/null
+++ b/usr/share/man/man5/moonbase.5
@@ -0,0 +1,133 @@
+.TH MOONBASE "5" "June 2009" "Lunar Linux" LUNAR
+.SH NAME
+moonbase \- the software catalog for the Lunar-Linux distribution
+.SH COPYRIGHT
+.if n moonbase(5) is Copyright (C) 2002-2003 Terry Chan with portions copyrighted by previous authors 2001-2002
+.if t moonbase(5) is Copyright \(co 2002-2003 Terry Chan with portions copyrighted by previous authors 2001-2002
+.SH "DESCRIPTION"
+The software catalog is a list of software modules (simply referred to
+as "modules") divided into sections. Each module contains one
+or more description files. Description files contain such information as
+module name, version, URL, directory information, etc. Other description files provide unpacking, compilation, installation, and tracking instructions. One section in the 
+software catalog of particular interest is PROFILES. Profiles are
+groups of modules. With profiles you can automatically install predefined or
+custom-built module sets using a single command.
+.SH "SUMMARY"
+The moonbase is found under /var/lib/lunar. The top level of directories
+are the section names. The directories under the section names are the
+modules. Each module directory will have a BASH description file called
+DETAILS and optionally contain one or more of the following description files:
+CONFIGURE, DEPENDS, CONFLICTS, PRE_BUILD, BUILD, POST_BUILD, POST_INSTALL, POST_REMOVE.
+If a description file does not exist in the module directory then a set of default
+description instructions are used. The default instructions for each description
+file can be found in /var/lib/lunar/functions/*.lunar.
+.SH "DETAILS"
+\fBPROFILES\fR
+.PP
+Each profile contains a simplified DETAILS file: profile name, version, and
+description. Profiles are effectively just a DEPEND file with a list of
+modules to be installed. 
+.PP
+\fBDESCRIPTION FILES\fR
+.PP
+A typical source code installation might look like this (assume the
+application is called foo):
+.IP
+step 1) find the URL and download the tarball
+.IP
+step 2) tar xvfz foo-1.00.tar.gz
+.IP
+step 3) cd foo
+.IP
+step 4) less README (perhaps you skip this step?)
+.IP
+step 5) less INSTALL (... and this one?)
+.IP
+step 6) ./configure
+.IP
+step 7) make
+.IP
+step 8) make install
+.PP
+.PP
+Here is a breakdown of the description files and how they relate to the above
+installation procedure:
+.PP
+\fBDETAILS\fR
+.IP
+This file is required and describes the URL for step 1. It also contains version information,
+module name, source name, source directory, and a description of the module.
+.PP
+\fBCONFIGURE\fR
+.IP
+The configure script.
+.PP
+\fBDEPENDS\fR
+.IP
+This file contains a list of other modules upon which the module depends.
+If dependencies are turned on then the modules listed are installed in order
+prior to installing module.
+.PP
+.PP
+\fBCONFLICTS\fR
+.IP
+Contains a list of modules that conflict with this module. Use sparingly. A good example of a reasonable
+use is when you have two modules in the moonbase that are the same but one is patched. eg apache and apache-mod_ssl
+.PP
+\fBPRE_BUILD\fR
+.IP
+This describes the unpacking process as performed in step 2. The default PRE_BUILD will work for
+tarballs with gzip or bzip2 compression.
+.PP
+\fBBUILD\fR
+.IP
+This describes the compilation and installation processes as performed in steps 6-8. If the
+software module compiles and installs using these 3 steps then the default
+BUILD can be used. 
+.PP
+\fBPOST_BUILD\fR
+.IP
+The default POST_BUILD simply calls the software tracking script. 
+.PP
+\fBPOST_INSTALL\fR
+.IP
+There is no default POST_INSTALL. If no POST_INSTALL is present in the
+module directory then no operations are performed in this step. Normally
+used to start daemons or extra cleanup or install default configuration files,
+after the module is ready to execute.
+.PP
+\fBPOST_REMOVE\fR
+.IP
+This is called, if present, after removing the module. See lrm(8).
+.PP
+.SH "NOTES"
+The best way to learn the software catalog is to examine some of the
+description files yourself. Most software catalog entries are simple. For
+example try looking under /var/lib/lunar/moonbase/editors/emacs.
+If however you want to look at a very unusual, but much more complex example look at
+/var/lib/lunar/moonbase/xorg7. To understand how the software
+catalog works, it is also important to look at /var/lib/lunar/functions/*.lunar and
+examine the functions default_pre_build, default_build, and default_post_build.
+.SH "AUTHOR"
+Kyle Sallee
+.PP
+Updated Thomas Stewart 01/15/2002
+.PP
+Converted to Lunar by Terry Chan 03/23/2002
+.PP
+Updated by Terry Chan 5/22/2002
+.PP
+Updated by Terry Chan 8/08/2003
+.PP
+Updated by Stefan Wold 6/07/2009
+.PP
+.SH "REPORTING BUGS"
+.PP
+Report bugs to <maintainer at lunar-linux.org>
+.SH "SEE ALSO"
+lunar(8), lin(8), lrm(8), lvu(1), lget(8)
+.PP
+.SH "WARRANTY"
+.PP
+This is free software with ABSOLUTELY NO WARRANTY
+
diff --git a/usr/share/man/man8/lcrash.8 b/usr/share/man/man8/lcrash.8
index ceec7dd..61fe74a 100644
--- a/usr/share/man/man8/lcrash.8
+++ b/usr/share/man/man8/lcrash.8
@@ -46,7 +46,7 @@ Below are some useful addresses
 This is a work in progress. Expect frequent updates.
 .SH "SEE ALSO"
 .LP 
-lunar(8), moonbase(1), lin(8), lvu(1), lget(8), lrm(8)
+lunar(8), moonbase(5), lin(8), lvu(1), lget(8), lrm(8)
 .SH "DISCLAIMER"
 .LP 
 The information and examples given here are for illustrative purposes. Use at
diff --git a/usr/share/man/man8/lin.8 b/usr/share/man/man8/lin.8
index 5670be3..a0f8115 100644
--- a/usr/share/man/man8/lin.8
+++ b/usr/share/man/man8/lin.8
@@ -163,6 +163,6 @@ Updated by Terry Chan 08/08/2003
 .SH "REPORTING BUGS"
 Report bugs to <maintainer at lunar\-linux.org>
 .SH "SEE ALSO"
-lunar(8), lrm(8), lvu(1), lget(8), moonbase(1)
+lunar(8), lrm(8), lvu(1), lget(8), moonbase(5)
 .SH "WARRANTY"
 This is free software with ABSOLUTELY NO WARRANTY
diff --git a/usr/share/man/man8/lunar.8 b/usr/share/man/man8/lunar.8
index 6688099..d84697b 100644
--- a/usr/share/man/man8/lunar.8
+++ b/usr/share/man/man8/lunar.8
@@ -161,7 +161,7 @@ Updated by Terry Chan 08/08/2003
 .SH "REPORTING BUGS"
 Report bugs to <maintainer at lunar\-linux.org>
 .SH "SEE ALSO"
-moonbase(1), lin(8), lvu(1), lget(8), lrm(8), lcrash(8)
+moonbase(5), lin(8), lvu(1), lget(8), lrm(8), lcrash(8)
 .SH "WARRANTY"
 This is free software with ABSOLUTELY NO WARRANTY

More information about the Lunar-commits mailing list