Index: groups.html =================================================================== --- groups.html (revision 25138) +++ groups.html (revision 25139) @@ -118,5 +118,12 @@ from the logical tree are converted into binary (native C values like "long int" or "double") and are saved in C variables for the code to access them directly. + +

[hidlib] settings

+

+Settings marked with [hidlib] are those that are shared among all +applications based on pcb-rnd's hidlib. They have the same syntax +and meaning in all those applications. + Index: tree/appearance.html =================================================================== --- tree/appearance.html (revision 25138) +++ tree/appearance.html (revision 25139) @@ -6,11 +6,11 @@ compact boolean 0 when set: optimize GUI widget arrangement for small screen; may be wasting some screen space on large screen rat_thickness coord 0 mark_size coord 0 relative marker size - layer_alpha real 0 alpha value for layer drawing - drill_alpha real 0 alpha value for drill drawing text_host_bbox boolean 0 when moving a text object, the outline thin-draw should also include the bounding box term_label_size real 0 size of terminal labels, in pcb font scale (100 is for the normal size) subc_layer_per_side boolean 0 hide top or bottom placed subcircuit annotations if the view is showing the other side invis_other_groups boolean 0 render non-current group layers with the inivisble color black_current_group boolean 0 render all layers of the current group black, for maximum contrast + layer_alpha real 0 [hidlib] alpha value for layer drawing + drill_alpha real 0 [hidlib] alpha value for drill drawing Index: tree/appearance_color.html =================================================================== --- tree/appearance_color.html (revision 25138) +++ tree/appearance_color.html (revision 25139) @@ -3,9 +3,7 @@

subtree: appearance/color

node name type flags description -
background color 0 background and cursor color ...
crosshair color 0 different object colors -
cross color 0 crosshair, drc outline color
selected color 0 generic object selection color
via color 0 non-terminal padstack shape on current layer
via_far color 0 non-terminal padstack shape on non-current ('far side') layer @@ -19,10 +17,12 @@
invisible_objects color 0 other-side objects and padstack shapes on non-current layer
connected color 0 'connected' highlight (galvanic connections found)
warn color 0 warning highlight (e.g. object found to cause a short) -
off_limit color 0 on-screen background beyond the configured drawing area -
grid color 0 on-screen grid
layer color 0 default layer colors; when a new layer is created, a color from this list is assigned initially
mask color 0 default mask layer color (when a new mask layer is created)
paste color 0 default paste layer color (when a new paste layer is created)
element color 0 default silk layer color (when a new silk layer is created) +
background color 0 [hidlib] background and cursor color ... +
off_limit color 0 [hidlib] on-screen background beyond the configured drawing area +
grid color 0 [hidlib] on-screen grid +
cross color 0 [hidlib] crosshair, drc outline color
Index: tree/appearance_loglevels.html =================================================================== --- tree/appearance_loglevels.html (revision 25138) +++ tree/appearance_loglevels.html (revision 25139) @@ -3,12 +3,12 @@

subtree: appearance/loglevels

node name type flags description -
debug_tag string 0 log style tag of debug messages -
debug_popup boolean 0 whether a debug line should pop up the log window -
info_tag string 0 log style tag of info messages -
info_popup boolean 0 whether an info line should pop up the log window -
warning_tag string 0 log style tag of warnings -
warning_popup boolean 0 whether a warning should pop up the log window -
error_tag string 0 log style tag of errors -
error_popup boolean 0 whether an error should pop up the log window +
debug_tag string 0 [hidlib] log style tag of debug messages +
debug_popup boolean 0 [hidlib] whether a debug line should pop up the log window +
info_tag string 0 [hidlib] log style tag of info messages +
info_popup boolean 0 [hidlib] whether an info line should pop up the log window +
warning_tag string 0 [hidlib] log style tag of warnings +
warning_popup boolean 0 [hidlib] whether a warning should pop up the log window +
error_tag string 0 [hidlib] log style tag of errors +
error_popup boolean 0 [hidlib] whether an error should pop up the log window
Index: tree/editor.html =================================================================== --- tree/editor.html (revision 25138) +++ tree/editor.html (revision 25139) @@ -3,7 +3,6 @@

subtree: editor

