Merge pull request #23 from alexmyczko/master

basic manual page for uxplay

uxplay.1

@@ -0,0 +1,48 @@
+.TH UXPLAY "1" "October 2021" "1.38" "User Commands"
+.SH NAME
+uxplay \- uxplay
+.SH SYNOPSIS
+.B uxplay
+[\fI\,-n name\/\fR] [\fI\,-s wxh\/\fR] [\fI\,-p \/\fR[\fI\,n\/\fR]]
+.SH DESCRIPTION
+UxPlay 1.37: An open\-source AirPlay mirroring server based on RPiPlay
+.SH OPTIONS
+.TP
+.B \fB\-n\fR name
+Specify the network name of the AirPlay server
+.TP
+.B
+\fB\-s\fR wxh[@r]Set display resolution [refresh_rate] default 1920x1080[@60]
+.TP
+\fB\-o\fR        Set mirror "overscanned" mode on (not usually needed)
+.TP
+\fB\-fps\fR n    Set maximum allowed streaming framerate, default 30
+.TP
+\fB\-f\fR {H|V|I}Horizontal|Vertical flip, or both=Inversion=rotate 180 deg
+.TP
+\fB\-r\fR {R|L}  Rotate 90 degrees Right (cw) or Left (ccw)
+.TP
+\fB\-p\fR        Use legacy ports UDP 6000:6001:7011 TCP 7000:7001:7100
+.TP
+\fB\-p\fR n      Use TCP and UDP ports n,n+1,n+2. range 1024\-65535
+.IP
+use "\-p n1,n2,n3" to set each port, "n1,n2" for n3 = n2+1
+"\-p tcp n" or "\-p udp n" sets TCP or UDP ports only
+.PP
+.TP
+\fB\-m\fR        Use random MAC address (use for concurrent UxPlay's)
+.TP
+\fB\-a\fR        Turn audio off. video output only
+.TP
+\fB\-t\fR n      Relaunch server if no connection existed in last n seconds
+.TP
+\fB\-vs\fR       Choose the  GStreamer videosink; default "autovideosink"
+.IP
+choices: ximagesink,xvimagesink,vaapisink,fpsdisplaysink, etc.
+.PP
+.TP
+\fB\-vs\fR 0     Streamed audio only, with no video display window
+.TP
+\fB\-d\fR        Enable debug logging
+.TP
+\fB\-v\fR/\-h     Displays this help and version information