diff --git a/llvm/docs/CommandGuide/index.rst b/llvm/docs/CommandGuide/index.rst index d13c2a0fc0a9b0..2dae12bb7f6dd9 100644 --- a/llvm/docs/CommandGuide/index.rst +++ b/llvm/docs/CommandGuide/index.rst @@ -44,6 +44,7 @@ GNU binutils replacements llvm-addr2line llvm-ar llvm-cxxfilt + llvm-install-name-tool llvm-nm llvm-objcopy llvm-objdump diff --git a/llvm/docs/CommandGuide/llvm-install-name-tool.rst b/llvm/docs/CommandGuide/llvm-install-name-tool.rst new file mode 100644 index 00000000000000..5fa1233721db58 --- /dev/null +++ b/llvm/docs/CommandGuide/llvm-install-name-tool.rst @@ -0,0 +1,51 @@ +llvm-install-name-tool - LLVM tool for manipulating install-names and rpaths +============================================================================ + +.. program:: llvm-install-name-tool + +SYNOPSIS +-------- + +:program:`llvm-install-name-tool` [*options*] *input* + +DESCRIPTION +----------- + +:program:`llvm-install-name-tool` is a tool to manipulate dynamic shared library +install names and rpaths listed in a Mach-O binary. + +For most scenarios, it works as a drop-in replacement for Apple's +:program:`install_name_tool`. + +OPTIONS +-------- +At least one of the following options are required, and some options can be +combined with other options: + +.. option:: -add_rpath + + Add an rpath named ```` to the specified binary. Can be specified multiple + times to add multiple rpaths. Throws an error if ```` is already listed in + the binary. + +.. option:: -delete_rpath + + Delete an rpath named ```` from the specified binary. Can be specified multiple + times to delete multiple rpaths. Throws an error if ```` is not listed in + the binary. + +EXIT STATUS +----------- + +:program:`llvm-install-name-tool` exits with a non-zero exit code of 1 if there is an error. +Otherwise, it exits with code 0. + +BUGS +---- + +To report bugs, please visit . + +SEE ALSO +-------- + +:manpage:`llvm-objcopy(1)`