[DRBD-cvs] documentation by phil; First draft of the drbdadm man page
drbd-user@lists.linbit.com
drbd-user@lists.linbit.com
Mon, 9 Feb 2004 21:58:56 +0100 (CET)
DRBD CVS committal
Author : phil
Project : drbd
Module : documentation
Dir : drbd/documentation
Modified Files:
Tag: rel-0_7-branch
drbd.sgml drbdadm.sgml
Log Message:
First draft of the drbdadm man page
===================================================================
RCS file: /var/lib/cvs/drbd/drbd/documentation/drbd.sgml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -3 -r1.1 -r1.1.2.1
--- drbd.sgml 2 Nov 2001 21:28:00 -0000 1.1
+++ drbd.sgml 9 Feb 2004 20:58:51 -0000 1.1.2.1
@@ -20,7 +20,6 @@
<arg choice=req>start</arg>
<arg choice=req>stop</arg>
<arg choice=req>status</arg>
- <arg choice=req>reconnect</arg>
</group>
</arg>
</cmdsynopsis>
===================================================================
RCS file: /var/lib/cvs/drbd/drbd/documentation/Attic/drbdadm.sgml,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -u -3 -r1.1.2.2 -r1.1.2.3
--- drbdadm.sgml 3 Feb 2004 08:41:57 -0000 1.1.2.2
+++ drbdadm.sgml 9 Feb 2004 20:58:51 -0000 1.1.2.3
@@ -1,6 +1,6 @@
<!DOCTYPE RefEntry PUBLIC "-//Davenport//DTD DocBook V3.0//EN">
<refentry>
- <docinfo><date>25 Aug 2003</date></docinfo>
+ <docinfo><date>09 Feg 2004</date></docinfo>
<refmeta>
<refentrytitle>drbdadm</refentrytitle>
@@ -29,8 +29,190 @@
<refsect1>
<title>Description</title>
<para>
-Bla foo.
-drbdadm is to drbdsetup what ifup/ifdown is to ifconfig.
+ Drbdadm is the high level tool of the DRBD program suite. Drbdadm is to
+ drbdsetup what ifup/ifdown is to ifconfig.
+ </para>
+ <para>
+ Drbdadm is the high level tool of the DRBD program suite. Drbdadm is to
+ drbdsetup what ifup/ifdown is to ifconfig. Drbdadm reads its configuration
+ file and performs the specified commands by calling the drbdsetup program.
+ </para>
+ </refsect1>
+ <refsect1>
+ <title>Options</title>
+ <variablelist>
+ <varlistentry>
+ <term><option>-d</option>, <option>--dry-run</option></term>
+ <listitem><para>
+ Just prints the calls of drbdsetup to stdout, but do not run
+ the commands.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-c</option>, <option>--config-file</option>
+ <replaceable>file</replaceable></term>
+ <listitem><para>
+ Specifies the configuration file drbdadm will use. If this parameter
+ is not specified, drbdadm will look for /etc/drbd-07.conf and
+ /etc/drbd.conf.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-s</option>, <option>--drbdsetup</option>
+ <replaceable>file</replaceable></term>
+ <listitem><para>
+ Specifies the full path to the drbdsetup program. If this option is
+ omitted, drbdadm will look for /sbin/drbdsetup and ./drbdsetup.
+ </para></listitem>
+ </varlistentry>
+ </variablelist>
+ <refsect1>
+ <title>Commands</title>
+ <variablelist>
+ <varlistentry>
+ <term>attach</term>
+ <listitem><para>
+ Attaches a local backing block device to the DRBD resource's device.
+ In file system language this would be the mount operation.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>detach</term>
+ <listitem><para>
+ Removes the backing storage device from a DRBD resources's device.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>connect</term>
+ <listitem><para>
+ Sets up the network configuration of the resource's device. If the
+ peer device is already configured, the two DRBD devices will connect.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>disconnect</term>
+ <listitem><para>
+ Removes the network configuration from the resource. The device
+ will go into StandAllone state.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>syncer</term>
+ <listitem><para>
+ Loads the resynchronisation parameters into the device.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>up</term>
+ <listitem><para>
+ Is a shortcut for attach and connect.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>down</term>
+ <listitem><para>
+ Is a shortcut for disconnect and detach.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>primary</term>
+ <listitem><para>
+ Switch the resource's device into primary state. You need to do
+ this before you may mount a filesystem onto the device.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>secondary</term>
+ <listitem><para>
+ Brings the device back into secondary state. This is needed since in
+ a connected DRBD device pair there might only be one of the two peers
+ in primary state.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>invalidate</term>
+ <listitem><para>
+ This forces DRBD to consider the data on the local backing
+ storage device as out-of-sync. Therefor DRBD will copy each
+ and every block over from its peer, to bring the local storage
+ device back in sync.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>invalidate_remote</term>
+ <listitem><para>
+ This command is simmilar to the invalidate command, but the
+ backing storage of the peer is invalidated and hence rewritten
+ with the data of the local node.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>resize</term>
+ <listitem><para>
+ DRBD will reexamine all sizing constraints, and resize the
+ resource's device accoringly. E.g. In case you increased the
+ size of your backing storage devices (on both nodes of course),
+ then DRBD will addopt to the new size after you called
+ this command on _both_ nodes.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>adjust</term>
+ <listitem><para>
+ Synchronizes the configuration of device with your configuration
+ file. You should always examine the output of the dry-run
+ mode before actually execuring this command.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>wait_connect</term>
+ <listitem><para>
+ Waits until the device is connected to its peer device.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>dump</term>
+ <listitem><para>
+ Just parse the configuration file and dump it to stdout. Might
+ be used the check the configuration file for syntactical correctness.
+ </para></listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+ <refsect1>
+ <title>Version</title>
+ <simpara>
+ This document is correct for version 0.7 of the DRBD distribution.
+ </simpara>
+ </refsect1>
+
+ <refsect1>
+ <title>Author</title>
+ <simpara>Written by Philipp Reisner <email>philipp.reisner@linbit.com</email>.
+ </simpara>
+ </refsect1>
+ <refsect1>
+ <title>Reporting Bugs</title>
+ <simpara>Report bugs to <email>drbd-user@lists.linbit.com</email>.
+ </simpara>
+ </refsect1>
+ <refsect1>
+ <title>Copyright</title>
+ <simpara>
+ Copyright (c) 2004 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>drbddisk</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>