doc/pcbrc-sample

   1 # ---- Sample pcbrc file
   2 #
   3 # A pcbrc file provides various configuration options for customizing
   4 # a pcb library environment beyond the installed defaults.  These pcbrc
   5 # files are loaded in this order if they exist:
   6 #
   7 # /etc/pcbrc
   8 # /usr/local/etc/pcbrc
   9 # ${prefix}/share/pcb/pcbrc
  10 # ~/.pcb/pcbrc
  11 # ./pcbrc
  12 #
  13 # Which allows for system wide, pcb install specific, user specific, and
  14 # project specific customization.  All of these options may also be
  15 # specified on the command line which will override any pcbrc settings
  16 # unless it is an append or prepend option.
  17 # If an append or prepend path is given on the command line, there must
  18 # be no spaces after the += or =+.  Eg:  pcb --element-path +=path
  19 # Final library paths and commands can be seen when running pcb in
  20 # verbose mode:  pcb -v
  21
  22 # Uncomment and edit any desired customization options below.  For the
  23 # defaults given, a ${prefix} is the install prefix.  It defaults to
  24 # /usr/local and is set to other values via the --prefix configure arg.
  25
  26
  27
  28 # Execute an initial action at startup.  This has no default.
  29 #
  30 #action-string  some actions
  31
  32 # Execute the actions in a script file at startup.  This has no default.
  33 #
  34 #action-script  script-filename
  35
  36
  37 # ------------ library options -----------------
  38 # Set the directory to search for the library command and library contents
  39 # command.  This defaults to:  ${prefix}/share/pcb/
  40 #
  41 # lib-command-dir  directory
  42
  43 # Set the library command for copying elements from the library.
  44 # This defaults to:  QueryLibrary.sh '%p' '%f' %a
  45 #
  46 #lib-command command
  47
  48 # Set the library contents command for listing the library contents.
  49 # This defaults to:  ListLibraryContents.sh '%p' '%f'
  50 #
  51 #lib-contents-command command
  52
  53 # Set or add to the library search path.  One of the three forms below
  54 # may used to respectively set, append to or prepend to the search path.
  55 # This defaults to:  ${prefix}/share/pcb
  56 #
  57 #lib-path  path
  58 #lib-path += path
  59 #lib-path =+ path
  60
  61 # Set or add to the newlib library path.  The set, append to or prepend to
  62 # forms may be used here as well.  Components to this path are also
  63 # per user configurable via the gui Preferences->Library and paths entered
  64 # there are prepended to the final path after all rc files have been
  65 # processed.  This defaults to:  ${prefix}/share/pcb/newlib
  66 #
  67 #lib-newlib path
  68 #lib-newlib += path
  69 #lib-newlib =+ path
  70
  71
  72 # ------------- layout font -----------------
  73 # Set the font command for processing the layout font file.
  74 # This defaults to:  M4PATH='%p';export M4PATH;echo 'include(%f)' | m4
  75 # where 'm4' may be the GNU 'gm4' as detected when configure was run.
  76 #
  77 #font-command  command
  78
  79 # Set the font path to search for the layout font file.
  80 # This defaults to:  .:${prefix}/share/pcb
  81 #
  82 #font-path path
  83 #font-path += path
  84 #font-path =+ path
  85
  86 # Set the layout font file name, defaults to:  default_font
  87 #
  88 #font-file  filename
  89
  90
  91 # --------------- elements -------------------
  92 # Set the command to load element files.
  93 # This defaults to:  M4PATH='%p';export M4PATH;echo 'include(%f)' | m4
  94 # where, again, m4 may be gm4
  95 #
  96 #element-command  command
  97
  98 # Set the element paths to search for elements.
  99 # This defaults to:  ${prefix}/share/pcb
 100 #
 101 #element-path  path
 102 #element-path += path
 103 #element-path =+ path
 104
 105
 106 # ---------------- misc ------------------
 107 # Set the defualt file name sequence to be used for printouts.
 108 #
 109 #print-file  %f.output
 110
 111 # These options are shown with their default value and are
 112 # unlikely to need customization.
 113 #
 114 #file-command  cat '%f
 115 #save-command  cat - > '%f'
 116
 117 # These options will set values used as the default for new layouts
 118 # and they are also user settable via the Preferences gui.  If these
 119 # options are given in a pcbrc file, they *will* override the users
 120 # Preference settings.
 121 #
 122 #groups layer-group-string
 123 #routes route-styles-string
 124 #board-size <width>x<height>
 125