Manpage for the installer

Better Version control for the manpage of mkdxsinitrd


git-svn-id: http://svn.openslx.org/svn/openslx/ld4@200 95ad53e4-c205-0410-b2fa-d234c58c8868

5 files changed, 129 insertions, 2 deletions

diff --git a/packaging/default_files/ld4-inst.1 b/packaging/default_files/ld4-inst.1
new file mode 100644
index 00000000..9b32b744
--- /dev/null
+++ b/packaging/default_files/ld4-inst.1
@@ -0,0 +1,41 @@
+.\" Man page for ld4-inst
+.\"
+.\" Copyright (C), 2006, Felix Endres
+.\"
+.\" You may distribute under the terms of the GNU General Public
+.\" License as specified in the file COPYING that comes with the man
+.\" distribution.
+.\"
+.\" 
+.TH ld4-inst 1 "2006-05-05" "4.0.1" ""
+.LO 1
+.SH NAME
+ld4-inst \- Setup of the bootserver for a diskless client network environment
+.SH SYNTAX
+.B ld4-inst
+
+.SH DESCRIPTION
+ld
+.B ld4-inst
+guides the user through the setup of a server providing the operating system
+template to (diskless) clients booting via PXE.
+
+The steps taken are as follows:
+
+- Ask user about system specifics and desired results
+
+- Create the OS template by rsyncing from an installed instance
+
+- Create the initial ramdisk vor boottime configuration of the clients
+
+- If desired: Configure necessary servers (i.e tftp, nfs)
+
+.SH SEE ALSO
+.BR ld4-inst "(1).
+.SH BUGS
+The project is under heavy development, thus bugs are likely to appear.
+
+Your Feedback is appreciated.
+.SH AUTHOR
+dxs project manager is Dirk von Suchodoletz (dirk.von.suchodoletz@rz.uni-freiburg.de)
+This manpage was written by Felix Endres (felix-dxs@256bit.org)
diff --git a/packaging/default_files/mkdxsinitrd.1 b/packaging/default_files/mkdxsinitrd.1
new file mode 100644
index 00000000..9682070a
--- /dev/null
+++ b/packaging/default_files/mkdxsinitrd.1
@@ -0,0 +1,84 @@
+.\" Man page for mkdxsinitrd
+.\"
+.\" Copyright (C), 2006, Felix Endres
+.\"
+.\" You may distribute under the terms of the GNU General Public
+.\" License as specified in the file COPYING that comes with the man
+.\" distribution.
+.\"
+.\" 
+.TH mkdxsinitrd 1 "2006-05-05" "4.0.1" ""
+.LO 1
+.SH NAME
+mkdxsinitrd \- erstellt eine initial ramdisk für diskless clients
+.SH SYNTAX
+.B mkdxsinitrd 
+.RB [\| \-gh \|] 
+.RB [\| \-k 
+.IR Kernelversion\|] 
+.RB [\| \-i 
+.IR Pfad \|] 
+.RB [\| \-f 
+.IR Module \|] 
+.RB [\| \-n 
+.IR Module\|] 
+.RB [\| \-r 
+.IR Pfad \|] 
+.RB [\| \-s 
+.IR Bildgröße \|] 
+
+.SH BESCHREIBUNG
+Damit Clients ein Betriebssystem nutzen können dass über ein 
+Netzwerk bereitgestellt wird, brauchen diese eine initial ramdisk, 
+in der Vorkonfigurationsschritte stattfinden. Diese sind nötig,
+damit das Betriebssystem eine Umgebung vorfindet in der es seine 
+gewohnte Initialisierung betreiben kann.  
+.B mkdxsinitrd 
+erstellt eine solche ramdisk, die von PXE-fähigen zum Booten benutzt
+werden kann.
+
+
+.SH OPTIONEN
+.TP
+.B \-g 
+Benutze glibc als Basisbibliothek in der ramdisk.
+.TP
+.B \-h
+Zeige Informationen zur Benutzung.
+.TP
+.BI \-k\  Kernelversion
+.B mkdxsinitrd
+versucht die aktuellste Kernelversion zu finden. Falls dies nicht klappt, 
+oder eine andere Kernelversion gewünscht ist kann diese hier angegeben werden 
+(funktioniert natürlich nur für auf dem Hostsystem vorhandene Kernelversionen).
+.TP
+.BI \-i\  Pfad 
+Optionale Angabe wo die erstellte ramdisk hingeschrieben werden soll.
+.TP
+.BI \-f\  Modulliste 
+Kernelmodule die benutzt werden sollen um das Rootfilesystem über das dem Netzwerk zu mounten (z.B. nfs, nbd dnbd).
+.TP
+.BI \-n\  Modulliste
+Kernelmodule zum Betrieb der Clientnetzwerkkarten (z.B. e100 tg3 via-rhine).
+.TP
+.BI \-r\  Pfad
+Pfad zum Wurzelverzeichnis des zu exportierenden Betriebsystems (z.B. /nfsroot).
+.TP
+.BI \-s\  Bildgröße
+Größenangabe des splash images.
+.TP
+.BI \-d\  Name
+Name der Distribution der Betriebsystemvorlage
+.TP
+.BI \-v\  Version
+Versionskennung der Distribution der Betriebsystemvorlage
+.TP
+.BI \-s\  Bildgröße
+Größenangabe des splash images.
+
+.SH SIEHE AUCH
+.BR ld4-inst "(1).
+.SH FEHLER
+Sicherlich allerhand. Feedback ist sehr willkommen.
+.SH AUTOR
+Felix Endres (felix-dxs@256bit.org)
diff --git a/packaging/default_files/mkdxsinitrd.1.gz b/packaging/default_files/mkdxsinitrd.1.gz
deleted file mode 100644
index e88181e5..00000000
--- a/packaging/default_files/mkdxsinitrd.1.gz
+++ /dev/null
diff --git a/packaging/dxs2deb b/packaging/dxs2deb
index 39a27288..453d54ed 100755
--- a/packaging/dxs2deb
+++ b/packaging/dxs2deb
@@ -55,7 +55,8 @@ mkdir -p /tmp/ld$$/DEBIAN
 cp default_files/control  /tmp/ld$$/DEBIAN/
 cp default_files/prerm    /tmp/ld$$/DEBIAN/
 cp default_files/postinst /tmp/ld$$/DEBIAN/
-cp default_files/mkdxsinitrd.1.gz /tmp/ld$$/usr/share/man/man1/
+cp default_files/*.1 /tmp/ld$$/usr/share/man/man1/
+gzip /tmp/ld$$/usr/share/man/man1/*
 
 #Goto project root
 pushd .. > /dev/null
diff --git a/packaging/dxs2tgz b/packaging/dxs2tgz
index 1f55246c..edbef50f 100755
--- a/packaging/dxs2tgz
+++ b/packaging/dxs2tgz
@@ -49,7 +49,8 @@ goto_script_dir
 #Create Temporary working directory
 mkdir -p /tmp/ld$$/dxs
 mkdir -p /tmp/ld$$/man/
-cp default_files/*.1.gz /tmp/ld$$/man/
+cp default_files/*.1 /tmp/ld$$/man/
+gzip /tmp/ld$$/man/*
 cp default_files/*install.sh /tmp/ld$$/
 
 #Goto project root