structix/obs-cli
1
0
Fork 0
Code Issues 1 Pull Requests Releases Wiki Activity

Update README with examples

Browse Source
This commit is contained in:
structix
2022-11-04 19:46:28 +01:00
parent 0631e2a483
commit 515770a7a2
1 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -5,6 +5,25 @@ obs-cli is a simple cli tool for planned OBS recordings.
## Usage ## Usage
* `-s`, `--start-minutes` `<START_MINUTES>`: Define the minutes where the recording should start [default: 0] * `-s`, `--start-minutes` `<START_MINUTES>`: Define the minutes where the recording should start [default: 0]
* `-d`, `--duration-minutes` `<DURATION_MINUTES>`: Define the duration of the recording in minutes [default: 1] * `-d`, `--duration-minutes` `<DURATION_MINUTES>`: Define the duration of the recording in minutes [default: 1]
* `-b`, `--begin-time` `<BEGIN_TIME>`: Define the start time in HH:MM format
* `-e`, `--end-time` `<END_TIME>`: Define the end time in HH:MM format
* `-p`, `--poweroff`: Flag to shutdown the machine after recording * `-p`, `--poweroff`: Flag to shutdown the machine after recording
* `-h`, `--help`: Print help information * `-h`, `--help`: Print help information
* `-V`, `--version`: Print version information * `-V`, `--version`: Print version information
### Examples
Use minutes to input durations. The following command will start a 60min long recording in 10 minutes.
```sh
./obs-cli -s 10 -d 60
```
Another option is to use time strings in `HH:MM` format.
The following command will trigger a 30min long recording starting at 14:00.
```sh
./obs-cli -b 14:00 -e 14:30
```
These two formats can be used together:
```sh
./obs-cli -b 14:00 -d 30
```