RepoMirrors
/
syncplay
mirror of https://github.com/Syncplay/syncplay
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
syncplay/docs/syncplay-server.1

108 lines
3.0 KiB
Groff
Raw Permalink Normal View History

Add manpages courtesy of Bruno Kleinert #387
2021-03-07 19:07:27 +00:00
.\" Hey, EMACS: -*- nroff -*-
.\" (C) Copyright 2021 Bruno Kleinert <fuddl@debian.org>,
.\"
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH "Syncplay Server" 1 "February 7 2021"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh disable hyphenation
.\" .hy enable hyphenation
.\" .ad l left justify
.\" .ad b justify to both left and right margins
.\" .nf disable filling
.\" .fi enable filling
.\" .br insert line break
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
syncplay-server \- server to host syncplay rooms
.SH SYNOPSIS
.B syncplay-server
.RI [ options ]
.RI [ file ]
.RI [ playeroptions ]
.SH DESCRIPTION
This manual page documents briefly the
.B syncplay-server
command.
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
.\" respectively.
\fBsyncplay-server\fP is a program that syncplay clients connect to and hosts
rooms.
To host rooms for viewers via internet, make sure the server can be accessed
from the internet, i.e., its listening port is not blocked by a NAT or a
firewall.
.SH OPTIONS
This program follows the usual GNU command line syntax, with long
options starting with two dashes (`-').
A summary of options is included below.
.TP
.B \-h, \-\-help
Show summary of options.
.TP
.B \-\-port [port]
TCP port to listen for connections.
.TP
.B \-\-password [password]
Server password.
.TP
.B \-\-isolate\-rooms
Whether rooms should be isolated.
.TP
.B \-\-disable\-ready
Disable readiness feature.
.TP
.B \-\-disable\-chat
Disable the chat function.
.TP
.B \-\-salt [salt]
Random string used to generate managed room passwords.
.TP
.B \-\-motd\-file [file]
Path to a file from which motd (Message Of The Day) will be read.
Added room permanence option to server (#434)
2021-11-29 21:53:09 +00:00
.TP
Correct persistance argument type (#496) The current documentation specifies directories, likely as a result of the original design before use of a database, but the arguments expect files. This simply clarifies the documentation to match the code itself.
2022-01-13 00:50:30 +00:00
.B \-\-rooms\-db-file [file]
Re-work room persistence (#487) * Initial server-side room persistence implementation (#434) * Added room permanence option to server * Fixed error if roomsDirPath is None * Sanitized filenames * Delete room file on empty playlist * Fixed position not saving when leaving and seeking, and position not loading after a restart * Decoupled permanence check * Added --rooms-timer option that limits the max lifespan of persistent rooms * Assigned filename to variable to deduplicate calculation * Freed up room when loading unwanted room from file Co-authored-by: Assistant <assistant.moetron@gmail.com> * Use sqlite for persistent/permanent rooms (#434) * Add -temp rooms and persistent room notices * Use system loanguage for servers * Make room temp check case-insensitive * Improve temp room check * Fix controlled rooms * Refactor how non-macOS/frozen initialLanguage is fixed * Fix persistent room list * Don't send dummy users to new console clients (#434) * Allow hiding of empty persistent rooms (#434) * List current rooms in join list Co-authored-by: Assistant <assistant.moetron@gmail.com>
2021-12-09 16:23:57 +00:00
Enables room persistence. Path is to where a database file should be loaded/create where room data will be written to and read from. This will enable rooms to persist without watchers and through restarts. Will not work if using \fB\-\-isolate\-rooms\fP.
Added room permanence option to server (#434)
2021-11-29 21:53:09 +00:00
.TP
Correct persistance argument type (#496) The current documentation specifies directories, likely as a result of the original design before use of a database, but the arguments expect files. This simply clarifies the documentation to match the code itself.
2022-01-13 00:50:30 +00:00
.B \-\-permanent\-rooms-file [file]
Re-work room persistence (#487) * Initial server-side room persistence implementation (#434) * Added room permanence option to server * Fixed error if roomsDirPath is None * Sanitized filenames * Delete room file on empty playlist * Fixed position not saving when leaving and seeking, and position not loading after a restart * Decoupled permanence check * Added --rooms-timer option that limits the max lifespan of persistent rooms * Assigned filename to variable to deduplicate calculation * Freed up room when loading unwanted room from file Co-authored-by: Assistant <assistant.moetron@gmail.com> * Use sqlite for persistent/permanent rooms (#434) * Add -temp rooms and persistent room notices * Use system loanguage for servers * Make room temp check case-insensitive * Improve temp room check * Fix controlled rooms * Refactor how non-macOS/frozen initialLanguage is fixed * Fix persistent room list * Don't send dummy users to new console clients (#434) * Allow hiding of empty persistent rooms (#434) * List current rooms in join list Co-authored-by: Assistant <assistant.moetron@gmail.com>
2021-12-09 16:23:57 +00:00
Specifies a list of rooms that will still be listed even if their playlist is empty. Path is to where a text file with one room per line. This will require persistent rooms to be enabled.
Added room permanence option to server (#434)
2021-11-29 21:53:09 +00:00
Add manpages courtesy of Bruno Kleinert #387
2021-03-07 19:07:27 +00:00
.TP
.B \-\-max\-chat\-message\-length [maxChatMessageLength]
Maximum number of characters in one chat message (default is 150).
.TP
.B \-\-max\-username\-length [maxUsernameLength]
Maximum number of characters in a username (default is 150).
.TP
.B \-\-stats\-db\-file [file]
Enable server statistics using the SQLite database file.
.TP
.B \-\-tls [path]
Enable TLS connections using the certificate files in path.
.SH SEE ALSO
.BR syncplay (1).