From fee0abf513c93b3af065fa7e3aa2de9268acfbb5 Mon Sep 17 00:00:00 2001 From: albertony <12441419+albertony@users.noreply.github.com> Date: Sun, 13 Jun 2021 18:45:17 +0200 Subject: [PATCH] docs: add note about use of user and logname environment variables for current username --- docs/content/docs.md | 1 + docs/content/tardigrade.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/content/docs.md b/docs/content/docs.md index 0e927f90b..ceb24c6a1 100644 --- a/docs/content/docs.md +++ b/docs/content/docs.md @@ -2187,4 +2187,5 @@ For non backend configuration the order is as follows: - `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` (or the lowercase versions thereof). - `HTTPS_PROXY` takes precedence over `HTTP_PROXY` for https requests. - The environment values may be either a complete URL or a "host[:port]" for, in which case the "http" scheme is assumed. +- `USER` and `LOGNAME` values are used as fallbacks for current username. The primary method for looking up username is OS-specific: Windows API on Windows, real user ID in /etc/passwd on Unix systems. In the documentation the current username is simply referred to as `$USER`. - `RCLONE_CONFIG_DIR` - rclone **sets** this variable for use in config files and sub processes to point to the directory holding the config file. diff --git a/docs/content/tardigrade.md b/docs/content/tardigrade.md index 15d7fb174..49c688784 100644 --- a/docs/content/tardigrade.md +++ b/docs/content/tardigrade.md @@ -314,4 +314,4 @@ See [rclone about](https://rclone.org/commands/rclone_about/) If you get errors like `too many open files` this usually happens when the default `ulimit` for system max open files is exceeded. Native Storj protocol opens a large number of TCP connections (each of which is counted as an open file). For a single upload stream you can expect 110 TCP connections to be opened. For a single download stream you can expect 35. This batch of connections will be opened for every 64 MiB segment and you should also expect TCP connections to be reused. If you do many transfers you eventually open a connection to most storage nodes (thousands of nodes). -To fix these, please raise your system limits. You can do this issuing a `ulimit -n 65536` just before you run rclone, inside a bash script or inside the `$USER/.bashrc` file. If you need to change limits system-wide, this usually takes place at `/etc/sysctl.conf` and/or `/etc/security/limits.conf` on Linux, but please refer to your operating system manual. +To fix these, please raise your system limits. You can do this issuing a `ulimit -n 65536` just before you run rclone. To change the limits more permanently you can add this to your shell startup script, e.g. `$HOME/.bashrc`, or change the system-wide configuration, usually `/etc/sysctl.conf` and/or `/etc/security/limits.conf`, but please refer to your operating system manual.