[Pkg-privacy-commits] [Git][pkg-privacy-team/onionshare][debian/sid] do not forget to commit my fixes to the manpage

[Ulrike Uhlig]

Ulrike Uhlig pushed to branch debian/sid at Privacy Maintainers / onionshare


Commits:
e9b21314 by Ulrike Uhlig at 2020-07-17T11:43:52+02:00
do not forget to commit my fixes to the manpage

- - - - -


1 changed file:

- debian/onionshare-gui.1


Changes:

=====================================
debian/onionshare-gui.1
=====================================
@@ -1,33 +1,34 @@
-.\"Created with GNOME Manpages Editor Wizard
-.\"http://sourceforge.net/projects/gmanedit2
-.TH onionshare 1 "September 2, 2014" "" "onionshare"
+.TH onionshare 1 "July 15, 2020" "" "onionshare"
 
 .SH NAME
-onionshare \- a tool for anonymously sharing files over a temporarily set up Tor Hidden service.
+onionshare \- a tool for anonymously sharing and receiving files over a temporarily set up Tor Hidden service.
 
 .SH SYNOPSIS
 .B onionshare-gui
 
 .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.
+\fBOnionShare\fP lets you anonymously share files, or receive files. From version 2.2, OnionShare can also be used as a webserver through which static HTML files can be served. OnionShare has four different operating modes: the default for sharing files, receive mode for receiving files, public mode for sharing files with a large audience, and website mode.
 .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.
+When using OnionShare, a web server is started, making OnionShare accessible as a Tor Onion Service, over the Internet. An unguessable address is generated and can be shared for the recipient to open in a tor client, such as Tor Browser, to download, upload, or consult files. Traffic between their device and your onion service end-to-end encrypted. No separate server or third party file-sharing service required. You host the files on your own computer, acting as a server, for as long as the program is running.
 .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.
+OnionShare can be configured to run with it's built-in version of tor, a TorBrowser or system tor running in the background. By default, OnionShare uses its built-in version of Tor.
 .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.
+OnionShare's default behaviour is to shut down the hidden service and to stop once the files have been up or 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.
 .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.
+\fBPublic mode\fP In case of sharing the unguessable URL with many peers, please enable "Public mode", otherwise OnionShare might interpret multiple accesses as an attack and shut down the hidden service.
 .PP
-It takes around 30 seconds until the hidden service is available over the Tor network.
+\fBReceive Mode\fP lets people upload files to your OnionShare via Tor Browser.
 .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.
+\fBWebsite Mode\fPOnionShare allows you to publish a website as an onion service very quickly.
+When you add an index.html file (along with any static files such as images, CSS etc) and share it under 'Website Mode', then your site will be viewable on the Tor network as an onion service as the actual website itself (not as an OnionShare interface). The onion service will render HTML in Tor Browser just like any other website.
+.PP
+\fBAutomatic start and stop\fP The auto-start timer allows you to schedule a share to start at some time in the future.
+.PP
+For detailed and up-to-date information such as using OnionShare with bridges, refer to the authors' public documentation at https://github.com/micahflee/onionshare/wiki/
 
 .SH OPTIONS
 .B
-.IP -h
+.TP
+\fB\-h\fR, \fB\-\-help\fR
 display a short help message and exit
-
-.SH AUTHOR
-Manual page by Ulrike Uhlig <u at 451f dot org>



View it on GitLab: https://salsa.debian.org/pkg-privacy-team/onionshare/-/commit/e9b21314c9d68f81e500d19fd101512d49a16160

-- 
View it on GitLab: https://salsa.debian.org/pkg-privacy-team/onionshare/-/commit/e9b21314c9d68f81e500d19fd101512d49a16160
You're receiving this email because of your account on salsa.debian.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://alioth-lists.debian.net/pipermail/pkg-privacy-commits/attachments/20200717/23bf07aa/attachment-0001.html>