Reference

General information about the commands, configuration files, etc.

Contents:

• Commands
  • Consumer commands
  • Creator commands
  • Package development commands
  • Misc commands
  • Output
  • Return codes
• conanfile.txt
  • Sections
• conanfile.py
  • Attributes
  • Methods
  • Python requires
  • Output and Running
• Generators
  • cmake
  • cmake_multi
  • cmake_paths
  • cmake_find_package
  • visual_studio
  • visual_studio_multi
  • visual_studio_legacy
  • xcode
  • compiler_args
  • gcc
  • Boost Build
  • B2 [EXPERIMENTAL]
  • qbs
  • qmake
  • scons
  • pkg_config
  • virtualenv
  • virtualbuildenv
  • virtualrunenv
  • youcompleteme
  • txt
  • json
  • premake [EXPERIMENTAL]
  • make
• Profiles
  • Package settings and env vars
  • Profile includes
  • Variable declaration
  • Examples
• Build helpers
  • CMake
  • AutoToolsBuildEnvironment (configure/make)
  • MSBuild
  • VisualStudioBuildEnvironment
  • Meson
  • RunEnvironment
• Tools
  • tools.cpu_count()
  • tools.vcvars_command()
  • tools.vcvars_dict()
  • tools.vcvars()
  • tools.build_sln_command() [DEPRECATED]
  • tools.msvc_build_command() [DEPRECATED]
  • tools.unzip()
  • tools.untargz()
  • tools.get()
  • tools.get_env()
  • tools.download()
  • tools.ftp_download()
  • tools.replace_in_file()
  • tools.replace_path_in_file()
  • tools.run_environment()
  • tools.check_with_algorithm_sum()
  • tools.patch()
  • tools.environment_append()
  • tools.chdir()
  • tools.pythonpath()
  • tools.no_op()
  • tools.human_size()
  • tools.OSInfo and tools.SystemPackageTool
  • tools.cross_building()
  • tools.get_gnu_triplet()
  • tools.run_in_windows_bash()
  • tools.get_cased_path()
  • tools.remove_from_path()
  • tools.unix_path()
  • tools.escape_windows_cmd()
  • tools.sha1sum(), sha256sum(), md5sum()
  • tools.md5()
  • tools.save()
  • tools.load()
  • tools.mkdir(), tools.rmdir()
  • tools.which()
  • tools.unix2dos()
  • tools.dos2unix()
  • tools.touch()
  • tools.relative_dirs()
  • tools.vswhere()
  • tools.vs_comntools()
  • tools.vs_installation_path()
  • tools.replace_prefix_in_pc_file()
  • tools.collect_libs()
  • tools.PkgConfig()
  • tools.Git()
  • tools.SVN()
  • tools.is_apple_os()
  • tools.to_apple_arch()
  • tools.apple_sdk_name()
  • tools.apple_deployment_target_env()
  • tools.apple_deployment_target_flag()
  • tools.XCRun()
  • tools.latest_vs_version_installed()
  • tools.apple_dot_clean()
• Configuration files
  • conan.conf
  • profiles/default
  • settings.yml
  • registry.txt / registry.json
  • client.crt / client.key
  • artifacts.properties
• Environment variables
  • CMAKE RELATED VARIABLES
  • CONAN_BASH_PATH
  • CONAN_CMAKE_GENERATOR
  • CONAN_COLOR_DARK
  • CONAN_COLOR_DISPLAY
  • CONAN_COMPRESSION_LEVEL
  • CONAN_CPU_COUNT
  • CONAN_DEFAULT_PROFILE_PATH
  • CONAN_NON_INTERACTIVE
  • CONAN_ENV_XXXX_YYYY
  • CONAN_LOG_RUN_TO_FILE
  • CONAN_LOG_RUN_TO_OUTPUT
  • CONAN_LOGGING_LEVEL
  • CONAN_LOGIN_USERNAME, CONAN_LOGIN_USERNAME_{REMOTE_NAME}
  • CONAN_MAKE_PROGRAM
  • CONAN_PASSWORD, CONAN_PASSWORD_{REMOTE_NAME}
  • CONAN_HOOKS
  • CONAN_PRINT_RUN_COMMANDS
  • CONAN_READ_ONLY_CACHE
  • CONAN_RUN_TESTS
  • CONAN_SKIP_VS_PROJECTS_UPGRADE
  • CONAN_SYSREQUIRES_MODE
  • CONAN_SYSREQUIRES_SUDO
  • CONAN_TEMP_TEST_FOLDER
  • CONAN_TRACE_FILE
  • CONAN_USERNAME, CONAN_CHANNEL
  • CONAN_USER_HOME
  • CONAN_USER_HOME_SHORT
  • CONAN_USE_ALWAYS_SHORT_PATHS
  • CONAN_VERBOSE_TRACEBACK
  • CONAN_VS_INSTALLATION_PREFERENCE
• Hooks [EXPERIMENTAL]
  • Hook interface
  • Function parameters