gschem/docs/gschem.1

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