Skip to content

updated man page + included script to automatically generate man page #623

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eyal0 merged 1 commit into from
May 10, 2022
Merged

updated man page + included script to automatically generate man page #623

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions man/generate_man.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#!/bin/bash

help2man pcb2gcode -i ./introduction.h2m -o ./pcb2gcode.1
29 changes: 29 additions & 0 deletions man/introduction.h2m
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
[DESCRIPTION]
This manual page documents briefly the \fBpcb2gcode\fP command.
.PP
\fBpcb2gcode\fP is a program that takes the files typically produced by PCB
(printed circuit board) designing tools, in particular Gerber (RS-274X) and
Excellon (an RS-274C variant) files as parsed by \fBgerbv\fP, and produces
files that can be used to control a CNC (computer numerical control) milling
machine. These files are in G code format (RS-274D/NGC) that can be read, for
example, by the linuxcnc EMC2 system.

When these files are executed, an engraving bit is used to remove the surface
from a copper covered circuit board, thus creating isolated areas. In another
step, holes are drilled into the board at the appropriate positions, and it can
be cut out in another step. (For each step, a separate output file is created.)

These programs follow the usual GNU command line syntax, with long
options starting with two dashes (`-').
A summary of options is included below.

Instead of passing all options on the command line, nearly all options can be
stored in a file named \fImillproject\fP. There, options are given one per line
as \fIoption\fP=\fIvalue\fP pairs (without the two dashes), and can be
separated by blank lines and commented (everything after a `#` character is
treated as a comment). Options that don't take an argument (like
\fB\-\-metric\fP) are entered as \fIoption\fP=true or \fIoption\fP=1 there.

Unless configured otherwise, numeric values are in units of inch and
inch/minute. When the \fB\-\-metric\fP option is given, they are in mm and
mm/minute.
Loading