Documentation ¶
Overview ¶
Package cmd implemnts the rclone command
It is in a sub package so it's internals can be re-used elsewhere
Index ¶
- Variables
- func AddBackendFlags()
- func CheckArgs(MinArgs, MaxArgs int, cmd *cobra.Command, args []string)
- func Main()
- func NewFsDir(args []string) fs.Fs
- func NewFsDstFile(args []string) (fdst fs.Fs, dstFileName string)
- func NewFsFile(remote string) (fs.Fs, string)
- func NewFsSrc(args []string) fs.Fs
- func NewFsSrcDst(args []string) (fs.Fs, fs.Fs)
- func NewFsSrcDstFiles(args []string) (fsrc fs.Fs, srcFileName string, fdst fs.Fs, dstFileName string)
- func NewFsSrcFileDst(args []string) (fsrc fs.Fs, srcFileName string, fdst fs.Fs)
- func Run(Retry bool, showStats bool, cmd *cobra.Command, f func() error)
- func ShowStats() bool
- func ShowVersion()
- func SigInfoHandler()
- func StartStats() func()
Constants ¶
This section is empty.
Variables ¶
var GeneratingDocs = false
GeneratingDocs is set by rclone gendocs to alter the format of the output suitable for the documentation.
var Root = &cobra.Command{ Use: "rclone", Short: "Show help for rclone commands, flags and backends.", Long: ` Rclone syncs files to and from cloud storage providers as well as mounting them, listing them in lots of different ways. See the home page (https://rclone.org/) for installation, usage, documentation, changelog and configuration walkthroughs. `, PersistentPostRun: func(cmd *cobra.Command, args []string) { fs.Debugf("rclone", "Version %q finishing with parameters %q", fs.Version, os.Args) atexit.Run() }, BashCompletionFunction: bashCompletionFunc, DisableAutoGenTag: true, }
Root is the main rclone command
Functions ¶
func AddBackendFlags ¶
func AddBackendFlags()
AddBackendFlags creates flags for all the backend options
func NewFsDstFile ¶
NewFsDstFile creates a new dst fs with a destination file name from the arguments
func NewFsFile ¶
NewFsFile creates a Fs from a name but may point to a file.
It returns a string with the file name if points to a file otherwise "".
func NewFsSrc ¶
NewFsSrc creates a new src fs from the arguments.
The source can be a file or a directory - if a file then it will limit the Fs to a single file.
func NewFsSrcDst ¶
NewFsSrcDst creates a new src and dst fs from the arguments
func NewFsSrcDstFiles ¶
func NewFsSrcDstFiles(args []string) (fsrc fs.Fs, srcFileName string, fdst fs.Fs, dstFileName string)
NewFsSrcDstFiles creates a new src and dst fs from the arguments If src is a file then srcFileName and dstFileName will be non-empty
func NewFsSrcFileDst ¶
NewFsSrcFileDst creates a new src and dst fs from the arguments
The source may be a file, in which case the source Fs and file name is returned
func ShowStats ¶
func ShowStats() bool
ShowStats returns true if the user added a `--stats` flag to the command line.
This is called by Run to override the default value of the showStats passed in.
func StartStats ¶
func StartStats() func()
StartStats prints the stats every statsInterval
It returns a func which should be called to stop the stats.
Types ¶
This section is empty.
Directories ¶
Path | Synopsis |
---|---|
Package all imports all the commands
|
Package all imports all the commands |
scan
Package scan does concurrent scanning of an Fs building up a directory tree.
|
Package scan does concurrent scanning of an Fs building up a directory tree. |
httplib
Package httplib provides common functionality for http servers
|
Package httplib provides common functionality for http servers |
httplib/serve
Package serve deals with serving objects over HTTP
|
Package serve deals with serving objects over HTTP |
proxy
Package proxy implements a programmable proxy for rclone serve
|
Package proxy implements a programmable proxy for rclone serve |
proxy/proxyflags
Package proxyflags implements command line flags to set up a proxy
|
Package proxyflags implements command line flags to set up a proxy |
restic
Package restic serves a remote suitable for use with restic
|
Package restic serves a remote suitable for use with restic |
servetest
Package servetest provides infrastructure for running loopback tests of "rclone serve backend:" against the backend integration tests.
|
Package servetest provides infrastructure for running loopback tests of "rclone serve backend:" against the backend integration tests. |
webdav
Package webdav implements a WebDAV server backed by rclone VFS
|
Package webdav implements a WebDAV server backed by rclone VFS |