Mark/restream
1
0
Fork 0
Code Actions Releases Activity

Add examples to usage info

Browse Source
This commit is contained in:
Rien Maertens 2020-04-07 11:48:46 +02:00
parent 48a7ed84c3
commit 088d3732c4
No known key found for this signature in database
GPG Key ID: AE66CE42F1AF9DEF
2 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -19,7 +19,8 @@ reMarkable screen sharing over SSH.
### Options
- `-p --portrait`: shows the reMarkable screen in portrait mode (the default is landscape mode, 90 degrees rotated tot the right)
- `-h --help`: show usage information
- `-p --portrait`: shows the reMarkable screen in portrait mode (default: landscape mode, 90 degrees rotated tot the right)
- `-s --source`: the ssh destination of the reMarkable (default: `root@10.11.99.1`)
- `-o --output`: path of the output where the video should be recorded, as understood by `ffmpeg`; if this is `-`, the video is displayed in a new window and not recorded anywhere (default: `-`)
- `-f --format`: when recording to an output, this option is used to force the encoding format; if this is `-`, `ffmpeg`’s auto format detection based on the file extension is used (default: `-`).

8
reStream.sh
View File

@ -28,8 +28,14 @@ while [ $# -gt 0 ]; do
shift
shift
;;
*)
-h | --help | *)
echo "Usage: $0 [-p] [-s <source>] [-o <output>] [-f <format>]"
echo "Examples:"
echo " $0 # live view in landscape"
echo " $0 -p # live view in portrait"
echo " $0 -s 192.168.0.10 # connect to different IP"
echo " $0 -o remarkable.mp4 # record to a file"
echo " $0 -o udp://dest:1234 -f mpegts # record to a stream"
exit 1
;;
esac