update README

This commit is contained in:
Denis Lehmann 2021-09-12 21:54:21 +02:00
parent fa08f80c28
commit 00b0d91f4f

View file

@ -7,20 +7,20 @@
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_src text
#+begin_example text
media
└── movies
├── ...
├── The Daily Dweebs (2017)
│   └── The Daily Dweebs (2017).mkv
└── ...
#+end_src
#+end_example
If *strm* is configured to use the =media= directory, you can play the shortfilm e.g. with the following command:
#+begin_src sh
#+begin_example sh
strm daily dweebs
#+end_src
#+end_example
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 (=*=).
@ -30,11 +30,11 @@
The shortfilm from the example above could have also been played with one of the following commands:
#+begin_src sh
#+begin_example sh
strm dweebs daily
strm movies dwee
strm d d 17
#+end_src
#+end_example
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.
@ -78,38 +78,44 @@
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:
#+begin_src sh
#+begin_example sh
nix run github:Deleh/strm -- --help
#+end_src
#+end_example
If you use it this way, mpv is started with *MPRIS* support by default.
** Usage
#+begin_src text
#+begin_example text
Usage: strm [OPTIONS] QUERIES ... [OPTIONS]
Stream media files over SSH in a convenient way.
OPTIONS
-h, --help Show this help message
-c, --config CONFIG_FILE Path to config file (default: ~/.config/strm/strm.config)
-c, --config CONFIG_FILE Path to config file
(default: ~/.config/strm/strm.config)
-f, --fullscreen Play video files in fullscreen
-i, --ignore-files IGNORE_FILES Ignore given filenames
-l, --list List files instead of playing
-m, --media-directories MEDIA_DIRECTORIES Use given media directories, config is ignored
-o, --or Combine queries with a logical OR (default: AND)
-m, --media-directories MEDIA_DIRECTORIES Use given media directories,
config is ignored
-o, --or Combine queries with a logical OR
(default: AND)
-p, --playback-directory DIRECTORY Use given playback directory
-q, --quit TIME_IN_MINUTES Quit after a given time
-r, --remote SSH_CONNECTION_STRING Execute strm with other given arguments on remote machine (-f is set by default)
-q, --quit TIME_IN_MINUTES Quit after given time
-r, --remote SSH_CONNECTION_STRING Execute strm with other given
arguments on remote machine (-f is
set by default)
-s, --shuffle Play files in random order
-t, --tidy Don't resume playback
EXAMPLES
strm -l . # List all available files
strm Elephants Dream # Play files whose path contain 'elephants' and 'dream'
strm e*phants # Play files whose path matches the glob pattern 'e*phants'
#+end_src
strm e*phants # Play files whose path matches the glob pattern
# 'e*phants'
#+end_example
The usual [[https://mpv.io/manual/master/#interactive-control][mpv controls]] are available while playback.
Here is a subset:
@ -150,7 +156,7 @@
If the =--media-directories= argument is not set, the script looks for a configuration file with the following content:
#+begin_src sh
#+begin_example sh
# Media directories on remote machines of the following form:
#
# <SSH connection string><absolute_path_to_media_directory>
@ -187,7 +193,7 @@
# cover.jpg
# *.jpg,*.png
ignore_files=""
#+end_src
#+end_example
An example configuration file can be found in the repository.