summaryrefslogtreecommitdiffstats
path: root/Help/command/get_filename_component.rst
diff options
context:
space:
mode:
authorKitware Robot <kwrobot@kitware.com>2013-10-15 15:17:36 (GMT)
committerBrad King <brad.king@kitware.com>2013-10-15 18:12:03 (GMT)
commitf051814ed0e63badbfd68049354f36259dbf4b49 (patch)
treef4e6f885f86c882d723a7dd53d2b702d0c7fdffb /Help/command/get_filename_component.rst
parente94958e99c4dec26c86ce8b76d744c04ba960675 (diff)
downloadCMake-f051814ed0e63badbfd68049354f36259dbf4b49.zip
CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.gz
CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.bz2
Convert builtin help to reStructuredText source files
Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
Diffstat (limited to 'Help/command/get_filename_component.rst')
-rw-r--r--Help/command/get_filename_component.rst37
1 files changed, 37 insertions, 0 deletions
diff --git a/Help/command/get_filename_component.rst b/Help/command/get_filename_component.rst
new file mode 100644
index 0000000..5eec792
--- /dev/null
+++ b/Help/command/get_filename_component.rst
@@ -0,0 +1,37 @@
+get_filename_component
+----------------------
+
+Get a specific component of a full filename.
+
+::
+
+ get_filename_component(<VAR> <FileName> <COMP> [CACHE])
+
+Set <VAR> to a component of <FileName>, where <COMP> is one of:
+
+::
+
+ DIRECTORY = Directory without file name
+ NAME = File name without directory
+ EXT = File name longest extension (.b.c from d/a.b.c)
+ NAME_WE = File name without directory or longest extension
+ ABSOLUTE = Full path to file
+ REALPATH = Full path to existing file with symlinks resolved
+ PATH = Legacy alias for DIRECTORY (use for CMake <= 2.8.11)
+
+Paths are returned with forward slashes and have no trailing slahes.
+The longest file extension is always considered. If the optional
+CACHE argument is specified, the result variable is added to the
+cache.
+
+::
+
+ get_filename_component(<VAR> FileName
+ PROGRAM [PROGRAM_ARGS <ARG_VAR>]
+ [CACHE])
+
+The program in FileName will be found in the system search path or
+left as a full path. If PROGRAM_ARGS is present with PROGRAM, then
+any command-line arguments present in the FileName string are split
+from the program name and stored in <ARG_VAR>. This is used to
+separate a program name from its arguments in a command line string.