denis/strm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update syntax

Browse source
This commit is contained in:
Denis Lehmann 2021-09-21 18:12:06 +02:00
parent 9a5ed5f548
commit 29baec2a4c
1 changed files with 7 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.org
View file

@ -7,7 +7,7 @@
Here is an example.. let's assume you have the shortfilm [[https://www.dailydweebs.com/][The Daily Dweebs]] stored on a remote machine in the following directory structure: Here is an example.. let's assume you have the shortfilm [[https://www.dailydweebs.com/][The Daily Dweebs]] stored on a remote machine in the following directory structure:
#+begin_example text #+begin_example
media media
└── movies └── movies
├── ... ├── ...
@ -18,9 +18,7 @@
If *strm* is configured to use the =media= directory, you can play the shortfilm e.g. with the following command: If *strm* is configured to use the =media= directory, you can play the shortfilm e.g. with the following command:
#+begin_example sh : strm daily dweebs
strm daily dweebs
#+end_example
Every argument which is not assigned to an flag is interpreted as part of the query. Every argument which is not assigned to an flag is interpreted as part of the query.
The query arguments are interpreted as [[https://en.wikipedia.org/wiki/Glob_(programming)][glob patterns]], additionally surrounded by wildcards (=*=). The query arguments are interpreted as [[https://en.wikipedia.org/wiki/Glob_(programming)][glob patterns]], additionally surrounded by wildcards (=*=).
@ -30,11 +28,9 @@
The shortfilm from the example above could have also been played with one of the following commands: The shortfilm from the example above could have also been played with one of the following commands:
#+begin_example sh : strm dweebs daily
strm dweebs daily : strm movies dwee
strm movies dwee : strm d d 17
strm d d 17
#+end_example
It is possible that multiple files are matched by one of the commands. It is possible that multiple files are matched by one of the commands.
All files are then played in the order of the configured media directories, followed by lexicographical order of the filepath. All files are then played in the order of the configured media directories, followed by lexicographical order of the filepath.
@ -78,15 +74,13 @@
This project is also a [[https://nixos.wiki/wiki/Flakes][Nix flake]]. This project is also a [[https://nixos.wiki/wiki/Flakes][Nix flake]].
You can execute it with the following command if you have a recent version of [[https://nixos.org/][Nix]] installed and flakes are enabled: You can execute it with the following command if you have a recent version of [[https://nixos.org/][Nix]] installed and flakes are enabled:
#+begin_example sh : nix run github:Deleh/strm -- --help
nix run github:Deleh/strm -- --help
#+end_example
If you use it this way, mpv is started with *MPRIS* support by default. If you use it this way, mpv is started with *MPRIS* support by default.
** Usage ** Usage
#+begin_example text #+begin_example
Usage: strm [OPTIONS] QUERIES ... [OPTIONS] Usage: strm [OPTIONS] QUERIES ... [OPTIONS]
Stream media files over SSH in a convenient way. Stream media files over SSH in a convenient way.