|
| 1 | +# Beej's Guide to Network Programming |
| 2 | + |
| 3 | +This is the source for Beej's Guide to Network Programming. |
| 4 | + |
| 5 | +If you merely wish to read the guide, please visit the [Beej's Guide to |
| 6 | +Network Programming](https://beej.us/guide/bgnet/) website. |
| 7 | + |
| 8 | +This is here so that Beej has everything in a repo and so translators |
| 9 | +can easily clone it. |
| 10 | + |
| 11 | +## Build Instructions |
| 12 | + |
| 13 | +You'll need: |
| 14 | + |
| 15 | +* [Gnu make](https://www.gnu.org/software/make/) |
| 16 | +* [Python 2.4+](https://www.python.org/) |
| 17 | +* [Apache Xerces-C](https://xerces.apache.org/xerces-c/) (for |
| 18 | + validation; see step 0, below) |
| 19 | +* [Apache FOP](https://xmlgraphics.apache.org/fop/) (or hack in some |
| 20 | + other FO processor for print output) |
| 21 | + |
| 22 | +0. If you don't have Xerces-C, go to `bin/bgvalidate` and uncomment the |
| 23 | + `disable=1` line to disable validation. |
| 24 | + |
| 25 | +1. Type `make` from the top-level directory. |
| 26 | + |
| 27 | + If you have Gnu Make, it should work fine. Other makes might work as |
| 28 | + well. Windows users might want to check out Cygwin. |
| 29 | + |
| 30 | +2. There is no step two. |
| 31 | + |
| 32 | +You can also `cd` to anywhere in the `output` directory tree and `make`. |
| 33 | + |
| 34 | +`make clean` cleans, and `make pristine` cleans to "original" state. |
| 35 | + |
| 36 | +To embed your own fonts in the PDFs, see the file |
| 37 | +`output/print/fop.xconf` which already embeds the Liberation Fonts into |
| 38 | +the PDF. |
| 39 | + |
| 40 | +The `makeupload` script demonstrates the build steps for a complete |
| 41 | +release. You'll need to change the `upload` target in the top-level |
| 42 | +`Makefile` to point to your host if you want to use that. You're free |
| 43 | +to upload whatever versions you desire individually, as well. |
| 44 | + |
| 45 | +## Pull Requests |
| 46 | + |
| 47 | +Please keep these on the scale of typo and bug fixes. That way I don't |
| 48 | +have to consider any copyright issues when merging changes. |
| 49 | + |
| 50 | +## TODO |
| 51 | + |
| 52 | +### Content |
| 53 | + |
| 54 | +* File transfer example maybe in son of data encapsulation |
| 55 | +* Multicast? |
| 56 | +* Event IO? |
| 57 | + |
| 58 | +### In `bg2fo` |
| 59 | + |
| 60 | +* URL hyperlinks in PDF |
| 61 | +* Auto-manpage links in <func> tags. |
| 62 | + |
| 63 | + <code file="..." /> |
| 64 | + <code annotate="y"> ]]><foo>blah</foo><![CDATA[ |
| 65 | + |
| 66 | +### bg2html |
| 67 | +* Auto-manpage links in <func> tags. |
| 68 | + |
| 69 | + <code file="..." /> |
| 70 | + <code annotate="y"> ]]><foo>blah</foo><![CDATA[ |
| 71 | + |
0 commit comments