User Tools

Site Tools


geda:gaf_utility

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
Next revision Both sides next revision
geda:gaf_utility [2013/07/08 08:18]
vzh created a page describing the gaf utility (mostly gaf config)
geda:gaf_utility [2014/07/15 07:49]
vzh Fix several links and a typo
Line 47: Line 47:
  
 Key values in the gEDA config files may be single numbers or Key values in the gEDA config files may be single numbers or
-lists. ​ Note that unlike the [[#geda export]] command, where+lists. ​ Note that unlike the [[#gaf export]] command, where
 several list separators can be used, the only separator between several list separators can be used, the only separator between
 list values in the config files is semicolon ';'​. Another difference list values in the config files is semicolon ';'​. Another difference
Line 66: Line 66:
 //**Table 1.**// **export** group parameters //**Table 1.**// **export** group parameters
 ^  Key        ^ Format ​                                                               ^  Default ​              ^ ^  Key        ^ Format ​                                                               ^  Default ​              ^
-| align       | string ​''​auto'' ​or list of two integers in the form ''​HALIGN;​VALIGN''​ |  auto                  |+| align       | string ​"auto" ​or list of two integers in the form ''​HALIGN;​VALIGN'' ​  ​|  auto                  |
 | dpi         | integer ​                                                              ​| ​ 96                    | | dpi         | integer ​                                                              ​| ​ 96                    |
 | font        | string ​                                                               |  Arial                 | | font        | string ​                                                               |  Arial                 |
Line 72: Line 72:
 | margins ​    | list of four integers in the form ''​TOP;​LEFT;​BOTTOM;​RIGHT'' ​          ​| ​ 18;​18;​18;​18 ​          | | margins ​    | list of four integers in the form ''​TOP;​LEFT;​BOTTOM;​RIGHT'' ​          ​| ​ 18;​18;​18;​18 ​          |
 | monochrome ​ | boolean ​                                                              ​| ​ true                  | | monochrome ​ | boolean ​                                                              ​| ​ true                  |
-| paper       | predefined paper size string, see [[#​paper|notes below]] ​             ​|  //locale dependent// ​ | +| paper       | predefined paper size string ​                                         |  //locale dependent// ​ | 
-| size        | string ​''​auto'' ​or list of two integers in the form ''​HEIGHT;​WIDTH'' ​ |  auto                  |+| size        | string ​"auto" ​or list of two integers in the form ''​HEIGHT;​WIDTH'' ​   |  auto                  |
  
 === align === === align ===
Line 99: Line 99:
 === layout === === layout ===
 When using a paper size, set the orientation of the output. ​ If When using a paper size, set the orientation of the output. ​ If
-''​auto'' ​layout is used, the orientation that best fits the+"auto" ​layout is used, the orientation that best fits the
 drawing will be used. drawing will be used.
  
Line 130: Line 130:
 === size === === size ===
 Size the output with specific dimensions. ​ If the size is Size the output with specific dimensions. ​ If the size is
-''​auto''​, select the size that best fits the drawing.+"auto", select the size that best fits the drawing.
  
 The paper size set by the ''​size''​ key overrides that one set by the The paper size set by the ''​size''​ key overrides that one set by the
Line 156: Line 156:
 schematic. schematic.
  
-It is used to create netnames of the form ''​unnamed_netN''​+It is used to create netnames of the form "unnamed_netN"
 where ''​N''​ is a number. where ''​N''​ is a number.
  
Line 185: Line 185:
 in **gschem**. in **gschem**.
  
-It is used to create filenames of the form ''​untitled_N.sch''​+It is used to create filenames of the form "untitled_N.sch"
 where ''​N''​ is a number. where ''​N''​ is a number.
  
Line 192: Line 192:
 //**Table 4.**// **gschem.library** group parameters //**Table 4.**// **gschem.library** group parameters
 ^  Key                    ^  Format ​                                                  ​^ ​ Default ​             ^ ^  Key                    ^  Format ​                                                  ​^ ​ Default ​             ^
-| component-attributes ​   | comma separated list of attribute names                   | *                     ​+| component-attributes ​   | comma separated list of attribute names                   ​| ​                    
-| sort                    | boolean ​                                                  | false                 ​|+| sort                    | boolean ​                                                  ​| ​ false                |
  
 === component-attributes === === component-attributes ===
Line 214: Line 214:
 ==== gschem.printing group ==== ==== gschem.printing group ====
 //**Table 5.**// **gschem.printing** group parameters //**Table 5.**// **gschem.printing** group parameters
-^  Key        ^  Format ​                                                  ​^ ​ Default ​             +^  Key        ^  Format ​                                                  ​^ ​ Default ​              ​
-| layout ​     | predefined string: "​portrait",​ "​landscape",​ or "​auto" ​    | auto                  | +| layout ​     | predefined string: "​portrait",​ "​landscape",​ or "​auto" ​    ​| ​ auto                  | 
-| monochrome ​ | boolean ​                                                  | false                 | +| monochrome ​ | boolean ​                                                  ​| ​ false                 | 
-| paper       | predefined paper size string, see [[#paper|notes below]] ​ //locale dependent// ​ |+| paper       | predefined paper size string ​                             |  //locale dependent// ​ |
  
 === layout === === layout ===
 When using a paper size, set the orientation of the output. ​ If When using a paper size, set the orientation of the output. ​ If
-''​auto'' ​layout is used, the orientation that best fits the+"auto" ​layout is used, the orientation that best fits the
 drawing will be used. drawing will be used.
  
 **gschem** page orientation is intended to output pages to a **gschem** page orientation is intended to output pages to a
-printer rather than to PDF, so the value ''​auto'' ​means that if+printer rather than to PDF, so the value "auto" ​means that if
 you output pages to PDF you will get rotated landscape instead of you output pages to PDF you will get rotated landscape instead of
 ordinary. To get readable PDF with pages in landscape use instead ordinary. To get readable PDF with pages in landscape use instead
-the [[#gaf export]] command, and set to ''​auto'' ​the ''​layout''​ key +the [[#gaf export]] command, and set to "auto" ​the ''​layout''​ key 
-in the ''​export'' ​group.+in the [[#export group]].
  
-Note: as of now, printing using the script ''​print.scm''​ doesn'​t+Note: as of now, printing using the script ​//''​print.scm''​// doesn'​t
 use the ''​layout''​ key setting. use the ''​layout''​ key setting.
  
Line 239: Line 239:
 The default ''​paper''​ value depends on the current locale. The default ''​paper''​ value depends on the current locale.
 See the notes on the paper size above in the description of the See the notes on the paper size above in the description of the
-''​paper''​ key for the [[#gaf export|export]] ​group.+''​paper''​ key for the [[#​export ​group]].
  
 === monochrome === === monochrome ===
Line 245: Line 245:
  
 It is intended that unlike the ''​monochrome''​ value in the It is intended that unlike the ''​monochrome''​ value in the
-[[#gaf export|export]] ​group, the key value in this group is **false**.+[[#​export ​group]], the key value in this group is ''​false''​.
  
  
Line 290: Line 290:
 ^  gschem.dialog-geometry.multiattrib ​                                                                      ^^^ ^  gschem.dialog-geometry.multiattrib ​                                                                      ^^^
 ^  Key                    ^  Format ​                                                  ​^ ​ Default ​             ^ ^  Key                    ^  Format ​                                                  ​^ ​ Default ​             ^
-| show_inherited ​         | boolean ​                                                  | true                  |+| show_inherited ​         | boolean ​                                                  ​| ​ true                 ​|
  
 Note: all these values are automatically stored in the user Note: all these values are automatically stored in the user
Line 303: Line 303:
  
 === y === === y ===
-position of the dialog window.+position of the dialog window.
  
 === width === === width ===
Line 379: Line 379:
 ===== Examples ===== ===== Examples =====
 ==== Set up exporting ==== ==== Set up exporting ====
-Use the ''​landscape'' ​layout by default for a local project:+Use the "landscape" ​layout by default for a local project:
   gaf config --project export layout landscape   gaf config --project export layout landscape
-Use the ''​letter'' ​paper size by default for all your printouts:+Use the "letter" ​paper size by default for all your printouts:
   gaf config --user export paper na_letter   gaf config --user export paper na_letter
 Set paper size to the definite value of 1x2 inch for a local Set paper size to the definite value of 1x2 inch for a local
Line 413: Line 413:
   gaf config --user gnetlist default-net-name net   gaf config --user gnetlist default-net-name net
   gaf config --user gnetlist default-bus-name bus   gaf config --user gnetlist default-bus-name bus
-Ensure ​sure that a local project will use hierarchical net+Ensure that a local project will use hierarchical net
 names despite of settings in //''​geda-user.conf''//:​ names despite of settings in //''​geda-user.conf''//:​
   gaf config --project gnetlist traverse-hierarchy true   gaf config --project gnetlist traverse-hierarchy true
Line 420: Line 420:
 attribute: attribute:
   gaf config --project gnetlist net-naming-priority netname-attribute   gaf config --project gnetlist net-naming-priority netname-attribute
- 
  
 ==== Set up gschem ==== ==== Set up gschem ====
geda/gaf_utility.txt · Last modified: 2014/07/28 08:00 by vzh