[gnuastro-commits] master e4e4ec2 1/2: Corrections in --help output introductions

[Mohammad Akhlaghi]

branch: master
commit e4e4ec2e7baa6dc298beaad91abb2ad8bcc51a40
Author: Mohammad Akhlaghi <address@hidden>
Commit: Mohammad Akhlaghi <address@hidden>

    Corrections in --help output introductions
    
    The first few paragraphs of the `--help' output of the programs was
    reviewed and were necessary corrections were made. In particular, the
    example commands to run in `fixedstingmacros.h' now have a `$' sign at the
    start to more clearly show that they must be run on the command-line. The
    rest of the corrections, were just program-specific edits/corrections.
---
 bin/arithmetic/ui.c                       | 17 +++++++++--------
 bin/buildprog/main.h                      |  4 ++--
 bin/buildprog/ui.c                        |  8 +++-----
 bin/convolve/ui.c                         | 12 ++++--------
 bin/fits/ui.c                             |  5 +++--
 bin/mknoise/ui.c                          |  2 +-
 bin/mkprof/ui.c                           |  2 +-
 bin/table/ui.c                            |  2 +-
 lib/gnuastro-internal/fixedstringmacros.h |  8 ++++----
 9 files changed, 28 insertions(+), 32 deletions(-)

diff --git a/bin/arithmetic/ui.c b/bin/arithmetic/ui.c
index 4008f60..5640ceb 100644
--- a/bin/arithmetic/ui.c
+++ b/bin/arithmetic/ui.c
@@ -71,13 +71,15 @@ doc[] = GAL_STRINGS_TOP_HELP_INFO PROGRAM_NAME" will do 
arithmetic "
   "`5 6 +', or to get the average of two images, you should write `a.fits "
   "b.fits + 2 /' (or more simply use the `average' operator with "
   "`a.fits b.fits average'). Please see the manual for more information. "
-  "\n\nThe operators/functions recognized by "PROGRAM_NAME" are: +, -, *, "
-  "/, abs, pow, sqrt, log, log10, minvalue, maxvalue, min, max, average, "
-  "median, lt, le, gt, ge, eq, ne, and, or, not, isblank, and the full set "
-  "of bitwise operators, and numeric type conversion operators to all known "
-  "types. Please run `info gnuastro \"Arithmetic operators\"' for detailed "
-  "information on each operator. Note that multiplication should be quoted "
-  "(like \"*\", or '*') to avoid shell expansion.\n"
+  "\n\n"PROGRAM_NAME" recognizes a large collection of standard operators, "
+  "including basic arithmetic (e.g., +, -, *, /), mathematical (e.g., abs, "
+  "pow, sqrt, log), statistical (minvalue, min, max, average), comparison "
+  "(e.g., lt, le, gt), logical (e.g., and, or, not), the full set of bitwise "
+  "operators, and numeric type conversion operators to all known types. "
+  "Please run the command below for a complete list describing all "
+  "operators (press the `SPACE' keyboard key, or arrow keys, to go down "
+  "and `q' to return to the command-line):\n\n"
+  "     $ info gnuastro \"Arithmetic operators\"\n"
   GAL_STRINGS_MORE_HELP_INFO
   /* After the list of options: */
   "\v"
@@ -221,7 +223,6 @@ parse_opt(int key, char *arg, struct argp_state *state)
 /**************************************************************/
 /***************       Sanity Check         *******************/
 /**************************************************************/
-
 /* Sanity check on options AND arguments. If only option values are to be
    checked, use `ui_read_check_only_options'. */
 static void
diff --git a/bin/buildprog/main.h b/bin/buildprog/main.h
index 73cf6f1..56ea2e2 100644
--- a/bin/buildprog/main.h
+++ b/bin/buildprog/main.h
@@ -29,8 +29,8 @@ along with Gnuastro. If not, see 
<http://www.gnu.org/licenses/>.
 #include <gnuastro-internal/options.h>
 
 /* Progarm names.  */
-#define PROGRAM_NAME   "Build"    /* Program full name.       */
-#define PROGRAM_EXEC   "astbuild" /* Program executable name. */
+#define PROGRAM_NAME   "BuildProgram"    /* Program full name.       */
+#define PROGRAM_EXEC   "astbuildprog"    /* Program executable name. */
 #define PROGRAM_STRING PROGRAM_NAME" (" PACKAGE_NAME ") " PACKAGE_VERSION
 
 
diff --git a/bin/buildprog/ui.c b/bin/buildprog/ui.c
index 48b1423..473a1c2 100644
--- a/bin/buildprog/ui.c
+++ b/bin/buildprog/ui.c
@@ -63,11 +63,9 @@ doc[] = GAL_STRINGS_TOP_HELP_INFO PROGRAM_NAME" will compile 
and run a "
   "C program, while automatically linking with libraries that Gnuastro "
   "depends on. Hence you do not have to worry about explicitly linking "
   "with CFITSIO for example if you want to work on a FITS file, or with "
-  "GSL if you want to use GNU Scientific Library's functions. You can "
-  "optionally use the standard compiler options `-I', `-L', and `-l'. "
-  "You can use these to specify non-standard directories to look for "
-  "headers, directories to look for compiled libraries, or libraries to "
-  "link with, respectively.\n"
+  "GSL if you want to use GNU Scientific Library's functions. The standard "
+  "compiler options of `-I', `-L', and `-l' are also available for further "
+  "customization of the build.\n"
   GAL_STRINGS_MORE_HELP_INFO
   /* After the list of options: */
   "\v"
