Skip to content

Commit 3a1cdf4

Browse files
committed
Add usage to README
1 parent 1e723ed commit 3a1cdf4

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,28 @@
33
Control various aspects of Microsoft Surface devices on Linux from the Command-Line.
44
Aims to provide a unified front-end to the various sysfs-attributes and special devices.
55

6+
## Usage
7+
8+
```
9+
USAGE:
10+
surface <SUBCOMMAND>
11+
12+
FLAGS:
13+
-h, --help Prints help information
14+
-V, --version Prints version information
15+
16+
SUBCOMMANDS:
17+
dgpu Control or query the dGPU power state
18+
help Prints this message or the help of the given subcommand(s)
19+
latch Control the latch/dtx-system on the Surface Book 2
20+
performance Control or query the current performance-mode
21+
status Query the current system status
22+
```
23+
24+
See `surface <subcommand> help` for more details.
25+
26+
_Hint:_ You can specify the subcommand by any unabiguous prefix of it, i.e. `surface perf` and `surface p` will both evaluate to `surface performance`.
27+
628
## Building from Source
729

830
Building this application from source follows the standard rust procedure, i.e. simply call `cargo build --release --locked` for a release-ready executable.

0 commit comments

Comments
 (0)