From 848a9ac5289b8efcc5ab61b5b0e10824760fc83c Mon Sep 17 00:00:00 2001
From: Iustin Pop <iustin@google.com>
Date: Tue, 14 Jul 2009 16:01:38 +0200
Subject: [PATCH] Man page updates

This patch beautifies the man pages for hbal and hspace.
---
 hbal.1   | 41 ++++++++++++++++++++++++++++-------------
 hspace.1 | 33 ++++++++++++++++++++++++---------
 2 files changed, 52 insertions(+), 22 deletions(-)

diff --git a/hbal.1 b/hbal.1
index 75563a72e..08e80b51f 100644
--- a/hbal.1
+++ b/hbal.1
@@ -4,23 +4,38 @@ hbal \- Cluster balancer for Ganeti
 
 .SH SYNOPSIS
 .B hbal
-.BI "[-C[" file "]]"
-.B "[-p]"
-.B "[-o]"
-.B "[-v... | -q]"
-.BI "[-l" limit "]"
-.BI "[-O" name... "]"
-.BI "[-e" score "]"
-.BI "[-m " cluster "]"
-.BI "[-L[" path "]]"
-.BI "[-n " nodes-file " ]"
-.BI "[-i " instances-file "]"
-.BI "[--max-cpu " cpu-ratio "]"
-.BI "[--min-disk " disk-ratio "]"
+.B "[backend options...]"
+.B "[algorithm options...]"
+.B "[reporting options...]"
 
 .B hbal
 .B --version
 
+.TP
+Backend options:
+.BI "[ -m " cluster " ]"
+|
+.BI "[ -L[" path "]]"
+|
+.BI "[ -n " nodes-file " ]"
+.BI "[ -i " instances-file " ]"
+
+.TP
+Algorithm options:
+.BI "[ --max-cpu " cpu-ratio " ]"
+.BI "[ --min-disk " disk-ratio " ]"
+.BI "[ -l " limit " ]"
+.BI "[ -e " score " ]"
+.BI "[ -O " name... " ]"
+
+.TP
+Reporting options:
+.BI "[ -C[" file "] ]"
+.B "[ -p ]"
+.B "[ -o ]"
+.B "[ -v... | -q ]"
+
+
 .SH DESCRIPTION
 hbal is a cluster balancer that looks at the current state of the
 cluster (nodes with their total and free disk, memory, etc.) and
diff --git a/hspace.1 b/hspace.1
index 5cf7a4a3e..d88982c64 100644
--- a/hspace.1
+++ b/hspace.1
@@ -4,21 +4,36 @@ hspace \- Cluster space analyzer for Ganeti
 
 .SH SYNOPSIS
 .B hspace
+.B "[backend options...]"
+.B "[algorithm options...]"
+.B "[request options..."]
 .B "[-p]"
 .B "[-v... | -q]"
-.BI "[-O" name... "]"
-.BI "[-m " cluster "]"
-.BI "[-L[" path "]]"
-.BI "[-n " nodes-file " ]"
-.BI "[-i " instances-file "]"
+
+.B hspace
+.B --version
+
+.TP
+Backend options:
+.BI "[ -m " cluster " ]"
+|
+.BI "[ -L[" path "]]"
+|
+.BI "[ -n " nodes-file " ]"
+.BI "[ -i " instances-file " ]"
+
+.TP
+Algorithm options:
+.BI "[ --max-cpu " cpu-ratio " ]"
+.BI "[ --min-disk " disk-ratio " ]"
+.BI "[ -O " name... " ]"
+
+.TP
+Request options:
 .BI "[--memory " mem "]"
 .BI "[--disk " disk "]"
 .BI "[--req-nodes " req-nodes "]"
-.BI "[--max-cpu " cpu-ratio "]"
-.BI "[--min-disk " disk-ratio "]"
 
-.B hspace
-.B --version
 
 .SH DESCRIPTION
 hspace computes how many additional instances can be fit on a cluster,
-- 
GitLab