Subgraph OS Handbook
HTML Other
Permalink
Failed to load latest commit information.
build Small fixes to virt-manager guide and rebuild Jan 2, 2017
debian Created metadata for Debian package. Closes #32. Nov 30, 2016
po Re-genned .pot. Nov 17, 2016
scripts Added Appendix with syscall table. Added command to Makefile to gener… Nov 3, 2016
static Moved virt-manager images Jan 2, 2017
templates Added table styling to HTML. Re-genned HTML. Closes #29. Nov 9, 2016
01_intro_01_preface.md Edited some sentences in the Preface. Oct 31, 2016
02_about_01_intro.md Rewrote some of the 'About Subgraph OS' text. Oct 31, 2016
02_about_02_help.md Added link formatting in the markdown content. Re-genned HTML. Closes #… Nov 13, 2016
03_installation_01_installation.md Added link formatting in the markdown content. Re-genned HTML. Closes #… Nov 13, 2016
04_everyday-usage_01_intro.md Added emphasis to application names (where it was missing). Re-genned… Nov 13, 2016
04_everyday-usage_02_torbrowser.md Added emphasis to application names (where it was missing). Re-genned… Nov 13, 2016
04_everyday-usage_03_pdfs.md Added emphasis to application names (where it was missing). Re-genned… Nov 13, 2016
04_everyday-usage_04_coyim.md Added emphasis to application names (where it was missing). Re-genned… Nov 13, 2016
04_everyday-usage_05_ricochet.md Added link formatting in the markdown content. Re-genned HTML. Closes #… Nov 13, 2016
04_everyday-usage_06_onionshare.md Added link formatting in the markdown content. Re-genned HTML. Closes #… Nov 13, 2016
04_everyday-usage_07_subgraph_firewall.md Add Subgraph Firewall documentation and images to the book content. Oct 31, 2016
05_features_and_advanced_usage_01_intro.md Added an intro to Features and Advanced usage chapter. Incremented se… Oct 31, 2016
05_features_and_advanced_usage_02_oz.md Added emphasis to application names (where it was missing). Re-genned… Nov 13, 2016
05_features_and_advanced_usage_03_tor.md Added link formatting in the markdown content. Re-genned HTML. Closes #… Nov 13, 2016
05_features_and_advanced_usage_04_metaproxy.md Added an intro to Features and Advanced usage chapter. Incremented se… Oct 31, 2016
05_features_and_advanced_usage_05_roflcoptor.md Added link formatting in the markdown content. Re-genned HTML. Closes #… Nov 13, 2016
05_features_and_advanced_usage_06_grsecurity.md Added link formatting in the markdown content. Re-genned HTML. Closes #… Nov 13, 2016
05_features_and_advanced_usage_07_macouflage.md Added an intro to Features and Advanced usage chapter. Incremented se… Oct 31, 2016
05_features_and_advanced_usage_08_usblockout.md Added link formatting in the markdown content. Re-genned HTML. Closes #… Nov 13, 2016
05_features_and_advanced_usage_09_virtualmachines.md Added link to documenation about converting existing images from vari… Jan 4, 2017
06_appendix_01_intro.md Added Appendix with syscall table. Added command to Makefile to gener… Nov 3, 2016
06_appendix_02_syscalls_01.md Added Appendix with syscall table. Added command to Makefile to gener… Nov 3, 2016
06_appendix_02_syscalls_02.md Added Appendix with syscall table. Added command to Makefile to gener… Nov 3, 2016
Makefile Made DocBook paths relative. Re-genned DocBook. Closes #34. Nov 29, 2016
README.md Added missing build dep Jan 2, 2017
metadata.yaml Moved yaml metadata out of preface into metadata.yaml. Updated Makefi… Oct 8, 2016
subgraph-os-help.desktop Updated path in .desktop file. Nov 30, 2016

README.md

Subgraph OS Handbook

The Subgraph OS Handbook is a user guide for Subgraph OS, covering basic everyday uses as well as the advanced configuration.

The Subgraph OS Handbook is written in Markdown. This is so that we can have a single source text that can be converted to multiple output formats, such as PDF, DocBook, Epub, and HTML.

The goal of the Subgraph OS Handbook is to provide operating system documentation that is readable and translatable. The handbook is organized into sections for beginners and advanced users.

The current roadmap for this project is the following:

  1. Finish the document conversion framework
  2. Add support for translation such that the single source text can be translated and localized versions of the handbook can be generated for each output type
  3. Finish writing the content, adding graphics, etc.
  4. Publish the finished handbook, including making it available in a Debian package for Subgraph OS, putting sections onto our website, etc.

At this point, the next step will be to undertake having it translated into a few different languages.

Pull requests

The Subgraph OS Handbook is a work in progress. We will most likely not accept pull requests until the framework for generating the document and translation artifacts is complete and the text is mostly written. This is just to maintain consistency (ie: using the same voice throughout, ensuring the text meets the readability guidelines we are targetting, etc.). As the framework is not yet mature, the most important thing at this stage is that the document and translation artifacts build correctly. The bulk of the content is due to be added once the framework is mature.

Building

To build from source you will need to install at least the following build dependencies:

sudo apt install pdftk fonts-lmodern lmodern fig2ps make texlive-latex-recommended \
    texlive-xetex texlive-latex-extra aspell aspell-en diction