Improves Man

4 files changed, 62 insertions, 20 deletions

diff --git a/dev/createMan.sh b/dev/createMan.sh
new file mode 100755
index 0000000..6dda7da
--- /dev/null
+++ b/dev/createMan.sh
@@ -0,0 +1,43 @@
+#!/bin/bash - 
+#  Copyright (C) 2014 BARRATERO Laurent                                   
+#
+#  AeroUp is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by 
+#  the Free Software Foundation; either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  Aeroup is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License along
+#  with this program; if not, write to the Free Software Foundation, Inc.,
+#  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 
+
+#===============================================================================
+#
+#          FILE: createMan.sh
+# 
+#         USAGE: ./createMan.sh 
+# 
+#   DESCRIPTION: Create the man files 
+# 
+#       OPTIONS: ---
+#  REQUIREMENTS: ---
+#          BUGS: ---
+#         NOTES: ---
+#        AUTHOR: BARATTERO Laurent, laurentBa<at>larueluberlu.net
+#  ORGANIZATION: La rue Luberlu
+#       CREATED: 27/01/2014 09:32:46 CET
+#      REVISION:  ---
+#===============================================================================
+
+set -o nounset                              # Treat unset variables as an error
+
+rm ../man/aeroup.man.txt
+rm ../man/aeroup.man.html
+
+man ../man/aeroup.man > ../man/aeroup.man.txt 
+man ../man/aeroup.man | man2html  -noheads  -title "AeroUp Man Page" -compress  > ../man/aeroup.man.html
+
diff --git a/man/aeroup.man b/man/aeroup.man
index 171037d..a8f3092 100644
--- a/man/aeroup.man
+++ b/man/aeroup.man
@@ -14,6 +14,7 @@ AeroUp
 [-S \fIserialNumber\fR,\fIserialPort\fR]
 [-i \fIgloFile\fR]
 [-u \fIgloFile\fR,\fIserialPort\fR]
+[-k \fIserialPort\fR]
 [-U \fIglocFile\fR,\fIserialPort\fR]
 [-P]
 [-v]
@@ -62,9 +63,11 @@ Verify that syntax glo file is valid and if this is the case upload it on dev \f
 
 
 .TP
-\fB\-k\fR \fB\-\-symlink\fR 
+\fB\-k\fR \fB\-\-symlink=\fIserialPort\fR 
+.nf
 return the serial name used as symlink of kernel name by udev (work with linux only). see the improved management driver section below.
 But you can also use this command to retrieve an more readable id than serial number.
+.fi
 
 .TP
 Improved management driver (linux only)
diff --git a/man/aeroup.man.html b/man/aeroup.man.html
index b99d1d4..3ea0dd3 100644
--- a/man/aeroup.man.html
+++ b/man/aeroup.man.html
@@ -11,7 +11,7 @@
 SYNOPSIS
        aeroup  [-t  serialPort]  [-o  serialPort]  [-c red,green,blue,serialPort] [-G
        serialPort] [-S serialNumber,serialPort] [-i gloFile] [-u  gloFile,serialPort]
-       [-U glocFile,serialPort] [-P] [-v] [-h]
+       [-k serialPort] [-U glocFile,serialPort] [-P] [-v] [-h]
 
 DESCRIPTION
        AeroUp  is  an open source command line tool to control Ultimate (programmable
@@ -43,12 +43,10 @@ OPTIONS
               Verify that syntax glo file is valid and if this is the case upload  it
               on dev serialPort
 
-       -k --symlink
-              return  the  serial  name  used as symlink of kernel name by udev (work
-              with linux only). see the improved  management  driver  section  below.
-              But  you can also use this command to retrieve an more readable id than
+       -k --symlink=serialPort
+              return the serial name used as symlink of kernel name by udev (work with linux only). see the improved management driver section below.
+              But you can also use this command to retrieve an more readable id than serial number.
 
-              ================================================
                 Props | Range adress  | id char | Symlinks
               ================================================
                 Ball  | 0.0.98.0/24   | b       | /dev/Ball#
@@ -88,8 +86,8 @@ SEE ALSO
 AUTHOR
        Written by Laurent Barattero (laurent@larueluberlu.net.in)
 
-
-0.8                                 December 2013                              <B>man(1)</B>
+COPYRIGHT
+       Copyright © 2013 BARATTERO Laurent License GPLv3+: GNU GPL  version 3 or later
 </PRE>
 <HR>
 <ADDRESS>
diff --git a/man/aeroup.man.txt b/man/aeroup.man.txt
index 7b93858..90debf1 100644
--- a/man/aeroup.man.txt
+++ b/man/aeroup.man.txt
@@ -9,7 +9,7 @@ NAME
 SYNOPSIS
        aeroup  [-t  serialPort]  [-o  serialPort]  [-c red,green,blue,serialPort] [-G
        serialPort] [-S serialNumber,serialPort] [-i gloFile] [-u  gloFile,serialPort]
-       [-U glocFile,serialPort] [-P] [-v] [-h]
+       [-k serialPort] [-U glocFile,serialPort] [-P] [-v] [-h]
 
 
 
@@ -53,23 +53,21 @@ OPTIONS
 
 
 
-       -k --symlink
-              return  the  serial  name  used as symlink of kernel name by udev (work
-              with linux only). see the improved  management  driver  section  below.
-              But  you can also use this command to retrieve an more readable id than
-              serial number.
+       -k --symlink=serialPort
+              return the serial name used as symlink of kernel name by udev (work with linux only). see the improved management driver section below.
+              But you can also use this command to retrieve an more readable id than serial number.
 
 
        Improved management driver (linux only)
-              note: you may need to update to last   bootloader  (aeroup  was  tested
-              with  Club_Ball_Poi_V2.3.hex).  you 'll find it on the Aerotech ltd web
+              note:  you  may  need  to update to last  bootloader (aeroup was tested
+              with Club_Ball_Poi_V2.3.hex).  you 'll find it on the Aerotech ltd  web
               page.
 
               To use the system management driver, you first need to set the apropri‐
-              ate  serial  number in your props with the --setSerial option. (See the
+              ate serial number in your props with the --setSerial option.  (See  the
               address table belowx).  And put the file aeroup.rule to your udev rules
-              directory  if  it  wasn't done during installation.  When you plug your
-              props you should now have a corresponding symlink to your  /dev  direc‐
+              directory if it wasn't done during installation.  When  you  plug  your
+              props  you  should now have a corresponding symlink to your /dev direc‐
               tory.
 
               ================================================