[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[gnuastro-commits] master 170fb7d: Corrected comments in configuration f
From: |
Mohammad Akhlaghi |
Subject: |
[gnuastro-commits] master 170fb7d: Corrected comments in configuration files |
Date: |
Sat, 20 May 2017 20:09:13 -0400 (EDT) |
branch: master
commit 170fb7d1669a87a6fe09387f0396fa1e5cf2f33a
Author: Mohammad Akhlaghi <address@hidden>
Commit: Mohammad Akhlaghi <address@hidden>
Corrected comments in configuration files
The configuration file comments had not been updated since the updating of
the option management system. So with this commit, it was re-written and
copied/used for all the programs. The end of the top description of
`--help' is also updated with the suggested command descriptions listed on
the same line as the command.
In ConvertType, I noticed that `p->quality' (which accepts a value between
0 and 100) is being initialized with `UINT8_MAX' (because 0 is a valid
value for it). But this value is only meant as a blank value (to identify
if the option is actually given). So to be more clear, it is replaced with
`GAL_BLANK_UINT8'.
---
bin/TEMPLATE/astTEMPLATE.conf | 24 ++++++++++++------------
bin/arithmetic/astarithmetic.conf | 28 ++++++++++++++--------------
bin/buildprog/astbuildprog.conf | 24 ++++++++++++------------
bin/convertt/astconvertt.conf | 26 +++++++++++++-------------
bin/convertt/ui.c | 5 +++--
bin/convolve/astconvolve.conf | 26 +++++++++++++-------------
bin/cosmiccal/astcosmiccal.conf | 24 ++++++++++++------------
bin/crop/astcrop.conf | 24 ++++++++++++------------
bin/fits/astfits.conf | 28 ++++++++++++++--------------
bin/mkcatalog/astmkcatalog.conf | 24 ++++++++++++------------
bin/mknoise/astmknoise.conf | 24 ++++++++++++------------
bin/mkprof/astmkprof.conf | 24 ++++++++++++------------
bin/noisechisel/astnoisechisel.conf | 26 +++++++++++++-------------
bin/statistics/aststatistics.conf | 24 ++++++++++++------------
bin/table/asttable.conf | 24 ++++++++++++------------
bin/warp/astwarp.conf | 24 ++++++++++++------------
lib/gnuastro-internal/fixedstringmacros.h | 15 +++++++--------
17 files changed, 197 insertions(+), 197 deletions(-)
diff --git a/bin/TEMPLATE/astTEMPLATE.conf b/bin/TEMPLATE/astTEMPLATE.conf
index 82954e8..3e94701 100644
--- a/bin/TEMPLATE/astTEMPLATE.conf
+++ b/bin/TEMPLATE/astTEMPLATE.conf
@@ -1,18 +1,18 @@
# Default parameters (System) for TEMPLATE.
# TEMPLATE is part of GNU Astronomy Utitlies.
#
-# Use the long option name of each paramter followed by
-# a value. The name and value should be separated by
-# atleast one of the following charaacters:
-# space, `,`, `=` or `:`
+# Use the long option name of each parameter followed by a value. The name
+# and value should be separated by atleast one white-space character (for
+# example ` '[space], or tab). Lines starting with `#' are ignored.
#
-# Run with `--help` option or read the manual for a full
-# explanation of what each option means.
+# For more information, please run these commands:
#
-# NOTE I: All counting is from zero, not one.
-# NOTE II: Lines starting with `#` are ignored.
+# $ astTEMPLATE --help # Full list of options, short doc.
+# $ astTEMPLATE -P # Print all options and used values.
+# $ info astTEMPLATE # All options and input/output.
+# $ info gnuastro "Configuration files" # How to use configuration files.
#
-# Copying and distribution of this file, with or without modification,
-# are permitted in any medium without royalty provided the copyright
-# notice and this notice are preserved. This file is offered as-is,
-# without any warranty.
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and
+# this notice are preserved. This file is offered as-is, without any
+# warranty.
diff --git a/bin/arithmetic/astarithmetic.conf
b/bin/arithmetic/astarithmetic.conf
index ddb6ad1..7b82ea6 100644
--- a/bin/arithmetic/astarithmetic.conf
+++ b/bin/arithmetic/astarithmetic.conf
@@ -1,18 +1,18 @@
-# Default parameters (System) for ImageArithmetic.
-# ImageArithmetic is part of GNU Astronomy Utitlies.
+# Default parameters (System) for Arithmetic.
+# Arithmetic is part of GNU Astronomy Utitlies.
#
-# Use the long option name of each paramter followed by
-# a value. The name and value should be separated by
-# atleast one of the following charaacters:
-# space, `,`, `=` or `:`
+# Use the long option name of each parameter followed by a value. The name
+# and value should be separated by atleast one white-space character (for
+# example ` '[space], or tab). Lines starting with `#' are ignored.
#
-# Run with `--help` option or read the manual for a full
-# explanation of what each option means.
+# For more information, please run these commands:
#
-# NOTE I: All counting is from zero, not one.
-# NOTE II: Lines starting with `#` are ignored.
+# $ astarithmetic --help # Full list of options, short doc.
+# $ astarithmetic -P # Print all options and used values.
+# $ info astarithmetic # All options and input/output.
+# $ info gnuastro "Configuration files" # How to use configuration files.
#
-# Copying and distribution of this file, with or without modification,
-# are permitted in any medium without royalty provided the copyright
-# notice and this notice are preserved. This file is offered as-is,
-# without any warranty.
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and
+# this notice are preserved. This file is offered as-is, without any
+# warranty.
diff --git a/bin/buildprog/astbuildprog.conf b/bin/buildprog/astbuildprog.conf
index 2b0bddc..2ac1edf 100644
--- a/bin/buildprog/astbuildprog.conf
+++ b/bin/buildprog/astbuildprog.conf
@@ -1,18 +1,18 @@
# Default parameters (System) for BuildProgram.
# BuildProgram is part of GNU Astronomy Utitlies.
#
-# Use the long option name of each paramter followed by
-# a value. The name and value should be separated by
-# atleast one of the following charaacters:
-# space, `,`, `=` or `:`
+# Use the long option name of each parameter followed by a value. The name
+# and value should be separated by atleast one white-space character (for
+# example ` '[space], or tab). Lines starting with `#' are ignored.
#
-# Run with `--help` option or read the manual for a full
-# explanation of what each option means.
+# For more information, please run these commands:
#
-# NOTE I: All counting is from zero, not one.
-# NOTE II: Lines starting with `#` are ignored.
+# $ astbuildprog --help # Full list of options, short doc.
+# $ astbuildprog -P # Print all options and used values.
+# $ info astbuildprog # All options and input/output.
+# $ info gnuastro "Configuration files" # How to use configuration files.
#
-# Copying and distribution of this file, with or without modification,
-# are permitted in any medium without royalty provided the copyright
-# notice and this notice are preserved. This file is offered as-is,
-# without any warranty.
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and
+# this notice are preserved. This file is offered as-is, without any
+# warranty.
diff --git a/bin/convertt/astconvertt.conf b/bin/convertt/astconvertt.conf
index 084e677..fc3ba04 100644
--- a/bin/convertt/astconvertt.conf
+++ b/bin/convertt/astconvertt.conf
@@ -1,21 +1,21 @@
# Default parameters (System) for ConvertType.
-# MakeProfiles is part of GNU Astronomy Utitlies.
+# ConvertType is part of GNU Astronomy Utitlies.
#
-# Use the long option name of each paramter followed by
-# a value. The name and value should be separated by
-# atleast one of the following charaacters:
-# space, `,`, `=` or `:`
+# Use the long option name of each parameter followed by a value. The name
+# and value should be separated by atleast one white-space character (for
+# example ` '[space], or tab). Lines starting with `#' are ignored.
#
-# Run with `--help` option or read the manual for a full
-# explanation of what each option means.
+# For more information, please run these commands:
#
-# NOTE I: All counting is from zero, not one.
-# NOTE II: Lines starting with `#` are ignored.
+# $ astconvertt --help # Full list of options, short doc.
+# $ astconvertt -P # Print all options and used values.
+# $ info astconvertt # All options and input/output.
+# $ info gnuastro "Configuration files" # How to use configuration files.
#
-# Copying and distribution of this file, with or without modification,
-# are permitted in any medium without royalty provided the copyright
-# notice and this notice are preserved. This file is offered as-is,
-# without any warranty.
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and
+# this notice are preserved. This file is offered as-is, without any
+# warranty.
# Input:
diff --git a/bin/convertt/ui.c b/bin/convertt/ui.c
index 96f9f7e..5979925 100644
--- a/bin/convertt/ui.c
+++ b/bin/convertt/ui.c
@@ -33,6 +33,7 @@ along with Gnuastro. If not, see
<http://www.gnu.org/licenses/>.
#include <gnuastro/list.h>
#include <gnuastro/fits.h>
#include <gnuastro/table.h>
+#include <gnuastro/blank.h>
#include <gnuastro/arithmetic.h>
#include <gnuastro-internal/timing.h>
@@ -125,8 +126,8 @@ ui_initialize_options(struct converttparams *p,
cp->coptions = gal_commonopts_options;
/* Program specific non-zero values. */
- p->quality = UINT8_MAX;
p->maxbyte = UINT8_MAX;
+ p->quality = GAL_BLANK_UINT8;
/* Modify the common options. */
for(i=0; !gal_options_is_last(&cp->coptions[i]); ++i)
@@ -662,7 +663,7 @@ ui_set_output(struct converttparams *p)
"again", PACKAGE_STRING, PACKAGE_STRING);
#else
/* Small sanity checks. */
- if(p->quality == UINT8_MAX)
+ if(p->quality == GAL_BLANK_UINT8)
error(EXIT_FAILURE, 0, "the `--quality' (`-u') option is necessary for
"
"jpeg outputs, but it has not been given");
if(p->quality > 100)
diff --git a/bin/convolve/astconvolve.conf b/bin/convolve/astconvolve.conf
index 4cccb6a..46f5965 100644
--- a/bin/convolve/astconvolve.conf
+++ b/bin/convolve/astconvolve.conf
@@ -1,21 +1,21 @@
# Default parameters (System) for Convolve.
-# MakeProfiles is part of GNU Astronomy Utitlies.
+# Convolve is part of GNU Astronomy Utitlies.
#
-# Use the long option name of each paramter followed by
-# a value. The name and value should be separated by
-# atleast one of the following charaacters:
-# space, `,`, `=` or `:`
+# Use the long option name of each parameter followed by a value. The name
+# and value should be separated by atleast one white-space character (for
+# example ` '[space], or tab). Lines starting with `#' are ignored.
#
-# Run with `--help` option or read the manual for a full
-# explanation of what each option means.
+# For more information, please run these commands:
#
-# NOTE I: All counting is from zero, not one.
-# NOTE II: Lines starting with `#` are ignored.
+# $ astconvolve --help # Full list of options, short doc.
+# $ astconvolve -P # Print all options and used values.
+# $ info astconvolve # All options and input/output.
+# $ info gnuastro "Configuration files" # How to use configuration files.
#
-# Copying and distribution of this file, with or without modification,
-# are permitted in any medium without royalty provided the copyright
-# notice and this notice are preserved. This file is offered as-is,
-# without any warranty.
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and
+# this notice are preserved. This file is offered as-is, without any
+# warranty.
# Input:
kernel kernel.fits
diff --git a/bin/cosmiccal/astcosmiccal.conf b/bin/cosmiccal/astcosmiccal.conf
index 6134595..485a128 100644
--- a/bin/cosmiccal/astcosmiccal.conf
+++ b/bin/cosmiccal/astcosmiccal.conf
@@ -1,21 +1,21 @@
# Default parameters (System) for CosmicCalculator.
# CosmicCalculator is part of GNU Astronomy Utitlies.
#
-# Use the long option name of each paramter followed by
-# a value. The name and value should be separated by
-# atleast one of the following charaacters:
-# space, `,`, `=` or `:`
+# Use the long option name of each parameter followed by a value. The name
+# and value should be separated by atleast one white-space character (for
+# example ` '[space], or tab). Lines starting with `#' are ignored.
#
-# Run with `--help` option or read the manual for a full
-# explanation of what each option means.
+# For more information, please run these commands:
#
-# NOTE I: All counting is from zero, not one.
-# NOTE II: Lines starting with `#` are ignored.
+# $ astcosmiccal --help # Full list of options, short doc.
+# $ astcosmiccal -P # Print all options and used values.
+# $ info astcosmiccal # All options and input/output.
+# $ info gnuastro "Configuration files" # How to use configuration files.
#
-# Copying and distribution of this file, with or without modification,
-# are permitted in any medium without royalty provided the copyright
-# notice and this notice are preserved. This file is offered as-is,
-# without any warranty.
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and
+# this notice are preserved. This file is offered as-is, without any
+# warranty.
# Citation
diff --git a/bin/crop/astcrop.conf b/bin/crop/astcrop.conf
index 3c46861..d58836a 100644
--- a/bin/crop/astcrop.conf
+++ b/bin/crop/astcrop.conf
@@ -1,21 +1,21 @@
# Default parameters (System) for Crop.
# Crop is part of GNU Astronomy Utitlies.
#
-# Use the long option name of each paramter followed by
-# a value. The name and value should be separated by
-# atleast one of the following charaacters:
-# space, `,`, `=` or `:`
+# Use the long option name of each parameter followed by a value. The name
+# and value should be separated by atleast one white-space character (for
+# example ` '[space], or tab). Lines starting with `#' are ignored.
#
-# Run with `--help` option or read the manual for a full
-# explanation of what each option means.
+# For more information, please run these commands:
#
-# NOTE I: All counting is from zero, not one.
-# NOTE II: Lines starting with `#` are ignored.
+# $ astcrop --help # Full list of options, short doc.
+# $ astcrop -P # Print all options and used values.
+# $ info astcrop # All options and input/output.
+# $ info gnuastro "Configuration files" # How to use configuration files.
#
-# Copying and distribution of this file, with or without modification,
-# are permitted in any medium without royalty provided the copyright
-# notice and this notice are preserved. This file is offered as-is,
-# without any warranty.
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and
+# this notice are preserved. This file is offered as-is, without any
+# warranty.
# Input image and catalog parameters:
cathdu 1
diff --git a/bin/fits/astfits.conf b/bin/fits/astfits.conf
index c375bf8..cd3fe2f 100644
--- a/bin/fits/astfits.conf
+++ b/bin/fits/astfits.conf
@@ -1,18 +1,18 @@
-# Default parameters (System) for Header.
-# Header is part of GNU Astronomy Utitlies.
+# Default parameters (System) for Fits.
+# Fits is part of GNU Astronomy Utitlies.
#
-# Use the long option name of each paramter followed by
-# a value. The name and value should be separated by
-# atleast one of the following charaacters:
-# space, `,`, `=` or `:`
+# Use the long option name of each parameter followed by a value. The name
+# and value should be separated by atleast one white-space character (for
+# example ` '[space], or tab). Lines starting with `#' are ignored.
#
-# Run with `--help` option or read the manual for a full
-# explanation of what each option means.
+# For more information, please run these commands:
#
-# NOTE I: All counting is from zero, not one.
-# NOTE II: Lines starting with `#` are ignored.
+# $ astfits --help # Full list of options, short doc.
+# $ astfits -P # Print all options and used values.
+# $ info astfits # All options and input/output.
+# $ info gnuastro "Configuration files" # How to use configuration files.
#
-# Copying and distribution of this file, with or without modification,
-# are permitted in any medium without royalty provided the copyright
-# notice and this notice are preserved. This file is offered as-is,
-# without any warranty.
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and
+# this notice are preserved. This file is offered as-is, without any
+# warranty.
diff --git a/bin/mkcatalog/astmkcatalog.conf b/bin/mkcatalog/astmkcatalog.conf
index 40393ee..5637b17 100644
--- a/bin/mkcatalog/astmkcatalog.conf
+++ b/bin/mkcatalog/astmkcatalog.conf
@@ -1,21 +1,21 @@
# Default parameters (System) for MakeCatalog.
# MakeCatalog is part of GNU Astronomy Utitlies.
#
-# Use the long option name of each paramter followed by
-# a value. The name and value should be separated by
-# atleast one of the following charaacters:
-# space, `,`, `=` or `:`
+# Use the long option name of each parameter followed by a value. The name
+# and value should be separated by atleast one white-space character (for
+# example ` '[space], or tab). Lines starting with `#' are ignored.
#
-# Run with `--help` option or read the manual for a full
-# explanation of what each option means.
+# For more information, please run these commands:
#
-# NOTE I: All counting is from zero, not one.
-# NOTE II: Lines starting with `#` are ignored.
+# $ astmkcatalog --help # Full list of options, short doc.
+# $ astmkcatalog -P # Print all options and used values.
+# $ info astmkcatalog # All options and input/output.
+# $ info gnuastro "Configuration files" # How to use configuration files.
#
-# Copying and distribution of this file, with or without modification,
-# are permitted in any medium without royalty provided the copyright
-# notice and this notice are preserved. This file is offered as-is,
-# without any warranty.
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and
+# this notice are preserved. This file is offered as-is, without any
+# warranty.
# Input:
hdu 1
diff --git a/bin/mknoise/astmknoise.conf b/bin/mknoise/astmknoise.conf
index 232c3e7..a29f1b3 100644
--- a/bin/mknoise/astmknoise.conf
+++ b/bin/mknoise/astmknoise.conf
@@ -1,21 +1,21 @@
# Default parameters (System) for MakeNoise.
# MakeNoise is part of GNU Astronomy Utitlies.
#
-# Use the long option name of each paramter followed by
-# a value. The name and value should be separated by
-# atleast one of the following charaacters:
-# space, `,`, `=` or `:`
+# Use the long option name of each parameter followed by a value. The name
+# and value should be separated by atleast one white-space character (for
+# example ` '[space], or tab). Lines starting with `#' are ignored.
#
-# Run with `--help` option or read the manual for a full
-# explanation of what each option means.
+# For more information, please run these commands:
#
-# NOTE I: All counting is from zero, not one.
-# NOTE II: Lines starting with `#` are ignored.
+# $ astmknoise --help # Full list of options, short doc.
+# $ astmknoise -P # Print all options and used values.
+# $ info astmknoise # All options and input/output.
+# $ info gnuastro "Configuration files" # How to use configuration files.
#
-# Copying and distribution of this file, with or without modification,
-# are permitted in any medium without royalty provided the copyright
-# notice and this notice are preserved. This file is offered as-is,
-# without any warranty.
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and
+# this notice are preserved. This file is offered as-is, without any
+# warranty.
# Input:
background -10.00
diff --git a/bin/mkprof/astmkprof.conf b/bin/mkprof/astmkprof.conf
index b894d74..5323e1b 100644
--- a/bin/mkprof/astmkprof.conf
+++ b/bin/mkprof/astmkprof.conf
@@ -1,21 +1,21 @@
# Default parameters (System) for MakeProfiles.
# MakeProfiles is part of GNU Astronomy Utitlies.
#
-# Use the long option name of each paramter followed by
-# a value. The name and value should be separated by
-# atleast one of the following charaacters:
-# space, `,`, `=` or `:`
+# Use the long option name of each parameter followed by a value. The name
+# and value should be separated by atleast one white-space character (for
+# example ` '[space], or tab). Lines starting with `#' are ignored.
#
-# Run with `--help` option or read the manual for a full
-# explanation of what each option means.
+# For more information, please run these commands:
#
-# NOTE I: All counting is from zero, not one.
-# NOTE II: Lines starting with `#` are ignored.
+# $ astmkprof --help # Full list of options, short doc.
+# $ astmkprof -P # Print all options and used values.
+# $ info astmkprof # All options and input/output.
+# $ info gnuastro "Configuration files" # How to use configuration files.
#
-# Copying and distribution of this file, with or without modification,
-# are permitted in any medium without royalty provided the copyright
-# notice and this notice are preserved. This file is offered as-is,
-# without any warranty.
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and
+# this notice are preserved. This file is offered as-is, without any
+# warranty.
#input
backhdu 1
diff --git a/bin/noisechisel/astnoisechisel.conf
b/bin/noisechisel/astnoisechisel.conf
index 67a88aa..b0e4f9b 100644
--- a/bin/noisechisel/astnoisechisel.conf
+++ b/bin/noisechisel/astnoisechisel.conf
@@ -1,21 +1,21 @@
# Default parameters (System) for NoiseChisel.
-# Table is part of GNU Astronomy Utitlies.
+# NoiseChisel is part of GNU Astronomy Utitlies.
#
-# Use the long option name of each paramter followed by
-# a value. The name and value should be separated by
-# atleast one of the following charaacters:
-# space, `,`, `=` or `:`
+# Use the long option name of each parameter followed by a value. The name
+# and value should be separated by atleast one white-space character (for
+# example ` '[space], or tab). Lines starting with `#' are ignored.
#
-# Run with `--help` option or read the manual for a full
-# explanation of what each option means.
+# For more information, please run these commands:
#
-# NOTE I: All counting is from zero, not one.
-# NOTE II: Lines starting with `#` are ignored.
+# $ astnoisechisel --help # Full list of options, short doc.
+# $ astnoisechisel -P # Print all options and used values.
+# $ info astnoisechisel # All options and input/output.
+# $ info gnuastro "Configuration files" # How to use configuration files.
#
-# Copying and distribution of this file, with or without modification,
-# are permitted in any medium without royalty provided the copyright
-# notice and this notice are preserved. This file is offered as-is,
-# without any warranty.
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and
+# this notice are preserved. This file is offered as-is, without any
+# warranty.
# Input:
khdu 1
diff --git a/bin/statistics/aststatistics.conf
b/bin/statistics/aststatistics.conf
index 395bf43..07b9c92 100644
--- a/bin/statistics/aststatistics.conf
+++ b/bin/statistics/aststatistics.conf
@@ -1,21 +1,21 @@
# Default parameters (System) for Statistics.
# Statistics is part of GNU Astronomy Utitlies.
#
-# Use the long option name of each paramter followed by
-# a value. The name and value should be separated by
-# atleast one of the following charaacters:
-# space, `,`, `=` or `:`
+# Use the long option name of each parameter followed by a value. The name
+# and value should be separated by atleast one white-space character (for
+# example ` '[space], or tab). Lines starting with `#' are ignored.
#
-# Run with `--help` option or read the manual for a full
-# explanation of what each option means.
+# For more information, please run these commands:
#
-# NOTE I: All counting is from zero, not one.
-# NOTE II: Lines starting with `#` are ignored.
+# $ aststatistics --help # Full list of options, short doc.
+# $ aststatistics -P # Print all options and used values.
+# $ info aststatistics # All options and input/output.
+# $ info gnuastro "Configuration files" # How to use configuration files.
#
-# Copying and distribution of this file, with or without modification,
-# are permitted in any medium without royalty provided the copyright
-# notice and this notice are preserved. This file is offered as-is,
-# without any warranty.
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and
+# this notice are preserved. This file is offered as-is, without any
+# warranty.
# Input image:
diff --git a/bin/table/asttable.conf b/bin/table/asttable.conf
index 393aca5..fc88f34 100644
--- a/bin/table/asttable.conf
+++ b/bin/table/asttable.conf
@@ -1,18 +1,18 @@
# Default parameters (System) for Table.
# Table is part of GNU Astronomy Utitlies.
#
-# Use the long option name of each paramter followed by
-# a value. The name and value should be separated by
-# atleast one of the following charaacters:
-# space, `,`, `=` or `:`
+# Use the long option name of each parameter followed by a value. The name
+# and value should be separated by atleast one white-space character (for
+# example ` '[space], or tab). Lines starting with `#' are ignored.
#
-# Run with `--help` option or read the manual for a full
-# explanation of what each option means.
+# For more information, please run these commands:
#
-# NOTE I: All counting is from zero, not one.
-# NOTE II: Lines starting with `#` are ignored.
+# $ asttable --help # Full list of options, short doc.
+# $ asttable -P # Print all options and used values.
+# $ info asttable # All options and input/output.
+# $ info gnuastro "Configuration files" # How to use configuration files.
#
-# Copying and distribution of this file, with or without modification,
-# are permitted in any medium without royalty provided the copyright
-# notice and this notice are preserved. This file is offered as-is,
-# without any warranty.
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and
+# this notice are preserved. This file is offered as-is, without any
+# warranty.
diff --git a/bin/warp/astwarp.conf b/bin/warp/astwarp.conf
index a43f8fd..26a3af4 100644
--- a/bin/warp/astwarp.conf
+++ b/bin/warp/astwarp.conf
@@ -1,21 +1,21 @@
# Default parameters (System) for Warp.
# Warp is part of GNU Astronomy Utitlies.
#
-# Use the long option name of each paramter followed by
-# a value. The name and value should be separated by
-# atleast one of the following charaacters:
-# space, `,`, `=` or `:`
+# Use the long option name of each parameter followed by a value. The name
+# and value should be separated by atleast one white-space character (for
+# example ` '(space), or tab). Lines starting with `#' are ignored.
#
-# Run with `--help` option or read the manual for a full
-# explanation of what each option means.
+# For more information, please run these commands:
#
-# NOTE I: All counting is from zero, not one.
-# NOTE II: Lines starting with `#` are ignored.
+# $ astwarp --help # Full list of options, short doc.
+# $ astwarp -P # Print all options and used values.
+# $ info astwarp # All options and input/output.
+# $ info gnuastro "Configuration files" # How to use configuration files.
#
-# Copying and distribution of this file, with or without modification,
-# are permitted in any medium without royalty provided the copyright
-# notice and this notice are preserved. This file is offered as-is,
-# without any warranty.
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and
+# this notice are preserved. This file is offered as-is, without any
+# warranty.
# Input:
diff --git a/lib/gnuastro-internal/fixedstringmacros.h
b/lib/gnuastro-internal/fixedstringmacros.h
index 745aebc..4d7d685 100644
--- a/lib/gnuastro-internal/fixedstringmacros.h
+++ b/lib/gnuastro-internal/fixedstringmacros.h
@@ -47,14 +47,13 @@ along with Gnuastro. If not, see
<http://www.gnu.org/licenses/>.
/* This is fixed for all the packages. */
#define GAL_STRINGS_MORE_HELP_INFO \
"\nFor more information, please run any of the " \
- "following commands. They will respectively show you the `Invoking " \
- PROGRAM_NAME"' subsection, the complete `"PROGRAM_NAME"' section, or "\
- "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" \
+ "following commands. In particular the second contains a very " \
+ "comprehensive explanation of "PROGRAM_NAME"'s invocation: expected " \
+ "input(s), output(s), and a full description of all the options.\n\n" \
+ " All options and their values: $ "PROGRAM_EXEC" -P\n" \
+ " Inputs/Outputs and options: $ info "PROGRAM_EXEC"\n" \
+ " Full section in manual/book: $ info "PROGRAM_NAME"\n" \
+ " Full Gnuastro manual/book: $ 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" \
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [gnuastro-commits] master 170fb7d: Corrected comments in configuration files,
Mohammad Akhlaghi <=