From bc70a95fca06670c4e7065d621463417698186ae Mon Sep 17 00:00:00 2001 From: albertony <12441419+albertony@users.noreply.github.com> Date: Sun, 19 Jun 2022 18:59:54 +0200 Subject: [PATCH] docs: consistent capitalization of WebDAV, DLNA, HTTP --- README.md | 2 +- backend/http/http.go | 4 ++-- backend/webdav/webdav.go | 4 ++-- cmd/serve/http/data/data.go | 6 +++--- cmd/serve/httplib/httplib.go | 8 ++++---- cmd/serve/webdav/webdav.go | 12 ++++++------ docs/content/_index.md | 2 +- docs/content/faq.md | 2 +- docs/content/filtering.md | 2 +- docs/content/http.md | 2 +- docs/content/onedrive.md | 2 +- docs/content/webdav.md | 4 ++-- 12 files changed, 25 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 7a955d31f..ba85e16bd 100644 --- a/README.md +++ b/README.md @@ -111,7 +111,7 @@ These backends adapt or modify other storage providers * Optional encryption ([Crypt](https://rclone.org/crypt/)) * Optional FUSE mount ([rclone mount](https://rclone.org/commands/rclone_mount/)) * Multi-threaded downloads to local disk - * Can [serve](https://rclone.org/commands/rclone_serve/) local or remote files over HTTP/WebDav/FTP/SFTP/dlna + * Can [serve](https://rclone.org/commands/rclone_serve/) local or remote files over HTTP/WebDAV/FTP/SFTP/DLNA ## Installation & documentation diff --git a/backend/http/http.go b/backend/http/http.go index e2a993a44..bd53da943 100644 --- a/backend/http/http.go +++ b/backend/http/http.go @@ -35,11 +35,11 @@ var ( func init() { fsi := &fs.RegInfo{ Name: "http", - Description: "http Connection", + Description: "HTTP Connection", NewFs: NewFs, Options: []fs.Option{{ Name: "url", - Help: "URL of http host to connect to.\n\nE.g. \"https://example.com\", or \"https://user:pass@example.com\" to use a username and password.", + Help: "URL of HTTP host to connect to.\n\nE.g. \"https://example.com\", or \"https://user:pass@example.com\" to use a username and password.", Required: true, }, { Name: "headers", diff --git a/backend/webdav/webdav.go b/backend/webdav/webdav.go index 7016b289c..d663ac0bf 100644 --- a/backend/webdav/webdav.go +++ b/backend/webdav/webdav.go @@ -66,7 +66,7 @@ func init() { fs.Register(&fs.RegInfo{ Name: "webdav", - Description: "Webdav", + Description: "WebDAV", NewFs: NewFs, Options: []fs.Option{{ Name: "url", @@ -74,7 +74,7 @@ func init() { Required: true, }, { Name: "vendor", - Help: "Name of the Webdav site/service/software you are using.", + Help: "Name of the WebDAV site/service/software you are using.", Examples: []fs.OptionExample{{ Value: "nextcloud", Help: "Nextcloud", diff --git a/cmd/serve/http/data/data.go b/cmd/serve/http/data/data.go index f413c0552..de8362100 100644 --- a/cmd/serve/http/data/data.go +++ b/cmd/serve/http/data/data.go @@ -19,8 +19,8 @@ import ( var Help = ` #### Template ---template allows a user to specify a custom markup template for http -and webdav serve functions. The server exports the following markup +--template allows a user to specify a custom markup template for HTTP +and WebDAV serve functions. The server exports the following markup to be used within the template to server pages: | Parameter | Description | @@ -58,7 +58,7 @@ func AfterEpoch(t time.Time) bool { return t.After(time.Time{}) } -// GetTemplate returns the HTML template for serving directories via HTTP/Webdav +// GetTemplate returns the HTML template for serving directories via HTTP/WebDAV func GetTemplate(tmpl string) (tpl *template.Template, err error) { var templateString string if tmpl == "" { diff --git a/cmd/serve/httplib/httplib.go b/cmd/serve/httplib/httplib.go index ae6583af9..4e3efe7d0 100644 --- a/cmd/serve/httplib/httplib.go +++ b/cmd/serve/httplib/httplib.go @@ -53,8 +53,8 @@ inserts leading and trailing "/" on --baseurl, so --baseurl "rclone", --baseurl "/rclone" and --baseurl "/rclone/" are all treated identically. ---template allows a user to specify a custom markup template for http -and webdav serve functions. The server exports the following markup +--template allows a user to specify a custom markup template for HTTP +and WebDAV serve functions. The server exports the following markup to be used within the template to server pages: | Parameter | Description | @@ -99,8 +99,8 @@ Use --realm to set the authentication realm. #### SSL/TLS -By default this will serve over http. If you want you can serve over -https. You will need to supply the --cert and --key flags. If you +By default this will serve over HTTP. If you want you can serve over +HTTPS. You will need to supply the --cert and --key flags. If you wish to do client side certificate validation then you will need to supply --client-ca also. diff --git a/cmd/serve/webdav/webdav.go b/cmd/serve/webdav/webdav.go index 89a76b230..4d152a433 100644 --- a/cmd/serve/webdav/webdav.go +++ b/cmd/serve/webdav/webdav.go @@ -43,14 +43,14 @@ func init() { // Command definition for cobra var Command = &cobra.Command{ Use: "webdav remote:path", - Short: `Serve remote:path over webdav.`, + Short: `Serve remote:path over WebDAV.`, Long: ` -rclone serve webdav implements a basic webdav server to serve the -remote over HTTP via the webdav protocol. This can be viewed with a -webdav client, through a web browser, or you can make a remote of -type webdav to read and write it. +rclone serve webdav implements a basic WebDAV server to serve the +remote over HTTP via the WebDAV protocol. This can be viewed with a +WebDAV client, through a web browser, or you can make a remote of +type WebDAV to read and write it. -### Webdav options +### WebDAV options #### --etag-hash diff --git a/docs/content/_index.md b/docs/content/_index.md index c7a213bfa..42c8b4866 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -95,7 +95,7 @@ Rclone helps you: - [Move](/commands/rclone_move/) files to cloud storage deleting the local after verification - [Check](/commands/rclone_check/) hashes and for missing/extra files - [Mount](/commands/rclone_mount/) your cloud storage as a network disk -- [Serve](/commands/rclone_serve/) local or remote files over [HTTP](/commands/rclone_serve_http/)/[WebDav](/commands/rclone_serve_webdav/)/[FTP](/commands/rclone_serve_ftp/)/[SFTP](/commands/rclone_serve_sftp/)/[dlna](/commands/rclone_serve_dlna/) +- [Serve](/commands/rclone_serve/) local or remote files over [HTTP](/commands/rclone_serve_http/)/[WebDav](/commands/rclone_serve_webdav/)/[FTP](/commands/rclone_serve_ftp/)/[SFTP](/commands/rclone_serve_sftp/)/[DLNA](/commands/rclone_serve_dlna/) - Experimental [Web based GUI](/gui/) ## Supported providers {#providers} diff --git a/docs/content/faq.md b/docs/content/faq.md index ecd240882..00ed0e06d 100644 --- a/docs/content/faq.md +++ b/docs/content/faq.md @@ -118,7 +118,7 @@ e.g. export no_proxy=localhost,127.0.0.0/8,my.host.name export NO_PROXY=$no_proxy -Note that the ftp backend does not support `ftp_proxy` yet. +Note that the FTP backend does not support `ftp_proxy` yet. ### Rclone gives x509: failed to load system roots and no roots provided error ### diff --git a/docs/content/filtering.md b/docs/content/filtering.md index de191ddc2..8fc3bf109 100644 --- a/docs/content/filtering.md +++ b/docs/content/filtering.md @@ -274,7 +274,7 @@ every path against the supplied regular expression(s). Directory recursion optimisation occurs if either: * A source remote does not support the rclone `ListR` primitive. local, -sftp, Microsoft OneDrive and WebDav do not support `ListR`. Google +sftp, Microsoft OneDrive and WebDAV do not support `ListR`. Google Drive and most bucket type storage do. [Full list](https://rclone.org/overview/#optional-features) * On other remotes (those that support `ListR`), if the rclone command is not naturally recursive, and diff --git a/docs/content/http.md b/docs/content/http.md index 501cd5a22..9affbf358 100644 --- a/docs/content/http.md +++ b/docs/content/http.md @@ -52,7 +52,7 @@ name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] -XX / http Connection +XX / HTTP Connection \ "http" [snip] Storage> http diff --git a/docs/content/onedrive.md b/docs/content/onedrive.md index f25bbe513..36f3c89fb 100644 --- a/docs/content/onedrive.md +++ b/docs/content/onedrive.md @@ -670,7 +670,7 @@ Description: Using application 'rclone' is currently not supported for your orga This means that rclone can't use the OneDrive for Business API with your account. You can't do much about it, maybe write an email to your admins. -However, there are other ways to interact with your OneDrive account. Have a look at the webdav backend: https://rclone.org/webdav/#sharepoint +However, there are other ways to interact with your OneDrive account. Have a look at the WebDAV backend: https://rclone.org/webdav/#sharepoint ### invalid\_grant (AADSTS50076) #### diff --git a/docs/content/webdav.md b/docs/content/webdav.md index c5612fead..766a5cc8c 100644 --- a/docs/content/webdav.md +++ b/docs/content/webdav.md @@ -31,7 +31,7 @@ name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] -XX / Webdav +XX / WebDAV \ "webdav" [snip] Storage> webdav @@ -40,7 +40,7 @@ Choose a number from below, or type in your own value 1 / Connect to example.com \ "https://example.com" url> https://example.com/remote.php/webdav/ -Name of the Webdav site/service/software you are using +Name of the WebDAV site/service/software you are using Choose a number from below, or type in your own value 1 / Nextcloud \ "nextcloud"