[DRBD-cvs] r1944 - branches/drbd-0.7/documentation

[drbd-cvs at lists.linbit.com]

Author: phil
Date: 2005-09-01 11:36:33 +0200 (Thu, 01 Sep 2005)
New Revision: 1944

Added:
   branches/drbd-0.7/documentation/drbddisk.sgml
Modified:
   branches/drbd-0.7/documentation/Makefile
Log:
A manpage for drbddisk! Thanks Helmut!


Modified: branches/drbd-0.7/documentation/Makefile
===================================================================
--- branches/drbd-0.7/documentation/Makefile	2005-09-01 08:48:51 UTC (rev 1943)
+++ branches/drbd-0.7/documentation/Makefile	2005-09-01 09:36:33 UTC (rev 1944)
@@ -28,7 +28,7 @@
 
 MAKEFILES_LANG := $(foreach dir,$(LANGS),$(dir)/Makefile)
 
-MANPAGES       := drbdsetup.8 drbd.conf.5 drbd.8 drbdadm.8
+MANPAGES       := drbdsetup.8 drbd.conf.5 drbd.8 drbdadm.8 drbddisk.8
 
 #
 # Docbook Magic for SuSE, Worksforme...

Added: branches/drbd-0.7/documentation/drbddisk.sgml
===================================================================
--- branches/drbd-0.7/documentation/drbddisk.sgml	2005-09-01 08:48:51 UTC (rev 1943)
+++ branches/drbd-0.7/documentation/drbddisk.sgml	2005-09-01 09:36:33 UTC (rev 1944)
@@ -0,0 +1,90 @@
+<!DOCTYPE RefEntry PUBLIC "-//Davenport//DTD DocBook V3.0//EN">
+<refentry>
+<docinfo><date>30 Aug 2005</date></docinfo>
+
+<refmeta>
+ <refentrytitle>drbddisk</refentrytitle>
+ <manvolnum>8</manvolnum>
+</refmeta>
+
+<refnamediv>
+ <refname>/etc/ha.d/resource.d/drbddisk</refname>
+ <refpurpose>Script to mark devices as primary and mount filesystems</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+ <cmdsynopsis>
+  <command>/etc/ha.d/resource.d/drbddisk</command>
+  <arg><replaceable>resource</replaceable></arg>
+  <arg choice=req><group choice=plain>
+      <arg choice=req>start</arg>
+      <arg choice=req>stop</arg>
+      <arg choice=req>status</arg>
+    </group>
+    </arg>
+ </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1>
+ <title>Introduction</title>
+ <para>
+   The <option>/etc/ha.d/resource.d/drbddisk</option> script
+   brings the local device of <replaceable>resource</replaceable> into
+   primary state. It is designed to be
+   used by heartbeat.
+  </para>
+  <para>
+    In order to use <option>/etc/ha.d/resource.d/drbddisk</option> you must 
+    define 
+    a resource, a host, and any other configuration options in the DRBD
+    configuration file.  See <option>/etc/drbd.conf</option> for details.
+    If <replaceable>resource</replaceable> is omitted, then all of the 
+    resources listed in the config file are affected.
+  </para>
+</refsect1>
+
+<refsect1>
+<title>Version</title>
+<simpara>This document is correct for version 0.7.13 of the DRBD distribution.
+</simpara>
+</refsect1>
+
+<refsect1>
+  <title>Author</title>
+  <simpara>
+    Written by Philipp Reisner <email>philipp.reisner at linbit.com</email>.
+  </simpara>
+</refsect1>
+
+<refsect1>
+  <title>Reporting Bugs</title>
+  <simpara>
+    Report bugs to <email>drbd-user at lists.linbit.com</email>.
+  </simpara>
+</refsect1>
+
+<refsect1>
+  <title>Copyright</title>
+  <simpara>
+    Copyright (c) 2004-2005 Philipp Reisner. This  is  free software; 
+    see the source for copying conditions.  There is NO warranty; 
+    not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+  </simpara>
+</refsect1>
+
+<refsect1>
+  <title>See Also</title>
+  <para>
+    <citerefentry><refentrytitle>drbd.conf</refentrytitle>
+    <manvolnum>5</manvolnum></citerefentry>,
+    <citerefentry><refentrytitle>drbd</refentrytitle>
+    <manvolnum>8</manvolnum></citerefentry>,
+    <citerefentry><refentrytitle>drbdsetup</refentrytitle>
+    <manvolnum>8</manvolnum></citerefentry>
+    <citerefentry><refentrytitle>drbdadm</refentrytitle>
+    <manvolnum>8</manvolnum></citerefentry>
+  </para>
+</refsect1>
+
+</refentry>
+