[Pkg-privacy-commits] [Git][pkg-privacy-team/onionshare][debian/sid] 3 commits: Merge branch 'debian/sid' of https://salsa.debian.org/pkg-privacy-team/onionshare into debian/sid

[Ulrike Uhlig]

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


Commits:
2c12fa55 by Ulrike Uhlig at 2020-07-15T20:34:13+02:00
Merge branch 'debian/sid' of https://salsa.debian.org/pkg-privacy-team/onionshare into debian/sid

- - - - -
e89cc7c4 by Ulrike Uhlig at 2020-07-15T21:31:20+02:00
Bring manpage up-to-date and delete erroneous information. (Closes: #965055)

- - - - -
6e950f3a by Ulrike Uhlig at 2020-07-15T21:34:50+02:00
Make description more precise.

- - - - -


1 changed file:

- debian/onionshare.1


Changes:

=====================================
debian/onionshare.1
=====================================
@@ -1,7 +1,7 @@
-.TH onionshare 1 "April 24, 2018" "" "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
@@ -10,41 +10,60 @@ onionshare \- a tool for anonymously sharing files over a temporarily set up Tor
 
 .SH DESCRIPTION
 .PP
-\fBOnionShare\fP lets you anonymously share files. This works either in send or in receive mode. OnionShare sets up use a Tor hidden service to either make files on your computer temporarily accessible over the Internet, or allows the uploading of files to your computer using a hidden service. OnionShare generates an unguessable URL to down- or upload files that you can share with your peers.
+\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
-In case of sharing with many peers, please enable "Public mode", otherwise OnionShare might interpret multiple accesses as an attack and shut down the hidden service.
+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
-OnionShare can configured to run with it's built-in version of tor, a TorBrowser or system tor running in the background. By default, OnionShare uses the built-in version of Tor.
+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
-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'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
-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.
-
+\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
+\fBReceive Mode\fP lets people upload files to your OnionShare via Tor Browser.
+.PP
+\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 --help
+.IP --auto-start-timer\ N
+Schedule this share to start N seconds from now
+.B
+.IP --auto-stop-timer\ N
+Stop sharing after N seconds
+.B
+.IP --config\ CONFIGFILE
+Path to a custom JSON config file (optional)
+.B
+.IP --connect-timeout\ N
+Give up connecting to Tor after a given amount of time (default: 120 seconds)
+.B
+.IP --debug
+enable more verbose output
+.B
+.TP
+\fB\-h\fR, \fB\-\-help\fR
 display a short help message and exit
 .B
 .IP --local-only
-don't run a public hidden service, just run on localhost
+don't run a public hidden service, just run on localhost (for development)
 .B
 .IP --receive
 Receive shares instead of sending them
 .B
-.IP --stay-open
-don't exit after file has been successfully downloaded
-.B
-.IP --stealth
-Create stealth onion service (advanced)
-.B
 .IP --shutdown-timeout\ N
 Shut down the onion service after N seconds
 .B
-.IP --config\ CONFIGFILE
-Path to a custom JSON config file (optional)
+.IP --stay-open
+Continue sharing after files have been sent
 .B
-.IP --debug
-enable more verbose output
-
-.SH AUTHOR
-Manual page by Ulrike Uhlig <ulrike at debian dot org>
+.IP --stealth
+Use client authorization (advanced)
+.B
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Log OnionShare errors to stdout, and web errors to disk



View it on GitLab: https://salsa.debian.org/pkg-privacy-team/onionshare/-/compare/a97caf90bf600175591c22d5695a62b69d9c8725...6e950f3ad7201836e8dab6080990f94b9384b9d9

-- 
View it on GitLab: https://salsa.debian.org/pkg-privacy-team/onionshare/-/compare/a97caf90bf600175591c22d5695a62b69d9c8725...6e950f3ad7201836e8dab6080990f94b9384b9d9
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/20200715/f732ce0c/attachment-0001.html>