summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFlorian Pritz <bluewind@xinu.at>2012-01-26 20:49:09 +0100
committerFlorian Pritz <bluewind@xinu.at>2012-01-26 22:21:27 +0100
commita87a803936c031bff17f903a24cfb5dca90d7c8e (patch)
tree0639e6ef86ce9bdf8e3cd754b1fee60729a9ab37
parent16558a6bbba2d76abdd43f94c65709128911609b (diff)
fb.1: adapt for this branch; misc style changes
- reorder options alphabetically - remove BUGS section since it doesn't apply any more Signed-off-by: Florian Pritz <bluewind@xinu.at>
-rw-r--r--fb.170
1 files changed, 33 insertions, 37 deletions
diff --git a/fb.1 b/fb.1
index 2607bf4..e77eb12 100644
--- a/fb.1
+++ b/fb.1
@@ -1,4 +1,4 @@
-.\" Copyright (c) 2010 Florian Pritz, flo at xssn.at
+.\" Copyright (c) 2010-2012 Florian Pritz, bluewind at xinu.at
.\" 2011 Moritz Wilhelmy, mw at wzff.de
.\"
.\" DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
@@ -18,13 +18,15 @@
.Dt FB 1
.Os
.Sh NAME
-.Nm fb
+.Nm fb
.Nd a shell-script client for http://paste.xinu.at
.Sh SYNOPSIS
.Nm
+.Op options
.Ar file/directory ...
.Nm
.Op Fl dg
+.Op options
.Ar ID/URL ...
.Nm
.Op Fl hv
@@ -35,53 +37,54 @@ delete or download files.
By default, files will be uploaded as-is and a link to the file will be printed
to stdout after each upload.
.Pp
-Before terminating,
-.Nm
-will try to copy all links into the X clipboard if
-.Xr xclip 1
-is installed.
Folders will be packed into a tarball with
.Xr tar 1 and the resulting
.Pa upload.tar
file will be uploaded.
If no arguments are given, data will be read from stdin into a temporary file
-that will be uploaded as soon as EOF is received..
+that will be uploaded as soon as EOF is received.
If the file being uploaded is bigger than 10MB
.Nm
will query the server for the maximum upload size and abort the upload if the
file would be rejected.
-.Pp
-Following options are supported:
+Before terminating,
+.Nm
+will try to copy all links into the X clipboard if
+.Xr xclip 1
+is installed.
+.Sh OPTIONS
.Bl -tag -width Ds
+.It Fl c
+Compress the files to be uploaded using
+.Xr gzip 1 .
+This affects all files including piped content and folders.
+If specified twice,
+.Xr xz 1
+will be used rather than gzip.
+If used in conjunction with the -g option this decompresses the download
+before it's output to stdout.
.It Fl d
Delete the IDs. You can no longer upload files in this mode. If the argument is a URL,
.Nm
will try to extract the ID.
+.It Fl e Ar extension
+Change the extension used for highlighting. You can also do this if you
+have already uploaded the file by appending the extension to the URL.
+http://paste.xinu.at/<ID>/bash will change the syntax highlighting to bash.
.It Fl g
Download the IDs and output on stdout. Please take care when using this, as
binary data may cause unexpected results when being output directly to a
terminal. You can no longer upload files in this mode. If the argument is a
-URL,
+URL,
.Nm
will try to extract the ID.
.It Fl h
Display a short help message.
-.It Fl v
-Display the client version.
-.It Fl e Ar extension
-Change the extension used for highlighting. You can also do this if you
-have already uploaded the file by appending the extension to the URL.
-http://paste.xinu.at/<ID>/bash will change the syntax highlighting to bash.
.It Fl t
Upload a tar file containing all files and directories specified on the
command line.
-.It Fl c
-Compress the files to be uploaded using
-.Xr gzip 1 .
-This affects all files including piped content and folders.
-If specified twice,
-.Xr xz 1
-will be used rather than gzip.
+.It Fl v
+Display the client version.
.El
.Pp
If you want to be able to delete files, you have to add the following lines to
@@ -94,17 +97,19 @@ machine paste.xinu.at
.Sh ENVIRONMENT
Some options can be changed by modifying environment variables:
.Bl -tag -width XZ_OPTS
-.It Ev GZIP
+.It Ev GZIP
Assigning GZIP will make the gzip-program treat it's value as if they had been
appended to the command line.
.It Ev XZ_OPTS
The XZ_OPTS environment variable can be used in order to pass additional
options to xz, in case xz is used for compression.
.It TMPDIR
-Setting TMPDIR to some directory where
+Setting TMPDIR to some directory where
.Nm
create temporary files inside this directory rather than /tmp, if the
-underlying mktemp program supports it.
+underlying
+.Xr mktemp 1
+program supports it.
.Sh EXAMPLES
.Bl -tag
.It Nm Fl tc Ar folder file
@@ -132,17 +137,8 @@ was written by
.Bl -bullet -compact
.It
.\" mdoc has clever spam protection ;)
-.An Florian Pritz Aq fl\&o@xssn.at
+.An Florian Pritz Aq bluewi\&nd@xinu.at
.It
.An Moritz Wilhelmy Aq mor\&itz@wzff.de
.El
and may be copied under the terms of the WTFPL.
-.Sh BUGS
-curl has a nasty comma expansion bug.
-When filenames containing a comma are being uploaded, The main branch tries to
-address this problem by providing a binary helper that links against libcurl in
-order to work around this bug.
-The legacy branch, from which this version of fb was obtained is supposed to
-remain a plain shell-script client, focusing on fixing all fixable bugs
-(i.e. not the curl one) and making it work on all POSIX platforms by removing
-code that only works with GNU bash.