Logger and print configuration

Environmental variable	Description	Related documentation page
`YARP_QUIET`	If this variables exists and is set to a positive integer, it disables the (internal) YARP messages prints. Note: this variable do not modify the behavior of `yError`, `yDebug`, ... .	Logging with YARP
`YARP_VERBOSE`	If this variables exists and is set to a nonnegative integer, it sets the verbosity level (the higher the integer, the more messages will be printed) for YARP messages prints. This variable is ignored if `YARP_QUIET` is set to a positive integer. Note: this variable does not modify the behavior of `yError`, `yDebug`, ... .	Logging with YARP
`YARP_COLORED_OUTPUT`	If this variable exists and is set to 1, it enables the YARP colored prints. Otherwise disable the colored prints.	Logging with YARP
`YARP_COMPACT_OUTPUT`	If this variable exists and is set to 1, and colors are enabled, print a single colored character instead of the log level.	Logging with YARP
`YARP_VERBOSE_OUTPUT`	If this variable exists and is set to 1, it adds to the YARP prints the filename, the line of the source and the function from which the message is printed.	Logging with YARP
`YARP_TRACE_ENABLE`	If this variable exists and is set to 1, it enables the YARP trace prints. Otherwise disable the trace prints.	Logging with YARP
`YARP_DEBUG_ENABLE`	If this variable exists and is set to 0, it disables the YARP debug prints. Otherwise leaves them enabled.	Logging with YARP
`YARP_FORWARD_LOG_ENABLE`	If this variable exists and is set to 1, enables the forwarding of log over ports to be used by the yarplogger. Otherwise disable the forwarding.	Logging with YARP
`YARP_LOG_PROCESS_LABEL`	If this variable exists and is set to a string, the specified label is attached to the log port to better specify the name of the process to which the log belongs to.	Logging with YARP

Directories

Environmental variable	Description	Related documentation page
`YARP_DATA_HOME`	Directory where user-specific YARP data files should be written.	yarp::conf::dirs::yarpdatahome()
`YARP_CONFIG_HOME`	Directory where user-specific YARP configuration files should be written.	yarp::conf::dirs::yarpconfighome()
`YARP_DATA_DIRS`	Directories where YARP data files are be searched.	yarp::conf::dirs::yarpdatadirs()
`YARP_CONFIG_DIRS`	Directories where YARP configuration files are searched.	yarp::conf::dirs::yarpconfigdirs()
`YARP_CACHE_HOME`	Directory where user-specific non-essential (cached) YARP data should be written.	yarp::conf::dirs::yarpcachehome()
`YARP_RUNTIME_DIR`	Directory where user-specific runtime files and other file objects should be placed.	yarp::conf::dirs::yarpruntimedir()

Defaults for these variables depend on the operating system and on other environment variables. See the relative documentation to understand how these influence each variable

Environmental variables checked on Linux
`XDG_CONFIG_HOME`
`XDG_DATA_HOME`
`XDG_CONFIG_DIRS`
`XDG_DATA_DIRS`
`XDG_CACHE_HOME`
`XDG_RUNTIME_DIR`
`USER`
`HOME`
`TMPDIR`

Environmental variables checked on Windows
`APPDATA`
`LOCALAPPDATA`
`ALLUSERSPROFILE`
`USERNAME`
`USERPROFILE`
`TEMP`

Environmental variables checked on macOS
`USER`
`TMPDIR`
`HOME`

Robot Configuration

Environmental variable	Description	Related documentation page
`YARP_ROBOT_NAME`	Variable used to refer to the name of the specific robot used in the system, to load its specific configuration files.	YARP data directories

UDP Carrier configuration

Environmental variable	Description	Related documentation page
`YARP_DGRAM_SIZE`	Large UDP messages are broken into a series of datagrams. This variable control the size of this datagrams in bytes for both the `udp` and `mcast` carriers.	Configuring YARP Connections
`YARP_MCAST_SIZE`	This variable controls the size of datagrams in bytes for just the `mcast` carrier.	Configuring YARP Connections
`YARP_UDP_SIZE`	This variable controls the size of datagrams in bytes for just the `udp` carrier.	Configuring YARP Connections
`YARP_DGRAM_BUFFER_SIZE`	This variable controls the size in bytes of the UDP socket buffer, both for receiving and sending.
`YARP_DGRAM_RECV_BUFFER_SIZE`	This variable controls the size in bytes of the UDP socket receiving buffer.
`YARP_DGRAM_SND_BUFFER_SIZE`	This variable controls the size in bytes of the UDP socket sending buffer.

Misc configuration

Environmental variable	Description	Related documentation page
`YARP_CLOCK`	If this variable is set, the default YARP time facilities will read the time from the yarp port whose name is contained in this variable.
`YARP_PORT_PREFIX`	If this variable is set, its content is prepended to the name of the port whenever a port is opened. For example: `YARP_PORT_PREFIX=/prefix yarp read /read` will open a port named `/prefix/read` for shells where this syntax is permitted.
`YARP_RENAME<???>`	Suppose a program has a port called `/foo/bar` and there is no way provided to change the name of that port other than source code modification. The port name can be changed entirely setting the `YARP_RENAME_foo_bar` variable to the desired name of the port. For example: `YARP_RENAME_read=/logger yarp read /read` will open a port named `/logger` for shells where this syntax is permitted. Renames (if present) are applied before prefixes specified with `YARP_PORT_PREFIX` (if present).
`YARP_PORTNUMBER<???>`	Suppose a program has a port called `/foo/bar` and there is no way provided to change the number of that port other than source code modification. The port number can be changed setting the `YARP_PORTNUMBER_foo_bar` variable to the desired port number of the port. For example: `YARP_PORTNUMBER_read=20050 yarp read /read` will open a port named `/read` on the `20050` port. Port numbers (if present) are applied before prefixes specified with `YARP_PORT_PREFIX` and renames specified with `YARP_RENAME` (if present). WARNING, if the same port is opened with the same name but different port number by two processes, this might lead to port stealing by the latest process executed.
`YARP_NAMESPACE`	If this variable is set, its content is used by YARP as namespace, overriding the value set by `yarp namespace`
`YARP_IP`	If this variable is set, it forces the IP address used for registering YARP ports to be in a particular family. Prefixes are allowed. For example, on a machine with a 10.11.4.4 address and a 192.168.1.10 address, seeting YARP_IP to 192 or 192.168 or 192.168.1.10 all result in the 192.xxx.xxx.xxx IP address being used.

TODO YARP_IS_YARPRUN TODO YARPRUN_IS_FORWARDING_LOG

Other

Environment variables related to YARP, but not consumed by YARP itself

Environmental variable	Description	Related documentation page
`YARP_DIR`	Variable consumed by CMake to find the location of YARP. See https://cmake.org/cmake/help/latest/command/find_package.html for more info
`YARP_ROOT`	Variable that usually points to the source directory of the YARP repository, used typically in YARP documentation.

Deprecated Environmental Variables

Environmental variable	Description	Related documentation page
`YARP_POLICY`	Legacy variable used to change the behavior of the ResourceFinder. Deprecated since YARP 2.3.65
`YARP_STACK_SIZE`	Default stack size (in bytes) for YARP threads. Deprecated since YARP 3.0.0
`YARP_LOGGER_STREAM`	Legacy variable to print legacy debug messages on `stdout` instead instead of `stderr`. Deprecated since YARP 3.4.0

Build system

Environmental variable	Description	Related documentation page
`CLICOLOR_FORCE`	Enable colors in CMake output	https://bixense.com/clicolors/