displayz 1.0.0

A CLI tool and library to control display settings on Windows written in Rust.
Documentation 
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

# displayz

[![MIT License](https://img.shields.io/crates/l/displayz)](https://choosealicense.com/licenses/mit/) [![Continuous Integration](https://github.com/michidk/displayz/actions/workflows/ci.yaml/badge.svg)](https://github.com/michidk/displayz/actions/workflows/ci.yaml) [![rust docs](https://docs.rs/displayz/badge.svg)](https://docs.rs/displayz/latest/displayz/) [![Crates.io](https://img.shields.io/crates/v/displayz)](https://crates.io/crates/displayz)
[![Chocolatey](https://img.shields.io/chocolatey/v/displayz?include_prereleases)](https://community.chocolatey.org/packages/displayz)

A CLI tool and library to control display settings on Windows written in Rust.

## Installation

### Chocolatey

Install [displayz using Chocolatey](https://community.chocolatey.org/packages/displayz) on Windows:

```sh
choco install displayz
```

### Cargo

Install [displayz using Cargo](https://crates.io/displayz) on Windows:

```sh
cargo install displayz
```

## Usage

### Commandline

After installation, the `displayz` command will be available.

Use the following command to access the help:

```sh
displayz --help
```

The following subcommands are available:

- `set-primary --id <id>`: Sets the display with the specified ID as the primary display.
- `primary <properties>`: Sets the primary display properties.
- `properties --id <id> <properties>`: Sets the display properties for the specified ID.

The `<properties>` argument can be multiple (but at least one and max one per kind) of:

- `--position <x>,<y>`: Sets the position of the display.
- `--resolution <width>x<height>`: Sets the resolution of the display.
- `--orientation <orientation>`: Sets the orientation of the display.
  - Orientation can be either `Default`, `UpsideDown`, `Right` or `Left`.
- `--fixedoutput <fixed output mode>`: Sets the fixed output mode of the display.
  - The mode can be one of `Default`, `Stretch` or `Center`.
- `--frequency <frequency>`: Sets the refresh rate of the display.

### Rust Library

See the examples in the [examples/](examples/) folder and the [documentation](https://docs.rs/displayz/latest/displayz/) on how to use the library.