Skip to content

Commit

Permalink
Fix man page
Browse files Browse the repository at this point in the history
  • Loading branch information
mendess committed Nov 5, 2020
1 parent e034443 commit 0063a50
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions web-xdg-open.1
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,16 @@ normal browser
.B web-xdg-open
tries to open links with the
.B default filetype
handler. For
example images are opened in the default image viewer as configured by
handler. For example images are opened in the default image viewer as
configured by
.B xdg-utils.

.SH CONFIGURATION

You can configure
.B web-xdg-open
by overriding it's default behaviour for a file group. This can be done in:
by overriding it's default behaviour for a file group. This can be done in one
of:

.in 10
.B $XDG_CONFIG_HOME/wxorc
Expand Down Expand Up @@ -49,7 +50,6 @@ For example, to open text files in neovim one can define this function in the
config file:

.in 10

text() {
dl "$1" >"$TEMPFILE" && $TERMINAL -e bash -c "nvim '$TEMPFILE'"
.br
Expand All @@ -67,7 +67,7 @@ or append
.I ||return
to the command.

If you don't do this then the fallback will not be used and
If you don't do this then the fallback might not be used and
.B web-xdg-open
will be very frustrating to use.

Expand All @@ -88,22 +88,22 @@ video() {
}

.in 7
When defining these function there are a few utilities that
When defining these functions there are a few utilities that
.B web-xdg-open
defines. You can make use of these when making your config file. You can also
defines you can make use of when making your config file. You can also
override them but this is highly discouraged.

.TP
.B notify()
A simple wrapper around
.B notify-send(1)
that never an error exit status.
that never returns an error exit status.

.TP
.B dl()
Downloads the passed link and outputs it to
Downloads the passed link and outputs the downloaded data to
.B stdout
returning and error exit status if the download fails for any reason and uses
returning an error exit status if the download fails for any reason and uses
.B notify()
to warn about it.

Expand Down Expand Up @@ -134,8 +134,9 @@ exits.

.SH FAQ
.TP
.B What is clipboard used for?
For now only files ending in
.B What is 'clipboard' used for?
The 'clipboard' function will copy the file's contents to the clipboard.
Currently only files ending in
.I *.pub
are copied to the clipboard, as these are usually public rsa keys.

Expand Down

0 comments on commit 0063a50

Please sign in to comment.