diff --git a/bin/convolve/ui.c b/bin/convolve/ui.c
index ffa8d2a..59f472b 100644
--- a/bin/convolve/ui.c
+++ b/bin/convolve/ui.c
@@ -67,14 +67,10 @@ static char
 args_doc[] = "ASTRdata";
 
 const char
-doc[] = GAL_STRINGS_TOP_HELP_INFO PROGRAM_NAME" can be used to view the "
-  "information, select columns, or convert tables. The inputs and outputs "
-  "can be plain text (with whitespace or comma as delimiters), FITS ascii, "
-  "or FITS binary tables. The output columns can either be selected by "
-  "number (counting from 1), name or using regular expressions. For regular "
-  "expressions, enclose the value to the `--column' (`-c') option in "
-  "slashes (`\\', as in `-c\\^mag\\'). To print the selected columns on the "
-  "command-line, don't specify an output file.\n"
+doc[] = GAL_STRINGS_TOP_HELP_INFO PROGRAM_NAME" will convolve an input "
+  "image with a given spatial kernel (image) in the spatial domain (no "
+  "edge effects) or frequency domain. The latter suffers from edge effects, "
+  "but can be much faster.\n"
   GAL_STRINGS_MORE_HELP_INFO
   /* After the list of options: */
   "\v"
diff --git a/bin/fits/ui.c b/bin/fits/ui.c
index 414d3ff..a359994 100644
--- a/bin/fits/ui.c
+++ b/bin/fits/ui.c
@@ -59,8 +59,9 @@ static char
 args_doc[] = "ASTRdata";
 
 const char
-doc[] = GAL_STRINGS_TOP_HELP_INFO PROGRAM_NAME" view and manipulate (add, "
-  "delete, or modify) FITS extensions and header keywords. \n"
+doc[] = GAL_STRINGS_TOP_HELP_INFO PROGRAM_NAME" allows you to view and "
+  "manipulate (add, delete, or modify) FITS extensions (or HDUs) and FITS "
+  "header keywords within one extension.\n"
   GAL_STRINGS_MORE_HELP_INFO
   /* After the list of options: */
   "\v"
diff --git a/bin/mknoise/ui.c b/bin/mknoise/ui.c
index 35023a9..14db897 100644
--- a/bin/mknoise/ui.c
+++ b/bin/mknoise/ui.c
@@ -65,7 +65,7 @@ args_doc[] = "ASTRdata";
 const char
 doc[] = GAL_STRINGS_TOP_HELP_INFO PROGRAM_NAME" will add noise to all the "
   "pixels in an input dataset. The noise parameters can be specified with "
-  "the command line options. \n"
+  "the options below. \n"
   GAL_STRINGS_MORE_HELP_INFO
   /* After the list of options: */
   "\v"
diff --git a/bin/mkprof/ui.c b/bin/mkprof/ui.c
index 004b4f4..4687ecf 100644
--- a/bin/mkprof/ui.c
+++ b/bin/mkprof/ui.c
@@ -70,7 +70,7 @@ doc[] = GAL_STRINGS_TOP_HELP_INFO PROGRAM_NAME" will create a 
FITS image "
   "containing any number of mock astronomical profiles based on an input "
   "catalog. All the profiles will be built from the center outwards. First "
   "by Monte Carlo integration, then using the central pixel position. The "
-  "tolerance level specifies when to switch to a latter.\n"
+  "tolerance level specifies when the switch will occur.\n"
   GAL_STRINGS_MORE_HELP_INFO
   /* After the list of options: */
   "\v"
diff --git a/bin/table/ui.c b/bin/table/ui.c
index 13e3d93..ef92b91 100644
--- a/bin/table/ui.c
+++ b/bin/table/ui.c
@@ -63,7 +63,7 @@ args_doc[] = "ASTRdata";
 const char
 doc[] = GAL_STRINGS_TOP_HELP_INFO PROGRAM_NAME" can be used to view the "
   "information, select columns, or convert tables. The inputs and outputs "
-  "can be plain text (with whitespace or comma as delimiters), FITS ascii, "
+  "can be plain text (with white-space or comma as delimiters), FITS ascii, "
   "or FITS binary tables. The output columns can either be selected by "
   "number (counting from 1), name or using regular expressions. For regular "
   "expressions, enclose the value to the `--column' (`-c') option in "
diff --git a/lib/gnuastro-internal/fixedstringmacros.h 
b/lib/gnuastro-internal/fixedstringmacros.h
index ed0eb11..745aebc 100644
--- a/lib/gnuastro-internal/fixedstringmacros.h
+++ b/lib/gnuastro-internal/fixedstringmacros.h
@@ -52,13 +52,13 @@ along with Gnuastro. If not, see 
<http://www.gnu.org/licenses/>.
   "the full "PACKAGE_NAME" manual. In particular the first contains a " \
   "very comprehensive explanation of "PROGRAM_NAME"'s invocation and "  \
   "all the options.\n\n"                                                \
-  "     info "PROGRAM_EXEC"\n\n"                                        \
-  "     info "PROGRAM_NAME"\n\n"                                        \
-  "     info "PACKAGE_TARNAME"\n\n"                                     \
+  "     $ info "PROGRAM_EXEC"\n\n"                                      \
+  "     $ info "PROGRAM_NAME"\n\n"                                      \
+  "     $ info "PACKAGE_TARNAME"\n\n"                                   \
   "If you couldn't find your answer in the manual, you can get "        \
   "direct help from experienced Gnuastro users and developers. "        \
   "For more information, please run:\n\n"                               \
-  "     info help-gnuastro\n\n"                                         \
+  "     $ info help-gnuastro\n\n"                                       \
   PROGRAM_NAME" options:"                                               \