GNOME.org
 

[anjuta] manual: Document run plugin

commit d322b970cd9b80b78fe5f0915642a5c21b6ec954
Author: SÃbastien Granjoux <seb sfo free fr>
Date:   Fri Jul 8 22:16:20 2011 +0200

    manual: Document run plugin

 .../anjuta-manual/C/anjuta-debug-breakpoints.page  |    4 +-
 manuals/anjuta-manual/C/anjuta-debug-crash.page    |    4 +-
 manuals/anjuta-manual/C/anjuta-debug-start.page    |   11 ++-
 manuals/anjuta-manual/C/anjuta-debug-watches.page  |    4 +-
 manuals/anjuta-manual/C/anjuta-run.page            |   26 -------
 manuals/anjuta-manual/C/index.page                 |   12 ++--
 manuals/anjuta-manual/C/run-parameters-dialog.page |   69 ++++++++++++++++++++
 manuals/anjuta-manual/C/run-run.page               |   51 ++++++++++++++
 manuals/anjuta-manual/Makefile.am                  |    3 +-
 9 files changed, 141 insertions(+), 43 deletions(-)
---
diff --git a/manuals/anjuta-manual/C/anjuta-debug-breakpoints.page b/manuals/anjuta-manual/C/anjuta-debug-breakpoints.page
index 072d15f..cdc9ebb 100644
--- a/manuals/anjuta-manual/C/anjuta-debug-breakpoints.page
+++ b/manuals/anjuta-manual/C/anjuta-debug-breakpoints.page
@@ -4,7 +4,7 @@
 
   <info xmlns:facet="http://projectmallard.org/facet/1.0/";>
     <facet:tag key="all-pages" value="whatever"/> <!--Include page in index-->
-    <link type="guide" xref="index#anjuta-debug" group="second"/>
+    <link type="guide" xref="index#anjuta-debug" group="third"/>
     <revision pkgversion="3.0" version="0.1" date="2011-03-27" status="incomplete"/>
     <credit type="author">
       <name>Johannes Schmid</name>
@@ -23,4 +23,4 @@
 <title>Conditional breakpoints</title>
 </section>
 
-</page>
\ No newline at end of file
+</page>
diff --git a/manuals/anjuta-manual/C/anjuta-debug-crash.page b/manuals/anjuta-manual/C/anjuta-debug-crash.page
index 3c86036..cdeaf73 100644
--- a/manuals/anjuta-manual/C/anjuta-debug-crash.page
+++ b/manuals/anjuta-manual/C/anjuta-debug-crash.page
@@ -4,7 +4,7 @@
 
   <info xmlns:facet="http://projectmallard.org/facet/1.0/";>
     <facet:tag key="all-pages" value="whatever"/> <!--Include page in index-->
-    <link type="guide" xref="index#anjuta-debug" group="third"/>
+    <link type="guide" xref="index#anjuta-debug" group="fifth"/>
     <revision pkgversion="3.0" version="0.1" date="2011-03-27" status="incomplete"/>
     <credit type="author">
       <name>Johannes Schmid</name>
@@ -23,4 +23,4 @@
 <title>Debug Glib/Gtk+-Criticals</title>
 </section>
 
-</page>
\ No newline at end of file
+</page>
diff --git a/manuals/anjuta-manual/C/anjuta-debug-start.page b/manuals/anjuta-manual/C/anjuta-debug-start.page
index 4ec28b9..b9ece5b 100644
--- a/manuals/anjuta-manual/C/anjuta-debug-start.page
+++ b/manuals/anjuta-manual/C/anjuta-debug-start.page
@@ -1,18 +1,21 @@
 <page xmlns="http://projectmallard.org/1.0/";
       type="topic" style="task"
-      id="anjuta-debug-started">
+      id="anjuta-run">
 
   <info xmlns:facet="http://projectmallard.org/facet/1.0/";>
     <facet:tag key="all-pages" value="whatever"/> <!--Include page in index-->
-    <link type="guide" xref="index#anjuta-debug" group="first"/>
+    <link type="guide" xref="index#anjuta-debug" group="second"/>
     <revision pkgversion="3.0" version="0.1" date="2011-03-27" status="incomplete"/>
