Skip to content

Commit

Permalink
Use comma instead of pipe for separating argument name variations
Browse files Browse the repository at this point in the history
  • Loading branch information
@perk11
perk11 committed Jan 7, 2024
1 parent ee3840b commit 92ab534
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 17 deletions.
20 changes: 10 additions & 10 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,16 +69,16 @@ If you want to install it system-wide, run `sudo make install` or simply `sudo c

### Options

| Option | Description | Default Value |
|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
| `--timeout\| -t <seconds>` | Set the user idle time after which the process can be resumed in seconds. | 300 seconds |
| `--pid\|-p <pid>` | Monitor an existing process. When this option is used, shell_command_to_run should not be passed. | |
| `--start-monitor-after\| -a <ms>` | Set an initial delay in milliseconds before monitoring starts. During this time the process runs unrestricted. This helps to catch quick errors. | 300 ms |
| `--pause-method\| -m <method>` | Specify method for pausing the process when the user is not idle. Available Options: SIGTSTP (can be ignored by the program), SIGSTOP (cannot be ignored). | SIGSTOP |
| `--quiet\| -q` | Suppress all output from ./runwhenidle except errors and only display output from the command that is running. No output if `--pid` options is used. | Not quiet |
| `--verbose\| -v` | Enable verbose output for monitoring. | Not verbose |
| `--debug` | Enable debugging output. | No debug |
| `--version\| -V` | Print the program version information. | |
| Option | Description | Default Value |
|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
| `--timeout, -t <seconds>` | Set the user idle time after which the process can be resumed in seconds. | 300 seconds |
| `--pid, -p <pid>` | Monitor an existing process. When this option is used, shell_command_to_run should not be passed. | |
| `--start-monitor-after, -a <ms>` | Set an initial delay in milliseconds before monitoring starts. During this time the process runs unrestricted. This helps to catch quick errors. | 300 ms |
| `--pause-method, -m <method>` | Specify method for pausing the process when the user is not idle. Available Options: SIGTSTP (can be ignored by the program), SIGSTOP (cannot be ignored). | SIGSTOP |
| `--quiet, -q` | Suppress all output from ./runwhenidle except errors and only display output from the command that is running. No output if `--pid` options is used. | Not quiet |
| `--verbose, -v` | Enable verbose output for monitoring. | Not verbose |
| `--debug` | Enable debugging output. | No debug |
| `--version, -V` | Print the program version information. | |


### Known issues
Expand Down
14 changes: 7 additions & 7 deletions arguments_parsing.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,23 +20,23 @@ const long START_MONITOR_AFTER_MIN_SUPPORTED_VALUE = 0;
void print_usage(char *binary_name) {
printf("Usage: %s [OPTIONS] [shell_command_to_run] [shell_command_arguments]\n", binary_name);
printf("\nOptions:\n");
printf(" --timeout|-t <seconds> Set the user idle time after which the process\n"
printf(" --timeout, -t <seconds> Set the user idle time after which the process\n"
" can be resumed in seconds. (default: 300 seconds).\n\n");
printf(" --pid|-p <pid> Monitor an existing process. When this option is used,\n"
printf(" --pid, -p <pid> Monitor an existing process. When this option is used,\n"
" shell_command_to_run should not be passed.\n\n");
printf(" --start-monitor-after|-a <ms> Set an initial delay in milliseconds before monitoring\n"
printf(" --start-monitor-after, -a <ms> Set an initial delay in milliseconds before monitoring\n"
" starts. During this time the process runs unrestricted.\n"
" This helps to catch quick errors. (default: 300 ms).\n\n");
printf(" --pause-method|-m <method> Specify method for pausing the process when the user is\n"
printf(" --pause-method, -m <method> Specify method for pausing the process when the user is\n"
" not idle. Available Options (default: SIGSTOP): \n"
" SIGTSTP (can be ignored by the program),\n"
" SIGSTOP (cannot be ignored).\n\n");
printf(" --quiet|-q Suppress all output from %s except errors and only\n"
printf(" --quiet, -q Suppress all output from %s except errors and only\n"
" display output from the command that is running.\n"
" No output if --pid options is used.\n\n", binary_name);
printf(" --verbose|-v Enable verbose output for monitoring.\n");
printf(" --verbose, -v Enable verbose output for monitoring.\n");
printf(" --debug Enable debugging output.\n");
printf(" --version|-V Print the program version information.\n");
printf(" --version, -V Print the program version information.\n");
}

void print_version() {
Expand Down

0 comments on commit 92ab534

Please sign in to comment.