Skip to content

Commit

Permalink
Fix Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Schweber committed Dec 28, 2023
1 parent 808a807 commit 2c0bd75
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 20 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,16 @@ This Bash script emulates the main features of [tdrop](https://github.com/noctui
#### Options:

> -b, --background
> changes the default behaviour: if the specified program is not running, launch it in the background instead of foreground. Thereafter 'hdrop -b' will work the same as without this flag.
> changes the default behaviour: if the specified program is not running, launch it in the background instead of in the foreground. Thereafter 'hdrop -b' will work the same as without this flag.
>
> -i, --insensitive
> case insensitive partial matching of class names. Try this if a running program is not recognized and a new instance is launched instead.
> Note: incorrect matches may occur.
> Case insensitive partial matching of class names. Can work as a stopgap if a running program is not recognized and a new instance is launched instead. Note: incorrect matches may occur, adding a special handling of the program to `hdrop` is preferable.
>
> -v, --verbose
> Show notifications regarding the matching process. Can be used to figure out why running programs are not matched."
> Show notifications regarding the matching process. Try this to figure out why running programs are not matched.
>
> -h, --help
> Print this help message
> Print help message
>
> -V, --version
> Print version
Expand All @@ -37,7 +36,7 @@ This Bash script emulates the main features of [tdrop](https://github.com/noctui

Multiple instances of the same program can be run concurrently, if different class names are assigned to each instance. Presently there is support for the following flags in the [COMMAND] string:

> -a ('foot' terminal emulator)
> -a (`foot` terminal emulator)
> --class (all other programs)
#### Example bindings in Hyprland config:
Expand All @@ -54,7 +53,7 @@ If you want to run a program on boot and have it wait in the background until ca

> exec-once = hdrop -b librewolf
Please report missing flags or peculiarities for other programs so that i can add them!
Please report missing flags or peculiarities for other programs, so that i can add them!

Dependencies: bash jq hyprland

Expand All @@ -70,7 +69,7 @@ Make sure that `bash` and `jq` are in your PATH.

Download the script, make it executable and add it to your PATH.

Note: `hdrop` will only work in a `hyprland` session.
Note: `hdrop` will only work in a `Hyprland` session.

### Makefile

Expand Down
13 changes: 6 additions & 7 deletions hdrop
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,21 @@ print_help() {
echo ""
echo "Options:"
echo " -b, --background"
echo " changes the default behaviour: if the specified program is"
echo " Changes the default behaviour: if the specified program is"
echo " not running, launch it in the background instead of foreground."
echo " Thereafter 'hdrop -b' will work the same as without this flag."
echo ""
echo " -i, --insensitive"
echo " case insensitive partial matching of class names."
echo " Case insensitive partial matching of class names."
echo " Try this if a running program is not recognized and a new"
echo " instance is launched instead."
echo ""
echo " -h, --help"
echo " Print this help message"
echo ""
echo " -v, --verbose"
echo " Show notifications regarding the matching process."
echo " Can be used to figure out why running programs are"
echo " not matched."
echo " Try this to figure out why running programs are not matched."
echo ""
echo " -h, --help"
echo " Print this help message"
echo ""
echo " -V, --version"
echo " Print version"
Expand Down
10 changes: 5 additions & 5 deletions hdrop.1.scd
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ hdrop - run, show and hide programs on Hyprland
The usual command you would run to start the desired program

*-b, --background*
changes the default behaviour: if the specified program is not running, launch it in the background instead of foreground. Thereafter 'hdrop -b' will work the same as without this flag.
Changes the default behaviour: if the specified program is not running, launch it in the background instead of foreground. Thereafter 'hdrop -b' will work the same as without this flag.

*-i, --insensitive*
case insensitive partial matching of class names. Try this if a running program is not recognized and a new instance is launched instead.

*-h, --help*
Print help message
Case insensitive partial matching of class names. Can work as a stopgap if a running program is not recognized and a new instance is launched instead. Note: incorrect matches may occur, adding a special handling of the program to `hdrop` is preferable.

*-v, --verbose*
Show notifications regarding the matching process. Can be used to figure out why running programs are not matched."

*-h, --help*
Print help message

*-V, --version*
Print version

Expand Down

0 comments on commit 2c0bd75

Please sign in to comment.