+    <desc>
+      Run a program with the debugger.
+    </desc>
     <credit type="author">
       <name>Johannes Schmid</name>
       <email>jhs gnome org</email>
     </credit>
   </info>
 
-  <title>Getting started with the debugger</title>
+  <title>Debug a program</title>
 
 <section>
 <title>Enable the debug configuration</title>
@@ -23,4 +26,4 @@
 <title>Run the application in the debugger</title>
 </section>
 
-</page>
\ No newline at end of file
+</page>
diff --git a/manuals/anjuta-manual/C/anjuta-debug-watches.page b/manuals/anjuta-manual/C/anjuta-debug-watches.page
index 12efe7f..a252680 100644
--- a/manuals/anjuta-manual/C/anjuta-debug-watches.page
+++ b/manuals/anjuta-manual/C/anjuta-debug-watches.page
@@ -4,7 +4,7 @@
 
   <info xmlns:facet="http://projectmallard.org/facet/1.0/";>
     <facet:tag key="all-pages" value="whatever"/> <!--Include page in index-->
-    <link type="guide" xref="index#anjuta-debug" group="second"/>
+    <link type="guide" xref="index#anjuta-debug" group="fourth"/>
     <revision pkgversion="3.0" version="0.1" date="2011-03-27" status="incomplete"/>
     <credit type="author">
       <name>Johannes Schmid</name>
@@ -23,4 +23,4 @@
 <title>Add variables watches</title>
 </section>
 
-</page>
\ No newline at end of file
+</page>
diff --git a/manuals/anjuta-manual/C/index.page b/manuals/anjuta-manual/C/index.page
index 3222ae3..669cb43 100644
--- a/manuals/anjuta-manual/C/index.page
+++ b/manuals/anjuta-manual/C/index.page
@@ -28,16 +28,16 @@
     <title>Project Management</title>
   </section>
 
-  <section id="anjuta-build" style="2column" groups="first second third fourth fifth sixth">
-    <title>Building Project</title>
-  </section>
-
   <section id="anjuta-code" style="2column">
     <title>Coding and code navigation</title>
   </section> 
 
-  <section id="anjuta-debug" style="2column" groups="first second third">
-    <title>Running and Debugging</title>
+  <section id="anjuta-build" style="2column" groups="first second third fourth fifth sixth">
+    <title>Building Project</title>
+  </section>
+
+  <section id="anjuta-debug" style="2column" groups="first second third fourth fifth">
+    <title>Debugging Program</title>
   </section>
  
   <section id="anjuta-glade" style="2column" groups="first second">
