about summary refs log tree commit diff stats
path: root/docs/profanity-executable.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/profanity-executable.1')
-rw-r--r--docs/profanity-executable.182
1 files changed, 82 insertions, 0 deletions
diff --git a/docs/profanity-executable.1 b/docs/profanity-executable.1
new file mode 100644
index 00000000..ae529dfe
--- /dev/null
+++ b/docs/profanity-executable.1
@@ -0,0 +1,82 @@
+.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client"
+
+.SH NAME
+/executable
+
+.SH DESCRIPTION
+Configure executable that should be called upon a certain command.
+
+.SH SYNOPSIS
+/executable avatar <cmd>
+
+.LP
+/executable urlopen set <cmdtemplate>
+
+.LP
+/executable urlopen default
+
+.LP
+/executable urlsave set <cmdtemplate>
+
+.LP
+/executable urlsave default
+
+.LP
+
+.SH ARGUMENTS
+.PP
+\fBavatar\fR
+.RS 4
+Set executable that is run by /avatar open. Use your favorite image viewer.
+.RE
+.PP
+\fBurlopen set\fR
+.RS 4
+Set executable that is run by /url open. Takes a command template that replaces %u and %p with the URL and path respectively.
+.RE
+.PP
+\fBurlopen default\fR
+.RS 4
+Restore to default settings.
+.RE
+.PP
+\fBurlsave set\fR
+.RS 4
+Set executable that is run by /url save. Takes a command template that replaces %u and %p with the URL and path respectively.
+.RE
+.PP
+\fBurlsave default\fR
+.RS 4
+Use the built-in download method for saving.
+.RE
+.PP
+\fBeditor set\fR
+.RS 4
+Set editor to be used with /editor. Needs a terminal editor or a script to run a graphical editor.
+.RE
+
+.SH EXAMPLES
+/executable avatar xdg-open
+
+.LP
+/executable urlopen set "xdg-open %u"
+
+.LP
+/executable urlopen set "firefox %u"
+
+.LP
+/executable urlopen default
+
+.LP
+/executable urlsave set "wget %u -O %p"
+
+.LP
+/executable urlsave set "curl %u -o %p"
+
+.LP
+/executable urlsave default
+
+.LP
+/executable editor set vim
+
+.LP