-
Notifications
You must be signed in to change notification settings - Fork 1
/
ddcutil-client.1
135 lines (118 loc) · 4.65 KB
/
ddcutil-client.1
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
126
127
128
129
130
131
132
133
134
135
.TH ddcutil-client 1 "ddcutil-client" "MH" \" -*- nroff -*-
.SH NAME
ddcutil-client \- a command-line client for managing VDU settings via ddcutil-service
.SH SYNOPSIS
.B ddcutil-client
[\fIOPTION\fR]... \fICOMMAND\fR
.SH DESCRIPTION
\fBddcutil-client\fR is a command-line client of \fBddcutil-service\fP a service that can
manage various settings of Visual Display Units (VDUs) using the DDC/CI protocol.
This client uses the service to provide a fast counterpart to the \fBddcutil\fP command.
If the \fBddcutil-service\fP is already initialised, \fBddcutil-client\fR may perform
some operations up to 30 times faster than \fBddcutil\fP.
\fBWhen using this service, avoid excessively writing VCP values because each VDU's NVRAM
likely has a write-cycle limit/lifespan. The suggested guideline is to limit updates
to rates comparable to those observed when using the VDU's onboard controls. Avoid coding
that might rapidly or infinitely loop, including when recovering from errors and bugs.\fP
\fBNon-standard manufacturer specific features should only be experimented with caution,
some may have irreversible consequences, including bricking the hardware.\fP
.SH COMMANDS
.TP
.B detect
Detect connected displays.
.TP
.B capabilities
Display detailed capabilities of the specified display in a indented format and include value option names.
.TP
.B capabilities-terse
Display concise capabilities of the specified display.
.TP
.B getvcp \fI0xNN\fR
Get the value of the VCP code specified by \fI0xNN\fR.
.TP
.B setvcp \fI0xNN n\fR
Set the value of the VCP code specified by \fI0xNN\fR to \fIn\fR.
.TP
.B getvcp-metadata \fI0xNN
Get the metadata for the VCP code specified by \fI0xNN\fR.
.SH OPTIONS
.TP
.B \-h, \-\-help
Show help options.
.TP
.B \-d, \-\-display=\fIDISPLAY_NUMBER\fR
Specify the display number to control. Only one of \-\-display or \-\-edid should be provided.
.TP
.B \-e, \-\-edid=\fIEDID\fR
Specify the base64 encoded EDID (Extended Display Identification Data) of the display.
Only one of \-\-display or \-\-edid should be provided.
A prefix of a valid EDID is also acceptable.
.TP
.B \-r, \-\-raw
Force getvcp to return SNC-features as raw 16-bit values (SNCs default to 8-bit bits).
.TP
.B \-v, --version
Query the service interface version (property \fBServiceInterfaceVersion\fP).
.TP
.B \-V, --ddcutil-version
Query the ddcutil/libddcutil version (property \fBDdcutilVersion\fP).
.TP
.B \-y, --dynamic-sleep
Query or set ddcutil dynamic sleep setting (property \fBDdcutilDynamicSleep\fP).
.TP
.B \-i, --info-logging
Query or set info logging (property \fBServiceInfoLogging\fP).
.TP
.B \-s, --signal
Query or set service hotplug signals (property \fBServiceEmitSignals\fP).
.TP
.B \-l, --locked
Query if service parameters are locked (property \fBServiceParametersLocked\fP).
.TP
.B \-u, --status-values
List all ddcutil status values (property \fBStatusValues\fP).
.TP
.B \-p, --display-events
List all display event types (property \fBDisplayEventTypes\fP).
.TP
.B \-f, --service-flags
List all service flag options (property \fBServiceFlagOptions\fP).
.TP
.B \-t, --poll-interval
Hotplug/connectivity poll seconds >=30, 0 to query (property \fBServicePollInterval\fP).
.TP
.B \-c, --cascade-interval
Hotplug/connectivity cascade seconds >=0.5, 0 to query (property \fBServicePollCascadeInterval\fP).
.TP
.B \-o, --output-level
Ddcutil output level (property \fBDdcutilOutputLevel\fP).
.TP
If neither display number nor EDID are provided, the display number will default to 1.
.SH EXAMPLES
.B Detect all connected displays.
.nf
ddcutil-client detect
.fi
.B Display detailed capabilities of display 1.
.nf
ddcutil-client \-d 1 capabilities
.fi
.B Get the value of VCP code 0x10 (brightness) for display 1.
.nf
ddcutil-client \-d 1 getvcp 0x10
.fi
.B Set the value of VCP code 0x10 (brightness) to 50 for display 1.
.nf
ddcutil-client \-d 1 setvcp 0x10 50
.fi
.SH LIMITATIONS
See \fBddcutil-service (1) LIMITATIONS\fP.
.SH SEE ALSO
.BR ddcutil (1),
.BR ddcutil-service (1)
.SH AUTHOR
Michael Hamilton
.SH LICENSE
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.