node name type flags description -
grid_unit unit 0 select whether you draw in mm or mil
grid coord 0 grid in pcb-units
grids list 0 grid in grid-string format
grids_idx integer 0 the index of the currently active grid from grids @@ -22,7 +21,6 @@
save_last_command boolean 0 OBSOLETE: use the session-persistent command line history instead (press the up arrow)
line_refraction integer 0 value for line lookahead setting
save_in_tmp boolean 0 emergency save unsaved PCB data (despite the user clicks don't save) when: user starts a new PCB; user quits pcb-rnd. Does not affect the on-crash emergency save. -
draw_grid boolean 0 draw grid points
all_direction_lines boolean 0 enable lines to all directions
rubber_band_mode boolean 0 move, rotate use rubberband connections
rubber_band_keep_midlinedir boolean 0 keep line direction when a middle line is moved @@ -33,7 +31,6 @@
show_number boolean 0 OBSOLETE: pinout shows number
orthogonal_moves boolean 0 move items orthogonally.
reset_after_element boolean 0 OBSOLETE: reset connections after each element while saving all connections -
auto_place boolean 0 force placement of GUI windows (dialogs), trying to override the window manager
lock_names boolean 0 lock down text so they can not be moved or selected
only_names boolean 0 lock down everything else but text so only text objects can be moved or selected
thin_draw boolean 0 if set, objects on the screen are drawn as outlines (lines are drawn as center-lines). This lets you see line endpoints hidden under pins, for example. @@ -47,7 +44,6 @@
name_on_pcb boolean 0 obsolete - DO NOT USE - kept for compatibility
subc_id string 0 subcircuit ID template for diplaying the subcircuit label on the subcircuit layer; default to displaying the refes, if empty; syntax if the same as for DYNTEXT
term_id string 0 terminal ID template for diplaying the subcircuit label on the subcircuit layer; default to displaying termid[intconn], if empty; syntax if the same as for DYNTEXT -
fullscreen boolean 0 hide widgets to make more room for the drawing
move_linepoint_uses_route boolean 0 Moving a line point calculates a new line route. This allows 45/90 line modes when editing lines.
auto_via boolean 0 when drawing traces and switching layers or when moving an object from one layer to another, try to keep connections by automatically inserting vias.
route_radius real 0 temporary: route draw helper's arc radius at corners (factor of the trace thickness) @@ -59,4 +55,8 @@
beep_when_finished boolean 0 flag if a signal should be produced when searching of connections is done
undo_warning_size integer 0 warn the user when undo list exceeds this amount of kilobytes in memory
subc_conv_refdes string 0 automatic refdes value assigned to new subcircuits on conversion from objects - if empty, no refdes text or attribute is added; if the value is , the refdes text object is added but no refdes attribute is created +
grid_unit unit 0 [hidlib] select whether you draw in mm or mil +
draw_grid boolean 0 [hidlib] draw grid points +
auto_place boolean 0 [hidlib] force placement of GUI windows (dialogs), trying to override the window manager +
fullscreen boolean 0 [hidlib] hide widgets to make more room for the drawing
Index: tree/editor_view.html =================================================================== --- tree/editor_view.html (revision 25138) +++ tree/editor_view.html (revision 25139) @@ -3,6 +3,6 @@

subtree: editor/view

node name type flags description -
flip_x boolean 0 view: flip the board along the X (horizontal) axis -
flip_y boolean 0 view: flip the board along the Y (vertical) axis +
flip_x boolean 0 [hidlib] view: flip the board along the X (horizontal) axis +
flip_y boolean 0 [hidlib] view: flip the board along the Y (vertical) axis
Index: tree/rc.html =================================================================== --- tree/rc.html (revision 25138) +++ tree/rc.html (revision 25139) @@ -3,9 +3,6 @@

subtree: rc

node name type flags description -
verbose integer 0 -
quiet integer 0 print only errors on stderr -
dup_log_to_stderr boolean 0 copy log messages to stderr even if there is a HID that can show them
backup_interval integer 0 time between two backups in seconds; 0 means disabled (no backups)
hid_fallback boolean 0 if there is no explicitly specified HID (--gui) and the preferred GUI fails, automatically fall back on other HIDs, eventually running in batch mode
brave string 0 brave mode flags: when non-empty, enable various experimental (unstable) features - useful for testers @@ -14,8 +11,6 @@
file_path string 0
library_shell string 0
library_search_paths list 0 -
menu_file string 0 where to load the default menu file from. If empty/unset, fall back to the legacy 'per hid ow menu file' setup. If contains slash, take it as a full path, if no slash, do a normal menu search for pcb-menu-NAME.lht -
export_basename boolean 0 if an exported file contains the source file name, remove path from it, keeping the basename only
emergency_name string 0 file name template for emergency save anonymous .pcb files (when pcb-rnd crashes); optional field: %ld --> pid; must be shorter than 240 characters. Don't do emergency save if this item is empty.
emergency_format string 0 if set, use this format for the backups; if unset, use the default format
backup_name string 0 file name template for periodic backup of board files; optional fields (the usual % substitutions work) @@ -31,7 +26,12 @@
preferred_gui list 0 if set, try GUI HIDs in this order when no GUI is explicitly selected
save_final_fallback_fmt string 0 when a new file is created (by running pcb-rnd with the file name) there won't be a known format; pcb-rnd will guess from the file name (extension) but eventhat may fail. This format is the final fallback that'll be used if no other guessing mechanism worked. The user can override this by save as.
save_fp_fmt string 0 when saving a buffer element/subcircuit, prefer this format by default -
cli_prompt string 0 plain text prompt to prefix the command entry -
cli_backend string 0 command parser action
have_regex boolean 0 whether we have regex compiled in +
verbose integer 0 [hidlib] +
quiet integer 0 [hidlib] print only errors on stderr +
dup_log_to_stderr boolean 0 [hidlib] copy log messages to stderr even if there is a HID that can show them +
cli_prompt string 0 [hidlib] plain text prompt to prefix the command entry +
cli_backend string 0 [hidlib] command parser action +
export_basename boolean 0 [hidlib] if an exported file contains the source file name, remove path from it, keeping the basename only +
menu_file string 0 [hidlib] where to load the default menu file from. If empty/unset, fall back to the legacy 'per hid ow menu file' setup. If contains slash, take it as a full path, if no slash, do a normal menu search for pcb-menu-NAME.lht
Index: tree/rc_path.html =================================================================== --- tree/rc_path.html (revision 25138) +++ tree/rc_path.html (revision 25139) @@ -7,7 +7,7 @@ lib string 0 e.g. /usr/lib/pcb-rnd bin string 0 e.g. /usr/bin share string 0 e.g. /usr/share/pcb-rnd - home string 0 user's home dir, determined run-time - exec_prefix string 0 exec prefix path (extracted from argv[0]) design string 0 directory path of the current design, or if the current design doesn't have a file name yet + home string 0 [hidlib] user's home dir, determined run-time + exec_prefix string 0 [hidlib] exec prefix path (extracted from argv[0])