Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'debug/org.eclipse.cdt.debug.application/scripts/README')
-rw-r--r--debug/org.eclipse.cdt.debug.application/scripts/README53
1 files changed, 53 insertions, 0 deletions
diff --git a/debug/org.eclipse.cdt.debug.application/scripts/README b/debug/org.eclipse.cdt.debug.application/scripts/README
new file mode 100644
index 00000000000..29615408067
--- /dev/null
+++ b/debug/org.eclipse.cdt.debug.application/scripts/README
@@ -0,0 +1,53 @@
+The CDT Stand-alone Debugger brings up an minimal Eclipse instance which has all that
+is needed of the CDT plug-ins to debug a C/C++ executable. Build is not supported.
+Editing is allowed, but you will need to rebuild outside the Stand-alone Debugger for
+those changes to manifest in your debugging session.
+
+To install the Stand-alone debugger locally in your $HOME directory, run the install.sh
+script directly from the scripts sub-directory of the plugins directory in your
+Eclipse installation:
+
+ sh ./install.sh
+
+The script uses relative directories so you cannot run the script from any other working directory.
+
+The install script will create a cdtdebugger directory in your $HOME directory. This
+directory will contain a config.ini file, a dev.properties file, and a cdtdebug.sh script.
+The cdtdebug.sh script will start the debugger from the command-line. It does not
+have relative directories so you can move it around as you like.
+
+The script takes a few options which are mentioned below:
+
+-data : workspace to use for your Eclipse session if you do not want the default
+ $HOME/workspace-gdbstandalone
+
+-consoleLog : if you want error messages reported directly to the command console
+
+-a : specify attaching to an existing executable on system. A dialog will
+ be brought up to allow you to select which one.
+
+-b $PATH : path to build log for an executable. This will be used to figure out
+ include paths and compilation flags. This option assumes you will
+ be using the -e option described below.
+
+-c $CPATH : path to core-file. This option must precede a -e option to specify an
+ executable.
+
+-e $PATH [args...] : path to your executable to debug plus any optional command line
+ arguments to pass to main(). This option must be last and should
+ not precede any other arguments as they will be treated as arguments
+ to main.
+
+If no -a or -e option is specified, the last executable debugged will be offered for
+debugging. Otherwise, if this is the first time, a dialog will be presented to enter
+an executable, build log, and program arguments.
+
+ e.g. sh ~/cdtdebugger/cdtdebug.sh -b ~/build.log ~/myproject/bin/a.out arg1 arg2
+
+The cdtdebug.sh script that is found in the plug-in can also be run directly, but only
+in this scripts directory as it uses relative directories to find the Eclipse instance and
+the plugins directory.
+
+ e.g. sh ./cdtdebug.sh -b ~/build.log ~/myproject/bin/a.out arg1 arg2
+
+ \ No newline at end of file

Back to the top