diff --git a/manuals/anjuta-manual/C/run-parameters-dialog.page b/manuals/anjuta-manual/C/run-parameters-dialog.page
new file mode 100644
index 0000000..d7bff75
--- /dev/null
+++ b/manuals/anjuta-manual/C/run-parameters-dialog.page
@@ -0,0 +1,69 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="run-parameters-dialog">
+
+  <info xmlns:facet="http://projectmallard.org/facet/1.0/";>
+    <facet:tag key="all-pages" value="whatever"/> <!--Include page in index-->
+    <facet:tag key="all-widgets" value="whatever"/> <!--Include page in index-->
+    <link type="seealso" xref="run-run"/>
+    <link type="seealso" xref="debug-run"/>
+    <revision pkgversion="3.0" version="0.1" date="2011-03-27" status="incomplete"/>
+    <desc>
+      Run parameters dialog
+    </desc>
+    <credit type="author">
+      <name>SÃbastien Granjoux</name>
+      <email>seb sfo free fr</email>
+    </credit>
+  </info>
+
+  <title>Run Parameters Dialog</title>
+
+  <p>The <gui>run parameter</gui> dialog allows you to define the current program and
+  several parameters.</p>
+
+  <terms>
+    <item>
+      <title><gui>Program</gui></title>
+      <p>This is the program that will be executed if you run a program with or
+      without the debugger. The drop-down list allows you to select programs
+      created by the current project, but you can click on the <gui>Browse</gui>
+      button to choose any other program.</p>
+    </item>
+    <item>
+      <title><gui>Arguments</gui></title>
+      <p>These are the command line arguments used by your
+      program. The drop-down list keeps an history of the last arguments
+      used.</p>
+    </item>
+    <item>
+      <title><gui>Working Directory</gui></title>
+      <p>The working directory is the current directory when your program will
+      be run.</p>
+    </item>
+    <item>
+      <title><gui>Environment Variables</gui></title>
+      <p>You can click on the drop-down section, to display all environment
+      variables those will be accessible by your program. By default, it
+      includes all the current environment variables, they are display in light
+      gray.</p>
+      <p>You can click on the <gui>New</gui> button to add a new
+      environment variable.</p>
+      <p>You can click on the <gui>Edit</gui> button to change the value
+      of the selected environment variable.</p>
+      <p>You can click on the <gui>Delete</gui> button to remove the
+      selected environment variable.</p>
+      <p>When a variable has not the same value than in the current
+      environment, it is displayed in black.</p>
+    </item>
+    <item>
+      <title><gui>Run in Terminal</gui></title>
+      <p>This has to be checked to run the program in a terminal allowing
+      you to provide inputs and see its outputs using the standard Unix
+      streams. It is not necessary for programs having a graphical interface.
+     </p>
+    </item>
+  </terms>
+
+</page>
+
diff --git a/manuals/anjuta-manual/C/run-run.page b/manuals/anjuta-manual/C/run-run.page
new file mode 100644
index 0000000..97de488
--- /dev/null
+++ b/manuals/anjuta-manual/C/run-run.page
@@ -0,0 +1,51 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="run-run">
+
+  <info xmlns:facet="http://projectmallard.org/facet/1.0/";>
+    <facet:tag key="all-pages" value="whatever"/> <!--Include page in index-->
+    <link type="guide" xref="index#anjuta-debug" group="first"/>
+    <link type="seealso" xref="run-parameters-dialog"/>
+    <link type="seealso" xref="autotools-build-install"/>
+    <revision pkgversion="3.0" version="0.1" date="2011-03-27" status="incomplete"/>
+    <desc>
+      Run a program without the debugger.
+    </desc>
+    <credit type="author">
+      <name>SÃbastien Granjoux</name>
+      <email>seb sfo free fr</email>
+    </credit>
+  </info>
+
+  <title>Run a program</title>
+
+  <p>If <app>Anjuta</app> is used to start a program it checks that it is
+  up to date and build it if needed.</p>
+
+  <steps>
+    <item>
+      <p>From the <gui>main menu</gui>, select <guiseq><gui>Run</gui>
+        <gui>Run</gui></guiseq> or press <key>F3</key> to execute
+	the current program.</p>
+    </item>
+  </steps>
+
+  <p>The current program and several parameters can be set on the <gui>parameter</gui>
+  dialog. See <link xref="run-parameters-dialog"/> for more information.</p>
+
+  <steps>
+    <item>
+      <p>From the <gui>main menu</gui>, select <guiseq><gui>Run</gui>
+      <gui>Program Parameters...</gui></guiseq> to display the dialog. 
+      </p>
+    </item>
+  </steps>
+
+  <note style="tip">
+    <p>If your program needs data files, you probably have to install it
+    at least one time before running it.
+    See <link xref="autotools-build-install"/> for more information.</p>
+  </note>
+ 
+</page>
+
diff --git a/manuals/anjuta-manual/Makefile.am b/manuals/anjuta-manual/Makefile.am
index be75185..e16c77c 100644
--- a/manuals/anjuta-manual/Makefile.am
+++ b/manuals/anjuta-manual/Makefile.am
@@ -12,7 +12,8 @@ DOC_PAGES = anjuta-code-assist.page \
 	anjuta-debug-watches.page \
 	anjuta-glade-signals.page \
 	anjuta-glade-start.page \
-	anjuta-run.page \
+	run-run.page \
+	run-parameters-dialog.page \
 	autotools-build-build.page \
 	autotools-build-clean.page \
 	autotools-build-compile.page \
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]