[gnuastro-commits] master 18296a2: Book: added example for --primaryimghdu (Fits program)

[Mohammad Akhlaghi]

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

    Book: added example for --primaryimghdu (Fits program)
    
    Hamed Altafi suggested adding an example for this option to make it easier
    to use.
---
 doc/announce-acknowledge.txt | 1 +
 doc/gnuastro.texi            | 8 ++++++++
 2 files changed, 9 insertions(+)

diff --git a/doc/announce-acknowledge.txt b/doc/announce-acknowledge.txt
index dc0de6f..766dfb9 100644
--- a/doc/announce-acknowledge.txt
+++ b/doc/announce-acknowledge.txt
@@ -1,5 +1,6 @@
 Alphabetically ordered list to acknowledge in the next release.
 
+Hamed Altafi
 Raúl Infante Sainz
 Sebastián Luna Valero
 
diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index 64b0505..35677c6 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -7729,6 +7729,14 @@ This is because of the unique position the first FITS 
extension has in the FITS
 @item --primaryimghdu
 Copy or cut an image HDU to the zero-th HDU/extension a file that doesn't yet 
exist.
 This option is thus irrelevant if the output file already exists or the 
copied/cut extension is a FITS table.
+For example with the commands below, first we make sure that @file{out.fits} 
doesn't exist, then we copy the first extension of @file{in.fits} to the 
zero-th extension of @file{out.fits}.
+
+@example
+$ rm -f out.fits
+$ astfits in.fits --copy=1 --primaryimghdu --output=out.fits
+@end example
+
+If we hadn't used @option{--primaryimghdu}, then the zero-th extension of 
@file{out.fits} would have no data, and its second extension would host the 
copied image (just like any other output of Gnuastro).
 
 @end table