diff --git a/documentation/boxes.1 b/documentation/boxes.1 new file mode 100644 index 0000000..dae38f4 --- /dev/null +++ b/documentation/boxes.1 @@ -0,0 +1,63 @@ +'\" t +.\" Title: Boxes +.\" Author: Georges Khaznadar +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 10/26/2019 +.\" Manual: boxes User Manual +.\" Source: boxes +.\" Language: English +.\" +.TH "BOXES" "1" "10/26/2019" "boxes" "boxes User Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +boxes \- program design boxes +.SH "DESCRIPTION" +.PP +\fBboxes\fR +is a program that generates SVG images that can be viewed directly in a web brower but also postscript and \- with pstoedit as external helper \- other vector formats including dxf, plt (aka hpgl) and gcode\&. +.PP +Of course the library and the generators allow selecting the "thickness" of the material used and automatically adjusts lengths and width of joining fingers and other elements\&. +.PP +The "burn" parameter compensates for the material removed by the laser\&. This allows fine tuning the gaps between joins up to the point where plywood can be press fitted even without any glue\&. +.PP +inger Joints are the work horse of the library\&. They allow 90\(de edges and T connections\&. Their size is scaled up with the material "thickness" to maintain the same appearance\&. The library also allows putting holes and slots for screws (bed bolts) into finger joints, although this is currently not supported for the included generators\&. +.PP +Dovetail joints can be used to join pieces in the same plane\&. +.PP +Flex cuts allows bending and stretching the material in one direction\&. This is used for rounded edges and living hinges\&. +.SH "AUTHOR" +.PP +\fBGeorges Khaznadar\fR <\&georgesk@debian\&.org\&> +.RS 4 +Wrote this manpage for the Debian system\&. +.RE +.SH "COPYRIGHT" +.br +Copyright \(co 2019 Georges Khaznadar +.br +.PP +This manual page was written for the Debian system (and may be used by others)\&. +.PP +Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or (at your option) any later version published by the Free Software Foundation\&. +.PP +On Debian systems, the complete text of the GNU General Public License can be found in +/usr/share/common\-licenses/GPL\&. +.sp diff --git a/documentation/boxes.xml b/documentation/boxes.xml new file mode 100644 index 0000000..aa76213 --- /dev/null +++ b/documentation/boxes.xml @@ -0,0 +1,136 @@ + +.
will be generated. You may view the +manual page with: nroff -man .
| less'. A typical entry +in a Makefile or Makefile.am is: + +DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/docbook-xsl/manpages/docbook.xsl +XP = xsltproc -''-nonet -''-param man.charmap.use.subset "0" + +manpage.1: manpage.xml + $(XP) $(DB2MAN) $< + +The xsltproc binary is found in the xsltproc package. The XSL files are in +docbook-xsl. A description of the parameters you can use can be found in the +docbook-xsl-doc-* packages. Please remember that if you create the nroff +version in one of the debian/rules file targets (such as build), you will need +to include xsltproc and docbook-xsl in your Build-Depends control field. +Alternatively use the xmlto command/package. That will also automatically +pull in xsltproc and docbook-xsl. + +Notes for using docbook2x: docbook2x-man does not automatically create the +AUTHOR(S) and COPYRIGHT sections. In this case, please add them manually as + ... . + +To disable the automatic creation of the AUTHOR(S) and COPYRIGHT sections +read /usr/share/doc/docbook-xsl/doc/manpages/authors.html. This file can be +found in the docbook-xsl-doc-html package. + +Validation can be done using: `xmllint -''-noout -''-valid manpage.xml` + +General documentation about man-pages and man-page-formatting: +man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ + +--> + + + + + + + + + + + + + +]> + + + + &dhtitle; + &dhpackage; + + + &dhfirstname; + &dhsurname; + Wrote this manpage for the Debian system. +
+ &dhemail; +
+ + + + 2019 + &dhusername; + + + This manual page was written for the Debian system + (and may be used by others). + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU General Public License, + Version 2 or (at your option) any later version published by + the Free Software Foundation. + On Debian systems, the complete text of the GNU General Public + License can be found in + /usr/share/common-licenses/GPL. + + + + &dhucpackage; + &dhsection; + + + &dhpackage; + program design boxes + + + DESCRIPTION + + &dhpackage; is a program that generates + SVG images that can be viewed directly in a web brower but also + postscript and - with pstoedit as external helper - + other vector formats including dxf, plt (aka hpgl) and gcode. + + + Of course the library and the generators allow selecting the + "thickness" of the material used and automatically adjusts lengths and + width of joining fingers and other elements. + + + The "burn" parameter compensates for the material removed by the + laser. This allows fine tuning the gaps between joins up to the point + where plywood can be press fitted even without any glue. + + + inger Joints are the work horse of the library. They allow 90° + edges and T connections. Their size is scaled up with the material + "thickness" to maintain the same appearance. The library also allows + putting holes and slots for screws (bed bolts) into finger joints, + although this is currently not supported for the included generators. + + + Dovetail joints can be used to join pieces in the same plane. + + + Flex cuts allows bending and stretching the material in one + direction. This is used for rounded edges and living hinges. + + + + diff --git a/documentation/boxesserver.1 b/documentation/boxesserver.1 new file mode 100644 index 0000000..a55ea92 --- /dev/null +++ b/documentation/boxesserver.1 @@ -0,0 +1,64 @@ +'\" t +.\" Title: BoxesServer +.\" Author: Georges Khaznadar +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 10/31/2019 +.\" Manual: boxesserver User Manual +.\" Source: boxesserver +.\" Language: English +.\" +.TH "BOXESSERVER" "1" "10/31/2019" "boxesserver" "boxesserver User Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +boxesserver \- a web server to make boxes\&. +.SH "SYNOPSIS" +.HP \w'\fBboxesserver\fR\ 'u +\fBboxesserver\fR [\fB\fIport_number\fR\fR] +.SH "DESCRIPTION" +.PP +\fBboxesserver\fR +is a web server which allows one to compute sketches to cut materials with a laser and make various types of boxes\&. +.SH "OPTIONS" +.PP +\fB\fIport_number\fR\fR +.RS 4 +If this optional parameter is set, the web service will be done using this port number\&. By default, the port number is 8000\&. +.sp +Please notice that port numbers lesser than 1024 are privileged, and can be used only by root\&. +.RE +.SH "AUTHOR" +.PP +\fBGeorges Khaznadar\fR <\&georgesk@debian\&.org\&> +.RS 4 +Wrote this manpage for the Debian system\&. +.RE +.SH "COPYRIGHT" +.br +Copyright \(co 2019 Georges Khaznadar +.br +.PP +This manual page was written for the Debian system (and may be used by others)\&. +.PP +Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or (at your option) any later version published by the Free Software Foundation\&. +.PP +On Debian systems, the complete text of the GNU General Public License can be found in +/usr/share/common\-licenses/GPL\&. +.sp diff --git a/documentation/boxesserver.xml b/documentation/boxesserver.xml new file mode 100644 index 0000000..9bfd4ce --- /dev/null +++ b/documentation/boxesserver.xml @@ -0,0 +1,133 @@ + +.
will be generated. You may view the +manual page with: nroff -man .
| less'. A typical entry +in a Makefile or Makefile.am is: + +DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/docbook-xsl/manpages/docbook.xsl +XP = xsltproc -''-nonet -''-param man.charmap.use.subset "0" + +manpage.1: manpage.xml + $(XP) $(DB2MAN) $< + +The xsltproc binary is found in the xsltproc package. The XSL files are in +docbook-xsl. A description of the parameters you can use can be found in the +docbook-xsl-doc-* packages. Please remember that if you create the nroff +version in one of the debian/rules file targets (such as build), you will need +to include xsltproc and docbook-xsl in your Build-Depends control field. +Alternatively use the xmlto command/package. That will also automatically +pull in xsltproc and docbook-xsl. + +Notes for using docbook2x: docbook2x-man does not automatically create the +AUTHOR(S) and COPYRIGHT sections. In this case, please add them manually as + ... . + +To disable the automatic creation of the AUTHOR(S) and COPYRIGHT sections +read /usr/share/doc/docbook-xsl/doc/manpages/authors.html. This file can be +found in the docbook-xsl-doc-html package. + +Validation can be done using: `xmllint -''-noout -''-valid manpage.xml` + +General documentation about man-pages and man-page-formatting: +man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ + +--> + + + + + + + + + + + + + +]> + + + + &dhtitle; + &dhpackage; + + + &dhfirstname; + &dhsurname; + Wrote this manpage for the Debian system. +
+ &dhemail; +
+ + + + 2019 + &dhusername; + + + This manual page was written for the Debian system + (and may be used by others). + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU General Public License, + Version 2 or (at your option) any later version published by + the Free Software Foundation. + On Debian systems, the complete text of the GNU General Public + License can be found in + /usr/share/common-licenses/GPL. + + + + &dhucpackage; + &dhsection; + + + &dhpackage; + a web server to make boxes. + + + + &dhpackage; + + + + + DESCRIPTION + &dhpackage; is a web server which allows + one to compute sketches to + cut materials with a laser and make various types of boxes. + + + OPTIONS + + + + + If this optional parameter is set, the web service + will be done using this port number. By default, the port number + is 8000. + + + Please notice that port numbers lesser than 1024 are privileged, + and can be used only by root. + + + + + + +