namespace lyx {
namespace support {
-/// @returns the contents of the environment variable @c name.
+/// @returns the contents of the environment variable @c name encoded in utf8.
std::string const getEnv(std::string const & envname);
/** @returns the contents of the environment variable @c name,
- * split into path elements using the OS-dependent separator token.
+ * split into path elements using the OS-dependent separator token
+ * and encoded in utf8.
* Each element is then passed through os::internal_path() to
* guarantee that it is in the form of a unix-style path.
* If the environment variable is not set, then the function returns
* an empty vector.
- */
+ */
std::vector<std::string> const getEnvPath(std::string const & name);
/** Set the contents of the environment variable @c name to @c value.
+ * \p value is encoded in utf8.
* @returns true if the variable was set successfully.
*/
bool setEnv(std::string const & name, std::string const & value);
/** Set the contents of the environment variable @c name
- * using the paths stored in the @c env vector.
+ * using the paths stored in the @c env vector (encoded in utf8).
* Each element is passed through os::external_path().
* Multiple elements are concatenated into a single string using
* os::path_separator().
/** Prepend a list of paths to that returned by the environment variable.
* Identical paths occurring later in the list are removed.
- * @param name the name of the environment variable.
- * @prefix the list of paths in OS-native syntax.
+ * @param name the name of the environment variable (encoded in utf8).
+ * @prefix the list of paths in OS-native syntax (encoded in utf8).
* Eg "/foo/bar:/usr/bin:/usr/local/bin" on *nix,
* "C:\foo\bar;C:\windows" on Windows.
*/