Begin work on docsdocs

7 files changed, 306 insertions, 1 deletions

diff --git a/.gitignore b/.gitignore
index 5e26f1711..9ccacc9a8 100644
--- a/.gitignore
+++ b/.gitignore
@@ -18,6 +18,10 @@ firejail-users.5
 firejail.1
 firemon.1
 firecfg.1
+docs/_build
+docs/_static
+docs/_templates
+!docs/Makefile
 src/firejail/firejail
 src/firemon/firemon
 src/firecfg/firecfg
@@ -40,4 +44,3 @@ seccomp.64
 seccomp.block_secondary
 seccomp.mdwx
 src/common.mk
-
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 000000000..0b6a91a14
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = Firejail
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+        @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+        @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 000000000..e1093e9ff
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,143 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+# -- Project information -----------------------------------------------------
+
+project = 'Firejail'
+copyright = '2018, Firejail Authors'
+author = 'Firejail Authors'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = '0.9.57'
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path .
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Firejaildoc'
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'Firejail.tex', 'Firejail Documentation', 'Firejail Authors',
+     'manual'),
+]
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [(master_doc, 'firejail', 'Firejail Documentation', [author], 1)]
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'Firejail', 'Firejail Documentation', author, 'Firejail',
+     'One line description of project.', 'Miscellaneous'),
+]
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
new file mode 100644
index 000000000..abb9589d0
--- /dev/null
+++ b/docs/getting_started.rst
@@ -0,0 +1,35 @@
+.. _getting_started:
+
+Getting Started with Firejail
+================================================================================
+
+A brief overview of Firejail, how to install it, and some common uses.
+
+What is Firejail?
+--------------------------------------------------------------------------------
+Firejail is a sandbox program for Linux that aims to do three things:
+
+1. Reduce the risk of security breaches by isolating and `sandboxing`_ programs.
+2. Integrate well with other existing technology like SELinux or AppArmor.
+3. Be easy to use, with very little consumption of computer resources.
+
+Traditional Linux sandboxes have offered fine-grained control for users, but
+often at the cost of being difficult to configure and use. In contrast, there is
+no *difficult* in Firejail, at least no *SELinux-difficult*. For us, the
+user always comes first. We want Firejail to be simple to use, powerful but not
+complicated.
+
+
+Quick install tips
+--------------------------------------------------------------------------------
+As with many other Linux programs, it's best to check if Firejail is present in
+your distribution's repositories and install from there, unless you need a
+specific version. Many distributions, such as Arch, Debian, Gentoo, and Ubuntu,
+provide Firejail.
+
+We also provide pre-built packages of the `latest release`_ and
+`latest long-term support (LTS) release`_ on our Sourceforge download page.
+
+.. _sandboxing: https://en.wikipedia.org/wiki/Sandbox_(computer_security)
+.. _latest release: https://sourceforge.net/projects/firejail/files/firejail/
+.. _latest long-term support (LTS) release: https://sourceforge.net/projects/firejail/files/LTS/
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 000000000..b6ceed917
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,32 @@
+.. Firejail documentation master file, created by
+   sphinx-quickstart on Wed Aug 22 20:47:50 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Firejail's documentation!
+====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Getting Started:
+
+   getting_started.rst
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Installing:
+
+   installing.rst
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/installing.rst b/docs/installing.rst
new file mode 100644
index 000000000..dfca9155d
--- /dev/null
+++ b/docs/installing.rst
@@ -0,0 +1,36 @@
+Installing Firejail
+================================================================================
+
+Install from distributions repositories (recommended)
+-------------------------------------------------------------------------------
+Some common Linux distributions to provide Firejail in their repositories are:
+ - `Alpine`_
+ - `Arch`_
+ - `Debian`_
+ - `Gentoo`_
+ - `Ubuntu`_
+
+
+*Notes:*
+
+1. For Ubuntu users (or those who use derivatives like Linux Mint) who want to always have the latest version of Firejail, we also provide a `PPA`_
+2. Ubuntu and Debian users: when installing Firejail from the repository or the PPA, you will probably also want to install the **firejail-profiles** package:
+
+.. code-block:: bash
+
+  sudo apt install firejail firejail-profiles
+
+
+Install directly
+--------------------------------------------------------------------------------
+While we recommend installing from your Linux distribution's repositories, there
+may be times you want to get Firejail directly from the developers.
+
+
+
+.. _Alpine: https://pkgs.alpinelinux.org/packages?name=firejail
+.. _Arch: https://www.archlinux.org/packages/community/x86_64/firejail/
+.. _Debian: https://packages.debian.org/search?keywords=firejail&searchon=names&suite=all&section=all
+.. _Gentoo: https://packages.gentoo.org/packages/sys-apps/firejail
+.. _Ubuntu: https://packages.ubuntu.com/search?keywords=firejail&searchon=names&suite=all&section=all
+.. _PPA: https://launchpad.net/~deki/+archive/ubuntu/firejail
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
index 000000000..90a332e2e
--- /dev/null
+++ b/docs/make.bat
@@ -0,0 +1,36 @@
+@ECHO OFF

+

+pushd %~dp0

+

+REM Command file for Sphinx documentation

+

+if "%SPHINXBUILD%" == "" (

+        set SPHINXBUILD=sphinx-build

+)

+set SOURCEDIR=.

+set BUILDDIR=_build

+set SPHINXPROJ=Firejail

+

+if "%1" == "" goto help

+

+%SPHINXBUILD% >NUL 2>NUL

+if errorlevel 9009 (

+        echo.

+        echo.The 'sphinx-build' command was not found. Make sure you have Sphinx

+        echo.installed, then set the SPHINXBUILD environment variable to point

+        echo.to the full path of the 'sphinx-build' executable. Alternatively you

+        echo.may add the Sphinx directory to PATH.

+        echo.

+        echo.If you don't have Sphinx installed, grab it from

+        echo.http://sphinx-doc.org/

+        exit /b 1

+)

+

+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%

+goto end

+

+:help

+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%

+

+:end

+popd