git.gag.com Git - debian/atlc/blob - src/non_gui/usage_atlc.c

   1 /* atlc - arbitrary transmission line calculator, for the analysis of
   2 transmission lines are directional couplers.
   3
   4 Copyright (C) 2002. Dr. David Kirkby, PhD (G8WRB).
   5
   6 This program is free software; you can redistribute it and/or
   7 modify it under the terms of the GNU General Public License
   8 as published by the Free Software Foundation; either package_version 2
   9 of the License, or (at your option) any later package_version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with this program; if not, write to the Free Software
  18 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,
  19 USA.
  20
  21 Dr. David Kirkby, e-mail drkirkby at ntlworld.com
  22
  23 */
  24
  25 #include "config.h"
  26
  27 #ifdef HAVE_STDLIB_H
  28 #include <stdlib.h>
  29 #endif
  30
  31 #include "definitions.h"
  32
  33 void usage_atlc(void)
  34 {
  35 #ifdef ENABLE_POSIX_THREADS
  36   fprintf(stderr,"Usage: atlc [options ...] bitmap\n\n");
  37 #endif
  38   fprintf(stderr,"atlc %s: options are:\n",PACKAGE_VERSION);
  39   fprintf(stderr,"  -C       \n      Print Licence and copying information\n");
  40   fprintf(stderr,"  -s       \n      Skip writing the Ex, Ey, E, V, U and Er files bitmap (.bmp) files\n");
  41   fprintf(stderr,"  -S       \n      Skip writing the Ex, Ey, E, V, U and Er files binary (.bin) files\n");
  42   fprintf(stderr,"  -v       \n      Be verbose (-vv -vvv or -vvvv gives progressively more information)\n");
  43   fprintf(stderr,"  -c cutoff\n      where 'cutoff' sets the cutoff criteria - see html docs or man page.\n");
  44   fprintf(stderr,"  -d rrggbb=Er\n      where the colour rrggbb (in hex) is a (d)ielectric of permittivity Er.\n");
  45   fprintf(stderr,"  -i factor\n      which lightens (factor>%.1f) or darkens (1.0 <factor<%.1f) output bitmaps.\n",
  46   IMAGE_FIDDLE_FACTOR,IMAGE_FIDDLE_FACTOR);
  47   fprintf(stderr,"  -p prefix\n      where 'prefix' is a name (normally a directory) added in front of output files\n");
  48   fprintf(stderr,"  -r rate_multiplier\n      where 'rate_multiplier' sets the rate multipler (1 <= r < 2)\n");
  49 #ifdef ENABLE_POSIX_THREADS
  50   fprintf(stderr,"  -t THREADs. \n      Where THREADs is the number of threads to use (normally best set to \n      the number of cpus). The default is %d. Set to 0 for single threaded algorithm.\n",MAX_THREADS);
  51 #endif
  52 #ifdef ENABLE_MPI
  53   fprintf(stderr,"  -w weights\n     where weights is a colon-separated list of weights to use when dividing up the work amongst the processors.\n");
  54 #endif
  55 /*
  56 #ifndef ENABLE_POSIX_THREADS
  57   fprintf(stderr,"****************NOTE******************************\n");
  58   fprintf(stderr,"The -t option setting the number of threads to use is disabled since\n");
  59   fprintf(stderr,"since this was not configured with multi-processor support.\n");
  60   fprintf(stderr,"To add support for multiple threads (for an MP machine), \"make clean\" then \nre-run the configure script with the option --with-threads\n");
  61 #endif
  62 */
  63 #ifndef ENABLE_MPI
  64   fprintf(stderr," ");
  65 /*
  66   fprintf(stderr,"****************NOTE******************************\n");
  67   fprintf(stderr,"The -w option setting the weights to use when dividing up the work for\n");
  68   fprintf(stderr,"multiple CPUs on distributed processors is disabled since this was not\n");
  69   fprintf(stderr,"for distributed processing. To add such support, \"make clean\" then re-run\n");
  70   fprintf(stderr,"the configure script with the option --with-mpi\n");
  71   */
  72 #endif
  73 #ifdef WINDOWS
  74   fprintf(stderr,"****************NOTE******************************\n");
  75   fprintf(stderr,"The -t and -w options are disabled disabled since\n");
  76   fprintf(stderr,"this is a Windoze executable.\n");
  77   fprintf(stderr,"There are no plans to add multi-processor or distributed\n");
  78   fprintf(stderr,"processing to Windoze.\n");
  79
  80 #endif
  81 }