docs: improve serve command descriptions

This commit is contained in:
albertony 2022-06-19 19:18:14 +02:00
parent bc70a95fca
commit 70d9d75801
7 changed files with 24 additions and 25 deletions

View File

@ -34,14 +34,16 @@ func init() {
var Command = &cobra.Command{ var Command = &cobra.Command{
Use: "dlna remote:path", Use: "dlna remote:path",
Short: `Serve remote:path over DLNA`, Short: `Serve remote:path over DLNA`,
Long: `rclone serve dlna is a DLNA media server for media stored in an rclone remote. Many Long: `Run a DLNA media server for media stored in an rclone remote. Many
devices, such as the Xbox and PlayStation, can automatically discover this server in the LAN devices, such as the Xbox and PlayStation, can automatically discover
and play audio/video from it. VLC is also supported. Service discovery uses UDP multicast this server in the LAN and play audio/video from it. VLC is also
packets (SSDP) and will thus only work on LANs. supported. Service discovery uses UDP multicast packets (SSDP) and
will thus only work on LANs.
Rclone will list all files present in the remote, without filtering based on media formats or Rclone will list all files present in the remote, without filtering
file extensions. Additionally, there is no media transcoding support. This means that some based on media formats or file extensions. Additionally, there is no
players might show files that they are not able to play back correctly. media transcoding support. This means that some players might show
files that they are not able to play back correctly.
` + dlnaflags.Help + vfs.Help, ` + dlnaflags.Help + vfs.Help,
Run: func(command *cobra.Command, args []string) { Run: func(command *cobra.Command, args []string) {

View File

@ -80,9 +80,9 @@ var Command = &cobra.Command{
Use: "ftp remote:path", Use: "ftp remote:path",
Short: `Serve remote:path over FTP.`, Short: `Serve remote:path over FTP.`,
Long: ` Long: `
rclone serve ftp implements a basic ftp server to serve the Run a basic FTP server to serve a remote over FTP protocol.
remote over FTP protocol. This can be viewed with a ftp client This can be viewed with a FTP client or you can make a remote of
or you can make a remote of type ftp to read and write it. type FTP to read and write it.
### Server options ### Server options

View File

@ -47,9 +47,9 @@ func init() {
var Command = &cobra.Command{ var Command = &cobra.Command{
Use: "http remote:path", Use: "http remote:path",
Short: `Serve the remote over HTTP.`, Short: `Serve the remote over HTTP.`,
Long: `rclone serve http implements a basic web server to serve the remote Long: `Run a basic web server to serve a remote over HTTP.
over HTTP. This can be viewed in a web browser or you can make a This can be viewed in a web browser or you can make a remote of type
remote of type http read from it. http read from it.
You can use the filter flags (e.g. --include, --exclude) to control what You can use the filter flags (e.g. --include, --exclude) to control what
is served. is served.

View File

@ -50,8 +50,8 @@ func init() {
var Command = &cobra.Command{ var Command = &cobra.Command{
Use: "restic remote:path", Use: "restic remote:path",
Short: `Serve the remote for restic's REST API.`, Short: `Serve the remote for restic's REST API.`,
Long: `rclone serve restic implements restic's REST backend API Long: `Run a basic web server to serve a remove over restic's REST backend
over HTTP. This allows restic to use rclone as a data storage API over HTTP. This allows restic to use rclone as a data storage
mechanism for cloud providers that restic does not support directly. mechanism for cloud providers that restic does not support directly.
[Restic](https://restic.net/) is a command-line program for doing [Restic](https://restic.net/) is a command-line program for doing

View File

@ -41,8 +41,8 @@ func init() {
var Command = &cobra.Command{ var Command = &cobra.Command{
Use: "serve <protocol> [opts] <remote>", Use: "serve <protocol> [opts] <remote>",
Short: `Serve a remote over a protocol.`, Short: `Serve a remote over a protocol.`,
Long: `rclone serve is used to serve a remote over a given protocol. This Long: `Serve a remote over a given protocol. Requires the use of a
command requires the use of a subcommand to specify the protocol, e.g. subcommand to specify the protocol, e.g.
rclone serve http remote: rclone serve http remote:

View File

@ -62,9 +62,8 @@ func init() {
var Command = &cobra.Command{ var Command = &cobra.Command{
Use: "sftp remote:path", Use: "sftp remote:path",
Short: `Serve the remote over SFTP.`, Short: `Serve the remote over SFTP.`,
Long: `rclone serve sftp implements an SFTP server to serve the remote Long: `Run a SFTP server to serve a remote over SFTP. This can be used
over SFTP. This can be used with an SFTP client or you can make a with an SFTP client or you can make a remote of type sftp to use with it.
remote of type sftp to use with it.
You can use the filter flags (e.g. --include, --exclude) to control what You can use the filter flags (e.g. --include, --exclude) to control what
is served. is served.

View File

@ -44,11 +44,9 @@ func init() {
var Command = &cobra.Command{ var Command = &cobra.Command{
Use: "webdav remote:path", Use: "webdav remote:path",
Short: `Serve remote:path over WebDAV.`, Short: `Serve remote:path over WebDAV.`,
Long: ` Long: `Run a basic WebDAV server to serve a remote over HTTP via the
rclone serve webdav implements a basic WebDAV server to serve the WebDAV protocol. This can be viewed with a WebDAV client, through a web
remote over HTTP via the WebDAV protocol. This can be viewed with a browser, or you can make a remote of type WebDAV to read and write it.
WebDAV client, through a web browser, or you can make a remote of
type WebDAV to read and write it.
### WebDAV options ### WebDAV options