summaryrefslogtreecommitdiffstats
path: root/Source/CursesDialog/cmCursesMainForm.cxx
diff options
context:
space:
mode:
authorBerk Geveci <berk.geveci@kitware.com>2001-11-30 18:59:36 (GMT)
committerBerk Geveci <berk.geveci@kitware.com>2001-11-30 18:59:36 (GMT)
commite9d40967136a10f69d5e516a77b2ef4d9a8667a5 (patch)
treec79653ccb6c6a95a9bcfb7f262bd048341df5699 /Source/CursesDialog/cmCursesMainForm.cxx
parent50c64a00600b941b7d64e8f7fb48a345ac26b750 (diff)
downloadCMake-e9d40967136a10f69d5e516a77b2ef4d9a8667a5.zip
CMake-e9d40967136a10f69d5e516a77b2ef4d9a8667a5.tar.gz
CMake-e9d40967136a10f69d5e516a77b2ef4d9a8667a5.tar.bz2
Improved help.
Diffstat (limited to 'Source/CursesDialog/cmCursesMainForm.cxx')
-rw-r--r--Source/CursesDialog/cmCursesMainForm.cxx41
1 files changed, 40 insertions, 1 deletions
diff --git a/Source/CursesDialog/cmCursesMainForm.cxx b/Source/CursesDialog/cmCursesMainForm.cxx
index b285596..fc9c0ef 100644
--- a/Source/CursesDialog/cmCursesMainForm.cxx
+++ b/Source/CursesDialog/cmCursesMainForm.cxx
@@ -736,4 +736,43 @@ void cmCursesMainForm::HandleInput()
}
}
-const char* cmCursesMainForm::s_ConstHelpMessage = "CMake is used to configure and generate build files for software projects. The basic steps for configuring a project are as follows:\n\n1. Select the source directory for the project. This should contain the CMakeLists.txt files for the project.\n\n2. Select the build directory for the project. This is the directory where the project will be built. It can be the same or a different directory than the source directory. For easy clean up, a separate build directory is recommended. CMake will create the directory if it does not exist.\n\n3. Once the source and binary directories are selected, it is time to press the Configure button. This will cause CMake to read all of the input files and discover all the variables used by the project. The first time a variable is displayed it will be in Red. Users should inspect red variables making sure the values are correct. For some projects the Configure process can be iterative, so continue to press the Configure button until there are no longer red entries.\n\n4. Once there are no longer red entries, you should click the OK button. This will write the build files to the build directory and exit CMake.";
+const char* cmCursesMainForm::s_ConstHelpMessage = "Welcome to ccmake, curses based user interface for CMake.\n"
+"CMake is used to configure and generate build files for software projects. "
+"The basic steps for configuring a project with ccmake are as follows:\n\n"
+"1. Run ccmake in the directory where you want the object and executable files to be placed (build directory). If the source directory is not the same as this build directory, you have to specify it as an argument on the command line.\n\n"
+"2. When ccmake is run, it will read the configuration files and display the current build options. "
+"If you have run CMake before and have updated the configuration files since then, any new entries will be displayed on top and will be marked with a *. "
+"On the other hand, the first time you run ccmake, all build options will be new and will be marked as such. "
+"At this point, you can modify any options (see keys below) you want to change. "
+"When you are satisfied with your changes, press 'c' to have CMake process the configuration files. "
+"Please note that changing some options may cause new ones to appear. These will be shown on top and will be marked with *. "
+"Repeat this procedure until you are satisfied with all the options and there are no new entries. "
+"At this point, a new command will appear: G)enerate and Exit. You can now hit 'g' to have CMake generate all the build files (i.e. makefiles or project files) and exit. "
+"At any point during the process, you can exit ccmake with 'q'. However, this will not generate/change any build files.\n\n"
+"ccmake KEYS:\n\n"
+"Navigation: "
+"You can use the arrow keys and page up, down to navigate the options. Alternatively, you can use the following keys: \n"
+" C-n : next option\n"
+" C-p : previous options\n"
+" C-d : down one page\n"
+" C-u : up one page\n\n"
+"Editing options: "
+"To change an option press enter or return. If the current options is a boolean, this will toggle it's value. "
+"Otherwise, ccmake will enter edit mode. In this mode you can edit an option using arrow keys and backspace. Alternatively, you can use the following keys:\n"
+" C-b : back one character\n"
+" C-f : forward one character\n"
+" C-a : go to the beginning of the field\n"
+" C-e : go to the end of the field\n"
+" C-d : delete previous character\n"
+" C-k : kill the rest of the field\n"
+"You can also delete an option by pressing 'd'\n\n"
+"Commands:\n"
+" q : quit ccmake without generating build files\n"
+" h : help, shows this screen\n"
+" c : process the configuration files with the current options\n"
+" g : generate build files and exit, only available when there are no "
+"new options and no errors have been detected during last configuration.\n"
+" l : shows last errors\n"
+" t : toggles advanced mode. In normal mode, only the most important options are shown. In advanced mode, all options are shown. We recommend using normal mode unless you are an expert.\n";
+
+