about summary refs log tree commit diff stats
path: root/docs/profanity-occupants.1
blob: 6b960a4e61cddc1ab1829a96d9eea61c60de824c (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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
.TH man 1 "2022-10-12" "0.13.0" "Profanity XMPP client"

.SH NAME
/occupants

.SH DESCRIPTION
Show or hide room occupants, and occupants panel display settings.

.SH SYNOPSIS
/occupants show|hide [jid|offline]

.LP
/occupants char <char>|none

.LP
/occupants color on|off

.LP
/occupants default show|hide [jid|offline]

.LP
/occupants size [<percent>]

.LP
/occupants indent <indent>

.LP
/occupants header char <char>|none

.LP
/occupants wrap on|off

.LP

.SH ARGUMENTS
.PP
\fBshow\fR
.RS 4
Show the occupants panel in current room.
.RE
.PP
\fBchar <char>\fR
.RS 4
Prefix occupants with specified character.
.RE
.PP
\fBchar none\fR
.RS 4
Remove occupants character prefix.
.RE
.PP
\fBcolor on\fR
.RS 4
Enable generated color names (XEP-0392) for occupants
.RE
.PP
\fBcolor off\fR
.RS 4
Disable generated color names (XEP-0392) for occupants
.RE
.PP
\fBhide\fR
.RS 4
Hide the occupants panel in current room.
.RE
.PP
\fBshow jid\fR
.RS 4
Show jid in the occupants panel in current room.
.RE
.PP
\fBhide jid\fR
.RS 4
Hide jid in the occupants panel in current room.
.RE
.PP
\fBshow offline\fR
.RS 4
Show offline occupants panel in current room.
.RE
.PP
\fBhide offline\fR
.RS 4
Hide offline occupants panel in current room.
.RE
.PP
\fBdefault show|hide\fR
.RS 4
Whether occupants are shown by default in new rooms.
.RE
.PP
\fBdefault show|hide jid\fR
.RS 4
Whether occupants jids are shown by default in new rooms.
.RE
.PP
\fBdefault show|hide offline\fR
.RS 4
Whether offline occupants are shown by default in new rooms.
.RE
.PP
\fBsize <percent>\fR
.RS 4
Percentage of the screen taken by the occupants list in rooms (1-99).
.RE
.PP
\fBindent <indent>\fR
.RS 4
Indent contact line by <indent> spaces (0 to 10).
.RE
.PP
\fBheader char <char>\fR
.RS 4
Prefix occupants headers with specified character.
.RE
.PP
\fBheader char none\fR
.RS 4
Remove occupants header character prefix.
.RE
.PP
\fBwrap on|off\fR
.RS 4
Enable or disable line wrapping in occupants panel.
.RE