summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFlorian Pritz <bluewind@xinu.at>2014-07-20 17:58:14 +0200
committerFlorian Pritz <bluewind@xinu.at>2014-07-20 17:58:14 +0200
commitbf13d941c800e4fe5b33aea5efccb9c186bb9163 (patch)
tree5003990d5a3a7e59af0103447a90d9ef3fa7c1ea
parent26d11433f13e69e71c431d021fc1a32d902d2247 (diff)
Update manpage: deprecate netrc; misc cleanupv1.3.3
- https instead of http - MiB instead of MB - Tell users to use api keys rathern than netrc Signed-off-by: Florian Pritz <bluewind@xinu.at>
-rw-r--r--fb.136
1 files changed, 20 insertions, 16 deletions
diff --git a/fb.1 b/fb.1
index 2f8696d..4a07538 100644
--- a/fb.1
+++ b/fb.1
@@ -1,15 +1,17 @@
-.\" Copyright (c) 2010-2012 Florian Pritz, bluewind at xinu.at
+.\" Copyright (c) 2010-2014 Florian Pritz, bluewind at xinu.at
.\" 2011 Moritz Wilhelmy, mw at wzff.de
.\"
.\" Licensed under GPLv3
.\" (see COPYING for full license text)
.\"
-.Dd May 11, 2012
+.Dd July 20, 2014
.Dt FB 1
.Os
+
.Sh NAME
.Nm fb
-.Nd a shell-script client for http://paste.xinu.at
+.Nd a shell-script client for https://paste.xinu.at
+
.Sh SYNOPSIS
.Nm
.Op options
@@ -20,9 +22,10 @@
.Ar ID/URL ...
.Nm
.Op Fl hv
+
.Sh DESCRIPTION
.Nm
-is a client to http://paste.xinu.at which allows the user to easily upload,
+is a client to https://paste.xinu.at which allows the user to easily upload,
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.
@@ -33,7 +36,7 @@ Directories will be packed into a tarball with
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.
-If the file being uploaded is bigger than 10MB
+If the file being uploaded is bigger than 10MiB
.Nm
will query the server for the maximum upload size and abort the upload if the
file would be rejected.
@@ -43,13 +46,10 @@ will try to copy all links into the X clipboard if
.Xr xclip 1
is installed.
.Pp
-If you want to use paste.xinu.at, you need to create an account there and add the following to your
-.Pa ~/.netrc :
-.Pp
-.Bd -literal -offset indent
-machine paste.xinu.at
- login <your_username> password <your_secret_password>
-.Ed
+If you want to use paste.xinu.at, you need to create an account there and then run
+.Sq Nm Fl a
+to create an API key.
+
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl c
@@ -68,12 +68,12 @@ 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.
+https://paste.xinu.at/<ID>/bash will change the syntax highlighting to bash.
.It Fl n Ar file name
Use the specified file name for the upload when pasting from stdin. Defaults
to "stdin"
.It Fl a
-Create a new api key.
+Create a new API key. Asks for username and password.
.It Fl H
Display a history of uploads.
.It Fl g
@@ -93,6 +93,7 @@ Display the client version.
.It Fl D
Display debugging information.
.El
+
.Sh CONFIGURATION FILES
.Bl -tag
.It $XDG_CONFIG_HOME/fb-client/apikey
@@ -106,13 +107,14 @@ The following option names are supported:
.It pastebin
The URL of the pastebin you want to use
.It clipboard_cmd
-The command used to copy URLs of uploaded files to the clipboard. This defaults to xclip or pbcopy on Darwin.
+The command used to copy URLs of uploaded files to the clipboard. This defaults to pbcopy on Darwin and xclip otherwise.
.It apikey_file
The file that contains the API key. This defaults to "$XDG_CONFIG_HOME/fb-client/apikey"
.El
.It ~/.netrc
-This file will be used for authentication.
+Deprecated. This file will be used for authentication unless an API key is configured. Usage of this file is discouraged because it contains your username and password in plain text.
.El
+
.Sh ENVIRONMENT
Some options can be changed by modifying environment variables:
.Bl -tag -width XZ_OPTS
@@ -130,6 +132,7 @@ underlying
.Xr mktemp 1
program supports it.
.El
+
.Sh EXAMPLES
.Bl -tag
.It Nm Fl tc Ar directory file
@@ -143,6 +146,7 @@ This will create a .tar archive containing only the directory and compress it us
.It Ic make \&|\&& Nm
This will upload the output of make (stdout and stderr) in csh and similar shells.
.El
+
.Sh SEE ALSO
.Xr curl 1 ,
.Xr gzip 1 ,