Revert "VERSION: Bump version up to 4.10.0rc1..."
[Samba.git] / ctdb / doc / ctdb_diagnostics.1.xml
blob274c70d10e42ca63ee16da482062675dd69a7348
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry
3         PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
4         "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
5 <refentry id="ctdb_diagnostics.1">
7   <refmeta>
8     <refentrytitle>ctdb_diagnostics</refentrytitle>
9     <manvolnum>1</manvolnum>
10     <refmiscinfo class="source">ctdb</refmiscinfo>
11     <refmiscinfo class="manual">CTDB - clustered TDB database</refmiscinfo>
12   </refmeta>
14   <refnamediv>
15     <refname>ctdb_diagnostics</refname>
16     <refpurpose>dump diagnostic information about CTDB/Samba installation</refpurpose>
17   </refnamediv>
19   <refsynopsisdiv>
20     <cmdsynopsis>
21       <command>ctdb_diagnostics</command>
22       <arg>OPTIONS</arg>
23           <arg choice="plain">...</arg>
24     </cmdsynopsis>
25   </refsynopsisdiv>
27   <refsect1>
28     <title>DESCRIPTION</title>
29     <para>
30       ctdb_diagnostics is used to dump diagnostic information about a
31       clustered Samba installation.  This includes configuration
32       files, output of relevant commands and logs.  This information
33       can be used to check the correctness of the configuration and to
34       diagnose problems.
35     </para>
36   </refsect1>
38   <refsect1>
39     <title>OPTIONS</title>
41     <variablelist>
43       <varlistentry>
44             <term>-n &lt;nodes&gt;</term>
45             <listitem>
46             <para>
47               Comma separated list of nodes to operate on
48             </para>
49             </listitem>
50       </varlistentry>
52       <varlistentry>
53             <term>-c</term>
54         <listitem>
55         <para>
56               Ignore comment lines (starting with '#') in file comparisons
57             </para>
58         </listitem>
59       </varlistentry>
61       <varlistentry>
62             <term>-w</term>
63             <listitem>
64           <para>
65               Ignore whitespace in file comparisons
66               </para>
67         </listitem>
68       </varlistentry>
70       <varlistentry>
71             <term>--no-ads</term>
72             <listitem>
73           <para>
74               Do not use commands that assume an Active Directory Server
75               </para>
76         </listitem>
77       </varlistentry>
79     </variablelist>
81   </refsect1>
83   <refsect1>
84     <title>SEE ALSO</title>
85     <para>
86       <citerefentry><refentrytitle>ctdb</refentrytitle>
87       <manvolnum>1</manvolnum></citerefentry>,
88       <citerefentry><refentrytitle>ctdb</refentrytitle>
89       <manvolnum>7</manvolnum></citerefentry>,
90       <ulink url="https://ctdb.samba.org/"/>
91     </para>
92   </refsect1>
94   <refentryinfo>
95     <author>
96       <contrib>
97           This documentation was written by Martijn van Brummelen
98       </contrib>
99     </author>
101     <copyright>
102       <year>2015</year>
103       <holder>Martijn van Brummelen</holder>
104     </copyright>
106     <legalnotice>
107       <para>
108           This program is free software; you can redistribute it and/or
109           modify it under the terms of the GNU General Public License as
110           published by the Free Software Foundation; either version 3 of
111           the License, or (at your option) any later version.
112       </para>
113       <para>
114           This program is distributed in the hope that it will be
115           useful, but WITHOUT ANY WARRANTY; without even the implied
116           warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
117           PURPOSE.  See the GNU General Public License for more details.
118       </para>
119       <para>
120           You should have received a copy of the GNU General Public
121           License along with this program; if not, see
122           <ulink url="http://www.gnu.org/licenses"/>.
123       </para>
124     </legalnotice>
126   </refentryinfo>
128 </refentry>