Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Include a guide for the Debian and Ubuntu installer. #3774

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions trunk/doc/man/README
Original file line number Diff line number Diff line change
@@ -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 -
```
72 changes: 72 additions & 0 deletions trunk/doc/man/srs-server.8.md
Original file line number Diff line number Diff line change
@@ -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<[email protected]>\
ZhaoWenjie<[email protected]>\
ShiWei<[email protected]>\
XiaoZhihong<[email protected]>\
WuPengqiang<[email protected]>\
XiaLixin<[email protected]>\
LiPeng<[email protected]>\
ChenGuanghua<[email protected]>\
ChenHaibo<[email protected]>\
and https://github.com/ossrs/srs/blob/develop/trunk/AUTHORS.md#contributors