rename manpage

I am also commiting the manpage itself temporarily, we should leave only the .rst in the repo!
author: kali <kali@leap.se> 2013-01-30 14:46:56 +0900
committer: kali <kali@leap.se> 2013-01-30 14:46:56 +0900
commit: 15e8cf89db0ba3f4921a9ffcae72a0bc4cbf4b69 (patch)
tree: 584e6331665b803a24fd134f1ea596cdf759cb77 /docs
parent: f1c397a70c6ecbc7dfed978752f69ebe351433d6 (diff)
3 files changed, 483 insertions, 0 deletions
diff --git a/docs/man/leap-client.1 b/docs/man/leap-client.1
new file mode 100644
index 00000000..aef24d85
--- /dev/null
+++ b/docs/man/leap-client.1
@@ -0,0 +1,83 @@
+.\" Man page generated from reStructeredText.
+.
+.TH LEAP-CLIENT 1 "2013-01-30" "0.2" "General Commands Manual"
+.SH NAME
+leap-client \- graphical client to control LEAP, the encrypted internet access toolkit.
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.SH SYNOPSIS
+.sp
+leap\-client [\-h] [\-d] [\-l [LOG FILE]] [\-\-openvpn\-verbosity [OPENVPN_VERB]]
+.SH DESCRIPTION
+.sp
+\fIleap\-client\fP is a graphical client to control LEAP, the encrypted internet access toolkit.
+.sp
+When launched, it places an icon in the system tray from where the LEAP services can be controlled.
+.SH OPTIONS
+.SS general options
+.sp
+\fB\-h, \-\-help\fP                  Print a help message and exit.
+.sp
+\fB\-d, \-\-debug\fP                 Launches client in debug mode, writing debug info to stdout.
+.sp
+\fB\-\-\-logfile=<file>\fP           Writes log to file.
+.SS openvpn options
+.sp
+\fB\-\-openvpn\-verbosity\fP [0\-5]       Verbosity level for openvpn logs.
+.SH WARNING
+.sp
+This software is still in early alfa testing. So don\(aqt trust your life to it!
+.sp
+At the current time, the LEAP Client is not compatible with \fBopenresolv\fP, but it works with \fBresolvconf\fP.
+.SH FILES
+.SS /etc/leap/resolv\-update
+.sp
+Post up/down script passed to openvpn. It writes /etc/resolv.conf to avoid dns leaks, and restores the original resolv.conf on exit.
+.SS /etc/leap/resolv\-head
+.SS /etc/leap/resolv\-tail
+.sp
+Custom entries that will appear in the written resolv.conf
+.SS /usr/share/polkit\-1/actions/net.openvpn.gui.leap.policy
+.sp
+PolicyKit policy file, used for granting access to openvpn without the need of entering a password each time.
+.SS ~/.config/leap/
+.sp
+Main config folder
+.SS ~/.config/leap/leap.conf
+.sp
+GUI options
+.SH BUGS
+.sp
+Please report any bugs to \fI\%https://leap.se/code\fP
+.SH AUTHOR
+LEAP Encryption Access Project https://leap.se
+.SH COPYRIGHT
+GPLv3+
+.\" Generated by docutils manpage writer.
+.\" 
+.
diff --git a/docs/man/leap.1.rst b/docs/man/leap-client.1.rst
index 1ef5b3cc..1ef5b3cc 100644
--- a/docs/man/leap.1.rst
+++ b/docs/man/leap-client.1.rst
diff --git a/docs/man/leap.1 b/docs/man/leap.1
new file mode 100644
index 00000000..d543bed2
--- /dev/null
+++ b/docs/man/leap.1
@@ -0,0 +1,400 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.8.1: http://docutils.sourceforge.net/" />
+<title>leap-client</title>
+<meta name="author" content="LEAP Encryption Access Project https://leap.se" />
+<meta name="date" content="2013-01-30" />
+<meta name="copyright" content="GPLv3+" />
+<style type="text/css">
+
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 7056 2011-06-17 10:50:48Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+  border: 0 }
+
+table.borderless td, table.borderless th {
+  /* Override padding for "table.docutils td" with "! important".
+     The right padding separates the table cells. */
+  padding: 0 0.5em 0 0 ! important }
+
+.first {
+  /* Override more specific margin styles with "! important". */
+  margin-top: 0 ! important }
+
+.last, .with-subtitle {
+  margin-bottom: 0 ! important }
+
+.hidden {
+  display: none }
+
+a.toc-backref {
+  text-decoration: none ;
+  color: black }
+
+blockquote.epigraph {
+  margin: 2em 5em ; }
+
+dl.docutils dd {
+  margin-bottom: 0.5em }
+
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+  overflow: hidden;
+}
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+  font-weight: bold }
+*/
+
+div.abstract {
+  margin: 2em 5em }
+
+div.abstract p.topic-title {
+  font-weight: bold ;
+  text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+  margin: 2em ;
+  border: medium outset ;
+  padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+  font-weight: bold ;
+  font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title {
+  color: red ;
+  font-weight: bold ;
+  font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+   compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+  margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+  margin-top: 0.5em }
+*/
+
+div.dedication {
+  margin: 2em 5em ;
+  text-align: center ;
+  font-style: italic }
+
+div.dedication p.topic-title {
+  font-weight: bold ;
+  font-style: normal }
+
+div.figure {
+  margin-left: 2em ;
+  margin-right: 2em }
+
+div.footer, div.header {
+  clear: both;
+  font-size: smaller }
+
+div.line-block {
+  display: block ;
+  margin-top: 1em ;
+  margin-bottom: 1em }
+
+div.line-block div.line-block {
+  margin-top: 0 ;
+  margin-bottom: 0 ;
+  margin-left: 1.5em }
+
+div.sidebar {
+  margin: 0 0 0.5em 1em ;
+  border: medium outset ;
+  padding: 1em ;
+  background-color: #ffffee ;
+  width: 40% ;
+  float: right ;
+  clear: right }
+
+div.sidebar p.rubric {
+  font-family: sans-serif ;
+  font-size: medium }
+
+div.system-messages {
+  margin: 5em }
+
+div.system-messages h1 {
+  color: red }
+
+div.system-message {
+  border: medium outset ;
+  padding: 1em }
+
+div.system-message p.system-message-title {
+  color: red ;
+  font-weight: bold }
+
+div.topic {
+  margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+  margin-top: 0.4em }
+
+h1.title {
+  text-align: center }
+
+h2.subtitle {
+  text-align: center }
+
+hr.docutils {
+  width: 75% }
+
+img.align-left, .figure.align-left, object.align-left {
+  clear: left ;
+  float: left ;
+  margin-right: 1em }
+
+img.align-right, .figure.align-right, object.align-right {
+  clear: right ;
+  float: right ;
+  margin-left: 1em }
+
+img.align-center, .figure.align-center, object.align-center {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+.align-left {
+  text-align: left }
+
+.align-center {
+  clear: both ;
+  text-align: center }
+
+.align-right {
+  text-align: right }
+
+/* reset inner alignment in figures */
+div.align-right {
+  text-align: inherit }
+
+/* div.align-center * { */
+/*   text-align: left } */
+
+ol.simple, ul.simple {
+  margin-bottom: 1em }
+
+ol.arabic {
+  list-style: decimal }
+
+ol.loweralpha {
+  list-style: lower-alpha }
+
+ol.upperalpha {
+  list-style: upper-alpha }
+
+ol.lowerroman {
+  list-style: lower-roman }
+
+ol.upperroman {
+  list-style: upper-roman }
+
+p.attribution {
+  text-align: right ;
+  margin-left: 50% }
+
+p.caption {
+  font-style: italic }
+
+p.credits {
+  font-style: italic ;
+  font-size: smaller }
+
+p.label {
+  white-space: nowrap }
+
+p.rubric {
+  font-weight: bold ;
+  font-size: larger ;
+  color: maroon ;
+  text-align: center }
+
+p.sidebar-title {
+  font-family: sans-serif ;
+  font-weight: bold ;
+  font-size: larger }
+
+p.sidebar-subtitle {
+  font-family: sans-serif ;
+  font-weight: bold }
+
+p.topic-title {
+  font-weight: bold }
+
+pre.address {
+  margin-bottom: 0 ;
+  margin-top: 0 ;
+  font: inherit }
+
+pre.literal-block, pre.doctest-block, pre.math {
+  margin-left: 2em ;
+  margin-right: 2em }
+
+span.classifier {
+  font-family: sans-serif ;
+  font-style: oblique }
+
+span.classifier-delimiter {
+  font-family: sans-serif ;
+  font-weight: bold }
+
+span.interpreted {
+  font-family: sans-serif }
+
+span.option {
+  white-space: nowrap }
+
+span.pre {
+  white-space: pre }
+
+span.problematic {
+  color: red }
+
+span.section-subtitle {
+  /* font-size relative to parent (h1..h6 element) */
+  font-size: 80% }
+
+table.citation {
+  border-left: solid 1px gray;
+  margin-left: 1px }
+
+table.docinfo {
+  margin: 2em 4em }
+
+table.docutils {
+  margin-top: 0.5em ;
+  margin-bottom: 0.5em }
+
+table.footnote {
+  border-left: solid 1px black;
+  margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+  padding-left: 0.5em ;
+  padding-right: 0.5em ;
+  vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+  font-weight: bold ;
+  text-align: left ;
+  white-space: nowrap ;
+  padding-left: 0 }
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+  font-size: 100% }
+
+ul.auto-toc {
+  list-style-type: none }
+
+</style>
+</head>
+<body>
+<div class="document" id="leap-client">
+<h1 class="title">leap-client</h1>
+<h2 class="subtitle" id="graphical-client-to-control-leap-the-encrypted-internet-access-toolkit">graphical client to control LEAP, the encrypted internet access toolkit.</h2>
+<table class="docinfo" frame="void" rules="none">
+<col class="docinfo-name" />
+<col class="docinfo-content" />
+<tbody valign="top">
+<tr><th class="docinfo-name">Author:</th>
+<td>LEAP Encryption Access Project <a class="last reference external" href="https://leap.se">https://leap.se</a></td></tr>
+<tr><th class="docinfo-name">Date:</th>
+<td>2013-01-30</td></tr>
+<tr><th class="docinfo-name">Copyright:</th>
+<td>GPLv3+</td></tr>
+<tr><th class="docinfo-name">Version:</th>
+<td>0.2</td></tr>
+<tr class="field"><th class="docinfo-name">Manual section:</th><td class="field-body">1</td>
+</tr>
+<tr class="field"><th class="docinfo-name">Manual group:</th><td class="field-body">General Commands Manual</td>
+</tr>
+</tbody>
+</table>
+<div class="section" id="synopsis">
+<h1>SYNOPSIS</h1>
+<p>leap-client [-h] [-d] [-l [LOG FILE]] [--openvpn-verbosity [OPENVPN_VERB]]</p>
+</div>
+<div class="section" id="description">
+<h1>DESCRIPTION</h1>
+<p><em>leap-client</em> is a graphical client to control LEAP, the encrypted internet access toolkit.</p>
+<p>When launched, it places an icon in the system tray from where the LEAP services can be controlled.</p>
+</div>
+<div class="section" id="options">
+<h1>OPTIONS</h1>
+<div class="section" id="general-options">
+<h2>general options</h2>
+<p><strong>-h, --help</strong>                  Print a help message and exit.</p>
+<p><strong>-d, --debug</strong>                 Launches client in debug mode, writing debug info to stdout.</p>
+<p><strong>---logfile=&lt;file&gt;</strong>           Writes log to file.</p>
+</div>
+<div class="section" id="openvpn-options">
+<h2>openvpn options</h2>
+<p><strong>--openvpn-verbosity</strong> [0-5]       Verbosity level for openvpn logs.</p>
+</div>
+</div>
+<div class="section" id="warning">
+<h1>WARNING</h1>
+<p>This software is still in early alfa testing. So don't trust your life to it!</p>
+<p>At the current time, the LEAP Client is not compatible with <tt class="docutils literal">openresolv</tt>, but it works with <tt class="docutils literal">resolvconf</tt>.</p>
+</div>
+<div class="section" id="files">
+<h1>FILES</h1>
+<div class="section" id="etc-leap-resolv-update">
+<h2>/etc/leap/resolv-update</h2>
+<p>Post up/down script passed to openvpn. It writes /etc/resolv.conf to avoid dns leaks, and restores the original resolv.conf on exit.</p>
+</div>
+<div class="section" id="etc-leap-resolv-head">
+<h2>/etc/leap/resolv-head</h2>
+</div>
+<div class="section" id="etc-leap-resolv-tail">
+<h2>/etc/leap/resolv-tail</h2>
+<p>Custom entries that will appear in the written resolv.conf</p>
+</div>
+<div class="section" id="usr-share-polkit-1-actions-net-openvpn-gui-leap-policy">
+<h2>/usr/share/polkit-1/actions/net.openvpn.gui.leap.policy</h2>
+<p>PolicyKit policy file, used for granting access to openvpn without the need of entering a password each time.</p>
+</div>
+<div class="section" id="config-leap">
+<h2>~/.config/leap/</h2>
+<p>Main config folder</p>
+</div>
+<div class="section" id="config-leap-leap-conf">
+<h2>~/.config/leap/leap.conf</h2>
+<p>GUI options</p>
+</div>
+</div>
+<div class="section" id="bugs">
+<h1>BUGS</h1>
+<p>Please report any bugs to <a class="reference external" href="https://leap.se/code">https://leap.se/code</a></p>
+</div>
+</div>
+</body>
+</html>
author	kali <kali@leap.se>	2013-01-30 14:46:56 +0900
committer	kali <kali@leap.se>	2013-01-30 14:46:56 +0900
commit	15e8cf89db0ba3f4921a9ffcae72a0bc4cbf4b69 (patch)
tree	584e6331665b803a24fd134f1ea596cdf759cb77 /docs
parent	f1c397a70c6ecbc7dfed978752f69ebe351433d6 (diff)