gschem/docs/gschem.1

   1 .TH gschem 1 "August 30th, 2009" Version 1.5.4.20090830
   2 .SH NAME
   3 gschem - gEDA/gaf Schematic Capture
   4 .SH SYNOPSIS
   5 .B gschem
   6 [-q] [-v] [-t] [-r rcfilename] [-s scriptfilename] [-o outputfilename] [-p] [-h] [schematic1 ... schematicN]
   7 .SH DESCRIPTION
   8 .PP
   9 \fIgschem\fP is the schematic capture program which is part gEDA
  10 (GPL Electronic Design Automation) toolset.  This program is used to draw
  11 electronic schematics.  Schematics consist of standard symbols (which
  12 are either part of a standard library or created by the user) which
  13 represent the various gates and components.  These components are then
  14 interconnected by nets (wires).  Schematics may be printed to a
  15 PostScript file for printing or further conversion to other output
  16 formats.  Output to various image formats is also supported.
  17
  18 \fIgschem\fP is also the symbol creation editor.  All the standard
  19 methods of creating schematics are used in the creation of symbols. There
  20 are a few special rules when creating symbols, so please refer to the
  21 (non-existant as of now) symbol creation document.
  22
  23 Please read the official documentation (very minimal at this point)
  24 on how to use \fIgschem\fP, since this man page just describes the command
  25 line arguments and a few examples on how to run \fIgschem\fP.
  26
  27 .SH OPTIONS
  28 .l
  29 \fIgschem\fP accepts the following options:
  30 .TP 8
  31 .B -q
  32 Quiet mode on.  This mode turns off all warnings/notes/messages. (optional)
  33 .TP 8
  34 .B -v
  35 Verbose mode on.  This mode gives as much feedback to the user as possible. (optional)
  36 .TP 8
  37 .B -t
  38 Print out more information when using mouse strokes.  With this command
  39 line flag and the middle button configured for mouse strokes, gschem
  40 will output the stroke sequence numbers as the user executes strokes.
  41 These numbers can be used to define new strokes in the system-gschemrc file.
  42 .TP 8
  43 .B -r filename
  44 Specify a rc filename.  Normally \fIgschem\fP searches for the system-gschemrc, then
  45 ~/.gEDA/gschemrc, and finally for a gschemrc in the current directory.  This
  46 options allows the user to specify an additional rc file which is read after
  47 all the other rc files are read. (optional)
  48 .TP 8
  49 .B -s filename
  50 Specify a guile script to be executed at startup. (optional)
  51 .TP 8
  52 .B -o filename
  53 Specify a filename for postscript output.  This command line argument is
  54 useful when running \fIgschem\fP from a shell script and with a guile script.  The
  55 filename can be changed through
  56 the print dialog box.
  57 .TP 8
  58 .B -p
  59 Automatically place the window, especially useful if running gschem from the
  60 command line and generating output.
  61 .TP 8
  62 .B -h
  63 Print out short command line help.
  64 .TP 8
  65 .B schematic1 [... schematicN]
  66 Schematic file to be loaded.  Specifing a schematic file is optional.  If
  67 multiple schematic files are specified they are read in sequentially and
  68 put on seperate pages.  It is important that the schematic(s) follow
  69 all the options (ie last).
  70
  71 .SH EXAMPLES
  72 These examples assume that you have a schematic called stack_1.sch in
  73 the current directory
  74
  75 To run \fIgschem\fP and then interact with the program:
  76
  77         gschem
  78 .br
  79
  80 To run \fIgschem\fP in interactive mode but load a sample schematic:
  81
  82         gschem adders_1.sch
  83
  84 To run \fIgschem\fP and load up all schematics in the current subdirectory:
  85
  86         gschem *.sch
  87
  88 .SH "ENVIRONMENT"
  89 \fIgschem\fP respects the following environment variable:
  90 .PP
  91 .TP 8
  92 .B GEDADATA
  93 specifies where the various required scheme and rc files are located
  94 (the default is ${prefix}/share/gEDA).  This environment variables does
  95 not need to be set by the end user unless they are moving the executables
  96 to a new install ${prefix}.
  97
  98 .SH "AUTHOR"
  99 Ales Hvezda and many others
 100
 101 .SH SEE ALSO
 102 .BR gnetlist (1),
 103 .BR gsymcheck (1)
 104 .SH COPYRIGHT
 105 .nf
 106 Copyright \(co  1999-2008 Ales Hvezda
 107
 108 This document can be freely redistributed according to the terms of the
 109 GNU General Public License version 2.0
 110