changeset 2313:f85f3a94a8ce

Add quickstart section with local command overview to man page Reviewed-by: omajid Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2016-March/018184.html
author Anirudhan Mukundan <amukunda@redhat.com>
date Tue, 24 May 2016 12:01:22 -0400
parents 5b2cb89debda
children e357a435d29d
files distribution/packaging/shared/man/thermostat.1
diffstat 1 files changed, 6 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/distribution/packaging/shared/man/thermostat.1	Tue May 24 12:46:14 2016 -0400
+++ b/distribution/packaging/shared/man/thermostat.1	Tue May 24 12:01:22 2016 -0400
@@ -64,9 +64,15 @@
 for options and arguments for a
 .I command.
 
+.SH "QUICK START"
+For new users and users looking to monitor JVMs only on the local machine, simply
+run the "\fBthermostat local\fP \fIcommand\fP" to get started.
+
 .SH "COMMAND OVERVIEW"
 .SS "thermostat help"
   show help for a given command or help overview
+.SS "thermostat local"
+  start a self contained instance of service/web-storage-service and the GUI client
 .SS "thermostat storage <--start|--stop|--status> [--dryRun] [-q] [-l <level>]"
   control Thermostat mongodb storage
 .SS "thermostat agent [-d <url>] [-s] [-l <level>]"