Fix Haskell log file naming after virtual cluster changes
[ganeti-local] / man / hscan.rst
index 497c96c..db2207f 100644 (file)
@@ -1,5 +1,5 @@
-HSCAN(1) htools | Ganeti H-tools
-================================
+HSCAN(1) Ganeti | Version @GANETI_VERSION@
+==========================================
 
 NAME
 ----
@@ -9,21 +9,21 @@ hscan - Scan clusters via RAPI and save node/instance data
 SYNOPSIS
 --------
 
-**hscan** [-p] [--no-headers] [-d *path* ] *cluster...*
+**hscan** [-p] [\--no-headers] [-d *path* ] *cluster...*
 
-**hscan** --version
+**hscan** \--version
 
 DESCRIPTION
 -----------
 
 hscan is a tool for scanning clusters via RAPI and saving their data
-in the input format used by **hbal**(1) and **hspace**(1). It will
+in the input format used by **hbal**\(1) and **hspace**\(1). It will
 also show a one-line score for each cluster scanned or, if desired,
 the cluster state as show by the **-p** option to the other tools.
 
 For each cluster, one file named *cluster***.data** will be generated
 holding the node and instance data. This file can then be used in
-**hbal**(1) or **hspace**(1) via the *-t* option. In case the
+**hbal**\(1) or **hspace**\(1) via the *-t* option. In case the
 cluster name contains slashes (as it can happen when the cluster is a
 fully-specified URL), these will be replaced with underscores.
 
@@ -57,7 +57,7 @@ f_disk
   Free disk space in the cluster
 
 Score
-  The score of the cluster, as would be reported by **hbal**(1) if run
+  The score of the cluster, as would be reported by **hbal**\(1) if run
   on the generated data files.
 
 In case of errors while collecting data, all fields after the name of
@@ -71,17 +71,17 @@ OPTIONS
 
 The options that can be passed to the program are as follows:
 
--p, --print-nodes
+-p, \--print-nodes
   Prints the node status for each cluster after the cluster's one-line
   status display, in a format designed to allow the user to understand
   the node's most important parameters. For details, see the man page
-  for **hbal**(1).
+  for **htools**\(1).
 
 -d *path*
   Save the node and instance data for each cluster under *path*,
   instead of the current directory.
 
--V, --version
+-V, \--version
   Just show the program version and exit.
 
 EXIT STATUS
@@ -108,19 +108,8 @@ EXAMPLE
     $ ls -l cluster1.data
     -rw-r--r-- 1 root root 364 2009-03-23 07:26 cluster1.data
 
-SEE ALSO
---------
-
-**hbal**(1), **hspace**(1), **hail**(1), **ganeti**(7),
-**gnt-instance**(8), **gnt-node**(8)
-
-COPYRIGHT
----------
-
-Copyright (C) 2009, 2010, 2011 Google Inc. Permission is granted to
-copy, distribute and/or modify under the terms of the GNU General
-Public License as published by the Free Software Foundation; either
-version 2 of the License, or (at your option) any later version.
-
-On Debian systems, the complete text of the GNU General Public License
-can be found in /usr/share/common-licenses/GPL.
+.. vim: set textwidth=72 :
+.. Local Variables:
+.. mode: rst
+.. fill-column: 72
+.. End: