package mountlib // "@" will be replaced by the command name, "|" will be replaced by backticksvar mountHelp = `rclone @ allows Linux, FreeBSD, macOS and Windows tomount any of Rclone's cloud storage systems as a file system withFUSE. First set up your remote using |rclone config|.  Check it works with |rclone ls| etc. On Linux and macOS, you can run mount in either foreground or background (akadaemon) mode. Mount runs in foreground mode by default. Use the |--daemon| flagto force background mode. On Windows you can run mount in foreground only,the flag is ignored. In background mode rclone acts as a generic Unix mount program: the mainprogram starts, spawns background rclone process to setup and maintain themount, waits until success or timeout and exits with appropriate code(killing the child process if it fails). On Linux/macOS/FreeBSD start the mount like this, where |/path/to/local/mount|is an **empty** **existing** directory:     rclone @ remote:path/to/files /path/to/local/mount On Windows you can start a mount in different ways. See [below](#mounting-modes-on-windows)for details. If foreground mount is used interactively from a console window,rclone will serve the mount and occupy the console so another window should beused to work with the mount until rclone is interrupted e.g. by pressing Ctrl-C. The following examples will mount to an automatically assigned drive,to specific drive letter |X:|, to path |C:\path\parent\mount|(where parent directory or drive must exist, and mount must **not** exist,and is not supported when [mounting as a network drive](#mounting-modes-on-windows)), andthe last example will mount as network share |\\cloud\remote| and map it to anautomatically assigned drive:     rclone @ remote:path/to/files *    rclone @ remote:path/to/files X:    rclone @ remote:path/to/files C:\path\parent\mount    rclone @ remote:path/to/files \\cloud\remote When the program ends while in foreground mode, either via Ctrl+C or receivinga SIGINT or SIGTERM signal, the mount should be automatically stopped. When running in background mode the user will have to stop the mount manually:     # Linux    fusermount -u /path/to/local/mount    # OS X    umount /path/to/local/mount The umount operation can fail, for example when the mountpoint is busy.When that happens, it is the user's responsibility to stop the mount manually. The size of the mounted file system will be set according to information retrievedfrom the remote, the same as returned by the [rclone about](https://rclone.org/commands/rclone_about/)command. Remotes with unlimited storage may report the used size only,then an additional 1 PiB of free space is assumed. If the remote does not[support](https://rclone.org/overview/#optional-features) the about featureat all, then 1 PiB is set as both the total and the free size. ### Installing on Windows To run rclone @ on Windows, you will need todownload and install [WinFsp](http://www.secfs.net/winfsp/). [WinFsp](https://github.com/billziss-gh/winfsp) is an open-sourceWindows File System Proxy which makes it easy to write user space filesystems for Windows.  It provides a FUSE emulation layer which rcloneuses combination with [cgofuse](https://github.com/billziss-gh/cgofuse).Both of these packages are by Bill Zissimopoulos who was very helpfulduring the implementation of rclone @ for Windows. #### Mounting modes on windows Unlike other operating systems, Microsoft Windows provides a different filesystemtype for network and fixed drives. It optimises access on the assumption fixeddisk drives are fast and reliable, while network drives have relatively high latencyand less reliability. Some settings can also be differentiated between the two types,for example that Windows Explorer should just display icons and not create previewthumbnails for image and video files on network drives. In most cases, rclone will mount the remote as a normal, fixed disk drive by default.However, you can also choose to mount it as a remote network drive, often describedas a network share. If you mount an rclone remote using the default, fixed drive modeand experience unexpected program errors, freezes or other issues, consider mountingas a network drive instead. When mounting as a fixed disk drive you can either mount to an unused drive letter,or to a path representing a **non-existent** subdirectory of an **existing** parentdirectory or drive. Using the special value |*| will tell rclone toautomatically assign the next available drive letter, starting with Z: and moving backward.Examples:     rclone @ remote:path/to/files *    rclone @ remote:path/to/files X:    rclone @ remote:path/to/files C:\path\parent\mount    rclone @ remote:path/to/files X: Option |--volname| can be used to set a custom volume name for the mountedfile system. The default is to use the remote name and path. To mount as network drive, you can add option |--network-mode|to your @ command. Mounting to a directory path is not supported inthis mode, it is a limitation Windows imposes on junctions, so the remote must alwaysbe mounted to a drive letter.     rclone @ remote:path/to/files X: --network-mode A volume name specified with |--volname| will be used to create the network share path.A complete UNC path, such as |\\cloud\remote|, optionally with path|\\cloud\remote\madeup\path|, will be used as is. Any otherstring will be used as the share part, after a default prefix |\\server\|.If no volume name is specified then |\\server\share| will be used.You must make sure the volume name is unique when you are mounting more than one drive,or else the mount command will fail. The share name will treated as the volume label forthe mapped drive, shown in Windows Explorer etc, while the complete|\\server\share| will be reported as the remote UNC path by|net use| etc, just like a normal network drive mapping. If you specify a full network share UNC path with |--volname|, this will implicitelyset the |--network-mode| option, so the following two examples have same result:     rclone @ remote:path/to/files X: --network-mode    rclone @ remote:path/to/files X: --volname \\server\share You may also specify the network share UNC path as the mountpoint itself. Then rclonewill automatically assign a drive letter, same as with |*| and use that asmountpoint, and instead use the UNC path specified as the volume name, as if it werespecified with the |--volname| option. This will also implicitely setthe |--network-mode| option. This means the following two examples have same result:     rclone @ remote:path/to/files \\cloud\remote    rclone @ remote:path/to/files * --volname \\cloud\remote There is yet another way to enable network mode, and to set the share path,and that is to pass the "native" libfuse/WinFsp option directly:|--fuse-flag --VolumePrefix=\server\share|. Note that the pathmust be with just a single backslash prefix in this case.  *Note:* In previous versions of rclone this was the only supported method. [Read more about drive mapping](https://en.wikipedia.org/wiki/Drive_mapping) See also [Limitations](#limitations) section below. #### Windows filesystem permissions The FUSE emulation layer on Windows must convert between the POSIX-basedpermission model used in FUSE, and the permission model used in Windows,based on access-control lists (ACL). The mounted filesystem will normally get three entries in its access-control list (ACL),representing permissions for the POSIX permission scopes: Owner, group and others.By default, the owner and group will be taken from the current user, and the built-ingroup "Everyone" will be used to represent others. The user/group can be customizedwith FUSE options "UserName" and "GroupName",e.g. |-o UserName=user123 -o GroupName="Authenticated Users"|.The permissions on each entry will be set according to [options](#options)|--dir-perms| and |--file-perms|, which takes a value in traditional[numeric notation](https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation). The default permissions corresponds to |--file-perms 0666 --dir-perms 0777|,i.e. read and write permissions to everyone. This means you will not be ableto start any programs from the the mount. To be able to do that you must addexecute permissions, e.g. |--file-perms 0777 --dir-perms 0777| to add itto everyone. If the program needs to write files, chances are you will haveto enable [VFS File Caching](#vfs-file-caching) as well (see also [limitations](#limitations)). Note that the mapping of permissions is not always trivial, and the resultyou see in Windows Explorer may not be exactly like you expected.For example, when setting a value that includes write access, this will bemapped to individual permissions "write attributes", "write data" and "append data",but not "write extended attributes". Windows will then show this as basicpermission "Special" instead of "Write", because "Write" includes the"write extended attributes" permission. If you set POSIX permissions for only allowing access to the owner, using|--file-perms 0600 --dir-perms 0700|, the user group and the built-in "Everyone"group will still be given some special permissions, such as "read attributes"and "read permissions", in Windows. This is done for compatibility reasons,e.g. to allow users without additional permissions to be able to read basicmetadata about files like in UNIX. One case that may arise is that other programs(incorrectly) interprets this as the file being accessible by everyone. For examplean SSH client may warn about "unprotected private key file". WinFsp 2021 (version 1.9) introduces a new FUSE option "FileSecurity",that allows the complete specification of file security descriptors using[SDDL](https://docs.microsoft.com/en-us/windows/win32/secauthz/security-descriptor-string-format).With this you can work around issues such as the mentioned "unprotected private key file"by specifying |-o FileSecurity="D:P(A;;FA;;;OW)"|, for file all access (FA) to the owner (OW). #### Windows caveats Drives created as Administrator are not visible to other accounts,not even an account that was elevated to Administrator with theUser Account Control (UAC) feature. A result of this is that if you mountto a drive letter from a Command Prompt run as Administrator, and then tryto access the same drive from Windows Explorer (which does not run asAdministrator), you will not be able to see the mounted drive. If you don't need to access the drive from applications running withadministrative privileges, the easiest way around this is to alwayscreate the mount from a non-elevated command prompt. To make mapped drives available to the user account that created themregardless if elevated or not, there is a special Windows setting called[linked connections](https://docs.microsoft.com/en-us/troubleshoot/windows-client/networking/mapped-drives-not-available-from-elevated-command#detail-to-configure-the-enablelinkedconnections-registry-entry)that can be enabled. It is also possible to make a drive mount available to everyone on the system,by running the process creating it as the built-in SYSTEM account.There are several ways to do this: One is to use the command-lineutility [PsExec](https://docs.microsoft.com/en-us/sysinternals/downloads/psexec),from Microsoft's Sysinternals suite, which has option |-s| to startprocesses as the SYSTEM account. Another alternative is to run the mountcommand from a Windows Scheduled Task, or a Windows Service, configuredto run as the SYSTEM account. A third alternative is to use the[WinFsp.Launcher infrastructure](https://github.com/billziss-gh/winfsp/wiki/WinFsp-Service-Architecture)).Note that when running rclone as another user, it will not usethe configuration file from your profile unless you tell it towith the [|--config|](https://rclone.org/docs/#config-config-file) option.Read more in the [install documentation](https://rclone.org/install/). Note that mapping to a directory path, instead of a drive letter,does not suffer from the same limitations. ### Limitations Without the use of |--vfs-cache-mode| this can only write filessequentially, it can only seek when reading.  This means that manyapplications won't work with their files on an rclone mount without|--vfs-cache-mode writes| or |--vfs-cache-mode full|.See the [VFS File Caching](#vfs-file-caching) section for more info. The bucket-based remotes (e.g. Swift, S3, Google Compute Storage, B2,Hubic) do not support the concept of empty directories, so emptydirectories will have a tendency to disappear once they fall out ofthe directory cache. When |rclone mount| is invoked on Unix with |--daemon| flag, the main rcloneprogram will wait for the background mount to become ready or until the timeoutspecified by the |--daemon-wait| flag. On Linux it can check mount status usingProcFS so the flag in fact sets **maximum** time to wait, while the real waitcan be less. On macOS / BSD the time to wait is constant and the check isperformed only at the end. We advise you to set wait time on macOS reasonably. Only supported on Linux, FreeBSD, OS X and Windows at the moment. ### rclone @ vs rclone sync/copy File systems expect things to be 100% reliable, whereas cloud storagesystems are a long way from 100% reliable. The rclone sync/copycommands cope with this with lots of retries.  However rclone @can't use retries in the same way without making local copies of theuploads. Look at the [VFS File Caching](#vfs-file-caching)for solutions to make @ more reliable. ### Attribute caching You can use the flag |--attr-timeout| to set the time the kernel cachesthe attributes (size, modification time, etc.) for directory entries. The default is |1s| which caches files just long enough to avoidtoo many callbacks to rclone from the kernel. In theory 0s should be the correct value for filesystems which canchange outside the control of the kernel. However this causes quite afew problems such as[rclone using too much memory](https://github.com/rclone/rclone/issues/2157),[rclone not serving files to samba](https://forum.rclone.org/t/rclone-1-39-vs-1-40-mount-issue/5112)and [excessive time listing directories](https://github.com/rclone/rclone/issues/2095#issuecomment-371141147). The kernel can cache the info about a file for the time given by|--attr-timeout|. You may see corruption if the remote file changeslength during this window.  It will show up as either a truncated fileor a file with garbage on the end.  With |--attr-timeout 1s| this isvery unlikely but not impossible.  The higher you set |--attr-timeout|the more likely it is.  The default setting of "1s" is the lowestsetting which mitigates the problems above. If you set it higher (|10s| or |1m| say) then the kernel will callback to rclone less often making it more efficient, however there ismore chance of the corruption issue above. If files don't change on the remote outside of the control of rclonethen there is no chance of corruption. This is the same as setting the attr_timeout option in mount.fuse. ### Filters Note that all the rclone filters can be used to select a subset of thefiles to be visible in the mount. ### systemd When running rclone @ as a systemd service, it is possibleto use Type=notify. In this case the service will enter the started stateafter the mountpoint has been successfully set up.Units having the rclone @ service specified as a requirementwill see all files and folders immediately in this mode. Note that systemd runs mount units without any environment variables including|PATH| or |HOME|. This means that tilde (|~|) expansion will not workand you should provide |--config| and |--cache-dir| explicitly as absolutepaths via rclone arguments.Since mounting requires the |fusermount| program, rclone will use the fallbackPATH of |/bin:/usr/bin| in this scenario. Please ensure that |fusermount|is present on this PATH. ### Rclone as Unix mount helper The core Unix program |/bin/mount| normally takes the |-t FSTYPE| argumentthen runs the |/sbin/mount.FSTYPE| helper program passing it mount optionsas |-o key=val,...| or |--opt=...|. Automount (classic or systemd) behavesin a similar way. rclone by default expects GNU-style flags |--key val|. To run it as a mounthelper you should symlink rclone binary to |/sbin/mount.rclone| and optionally|/usr/bin/rclonefs|, e.g. |ln -s /usr/bin/rclone /sbin/mount.rclone|.rclone will detect it and translate command-line arguments appropriately. Now you can run classic mounts like this:|||mount sftp1:subdir /mnt/data -t rclone -o vfs_cache_mode=writes,sftp_key_file=/path/to/pem||| or create systemd mount units:|||# /etc/systemd/system/mnt-data.mount[Unit]After=network-online.target[Mount]Type=rcloneWhat=sftp1:subdirWhere=/mnt/dataOptions=rw,allow_other,args2env,vfs-cache-mode=writes,config=/etc/rclone.conf,cache-dir=/var/rclone||| optionally accompanied by systemd automount unit|||# /etc/systemd/system/mnt-data.automount[Unit]After=network-online.targetBefore=remote-fs.target[Automount]Where=/mnt/dataTimeoutIdleSec=600[Install]WantedBy=multi-user.target||| or add in |/etc/fstab| a line like|||sftp1:subdir /mnt/data rclone rw,noauto,nofail,_netdev,x-systemd.automount,args2env,vfs_cache_mode=writes,config=/etc/rclone.conf,cache_dir=/var/cache/rclone 0 0||| or use classic Automountd.Remember to provide explicit |config=...,cache-dir=...| as a workaround formount units being run without |HOME|. Rclone in the mount helper mode will split |-o| argument(s) by comma, replace |_|by |-| and prepend |--| to get the command-line flags. Options containing commasor spaces can be wrapped in single or double quotes. Any inner quotes inside outerquotes of the same type should be doubled. Mount option syntax includes a few extra options treated specially: - |env.NAME=VALUE| will set an environment variable for the mount process.  This helps with Automountd and Systemd.mount which don't allow setting  custom environment for mount helpers.  Typically you will use |env.HTTPS_PROXY=proxy.host:3128| or |env.HOME=/root|- |command=cmount| can be used to run |cmount| or any other rclone command  rather than the default |mount|.- |args2env| will pass mount options to the mount helper running in background  via environment variables instead of command line arguments. This allows to  hide secrets from such commands as |ps| or |pgrep|.- |vv...| will be transformed into appropriate |--verbose=N|- standard mount options like |x-systemd.automount|, |_netdev|, |nosuid| and alike  are intended only for Automountd and ignored by rclone.`