From c61432701ad325172658970f21abb9e970b46117 Mon Sep 17 00:00:00 2001 From: kali Date: Thu, 7 Feb 2013 00:29:37 +0900 Subject: remove generated manpage --- docs/man/leap-client.1 | 83 ---------- docs/man/leap.1 | 400 ------------------------------------------------- 2 files changed, 483 deletions(-) delete mode 100644 docs/man/leap-client.1 delete mode 100644 docs/man/leap.1 (limited to 'docs') diff --git a/docs/man/leap-client.1 b/docs/man/leap-client.1 deleted file mode 100644 index aef24d85..00000000 --- a/docs/man/leap-client.1 +++ /dev/null @@ -1,83 +0,0 @@ -.\" 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=\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 b/docs/man/leap.1 deleted file mode 100644 index d543bed2..00000000 --- a/docs/man/leap.1 +++ /dev/null @@ -1,400 +0,0 @@ - - - - - - -leap-client - - - - - - -

-

leap-client

-

graphical client to control LEAP, the encrypted internet access toolkit.

- --- - - - - - - - - - - - - - -

Author:	LEAP Encryption Access Project https://leap.se
Date:	2013-01-30
Copyright:	GPLv3+
Version:	0.2
Manual section:	1
Manual group:	General Commands Manual

-

-

SYNOPSIS

-

leap-client [-h] [-d] [-l [LOG FILE]] [--openvpn-verbosity [OPENVPN_VERB]]

-

-

-

DESCRIPTION

-

leap-client is a graphical client to control LEAP, the encrypted internet access toolkit.

-

When launched, it places an icon in the system tray from where the LEAP services can be controlled.

-

-

-

OPTIONS

-

-

general options

-

-h, --help Print a help message and exit.

-

-d, --debug Launches client in debug mode, writing debug info to stdout.

-

---logfile=<file> Writes log to file.

-

-

-

openvpn options

-

--openvpn-verbosity [0-5] Verbosity level for openvpn logs.

-

-

-

-

WARNING

-

This software is still in early alfa testing. So don't trust your life to it!

-

At the current time, the LEAP Client is not compatible with openresolv, but it works with resolvconf.

-

-

-

FILES

-

-

/etc/leap/resolv-update

-

Post up/down script passed to openvpn. It writes /etc/resolv.conf to avoid dns leaks, and restores the original resolv.conf on exit.

-

-

-

/etc/leap/resolv-head

-

-

-

/etc/leap/resolv-tail

-

Custom entries that will appear in the written resolv.conf

-

- -

-

~/.config/leap/

-

Main config folder

-

-

-

~/.config/leap/leap.conf

-

GUI options

-

-

-

-

BUGS

-

Please report any bugs to https://leap.se/code

-

-

- - -- cgit v1.2.3 From 2f4b84d1f58e3c008ef9f8138bf1711e023f00e2 Mon Sep 17 00:00:00 2001 From: kali Date: Tue, 12 Feb 2013 00:24:49 +0900 Subject: add release checklist to docs --- docs/checklist_for_leap_client_release.wiki | 48 +++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 docs/checklist_for_leap_client_release.wiki (limited to 'docs') diff --git a/docs/checklist_for_leap_client_release.wiki b/docs/checklist_for_leap_client_release.wiki new file mode 100644 index 00000000..c61b258c --- /dev/null +++ b/docs/checklist_for_leap_client_release.wiki @@ -0,0 +1,48 @@ += LEAP CLient Release Checklist (*) = + + * [ ] validate rc + * [ ] all rc-critical closed! + * [ ] all bbots green + * [ ] uploaded translations: make translations + * [ ] re-generate pyqt resources + + * [ ] update docs + * [ ] CREDITS + * [ ] relnotes.txt + * [ ] docs/known_issues.rst + * [ ] NEWS.rst: Add release name and date to top-most item in NEWS. + + * [ ] change docs/quickstart.rst to point to just the current + leap-client-X.Y.Z.deb binaries and .tar.gz source code files + * [ ] on release/vX.Y.Z branch: git pull + * [ ] git tag X.Y.Z + * [ ] build locally to make sure the release is reporting itself as the + intended version (FIXME!) + * [ ] make sure buildbot is green + * [ ] make sure other people aren't committing at that moment + * [ ] FUTURE: push tag along with some other documentation-only patch (typically to + relnotes.txt) to trigger buildslaves + * [ ] git push --tags official; git push official + * [ ] that will build tarballs + * [ ] make sure buildbot is green (in a parallel universe, he) + * [ ] download tarballs, sign with "gpg -ba -u deadbeef TAR", upload *.asc + * [ ] symlink the release tarball on leap.se downloads page: + /var/www/source/leap-client/releases/ CHANGEME XXX + + * [ ] update news pages. release notes. + * [ ] send out relnotes.txt to internal list. + * [ ] wait ...? + + * [ ] PYPI UPLOAD: with "python ./setup.py sdist upload register" + * [ ] login to pypi + * [ ] from Edit, add new release + * [ ] upload .tar.gz, .asc + + * [ ] make an "announcement of new release" on leap.se + * [ ] close the Milestone on the chili Roadmap + * [ ] send out relnotes.txt to: + * [ ] mailing lists... + +notes +----- +(*) this checklist kindly borrowed from tahoe-lafs documentation =) -- cgit v1.2.3