diff --git a/trunk/doc/man/README b/trunk/doc/man/README new file mode 100644 index 0000000000..2a44870670 --- /dev/null +++ b/trunk/doc/man/README @@ -0,0 +1,9 @@ +convert `markdown` to `man-page` by `pandoc`: +```bash +pandoc srs-server.8.md -s -t man -o srs-server.8 +``` + +Also, you can preview as follows: +```bash +pandoc srs-server.8.md -s -t man | /usr/bin/man -l - +``` \ No newline at end of file diff --git a/trunk/doc/man/srs-server.8.md b/trunk/doc/man/srs-server.8.md new file mode 100644 index 0000000000..b5a82621b8 --- /dev/null +++ b/trunk/doc/man/srs-server.8.md @@ -0,0 +1,72 @@ +--- +title: SRS-SERVER +section: 8 +date: 30 July, 2023 +--- + +# NAME + +**srs-server** - an open-source video server, supports RTMP/WebRTC/HLS/HTTP-FLV/SRT. + +# SYNOPSIS + +**srs-server** \<-h?vVgGe\>\|\<\[-t\] -c filename\> + +# DESCRIPTION + +SRS is a simple, high efficiency and realtime video server, supports RTMP/WebRTC/HLS/HTTP-FLV/SRT. + +The options are as follows: + +Options: + +-?, -h, --help : Show this help and exit 0.\ +-v, -V, --version : Show version and exit 0.\ +-g, -G : Show server signature and exit 0. -e : Use environment variable only, ignore config file.\ +-t : Test configuration file, exit with error code(0 for success).\ +-c filename : Use config file to start server.\ + +# FILES + +/run/srs-server.pid + + Contains the process ID of srs-server. The contents of this file are not sensitive, so it can be world-readable. + +/etc/srs-server/srs.conf + + The main configuration file. + + +# EXIT STATUS + +Exit status is 0 on success, or 1 if the command fails. + +# EXAMPLE +For example: + + srs-server -v + srs-server -t -c conf/srs.conf + srs-server -c conf/srs.conf + +# SEE ALSO + +Documentation at https://ossrs.io/lts/en-us/docs/v5/doc/getting-started. + +# HISTORY + +Development of srs-server started in 2013. + +# AUTHORS + +Winlin\ +ZhaoWenjie\ +ShiWei\ +XiaoZhihong\ +WuPengqiang\ +XiaLixin\ +LiPeng\ +ChenGuanghua\ +ChenHaibo\ +and https://github.com/ossrs/srs/blob/develop/trunk/AUTHORS.md#contributors + +