utils/docs/garchive.1

   1 .TH garchive 1 "November 23rd, 2012" "gEDA Project" 1.8.1.20121123
   2
   3 .SH NAME
   4 garchive \- create and extract gEDA design archives
   5
   6 .SH SYNOPSIS
   7 .B garchive [
   8 .I options
   9 .B ] [-o
  10 .I output_file
  11 .B ]
  12 .I file
  13 .B ...
  14
  15 .SH DESCRIPTION
  16 .B garchive
  17 creates and extracts gEDA designs from an archive. The two modes of
  18 operation are "archive mode" (archive creation) and "extract mode".
  19 In archive mode it creates a project archive from a bunch of project
  20 files, and in extract mode it extracts the files from the archive and
  21 places them in the local dir.
  22 .PP
  23 Archive mode is the default.
  24
  25 .SH OPTIONS
  26 .TP
  27 \-f filename
  28 Optional.  Used in archive mode.  Read files to archive from <filename>
  29 instead of garchiverc.
  30 .TP
  31 \-v
  32 Verbose mode.
  33 .TP
  34 \-e
  35 Extract the archive specified on the command line.
  36 .TP
  37 \-a
  38 Create an archive. This is the default.
  39 .TP
  40 \-o outfile
  41 Optional.  Used in archive mode.  Specifies the name of the
  42 output archive file.  The output file extension should be ".tar.gz".
  43 If this flag is not specified, the output file name is
  44 "ProjectArchive.tar.gz".
  45 .SH EXAMPLES
  46 To create an archive named MyArchive.tar.gz (the files to store listed in
  47 garchiverc):
  48 .IP
  49 garchive \-o MyArchive.tar.gz
  50 .PP
  51 Verbosely create an archive (archives files listed on cmd line
  52 as well as those listed in garchiverc):
  53 .IP
  54 garchive \-v \-o MyArchive.tar.gz README Schematic1.sch Schematic2.sch Schematic3.sch
  55 .PP
  56 Extract an archive:
  57 .IP
  58 garchive \-e ProjectArchive.tar.gz
  59
  60 .SH AUTHOR
  61 Stuart Brorson <sdb@cloud9.net>
  62
  63 .SH SEE ALSO
  64 .BR gschem (1)
  65
  66 .SH COPYRIGHT
  67 .nf
  68 Copyright \(co 1999-2011 gEDA Contributors.  License GPLv2+: GNU GPL
  69 version 2 or later.  Please see the `COPYING' file included with this
  70 program for full details.
  71 .PP
  72 This is free software: you are free to change and redistribute it.
  73 There is NO WARRANTY, to the extent permitted by law.