static const char isaacp_man_date[] = "$Date: 2001/07/31 07:26:34 $" ; static const char isaacp_man[] = "\n" "\n" "***** ISAAC pipeline use\n" "\n" "\n" "\n" "This command implements most of the ISAAC pipeline recipes.\n" "All supported recipes share a similar user-interface for\n" "parameters and command-line arguments, these conventions\n" "are described below.\n" "\n" "To get more help, you can try:\n" "\n" "% isaacp -- list of all supported recipes.\n" "% isaacp man -- this help.\n" "% isaacp recipe -- short command-line help.\n" "% isaacp man recipe -- man page for the recipe.\n" "\n" "% isaacp manual -- generate full documentation\n" "% isaacp manual html -- generate full HTML documentation\n" "\n" "The two latter options will create a directory in the\n" "current working dir, and populate it with files containing\n" "manual pages for all supported recipes. This might be handy\n" "for printing or browsing the documentation. You can\n" "request the doc in ASCII (isaacp manual) or in HTML\n" "format (isaacp manual html).\n" "\n" "\n" "OPTIONS\n" "\n" "All recipes present in this program share the following\n" "conventions for command-line options:\n" "\n" "\n" " * The first argument on the command-line must be\n" " 'isaacp' of course. The second argument must be\n" " the recipe name.\n" "\n" " * All recipes require at least one argument, which\n" " is the input name of the file or files to process.\n" " Some recipes accept several input files, some\n" " recipes accept only one file. Some recipes are\n" " expecting FITS frames, some are expecting ASCII\n" " lists. Check out the recipe manual to see what\n" " kind of input is expected.\n" "\n" " * Without any other option, all recipes will start\n" " processing the input file(s) using default parameters.\n" " You can change the behaviour of a recipe by specifying\n" " different values. These options are local to each\n" " recipe, check out the recipe manual to see what the\n" " different options are.\n" "\n" " * Recipe-specific options can be placed anywhere on\n" " the command-line. The following are equivalent:\n" "\n" " % isaacp recipe input -a alpha -b beta -flag\n" " % isaacp recipe -a alpha input -b beta -flag\n" " % isaacp recipe -flag -a alpha -b beta input\n" " etc.\n" "\n" " * All recipes handle short and long options. Short\n" " options consist of one dash (-) and one character\n" " (a letter or a digit). All short options have\n" " a long option equivalent. Long options consist\n" " of a double dash (--) and a string. Both forms\n" " are equivalent. The short option is easier to\n" " type, the long option is usually preferred in\n" " scripts to enhance readability of the command\n" " call.\n" "\n" " * You can always provide an output file name to a\n" " recipe by using the -o/--output option. You are\n" " expected to provide a base name which will be used\n" " by the recipe to name its output files. An output\n" " file name looks like:\n" "\n" " base_type.ext\n" "\n" " where:\n" "\n" " base is the base name you provide with -o/--output.\n" " type is a suffix indicating the file type.\n" " ext is the file extension (fits, tfits, paf, ...).\n" "\n" " For example, using the 'twflat' recipe with the\n" " option -o twilight as:\n" "\n" " % isaacp twflat input -o twilight\n" "\n" " will produce a flat-field called 'twilight_flat.fits'.\n" " Notice that you can provide a base name containing\n" " a path, like: /data/reduced/calib/twilight, in which\n" " case the output name would be:\n" " /data/reduced/calib/twilight_flat.fits\n" " But you must then make sure that the path you give\n" " is suitable for writing.\n" "\n" " If you provide a base name containing an extension,\n" " the recipe will silently truncate the extension and\n" " use the result as a base name, so it is equivalent\n" " to provide:\n" "\n" " -o twilight\n" " -o twilight.fits\n" "\n" " * If you do not use the -o/--output option, the recipe\n" " will make an output name for you, by using the input\n" " file name. The rule is to truncate any path in the\n" " input file name and any extension. So if your input\n" " file is called /data/raw/input_list.ascii, the recipe\n" " will use 'input_list' as an output base name. This\n" " means that all recipe products are then produced in\n" " the current working directory. The following calls\n" " will all produce files with the same name in the\n" " same directory (.):\n" "\n" " isaacp recipe input\n" " isaacp recipe input.fits\n" " isaacp recipe /data/input\n" " isaacp recipe /data/raw/input.fits\n" "\n" " * It is usually not possible to predict the number\n" " of files which will be produced by a given recipe.\n" " This is due to the fact that the products naturally\n" " depend on the input data. An example is the\n" " 'dark-avg' recipe which will produce one output\n" " master dark file per consistent data set in the\n" " input list.\n" " To be able to write scripts dealing with data\n" " produced by a pipeline recipe, it is usually a\n" " good idea to force the output name using the\n" " -o/--output option to a place where you can retrieve\n" " all files with a wildcard. Example:\n" "\n" " % isaacp dark input -o ./tmp/result\n" "\n" " The above command will e.g. produce files called:\n" "\n" " ./tmp/result_001.fits\n" " ./tmp/result_002.fits\n" " ./tmp/result_003.fits\n" " ./tmp/result_ron.paf\n" "\n" " Using the wildcard ./tmp/result* you can group\n" " all files produced by the recipe in the same\n" " command-line argument.\n" "\n" "Enjoy!\n" "-- \n" "The ISAAC pipeline team\n";