[Pkg-privacy-commits] [onionshare] 30/33: format man pages more nicely, update paths
Ximin Luo
infinity0 at debian.org
Mon Oct 19 14:15:43 UTC 2015
This is an automated email from the git hooks/post-receive script.
infinity0 pushed a commit to branch debian
in repository onionshare.
commit 4476c59bf910f70aa32806b33d50518b295b6df2
Author: Ximin Luo <infinity0 at debian.org>
Date: Mon Oct 19 15:56:26 2015 +0200
format man pages more nicely, update paths
---
debian/onionshare-gui.1 | 15 +++++++--------
debian/onionshare.1 | 15 ++++++++-------
2 files changed, 15 insertions(+), 15 deletions(-)
diff --git a/debian/onionshare-gui.1 b/debian/onionshare-gui.1
index 2336a18..4c1c73b 100644
--- a/debian/onionshare-gui.1
+++ b/debian/onionshare-gui.1
@@ -7,22 +7,21 @@ onionshare \- a tool for anonymously sharing files over a temporarily set up Tor
.SH SYNOPSIS
.B onionshare-gui
-.br
.SH DESCRIPTION
.PP
\fBOnionShare\fP lets you anonymously share files. You host the file on your own computer and use a Tor hidden service to make it temporarily accessible over the Internet. OnionShare sets up this hidden service up for you. It then generates an unguessable URL to access and download the file.
-.br
+.PP
Before you can share a file, you need to open Tor Browser in the background. This will provide the Tor service that OnionShare uses to start the hidden service. All Tor hidden services (any website that's accessed through a .onion domain) are automatically end-to-end encrypted.
-.br
-In the case of OnionShare, the crypto key lives in /tmp/onionshare_XXX/private_key. The .onion URL address itself is a fingerprint of the key, which lets the Tor network look up the public key and start an encrypted session. So as long as you transmit the OnionShare URL successfully, the recipient who loads it in Tor Browser gets an end-to-end encrypted session with the server.
-.br
+.PP
+In the case of OnionShare, the crypto key lives in /tmp/onionshare/tmpXXX/private_key. The .onion URL address itself is a fingerprint of the key, which lets the Tor network look up the public key and start an encrypted session. So as long as you transmit the OnionShare URL successfully, the recipient who loads it in Tor Browser gets an end-to-end encrypted session with the server.
+.PP
When you open OnionShare you will be prompted to select a file to share. The unguessable URL is then generated and automatically copied to the clipboard.
-.br
+.PP
The person you want to share the file with just needs to use the Tor Browser to download the file from you, using the URL you sent to them over another, possibly encrypted, channel like encrypted e-mail or a chat using OTR.
-.br
+.PP
It takes around 30 seconds until the hidden service is available over the Tor network.
-.br
+.PP
OnionShare's default behaviour is to shut down the hidden service and to close the GUI once the file has been downloaded. You can prevent this behaviour by deselecting the "Stop server automatically" option. This can be useful if you want multiple people to access the same file.
.SH OPTIONS
diff --git a/debian/onionshare.1 b/debian/onionshare.1
index 15f7a89..f2d27ee 100644
--- a/debian/onionshare.1
+++ b/debian/onionshare.1
@@ -9,20 +9,19 @@ onionshare \- a tool for anonymously sharing files over a temporarily set up Tor
.B onionshare
.RI [ options ]
.RI filename
-.br
.SH DESCRIPTION
.PP
\fBOnionShare\fP lets you anonymously share files. You host the file on your own computer and use a Tor hidden service to make it temporarily accessible over the Internet. OnionShare sets up this hidden service up for you. It then generates an unguessable URL to access and download the file.
-.br
+.PP
Before you can share a file, you need to open Tor Browser in the background. This will provide the Tor service that OnionShare uses to start the hidden service. All Tor hidden services (any website that's accessed through a .onion domain) are automatically end-to-end encrypted.
-.br
-In the case of OnionShare, the crypto key lives in /tmp/onionshare_XXX/private_key. The .onion URL address itself is a fingerprint of the key, which lets the Tor network look up the public key and start an encrypted session. So as long as you transmit the OnionShare URL successfully, the recipient who loads it in Tor Browser gets an end-to-end encrypted session with the server.
-.br
+.PP
+In the case of OnionShare, the crypto key lives in /tmp/onionshare/tmpXXX/private_key. The .onion URL address itself is a fingerprint of the key, which lets the Tor network look up the public key and start an encrypted session. So as long as you transmit the OnionShare URL successfully, the recipient who loads it in Tor Browser gets an end-to-end encrypted session with the server.
+.PP
The person you want to share the file with just needs to use the Tor Browser to download the file from you, using the URL you sent to them over another, possibly encrypted, channel like encrypted e-mail or a chat using OTR.
-.br
+.PP
It takes around 30 seconds until the hidden service is available over the Tor network.
-.br
+.PP
OnionShare's default behaviour is to shut down the hidden service and to stop once the file has been downloaded. You can prevent this behaviour by invoking the --stay-open option. This can be useful if you want multiple people to access the same file.
.SH OPTIONS
@@ -32,8 +31,10 @@ display a short help message and exit
.B
.IP --local-only
don't run a public hidden service, just run on localhost
+.B
.IP --stay-open
don't exit after file has been successfully downloaded
+.B
.IP --debug
enable more verbose output
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-privacy/packages/onionshare.git
More information about the Pkg-privacy-commits
mailing list