blob: 923969cefe953276822f1c1a8376ba4b008f4ad1 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
|
.TH man 1 "2022-10-12" "0.13.0" "Profanity XMPP client"
.SH NAME
/help
.SH DESCRIPTION
Help on using Profanity. Passing no arguments list help areas. For command help, optional arguments are shown using square brackets, arguments representing variables rather than a literal name are surrounded by angle brackets. Arguments that may be one of a number of values are separated by a pipe e.g. val1|val2|val3.
.SH SYNOPSIS
/help [<area>|<command>|search_all|search_any] [<search_terms>]
.LP
.SH ARGUMENTS
.PP
\fB<area>\fR
.RS 4
Summary help for commands in a certain area of functionality.
.RE
.PP
\fB<command>\fR
.RS 4
Full help for a specific command, for example '/help connect'.
.RE
.PP
\fBsearch_all <search_terms>\fR
.RS 4
Search commands for returning matches that contain all of the search terms.
.RE
.PP
\fBsearch_any <search_terms>\fR
.RS 4
Search commands for returning matches that contain any of the search terms.
.RE
.SH EXAMPLES
/help search_all presence online
.LP
/help commands
.LP
/help presence
.LP
/help who
.LP
|