Page MenuHomeDevCentral
Files F3767485

No OneTemporary
Actions

View Options

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7602329
--- /dev/null
+++ b/README.md
@@ -0,0 +1,77 @@
+# Simply exchange files with WOOF
+
+I guess everybody with a laptop has experienced this problem at some
+point: You plug into a network and just want to exchange files with
+other participants. It *always* is a pain until you can exchange
+files with the person vis-a-vis.
+
+Of course there are a lot of tools to tackle this problem. For large
+scale communities there are dozens of filesharing networks. However,
+they don't work for small local networks. Of course you could put your
+stuff to exchange on a local web server, but who really wants to
+maintain this? Tools like the ingenious
+[npush/npoll](http://www.fefe.de/ncp/) are
+extremely helpful, provided that both parties have it installed,
+[SAFT](http://www.belwue.de/projekte/saft/)
+also aims to solve this problem, but needs a permanently running daemon...
+
+**Woof** (Web Offer One File) tries a different approach. It
+assumes that everybody has a web-browser or a commandline web-client
+installed. **Woof** is a small simple stupid webserver that can
+easily be invoked on a single file. Your partner can access the file
+with tools he trusts (e.g. **wget**). No need to enter
+passwords on keyboards where you don't know about keyboard sniffers, no
+need to start a huge lot of infrastructure, just do a
+```
+ $ woof filename
+```
+and tell the recipient the URL **woof** spits out. When he got that
+file, **woof** will quit and everything is done.
+
+And when someone wants to send you a file, **woof** has a switch
+to offer itself, so he can get **woof** and offer a file to you.
+
+### Prerequisites and usage
+
+**Woof** needs Python on a unix'ish operating system. Some people
+have used it successfully on Windows within the cygwin environment.
+
+```
+ Usage: woof [-i <ip_addr>] [-p <port>] [-c <count>] <file>
+ woof [-i <ip_addr>] [-p <port>] [-c <count>] [-z|-j|-Z|-u] <dir>
+ woof [-i <ip_addr>] [-p <port>] [-c <count>] -s
+ woof [-i <ip_addr>] [-p <port>] [-c <count>] -U
+
+ woof <url>
+
+ Serves a single file <count> times via http on port <port> on IP
+ address <ip_addr>.
+ When a directory is specified, an tar archive gets served. By default
+ it is gzip compressed. You can specify -z for gzip compression,
+ -j for bzip2 compression, -Z for ZIP compression or -u for no compression.
+ You can configure your default compression method in the configuration
+ file described below.
+
+ When -s is specified instead of a filename, woof distributes itself.
+
+ When -U is specified, woof provides an upload form, allowing file uploads.
+
+ defaults: count = 1, port = 8080
+
+ If started with an url as an argument, woof acts as a client,
+ downloading the file and saving it in the current directory.
+
+ You can specify different defaults in two locations: /etc/woofrc
+ and ~/.woofrc can be INI-style config files containing the default
+ port and the default count. The file in the home directory takes
+ precedence. The compression methods are "off", "gz", "bz2" or "zip".
+
+ Sample file:
+
+ [main]
+ port = 8008
+ count = 2
+ ip = 127.0.0.1
+ compressed = gz
+```
+

File Metadata

Mime Type
text/x-diff
Expires
Mon, Nov 25, 00:41 (16 h, 58 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
2259277
Default Alt Text
(3 KB)

Event Timeline

Nasqueron DevCentral · If it had been much bigger the moon would have had a core of ice. · Powered by Phabricator