gschem/docs/gschem.1.in

   1 .TH gschem 1 "@DATE@" "gEDA Project" @VERSION@
   2 .SH NAME
   3 gschem - gEDA/gaf Schematic Capture
   4 .SH SYNOPSIS
   5 .B gschem
   6 [\fIOPTION\fR...] [--] [\fIFILE\fR...]
   7 .SH DESCRIPTION
   8 .PP
   9 .B gschem
  10 is a schematic capture application and is part of the
  11 gEDA (GPL Electronic Design Automation) toolset.  It is used to draw
  12 electronic schematics which describe the logical structure of a
  13 circuit.  Schematics are made up of symbols which represent the
  14 various components in the circuit and are obtained either from a
  15 standard library or created by the user.  The connections between
  16 components represented by nets (wires).  Schematics may be exported
  17 to PDF and PostScript files for printing or to other output formats
  18 for further conversion.  Output to various image formats is also
  19 supported.
  20
  21 .B gschem
  22 can also be used for editing symbols for use in
  23 schematics.
  24
  25 .SH OPTIONS
  26 .TP 8
  27 \fB-q\fR, \fB--quiet\fR
  28 Quiet mode. Turn off all warnings/notes/messages.
  29 .TP 8
  30 \fB-v\fR, \fB--verbose\fR
  31 Verbose mode.  Output all diagnostic information.
  32 .TP 8
  33 \fB-r\fR, \fB--config-file\fR=\fIFILE\fR
  34 Specify an additional configuration file.  Normally \fBgschem\fR
  35 searches for the system configuration file, then
  36 `$HOME/.gEDA/gschemrc', and finally for a `gschemrc' file in the
  37 current working directory.  This option allows the user to specify an
  38 additional rc file which is read after all the other rc files have
  39 been are read.
  40 .TP 8
  41 \fB-L\fR \fIDIRECTORY\fR
  42 Prepend \fIDIRECTORY\fR to the list of directories to be searched for
  43 Scheme files.
  44 .TP 8
  45 \fB-s\fR \fIFILE\fR
  46 Specify a Scheme script to be executed at startup.
  47 .TP 8
  48 \fB-c\fR \fIEXPR\fR
  49 Specify a Scheme expression to be evaluated at startup.
  50 .TP 8
  51 \fB-o\fR, \fB--output\fR=\fIFILE\fR
  52 Specify a filename for PostScript output.  This command line argument
  53 is useful when running \fBgschem\fR from a shell script and with a
  54 Scheme script.  The filename can be changed through the print dialog
  55 box.
  56 .TP 8
  57 \fB-p\fR
  58 Automatically place the window. This may be useful if running \fBgschem\fR
  59 from the command line and generating output.
  60 .TP 8
  61 \fB-h\fR, \fB--help\fR
  62 Print a help message.
  63 .TP 8
  64 \fB-V\fR, \fB--version\fR
  65 Print \fBgschem\fR version information.
  66 .TP 8
  67 \fB--\fR
  68 Treat all remaining arguments as schematic or symbol filenames.  Use
  69 this if you have a schematic or symbol filename which begins with `-'.
  70
  71 .SH SCHEMATIC AND SYMBOL FILES
  72 Optionally, schematic or symbol \fIFILE\fRs may be specified on the
  73 command line.  Any schematic or symbols specified are loaded at
  74 startup as separate documents in the schematic editor.
  75 .PP
  76 If no \fIFILE\fRs are specified, a blank schematic is created for
  77 editing.
  78
  79 .SH ENVIRONMENT
  80 .TP 8
  81 .B GEDADATA
  82 specifies the search directory for Scheme and rc files.  The default
  83 is `${prefix}/share/gEDA'.
  84 .TP 8
  85 .B GEDADATARC
  86 specifies the search directory for rc files.  The default is `$GEDADATA'.
  87 .TP 8
  88 .B GEDALOG
  89 specifies the directory to which to write log files.  The default is
  90 `~/.gEDA/logs'.
  91
  92 .SH AUTHORS
  93 See the `AUTHORS' file included with this program.
  94
  95 .SH COPYRIGHT
  96 .nf
  97 Copyright \(co 1999-@YEAR@ gEDA Contributors.  License GPLv2+: GNU GPL
  98 version 2 or later.  Please see the `COPYING' file included with this
  99 program for full details.
 100 .PP
 101 This is free software: you are free to change and redistribute it.
 102 There is NO WARRANTY, to the extent permitted by law.
 103
 104 .SH SEE ALSO
 105 \fBgnetlist\fR(1), \fBgsymcheck\fR(1)
 106 .PP
 107 The full documentation for
 108 .B gschem
 109 is available from within the program by selecting the `gEDA
 110 Documentation' option from the program's `Help' menu.