Updated man page and README.

This commit is contained in:
Elijah 2022-08-13 12:49:26 +00:00
parent d0eaa14b8c
commit 8030e27c8e
2 changed files with 20 additions and 3 deletions

View file

@ -40,14 +40,20 @@ mkdir -p "$XDG_RUNTIME_DIR"
Then, you can start daemon either during start of your desktop environment or window manager or even in tty with this command:
```
pipeplayer ~/.cache/.pipeplayer
pipeplayer
```
Note: add `&` at the end of command to run process in background.
Or if you prefer old way:
```
pipeplayer /path/to/named/pipe
```
Now you can send commands to created named pipe like this:
```
echo l$HOME/Music/playlist > ~/.cache/.pipeplayer
echo l$HOME/Music/playlist > "$XDG_RUNTIME_DIR/pipeplayer"
```
Note: change "$XDG_RUNTIME_DIR/pipeplayer" to path to named pipe if you don't use XDG_RUNTIME_DIR variable.
### Available commands
@ -55,6 +61,8 @@ echo l$HOME/Music/playlist > ~/.cache/.pipeplayer
* `b` — play previous song
* `f` — play next song
* `e` — exit pipeplayer
* `p` — pause
* `c` — clear playlist (don't exit)
Also, you can find all commands in man page. Run `man pipeplayer` after installation.

View file

@ -3,7 +3,10 @@
pipeplayer \- simple music daemon
.SH SYNOPSIS
.B pipeplayer
/path/to/pipe
/path/to/named/pipe
.TP
.B pipeplayer
(Pipe will be created at $XDG_RUNTIME_DIR/pipeplayer)
.SH DESCRIPTION
.B pipeplayer
is simple music daemon controlled with named pipe. It uses libmpg123 to decode files and libao to play sound.
@ -20,6 +23,12 @@ play previous song.
.TP
.B f
play next song.
.TP
.B p
pause.
.TP
.B c
clear playlist.
.SH LOGGING
You can change LOGGING_LEVEL at
.B config.h