Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JSON api output format #95

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions doc/commands.md
Original file line number Diff line number Diff line change
@@ -10,9 +10,10 @@ fw-fanctrl [commands and options]

First, the global options

| Option | Optional | Choices | Default | Description |
|---------------------------|----------|---------|---------|--------------------------------------------------------------------------------|
| --socket-controller, --sc | yes | unix | unix | the socket controller to use for communication between the cli and the service |
| Option | Optional | Choices | Default | Description |
|---------------------------|----------|---------------|---------|--------------------------------------------------------------------------------|
| --socket-controller, --sc | yes | unix | unix | the socket controller to use for communication between the cli and the service |
| --output-format | yes | NATURAL, JSON | NATURAL | the client socket controller output format |

**run**

@@ -57,12 +58,13 @@ resume the service

print the selected information

| Option | Optional | Choices | Default | Description |
|--------------------|----------|----------------------|---------|------------------------|
| \<print_selection> | yes | current, list, speed | current | what should be printed |
| Option | Optional | Choices | Default | Description |
|--------------------|----------|---------------------------|---------|------------------------|
| \<print_selection> | yes | all, current, list, speed | all | what should be printed |

| Choice | Description |
|---------|----------------------------------|
| all | All details |
| current | The current strategy being used |
| list | List available strategies |
| speed | The current fan speed percentage |
Loading