contrib/scripts/sw2asc.1.in

   1 .TH sw2asc 1 "@DATE@" "gEDA Project" @VERSION@
   2
   3 .SH NAME
   4 .B sw2asc
   5 \- converts a SWITCAP2 output file into ASCII data files that other tools can read
   6
   7 .SH SYNOPSIS
   8 .B sw2asc \-c\||\-\-copyright
   9
  10 .B sw2asc \-h\||\-\-help
  11
  12 .B sw2asc \-V\||\-\-version
  13
  14 .B sw2asc
  15 .I switcap.out
  16
  17 .SH DESCRIPTION
  18
  19 The
  20 .I sw2asc
  21 program reads the switcap.out output file produced by SWITCAP2 and produces
  22 a set of ASCII datafiles which can be more easily loaded into various waveform
  23 plotting programs.
  24
  25 Data generated by SWITCAP2 "PRINT" statements is;
  26 extracted and written to an output file in an ASCII format which can be
  27 directly loaded by the
  28 .I gwave
  29 waveform viewer or more easily loaded into
  30 a tool such as
  31 .I scilab
  32 ,
  33 .I octave
  34 ,
  35 .I grace,
  36 , or
  37 .I matlab
  38 .
  39
  40 If multiple analyses are in the SWITCAP2 output file, then they are written
  41 to individual files.  The output file names are derived from the input
  42 file name by appending ".{SSS,TRAN}.#.asc"" to the name of the input file.
  43 SSS is used for Sinusoidal Steady State analysis output and TRAN is used for.
  44 TRANsient analysis output.  # corresponds to the analysis number (ie if you
  45 have 3 SSS analyses in your file, you will end up with .SSS.1.asc, .SSS.2.asc,
  46 and .SSS.3.asc.
  47
  48 .SH OPTIONS
  49 .TP
  50 \-c, \-\-copyright
  51 prints copyright information and exits
  52 .TP
  53 \-h, \-\-help
  54 prints help message and exits
  55 .TP
  56 \-V, \-\-version
  57 prints version information and exits
  58
  59 .SH EXIT STATUS
  60 .I sw2asc
  61 will return 0 on success and non-zero
  62 if the command did not complete successfully.
  63
  64 .SH SEE ALSO
  65 SWITCAP2 users manual
  66
  67
  68