anjuta r4478 - in trunk: . manuals/anjuta-manual/C
- From: jhs svn gnome org
- To: svn-commits-list gnome org
- Subject: anjuta r4478 - in trunk: . manuals/anjuta-manual/C
- Date: Tue, 23 Dec 2008 09:39:25 +0000 (UTC)
Author: jhs
Date: Tue Dec 23 09:39:25 2008
New Revision: 4478
URL: http://svn.gnome.org/viewvc/anjuta?rev=4478&view=rev
Log:
2008-12-22 Adam Dingle <adam medovina org>
* manuals/anjuta-manual/C/anjuta-manual.xml:
* manuals/anjuta-manual/C/authors.xml:
* manuals/anjuta-manual/C/build.xml:
* manuals/anjuta-manual/C/debugger.xml:
* manuals/anjuta-manual/C/fileoperations.xml:
* manuals/anjuta-manual/C/interface.xml:
* manuals/anjuta-manual/C/introduction.xml:
* manuals/anjuta-manual/C/preferences.xml:
* manuals/anjuta-manual/C/projects.xml:
* manuals/anjuta-manual/C/tools.xml:
Copy edited the entire Anjuta manual, making zillions of small improvements to
grammar and wording.
Removed description of tags browser in browser toolbar; this no longer exists.
This fixes #565381 (Anjuta manual needs copy editing).
Modified:
trunk/ChangeLog
trunk/manuals/anjuta-manual/C/anjuta-manual.xml
trunk/manuals/anjuta-manual/C/authors.xml
trunk/manuals/anjuta-manual/C/build.xml
trunk/manuals/anjuta-manual/C/debugger.xml
trunk/manuals/anjuta-manual/C/fileoperations.xml
trunk/manuals/anjuta-manual/C/interface.xml
trunk/manuals/anjuta-manual/C/introduction.xml
trunk/manuals/anjuta-manual/C/preferences.xml
trunk/manuals/anjuta-manual/C/projects.xml
trunk/manuals/anjuta-manual/C/tools.xml
Modified: trunk/manuals/anjuta-manual/C/anjuta-manual.xml
==============================================================================
--- trunk/manuals/anjuta-manual/C/anjuta-manual.xml (original)
+++ trunk/manuals/anjuta-manual/C/anjuta-manual.xml Tue Dec 23 09:39:25 2008
@@ -48,7 +48,7 @@
<copyright>
<year>2001-2002</year>
- <year>2006</year>
+ <year>2006-2008</year>
<holder>Naba Kumar, Andy Piper, Biswapesh Chattopadhyay</holder>
<holder>Johannes Schmid</holder>
</copyright>
Modified: trunk/manuals/anjuta-manual/C/authors.xml
==============================================================================
--- trunk/manuals/anjuta-manual/C/authors.xml (original)
+++ trunk/manuals/anjuta-manual/C/authors.xml Tue Dec 23 09:39:25 2008
@@ -2,9 +2,8 @@
<title>Authors</title>
<para>
The <application>Anjuta</application> project was founded by Naba Kumar.
- Please visit
- <ulink type="http" url="http://anjuta.org/credits";>this online list</ulink>
- to know all Anjuta contributors.
+ <ulink type="http" url="http://anjuta.org/credits";>This page</ulink>
+ lists all Anjuta contributors.
</para>
<para>
@@ -12,12 +11,14 @@
website at <ulink type="http" url="http://anjuta.org/";>http://anjuta.org</ulink>.
Bug reports should be made using the Bug Tracker at the project development site
<ulink type="http" url="http://www.sourceforge.net/projects/anjuta";>
- http://www.sourceforge.net/projects/anjuta</ulink>
+ http://www.sourceforge.net/projects/anjuta</ulink>.
</para>
<para>
- This manual was written by Naba Kumar and Andy Piper. Please send all comments and suggestions regarding
- this manual to Anjuta Devel list <email>anjuta-devel list sourceforge net</email>. Comments may also be submitted via the
+ This manual was written by Naba Kumar, Andy Piper, Biswapesh Chattopadhyay and Johannes Schmid.
+ Please send all comments and suggestions regarding
+ this manual to the Anjuta Devel list <email>anjuta-devel list sourceforge net</email>. Comments may also be submitted via the
project trackers at SourceForge.
</para>
</chapter>
+
Modified: trunk/manuals/anjuta-manual/C/build.xml
==============================================================================
--- trunk/manuals/anjuta-manual/C/build.xml (original)
+++ trunk/manuals/anjuta-manual/C/build.xml Tue Dec 23 09:39:25 2008
@@ -2,8 +2,8 @@
<chapter id="building">
<title>Building</title>
<para>
- Anjuta handles autotools projects. It is able to cope with other kinds of
- project like projects using a user written makefile but the current build
+ Anjuta handles <application>autotools</application> projects. It is able to cope with other kinds of
+ projects, such as projects using a user-written Makefile, but the current build
interface is targeted at autotools projects. Some knowledge of them is
useful to better understand the way a project is built.
</para>
@@ -19,46 +19,46 @@
</para>
<para>
<emphasis>Build</emphasis> is the main step in which all target files are
- generated from the source files. It can be divided in
- two sub phases: <emphasis>Compile</emphasis> and <emphasis>Link</emphasis>.
- In <emphasis>Compile</emphasis> phase each object file is generated from
+ generated from the source files. It can be divided into
+ two subphases: <emphasis>Compile</emphasis> and <emphasis>Link</emphasis>.
+ In the <emphasis>Compile</emphasis> phase each object file is generated from
its corresponding source file. For instance, a source file <filename>hello.c</filename>
will generate <filename>hello.o</filename> after compilation. Usually you do not need
to worry about these object files — just think of them as intermediate files.
- In <emphasis>Link</emphasis> phase, all object files and libraries
+ In the <emphasis>Link</emphasis> phase, all object files and libraries
are linked together to create the final executable.
Some programming languages do not need a <emphasis>Compile</emphasis>
and a <emphasis>Link</emphasis> phase. Moreover the <emphasis>Build</emphasis> step
- is used to generate other files, like documentation which don't need such phases.
+ may be used to generate other files, like documentation which doesn't need such phases.
</para>
<para>
- <emphasis>Configure</emphasis> is the step in which the sources tree is adjusted
- to your system. autotools projects can be built on a wide range of systems using
+ <emphasis>Configure</emphasis> is the step in which the source tree is adjusted
+ to your system. <application>autotools</application> projects can be built on a wide range of systems using
different compilers and having different library functions. This step runs a
script named <filename>configure</filename> that will check for various characteristics
of your system
and create some of the files required to perform a build (such as
<filename>Makefile</filename> and <filename>config.h</filename>).
- This step is used to select build options too, for
- instance, disable optimization to make debugging easier or disable some
+ This step is used to select build options, too; for
+ instance, a build option may disable optimization to make debugging easier or disable some
experimental part of a program.
</para>
<para>
<emphasis>Generate</emphasis> is the step in which the <filename>configure</filename>
script and other related files are created. The <filename>configure</filename>
script used above needs to run on
- various systems and checks a lots of things. It is quite difficult to write it
- by hand. Moreover the autotools stuff enforces some rules to organize a
- project like some mandatory files: <filename>NEWS</filename> or <filename>COPYING</filename>.
+ various systems and checks a lot of things. It would be quite difficult to write it
+ by hand. Moreover <application>autotools</application> enforces some project organization rules
+ such as the presence of some mandatory files: <filename>NEWS</filename> and <filename>COPYING</filename>, for example.
It includes several tools
- to check and create all necessary files from simpler files written by the developper
- like <filename>configure.in</filename> (or <filename>configure.ac</filename>) and
+ to create necessary files from simpler files written by the developer
+ such as <filename>configure.in</filename> (or <filename>configure.ac</filename>) and
<filename>Makefile.am</filename>. All these tools are commonly run
from a script named <filename>autogen.sh</filename> in the project directory. This step is useful only
for a developer (someone modifying the source files), as the
- <filename>configure</filename> script depends only on the sources files, it is distributed within the
+ <filename>configure</filename> script depends only on the source files, and is distributed within the
project package.
- Note that, the makefiles created by configure included some rules
+ Note that the makefiles created by <application>configure</application> include some rules
to automatically regenerate the project when needed, so it often not needed to
rerun it directly.
</para>
@@ -88,7 +88,7 @@
<para>
There is no requirement to run this only once. It can be
run at any time, usually when the configuration options need to be changed. One thing to
- note is that, if the <filename>config.h</filename> file in the top level directory is
+ note is that if the <filename>config.h</filename> file in the top level directory is
changed, running <filename>configure</filename> again will not overwrite it.
</para>
<para>
@@ -97,13 +97,13 @@
<guimenuitem>Configure Project…</guimenuitem></menuchoice>.
This menu item brings a dialog where you can choose:
<itemizedlist>
- <listitem><para>If you want to run the generate step or not</para>
+ <listitem><para>Whether you want to run the generate step or not</para>
<para>
- It needs to be run once at the beginning of the project then it is automatically
- handled by the build process. You can force to run it by checking the check box
- <interface>Regenerate project</interface> in cases you encounter some
- difficulties while building the projects (such as lots of errors reported
- due to mis-synchronization after modifying lots of build files).
+ The generate step needs to be run once at the beginning of the project; then it is automatically
+ handled by the build process. You can force it to run by checking the checkbox
+ <interface>Regenerate project</interface>; you might do this if you encounter
+ difficulties while building a project (e.g. if you receive build errors
+ after you've modified lots of build files).
</para>
</listitem>
<listitem><para>The configuration name</para>
@@ -116,7 +116,7 @@
<listitem><para>The build directory</para>
<para>
This is the build directory name. In the Default configuration, it is the same
- directory than the source directory but autotools support to build in a
+ directory as the source directory but autotools supports building in a
different directory.
</para>
<note><para>
@@ -129,9 +129,8 @@
</listitem>
<listitem><para>Configure options</para>
<para>
- These options are passed to the <filename>configure</filename> script. Some are standard like prefix, CFLAGS,
- … some depends on the project. You can get a list of allowed configuration option by
- running the <filename>configure</filename> script with --help argument.
+ These options are passed to the <filename>configure</filename> script. Some are standard, such as --prefix and CFLAGS; others depend on the project. You can get a list of allowed configuration options by
+ running the <filename>configure</filename> script with the <option>--help</option> argument.
</para>
</listitem>
</itemizedlist>
@@ -142,20 +141,20 @@
<para>
If you have created different configurations, you can select which one is active by
selecting it in <menuchoice><guisubmenu>Build</guisubmenu>
- <guimenuitem>Select Configuration</guimenuitem></menuchoice>
+ <guimenuitem>Select Configuration</guimenuitem></menuchoice>.
</para>
</sect2>
<sect2 id="configure">
<title>Clean a configuration</title>
<para>
- To clean the project and leave it in a state that requires to rerun the
- configure step, you have to choose <menuchoice><guisubmenu>Build</guisubmenu>
+ To clean the project and leave it in a state that requires rerunning the
+ configure step, choose <menuchoice><guisubmenu>Build</guisubmenu>
<guimenuitem>Remove Configuration</guimenuitem></menuchoice>.
- It run "make distclean" and deletes more files than <guimenuitem>Clean Project</guimenuitem>.
+ It run <command>make distclean</command> and deletes more files than <guimenuitem>Clean Project</guimenuitem>.
In other words, it leaves the project
as though it has just been extracted from a distribution tarball. Note
- that it does not remove the configuration directory itself but you can
- do it.
+ that it does not remove the configuration directory itself; you can
+ do that yourself if you like.
</para>
</sect2>
</sect1>
@@ -168,12 +167,12 @@
<sect2 id="build-compile">
<title>Compiling a file</title>
<para>
- In a project, the individual source files can be compiled separately into objects
+ In a project, individual source files can be compiled separately into objects
(<filename>*.o</filename> files). Although you do not have to worry about these object
files, sometimes it is handy to compile a file first (for example, to make sure there are
no syntax errors). Building a whole project can take a lot of time, especially in the case of
larger and more complex applications. Therefore, you will probably go through a series of
- edit-compile-edit-compile-.... loops while developing a project.
+ edit-compile iterations while developing a project.
</para>
<para>
To compile a file, choose the menu item <menuchoice><guisubmenu>Build</guisubmenu>
@@ -186,34 +185,33 @@
<title>Building an executable</title>
<para>
<application>Anjuta</application> has no separate link command, simply because
- it is not necessary. The build process will compile all the source files and link them together
- along with the libraries. The build command will note recompile those files which are
+ it is not necessary. The build process will compile all source files and link them together
+ along with the necessary libraries. The build command will not recompile those files which are
already up-to-date (this is called the <emphasis>dependency check</emphasis>).
- If you have already compiled all of the files individually, then the only thing the build
+ If you have already compiled all files individually, then the only thing the build
step performs is the link. If you have already built the project and no dependent file has been
modified, even the link stage will be skipped.
</para>
<para>
- So how exactly does the dependency check influence the project development?
+ So how exactly does the dependency check influence project development?
If you have modified a file, then all of the source files that depend on the modified
- file are recompiled. All files (not only the object files and executable) in the
+ file are recompiled. All files (not just the object files and executable) in the
project are checked for these dependencies during the build process. If it is found that
a particular file is dependent on some other file which has been modified, then that file
- will be re-generated.
+ will be regenerated.
</para>
<para>
- Since you have now got a rough understanding of the value of the dependency check, can
- you imagine how your life (as a programmer) would be if it had not been there? If you
- cannot answer just yet, then will find out when you start developing big projects!
+ Can you imagine how your life (as a programmer) would be if the dependency check were not there? If you
+ cannot answer just yet, then you will find out when you start developing big projects!
</para>
<para>
<menuchoice><guisubmenu>Build</guisubmenu><guimenuitem>Build</guimenuitem></menuchoice>
- will build all of the files in the directory of the currently active file.
+ will build all files in the directory of the currently active file.
</para>
<para>
<menuchoice><guisubmenu>Build</guisubmenu>
<guimenuitem>Build Project</guimenuitem></menuchoice> will build
- the whole project — all of the subdirectories are built recursively.
+ the whole project — all subdirectories are built recursively.
</para>
</sect2>
</sect1>
@@ -226,9 +224,9 @@
<sect2 id="build-dist">
<title>Creating a distribution package</title>
<para>
- To build the tarball distribution of the project choose <menuchoice><guisubmenu>Build</guisubmenu>
+ To build a tarball distribution of the project choose <menuchoice><guisubmenu>Build</guisubmenu>
<guimenuitem>Build Tarball</guimenuitem></menuchoice>. This will create a
- tarball (<filename>*.tar.gz</filename>) and put it in the top level project directory.
+ tarball (<filename>*.tar.gz</filename>) and put it in the top-level project directory.
Copy the file to a safe place for distribution.
</para>
</sect2>
@@ -240,12 +238,12 @@
application on your system.
</para>
<note>
- <title>System wide installation</title>
+ <title>System-wide installation</title>
<para>
You must be logged in as root to perform a system-wide install. Also note that for a GNOME
application to use the pixmaps in the project, it must be installed as a system-wide
application. Otherwise, when the application is executed in your project, there will be
- lots of "pixmap not found" errors. You can configure anjuta to use <command>sudo</command>
+ lots of "pixmap not found" errors. You can configure Anjuta to use <command>sudo</command>
or <command>su</command> before installing the project in the build preferences.
</para>
</note>
@@ -259,7 +257,7 @@
</para>
<para>
Choose the menu item <menuchoice><guisubmenu>Build</guisubmenu>
- <guimenuitem>Clean Project</guimenuitem></menuchoice> to clean all the project
+ <guimenuitem>Clean Project</guimenuitem></menuchoice> to clean all project
files.
</para>
<para>
Modified: trunk/manuals/anjuta-manual/C/debugger.xml
==============================================================================
--- trunk/manuals/anjuta-manual/C/debugger.xml (original)
+++ trunk/manuals/anjuta-manual/C/debugger.xml Tue Dec 23 09:39:25 2008
@@ -10,10 +10,10 @@
</para>
<para>
When a program does not behave in the way it is supposed to, we say the program
- contains a bug or bugs. This does not refer to compilation errors — those are
- simply errors and they are relatively easy to clear, because the compiler tells you
- where the problems are. On the other hand, <emphasis>bugs</emphasis> are errors
- that happen during the execution of the program and they can be hard (sometimes very hard!)
+ contains a <emphasis>bug</emphasis>. A bug is not a compilation error —
+ compilation errors are relatively easy to clear, because the compiler tells you
+ where the problems are. By contrast, bugs are errors
+ that happen during program execution and they can be hard (sometimes very hard!)
to detect.
</para>
<para>
@@ -45,7 +45,7 @@
<sect2 id="debug-run">
<title>Running an executable</title>
<para>
- Running a program with or without the debugger uses the same menu, selects
+ Running a program with or without the debugger uses the same menu: select
<menuchoice><guisubmenu>Run</guisubmenu><guimenuitem>Run Program</guimenuitem></menuchoice>
to run a program without the debugger and
<menuchoice><guisubmenu>Run</guisubmenu><guimenuitem>Debug Program</guimenuitem></menuchoice>
@@ -53,7 +53,7 @@
</para>
<note>
<para>
- In order to better user the debugger, it is strongly recommended to debug program
+ In order to better use the debugger, it is strongly recommended that you build your program
with debugging information (-g for gcc) and no optimization (-O0 for gcc). This can be
done by selecting the Debug configuration before building the program for the first time.
</para>
@@ -66,26 +66,24 @@
<listitem><para>The program that you want to debug</para>
<para>
The drop-down menu of the target drop-down combination box
- is already filled with all executables of the current project. But you
- can select another executable not part of the project. The debugger accepts libtool
- executable, it means script,generated by libtool, wrapping the real executable.
- Note that an URI is expected here, not a file path even if the debugger currently
- supports only local files.
+ is pre-filled with all executables of the current project. But you can alternatively
+ select another executable which is not part of the project. The debugger also accepts libtool
+ executables; these are scripts generated by libtool which wrap real executables.
</para>
</listitem>
- <listitem><para>The command line parameters</para></listitem>
- <listitem><para>The program working directory</para></listitem>
- <listitem><para>Add or remove some environment variables</para>
+ <listitem><para>The command-line parameters</para></listitem>
+ <listitem><para>The working directory</para></listitem>
+ <listitem><para>Environment variables</para>
<para>
- The environment variables in light gray are the current environment variables. You can
- add new one, modify existing one or remove their values.
+ Environment variables displayed in light gray are the current environment variables. You can
+ add, modify or remove environment variables here.
</para>
<tip>
- To debug Anjuta using Anjuta, you can use a different theme to recognize the
- instance under debugging immediatly adding by example "GTK2_RC_FILES=/usr/share/themes/Crux/gtk-2.0/gtkrc".
+ To debug Anjuta using Anjuta, you can use a different theme to change the look of the instance
+ being debugged; for example, you could add "GTK2_RC_FILES=/usr/share/themes/Crux/gtk-2.0/gtkrc".
</tip>
</listitem>
- <listitem><para>If you want a terminal or not (the Anjuta terminal plugin is used)</para></listitem>
+ <listitem><para>Whether the program should run in a terminal or not. If so, the Anjuta terminal plugin is used.</para></listitem>
</itemizedlist>
</para>
</sect2>
@@ -93,10 +91,10 @@
<sect2 id="debug-attach">
<title>Attaching to a Process</title>
<para>
- It is also possible to attach to a running process and debugging it by choosing the menu item
+ It is also possible to attach to a running process and debug it by choosing the menu item
<menuchoice><guisubmenu>Run</guisubmenu>
- <guimenuitem>Debug Process …</guimenuitem></menuchoice>. A list of all the
- process running on the system will appear.
+ <guimenuitem>Debug Process …</guimenuitem></menuchoice>. A list of all
+ processes running on the system will appear.
</para>
<figure id="attach">
<title>Attach to Process dialog</title>
@@ -111,8 +109,8 @@
</para>
<note>
<para>
- It is currently not possible to load symbol informations for the attached
- process. They should be included in the process.
+ It is currently not possible to load symbol information for an attached
+ process. Symbols should be included in the process.
</para>
</note>
</sect2>
@@ -122,8 +120,8 @@
<para>
Choose the menu item <menuchoice><guisubmenu>Run</guisubmenu>
<guimenuitem>Stop Debugger</guimenuitem></menuchoice> to stop the debugger.
- This option will kill the program which is being debugged. If the debugger has
- been attached to a running process, it will just detach from it without killing
+ This will kill the program which is being debugged. If the debugger has
+ been attached to a running process, the debugger will just detach from it without killing
it. You will get a confirmation box if a program is currently attached or running.
</para>
</sect2>
@@ -137,12 +135,12 @@
</para>
<para>
Most executables include full file paths, so defining the directories where are the source files
- is not useful. But some executables include only file names without paths, in this case,
- the source files will be searched in all these directories by the debugger.
- The directories order can be important if several files have the same name, so
+ is normally not useful. But some executables include only file names without paths; in this case,
+ the debugger will search for source files in all these directories.
+ The order of directories can be important if several files have the same name, so
you can change it using the <guibutton>Up</guibutton> and <guibutton>Down</guibutton> buttons.
- The directories list is send to the debugger when it is started. After changing it,
- you need to restart the debugger to take it in account.
+ The directory list is sent to the debugger when it is started. After changing it,
+ you need to restart the debugger to cause it to use the new list.
</para>
</sect2>
@@ -161,8 +159,8 @@
</para>
<para>
The methods those can be used to execute a program in the debugger are described in
- the next sections. These commands are available only when the program is already
- started.
+ the following sections. These commands are available only when the program has already
+ been started.
</para>
<sect2 id="dbg-step-in">
@@ -178,7 +176,7 @@
has stopped) and then returns control. If the statement that is executed contains one
or more functions, the debugger tries to step inside the functions (in the sequence in
which the functions are executed). Once the statement is executed and
- control is passed back, it is possible to study the various program parameters.
+ control is passed back, you can study your program's state.
</para>
<para>
If the <interface>Disassembly window</interface> has the focus when this command is selected,
@@ -250,11 +248,11 @@
Choose the menu item <menuchoice><guisubmenu>Debug</guisubmenu>
<guimenuitem>Run to Cursor</guimenuitem></menuchoice>
or click on the <guibutton>Run to Cursor</guibutton> icon in the
- <interface>Debug toolbar</interface> to run until the line at cursor is reached.
+ <interface>Debug toolbar</interface> to run until the line at the cursor is reached.
</para>
<para>
This option continues the execution of the program until the line or the
- address (if the <interface>Disassembly window</interface> has the focus) where
+ address (if the <interface>Disassembly window</interface> has the focus) at
the cursor is reached.
</para>
</sect2>
@@ -310,8 +308,8 @@
<listitem>
<para>
This is the position of the breakpoint in the source file. When the breakpoint
- is set by the debugger, you can get additional information like the function
- where is the breakpoint.
+ is set by the debugger, you can get additional information such as the function
+ containing the breakpoint.
</para>
</listitem>
</varlistentry>
@@ -328,8 +326,8 @@
<term>Type</term>
<listitem>
<para>
- This displays always "breakpoint". It will be used
- in a next version supporting different kind of breakpoints.
+ This always displays "breakpoint". It will be used
+ in a future release supporting different kinds of breakpoints.
</para>
</listitem>
</varlistentry>
@@ -337,7 +335,7 @@
<term>Condition</term>
<listitem>
<para>
- This is the breakpoint condition, it is empty if no condition is defined.
+ This is the breakpoint condition. It is empty if no condition is defined.
</para>
</listitem>
</varlistentry>
@@ -346,11 +344,11 @@
<listitem>
<para>
When the debugger is not running, this column displays the pass count of the breakpoint,
- zero if it is not defined.
+ or zero if it is not defined.
</para>
<para>
- When the debugger is running, if pass count is zero, this column displays
- the number of time this breakpoint has been triggered. If pass count is not
+ When the debugger is running, if the pass count is zero, this column displays
+ the number of times this breakpoint has been triggered. If the pass count is not
zero, both numbers are displayed. The pass count is the second number.
</para>
</listitem>
@@ -359,11 +357,11 @@
<term>State</term>
<listitem>
<para>
- This is the state of the breakpoint. You could have.
+ This is the state of the breakpoint. It may be
<itemizedlist>
- <listitem><para>Pending: breakpoint is not set in your program.</para></listitem>
- <listitem><para>Permanent: breakpoint is set (id number in given inside the parenthesis).</para></listitem>
- <listitem><para>Temporary: breakpoint is set but will be deleted if reached.</para></listitem>
+ <listitem><para>Pending: the breakpoint is not set in your program.</para></listitem>
+ <listitem><para>Permanent: the breakpoint is set (its id number in given inside parentheses).</para></listitem>
+ <listitem><para>Temporary: the breakpoint is set but will be deleted if reached.</para></listitem>
</itemizedlist>
</para>
</listitem>
@@ -372,9 +370,9 @@
</para>
<note>
<para>
- All breakpoints are kept across anjuta session even if they correspond to
- a non existing place. In this case their state are set as pending.The interface
- try to set them each time the program is started or a new dynamic library is loaded.
+ All breakpoints are kept across Anjuta sessions even if they correspond to
+ a non-existing location. In this case their states are set as pending. The interface
+ tries to set them each time the program is started or a new dynamic library is loaded.
</para>
</note>
</sect2>
@@ -385,7 +383,7 @@
Choose the menu item <menuchoice><guisubmenu>Debug</guisubmenu>
<guimenuitem>Add Breakpoint…</guimenuitem></menuchoice>
or <menuchoice><guimenuitem>Add Breakpoint…</guimenuitem></menuchoice>
- in the breakpoint list popup menu to open the add breakpoint dialog.
+ in the breakpoint list popup menu to open the <interface>add breakpoint</interface> dialog.
</para>
<para>
<figure>
@@ -397,15 +395,15 @@
</figure>
</para>
<para>
- You need to enter the location and optionally, the
- break condition and the pass count then click <guibutton>OK</guibutton> to set the
+ Enter the location and, optionally, the
+ break condition and the pass count; then click <guibutton>OK</guibutton> to set the
breakpoint.
<variablelist>
<varlistentry>
<term>Location</term>
<listitem>
<para>
- Enter the location at which to set the breakpoint. It has to be specified in one of
+ Enter the location at which to set the breakpoint. It can be specified in any of
the following formats:
</para>
<para>
@@ -416,9 +414,9 @@
</orderedlist>
</para>
<para>
- The first one is obvious — The location refers to the line number
+ The first format is obvious — the location refers to the line number
<emphasis>Line_number</emphasis> in the source file <emphasis>File</emphasis>.
- The second refers to the first line of the function
+ The second format refers to the first line of the function
<emphasis>Function_name</emphasis>. The third is similar to the second, except that
this notation is used where there is more than one function with the name
<emphasis>Function_name</emphasis> in the program. It is possible to
@@ -436,16 +434,16 @@
which should evaluate to a Boolean value — that is, the
evaluation of the expression should result in either TRUE(1) or FALSE(0).
If the final evaluation value is not a Boolean value, then it will be
- appropriately type casted to a Boolean.
+ appropriately type cast to a Boolean.
</para>
<para>
- Every time the breakpoint is encountered during the execution, the break
+ Every time the breakpoint is encountered during your program's execution, the break
condition will be evaluated. The debugger will break the execution only if
the evaluation results in a TRUE value, otherwise it will continue the
execution as though there had been no breakpoint.
</para>
<para>
- The default value, if you left this field blank, of <emphasis>Break condition</emphasis>
+ The default value, if you leave this field blank, of <emphasis>Condition</emphasis>
is TRUE. The debugger will always break the execution at the breakpoint location.
</para>
</listitem>
@@ -464,7 +462,7 @@
<emphasis>Pass count</emphasis> counts down to zero.
</para>
<para>
- The default value, if you left this field blank, of the <emphasis>Pass count</emphasis>
+ The default value, if you leave this field blank, of the <emphasis>Pass count</emphasis>
is zero. The breakpoint will be considered when it is first encountered.
</para>
</listitem>
@@ -474,15 +472,15 @@
<para>
A breakpoint may also be set by selecting a line in the editor
and choosing the menu item <menuchoice><guisubmenu>Debug</guisubmenu>
- <guimenuitem>Toggle Breakpoint</guimenuitem></menuchoice> in the editor popup
- menu item
+ <guimenuitem>Toggle Breakpoint</guimenuitem></menuchoice> in the editor context
+ menu
or the <guibutton>Toggle Breakpoint</guibutton> icon in the
<interface>Debug toolbar</interface>.
</para>
<tip>
<para>
- Breakpoints can be added even if the debugger is not started or in dynamic
- library not loaded yet. But they cannot be added while a program is running
+ Breakpoints can be added even if the debugger is not started, or in a dynamic
+ library which is not loaded yet. But they cannot be added while a program is running
under control of the debugger.
</para>
</tip>
@@ -491,9 +489,9 @@
<sect2 id="breaks-edit">
<title>Editing Breakpoints</title>
<para>
- It is possible to change the condition and the pass count by
- selecting the breakpoint in the breakpoint list and click in the
- popup menu item <menuchoice><guimenuitem>Edit Breakpoint</guimenuitem></menuchoice>.
+ You can change the condition and the pass count by
+ selecting the breakpoint in the breakpoint list and clicking <menuchoice><guimenuitem>Edit Breakpoint</guimenuitem></menuchoice>
+ in the popup menu.
</para>
<para>
Edit the entries as required and click on <guibutton>OK</guibutton> to
@@ -508,19 +506,19 @@
<menuchoice><guimenuitem>Remove Breakpoint</guimenuitem></menuchoice> to delete it.
</para>
<para>
- A existing breakpoint may also be deleted by selecting the line in the editor
+ A existing breakpoint may also be deleted by selecting its line in the editor
and choosing the menu item <menuchoice><guisubmenu>Debug</guisubmenu>
<guimenuitem>Toggle Breakpoint</guimenuitem></menuchoice>,
- the editor popup menu item
+ the editor context menu item
<menuchoice><guimenuitem>Toggle Breakpoint</guimenuitem></menuchoice>
or the <guibutton>Toggle Breakpoint</guibutton> icon in the
<interface>Debug toolbar</interface>.
</para>
<para>
- It is possible to remove all breakpoints by clicking on <menuchoice><guisubmenu>Debug</guisubmenu>
+ You can remove all breakpoints by clicking on <menuchoice><guisubmenu>Debug</guisubmenu>
<guimenuitem>Remove All Breakpoints</guimenuitem></menuchoice> or on
<menuchoice><guimenuitem>Remove All Breakpoints</guimenuitem></menuchoice> in
- the breakpoint list popup menu.
+ the breakpoint list context menu.
</para>
</sect2>
@@ -528,7 +526,7 @@
<title>Enabling or Disabling Breakpoints</title>
<para>
Click on the Enable column of the <interface>Breakpoint list window</interface> or
- in the menu item <menuchoice><guimenuitem>Enable Breakpoint</guimenuitem></menuchoice>
+ in the context menu item <menuchoice><guimenuitem>Enable Breakpoint</guimenuitem></menuchoice>
to enable or disable the selected breakpoint.
The breakpoint will be enabled or disabled, depending on its current state.
</para>
@@ -536,7 +534,7 @@
To disable all breakpoints, click on <menuchoice><guisubmenu>Debug</guisubmenu>
<guimenuitem>Disable All Breakpoints</guimenuitem></menuchoice> or on
<menuchoice><guimenuitem>Disable All Breakpoints</guimenuitem></menuchoice> in
- the breakpoint list popup menu.
+ the breakpoint list context menu.
</para>
</sect2>
</sect1>
@@ -546,19 +544,19 @@
<title>Expressions</title>
<sect2 id="var-local">
- <title>Listing local variable</title>
+ <title>Listing local variables</title>
<para>
When a program is running under the control of the debugger, the
<interface>Locals list window</interface> can be opened by
choosing <menuchoice><guisubmenu>View</guisubmenu>
- <guimenuitem>Locals</guimenuitem></menuchoice>
+ <guimenuitem>Locals</guimenuitem></menuchoice>.
</para>
<para>
Local variables of the current frame (the current function in which the program control
- is present) are displayed in the <interface>Locals list window</interface>.
- During execution of the program (eg. during single stepping), local
+ is present) are displayed in the <interface>Locals window</interface>.
+ During execution of the program (e.g. during single stepping), local
variables will be updated. If any variable value was changed in the last debugging step, its
- value will be highlight in red. The variables are presented in a tree form for easy
+ value will be highlighted in red. Variables are presented in a tree form for easy
view.
<figure>
<title>Local variables</title>
@@ -570,14 +568,14 @@
</para>
<para>
The value of a local variable can be modified by selecting it and clicking in
- the value column.
+ the <guilabel>Value</guilabel> column.
</para>
<note>
<para>
- Gdb is more and more often used as a back end for a graphical front end. It
- has been improved recently in this area. It is recommended to use the latest
- version (6.6) of gdb. On older version, gdb can crash when the front end
- ask for an pointer with an invalid (but not used) value.
+ <application>gdb</application> is more and more often used as a back end for a graphical front end. It
+ has been improved recently in this area. It is recommended that you use the latest
+ version (6.6) of gdb. With older versions, gdb can crash when the front end
+ asks for an pointer with an invalid (but unused) value.
</para>
</note>
</sect2>
@@ -586,19 +584,19 @@
<title>Listing watched expressions</title>
<para>
Inspecting or evaluating an expression provides the result only once. To continuously
- monitor some variables or expressions, use <emphasis>expression watch</emphasis>.
+ monitor some variables or expressions, use <emphasis>expression watches</emphasis>.
</para>
<para>
Choose the menu item <menuchoice><guisubmenu>View</guisubmenu><guimenuitem>Watches</guimenuitem>
- </menuchoice> to display the <interface>expression watch window</interface>.
+ </menuchoice> to display the <interface>Watches window</interface>.
</para>
</sect2>
<sect2 id="watch-add">
<title>Adding an expression to watch</title>
<para>
- Right-click on the <interface>expression watch window</interface>
- to open the <interface>Operation menu</interface>. Choose the
+ Right-click on the <interface>Watches window</interface>
+ to open the context menu. Choose the
menu item <guimenuitem>Add Watch…</guimenuitem>. Alternatively, you can
use <menuchoice><guisubmenu>Debug</guisubmenu>
<guimenuitem>Add Watch…</guimenuitem></menuchoice>
@@ -606,33 +604,32 @@
click <guibutton>OK</guibutton>.
</para>
<para>
- By default watch expression are updated automatically
+ By default watch expressions are updated automatically
each time the program is stopped. This can be changed in the add watch dialog
or later using the <guimenuitem>Automatic update</guimenuitem> menu item in the
- <interface>expression watch window</interface> popup menu. A watched expression
- can be update manually by choosing
+ <interface>Watches window</interface> context menu. A watched expression
+ can be updated manually by choosing
<guimenuitem>Update Watch</guimenuitem> or <guimenuitem>Update All</guimenuitem> in
- the previous menu.
+ the context menu.
</para>
<para>
It is not necessary to have the debugger running to add a new watch expression.
If the debugger is not running or the corresponding expression cannot be found,
- the front end will try to create the watch expression, each time the program
+ the front end will try to create the watch expression each time the program
is stopped.
</para>
</sect2>
<sect2 id="watch-remove">
- <title>Removing an expression from watch</title>
+ <title>Removing a watched expression</title>
<para>
- Select the watch expression that you want to remove in the <interface>expression watch
- window</interface>, then open the <interface>Operation menu</interface>, clicking
- with the right mouse button, and choose the
+ Right-click the watch expression that you want to remove in the <interface>Watches
+ window</interface>, then choose the context
menu item <guimenuitem>Remove</guimenuitem> to remove it.
</para>
<para>
- All watch can be removed by choosing <guimenuitem>Remove All</guimenuitem> in the
- popup menu of the <interface>expression watch window</interface>.
+ All watches can be removed by choosing <guimenuitem>Remove All</guimenuitem> in the
+ context menu of the <interface>Watches window</interface>.
</para>
</sect2>
@@ -644,18 +641,18 @@
program. Choose the menu item <menuchoice><guisubmenu>Debug</guisubmenu>
<guimenuitem>Inspect/Evaluate …</guimenuitem></menuchoice>,
<menuchoice><guimenuitem>Inspect/Evaluate …</guimenuitem></menuchoice>
- in the popup menu of the editor or click
+ in the context menu of the editor or click
the <guibutton>Inspect</guibutton> button on the <interface>Debug Toolbar</interface>.
</para>
<para>
A window will appear showing the evaluation of the expression
highlighted in the editor.
- You can evaluate a new expression by clicking on the name column
+ You can evaluate a new expression by clicking on the <guilabel>name</guilabel> column
and entering the new one.
</para>
<para>
- The expression can be added directly in the list of watched expressions by
- clicking on <guibutton>Add</guibutton> button.
+ You can add the expression to the list of watched expressions directly by
+ clicking on the <guibutton>Add</guibutton> button.
</para>
</sect2>
@@ -663,12 +660,12 @@
<title>Inspecting expressions in editor window</title>
<para>
When the debugger is active with the program stopped, you can get the value of an
- expression just by putting the pointer over it and stay here for a few time.
- If the expression is already present in the local or watch window, its value is
- displayed in a tool tips window.
+ expression just by putting the mouse pointer over it and staying there for a short time.
+ If the expression is already present in the <interface>Locals</interface> or <interface>Watches</interface> window, its value is
+ displayed in a tooltip.
</para>
<para>
- It is currently working only for simple variable, not for structures or arrays.
+ This capability is currently working only for simple variables, not for structures or arrays.
</para>
</sect2>
@@ -681,16 +678,16 @@
<sect2 id="stack-win">
<title>Stack Window</title>
<para>
- The <interface>Stack trace window</interface> shows the contents of the
- program stack. It lists all of the functions and their arguments in the
+ The <interface>stack trace window</interface> shows the contents of the
+ program stack. It lists all functions and their arguments in the
sequence they were called. There is also a number representing each call.
- This number is called the <emphasis>Frame</emphasis>. Each call in the trace
+ This number is called the <emphasis>frame</emphasis>. Each call in the trace
exists in a different frame. This starts from frame 0 (the last function
- called) and grows higher as the function nesting become deeper.
+ called) and grows higher as function nesting becomes deeper.
</para>
<para>
Choose the menu item <menuchoice><guisubmenu>View
- </guisubmenu><guimenuitem>Stack</guimenuitem></menuchoice>, to open the stack trace for the program
+ </guisubmenu><guimenuitem>Stack</guimenuitem></menuchoice> to open the stack trace for the program
being debugged.
</para>
<para>
@@ -704,9 +701,9 @@
</para>
<para>
A small arrow points to the currently selected frame in the stack trace. By
- default, this will be frame 0, the last function called. All of the evaluation
+ default, this will be frame 0, the last function called. All evaluation
and inspection of expressions or variables will be with reference to this selected
- frame. The scope of the variables or expressions being evaluated will be limited
+ frame. The scope of variables or expressions being evaluated will be limited
to the selected frame only. The same applies for new expressions only in the watch.
</para>
</sect2>
@@ -714,16 +711,16 @@
<sect2 id="stack-frame">
<title>Setting the current frame</title>
<para>
- Double-clicking on any frame in the stack trace set that frame as the
- currently selected frame (the arrow will point to the frame, indicating that it
- has been selected as the current frame). Alternatively, open the
- <interface>Operation menu</interface> by right-clicking on the
+ Double-clicking on any frame in the stack trace sets that frame as the
+ currently selected frame. The arrow will point to the frame, indicating that it
+ has been selected as the current frame. Alternatively, open the
+ context menu by right-clicking on the
<interface>Stack trace window</interface>, and choose the menu item
<guimenuitem>Set current frame</guimenuitem> to set the frame.
</para>
<para>
- Changing the stack frame changes the <interface>Locals list window</interface>
- content, but not the <interface>expression watch window</interface> as each
+ Changing the stack frame changes the <interface>Locals window</interface>
+ content, but not the <interface>Watches window</interface> as each
expression is evaluated in the frame used when it was defined.
</para>
</sect2>
@@ -736,14 +733,14 @@
<sect2 id="thread-win">
<title>Thread Window</title>
<para>
- The <interface>Thread window</interface> show all threads used by the program
- and display the current thread. Choose the menu item <menuchoice><guisubmenu>View</guisubmenu>
- <guimenuitem>Thread</guimenuitem></menuchoice>, to open this window.
+ The <interface>Thread window</interface> shows all threads used by the program
+ and indicates the current thread. Choose the menu item <menuchoice><guisubmenu>View</guisubmenu>
+ <guimenuitem>Thread</guimenuitem></menuchoice> to open this window.
</para>
<para>
A small arrow points to the current thread. When the
- program is stopped, it correspond to the thread which has been interrupted.
- Each thread has its own stack frame,so changing the current thread change
+ program is stopped, the current thread is the thread which has been interrupted.
+ Each thread has its own stack frame, so changing the current thread changes
the current stack frame.
</para>
</sect2>
@@ -752,15 +749,15 @@
<title>Setting the current thread</title>
<para>
Double-clicking on any thread in the thread list will set that thread as the
- currently selected thread (the arrow will point to the thread, indicating that it
- has been selected as the current thread). Alternatively, open the
- <interface>Operation menu</interface> by right-clicking on the
+ currently selected thread. The arrow will point to the thread, indicating that it
+ has been selected as the current thread. Alternatively, open the
+ context menu by right-clicking on the
<interface>Thread list window</interface>, and choose the menu item
<guimenuitem>Set current thread</guimenuitem> to set the thread.
</para>
<para>
Changing the thread changes the value of CPU registers and the current
- stack frame, so the <interface>Locals list window</interface> change too.
+ stack frame, so the <interface>Locals window</interface> changes too.
</para>
</sect2>
</sect1>
@@ -775,13 +772,13 @@
It is possible to examine the contents of the internal registers of the
CPU (microprocessor). Choose the menu item <menuchoice><guisubmenu>View</guisubmenu>
<guimenuitem>Registers</guimenuitem></menuchoice>. A window listing all
- of the available registers in the microprocessor and their corresponding contents
+ available registers in the microprocessor and their corresponding contents
will appear.
</para>
<para>
If any register value was changed in the last debugging step, its
- value will be highlight in red. It is possible to change one register value
- by selecting it and clicking in the value column.
+ value will be highlighted in red. It is possible to change one register value
+ by selecting it and clicking in the <guilabel>value</guilabel> column.
</para>
</sect2>
@@ -789,17 +786,17 @@
<title>Memory window</title>
<para>
Choose the menu item <menuchoice><guisubmenu>View</guisubmenu><guimenuitem>Memory
- </guimenuitem></menuchoice>, to open the <interface>memory window</interface>
+ </guimenuitem></menuchoice> to open the <interface>memory window</interface>
for the program being debugged. This window shows the contents of all memory.
</para>
<para>
- The first is the memory address in hexadecimal, the second is the memory content
- in hexadecimal too and the last column is the memory content in ASCII.
+ The first column displays memory addresses in hexadecimal, the second displays memory contents
+ in hexadecimal and the last column shows memory contents in ASCII.
</para>
<para>
- The addressing space of even a 32 bits microprocessor is quite big(4 Giga bytes),
+ The addressing space of even a 32-bit microprocessor is quite large (4 gigabytes),
so it is very difficult to go to a particular address with the scrollbar. But
- you can click on the right mouse button, get a new menu and select
+ you can click on the right mouse button to display a context menu and select
<menuchoice><guimenuitem>Goto address</guimenuitem></menuchoice> to get
a small edit box where you can enter an address in hexadecimal.
</para>
@@ -809,17 +806,17 @@
<title>Disassembly window</title>
<para>
Choose the menu item <menuchoice><guisubmenu>View</guisubmenu><guimenuitem>Disassembly
- </guimenuitem></menuchoice>, to open the <interface>disassembly window</interface>
+ </guimenuitem></menuchoice> to open the <interface>disassembly window</interface>
for the program being debugged.
</para>
<para>
- The first column is the address in hexadecimal. In the second column, you can
- have a label starting at the beginning of the line and ended with a colon or
- a assembler instruction starting after 4 space characters.
+ The first column displays addresses in hexadecimal. In the second column, you can
+ have a label starting at the beginning of the line and ending with a colon or
+ a assembly-language instruction indented by 4 space characters.
</para>
<para>
- Again, as the addressing space is very big, the scrollbar is quite useless.
- You can click on the right mouse button, get a new menu and select
+ Again, as the addressing space is very large, the scrollbar is quite useless.
+ You can click on the right mouse button to display the context menu and select
<menuchoice><guimenuitem>Goto address</guimenuitem></menuchoice> to get
a small edit box where you can enter an address in hexadecimal. The position
in the disassembly window will be changed to the program counter value when
@@ -840,11 +837,11 @@
<sect2 id="dbg-dyna-libs">
<title>Dynamically loaded Libraries</title>
<para>
- To obtain a list of the dynamic libraries used by the program, choose the
+ To obtain a list of the dynamic libraries used by a program, choose the
menu item <menuchoice><guisubmenu>Debug</guisubmenu><guisubmenu>Info</guisubmenu>
<guimenuitem>Shared Libraries</guimenuitem></menuchoice>. This will bring
- open a window which will list all the shared libraries the program has loaded
- and their locations in the memory. It also shows whether the symbol table is
+ open a window which will list all shared libraries the program has loaded
+ and their locations in memory. It also shows whether each library's symbol table is
loaded or not (Yes/No).
</para>
<para>
@@ -864,7 +861,7 @@
Kernel signals are a way of signaling between processes in Linux. The list
of signals available for a program can be displayed by choosing the menu item
<menuchoice><guisubmenu>Debug</guisubmenu><guisubmenu>Info</guisubmenu><guimenuitem>Kernel Signals</guimenuitem></menuchoice>.
- A window will open which lists all of the signals available in the system along with
+ A window will open which lists all signals available in the system along with
a brief description of each signal.
</para>
<para>
@@ -877,7 +874,7 @@
</figure>
</para>
<para>
- There are three columns which specify what to do when the signal is received:
+ There are three columns which specify what to do when a signal is received:
</para>
<orderedlist>
@@ -900,8 +897,8 @@
</orderedlist>
<note>
<para>
- The popup menu that is displayed when you click on the right mouse button has
- all its item disabled because the corresponding functions are not implemented
+ The context menu that is displayed when you click on the right mouse button has
+ all its items disabled because the corresponding functions are not implemented
yet.
</para>
</note>
@@ -910,37 +907,37 @@
<sect2 id="dbg-files">
<title>Information about used files</title>
<para>
- It is possible to get some information about the files used by the debugged program.
+ You can get some information about the files used by the debugged program
by choosing the menu item <menuchoice><guisubmenu>Debug</guisubmenu>
<guisubmenu>Information</guisubmenu><guimenuitem>Target files</guimenuitem></menuchoice>.
- A window will open displaying all informations.
+ A window will open displaying this information.
</para>
</sect2>
<sect2 id="dbg-program">
<title>Information about debugged program</title>
<para>
- It is possible to get some information about the debugged program
+ You can get some information about the debugged program
by choosing the menu item <menuchoice><guisubmenu>Debug</guisubmenu>
<guisubmenu>Information</guisubmenu><guimenuitem>Program</guimenuitem></menuchoice>.
- A window will open displaying all informations.
+ A window will open displaying this information.
</para>
</sect2>
<sect2 id="dbg-kernel">
<title>Information about kernel structure</title>
<para>
- It is possible to get some information kernel data on the current process
+ You can get some information about kernel data for the current process
by choosing the menu item <menuchoice><guisubmenu>Debug</guisubmenu>
<guisubmenu>Information</guisubmenu><guimenuitem>Kernel user struct</guimenuitem></menuchoice>.
- A window will open displaying all informations.
+ A window will open displaying this information.
</para>
</sect2>
<sect2 id="var-global">
<title>Information about global variables</title>
<para>
- It is possible to list all global variables
+ You can list all global variables
by choosing the menu item <menuchoice><guisubmenu>Debug</guisubmenu>
<guisubmenu>Information</guisubmenu><guimenuitem>Info Global Variable</guimenuitem></menuchoice>.
A window will open listing all global variables.
@@ -950,7 +947,7 @@
<sect2 id="stack-frame-info">
<title>Information about the current frame</title>
<para>
- It is possible to obtain information about the currently selected frame
+ You can obtain information about the currently selected frame
by choosing the menu item <menuchoice><guisubmenu>Debug</guisubmenu>
<guisubmenu>Information</guisubmenu><guimenuitem>Info Current Frame</guimenuitem></menuchoice>.
A window will open describing the current frame.
@@ -960,7 +957,7 @@
<sect2 id="stack-arg-info">
<title>Information about the current function arguments</title>
<para>
- It is possible to obtain information about the arguments of the current function
+ You can obtain information about the arguments of the current function
by choosing the menu item <menuchoice><guisubmenu>Debug</guisubmenu>
<guisubmenu>Information</guisubmenu><guimenuitem>Arguments</guimenuitem></menuchoice>.
A window will open describing the arguments.
@@ -978,7 +975,7 @@
</para>
<note>
<para>
- The front end sends this command directly to the back end without doing any check.
+ The front end sends this command directly to the back end without performing any checks.
By example if you set a breakpoint like this, it will not appear in the
<interface>breakpoint list window</interface>. It is better to avoid using this
command unless you know exactly what you are doing.
Modified: trunk/manuals/anjuta-manual/C/fileoperations.xml
==============================================================================
--- trunk/manuals/anjuta-manual/C/fileoperations.xml (original)
+++ trunk/manuals/anjuta-manual/C/fileoperations.xml Tue Dec 23 09:39:25 2008
@@ -3,15 +3,15 @@
<!-- ============= File operations: Creating a new file === -->
<sect1 id="creating-files">
- <title>Creating a New File and inserting texts</title>
+ <title>Creating a new file and inserting text</title>
<sect2 id="new-file">
- <title>Creating New File</title>
+ <title>Creating a New File</title>
<para>
To create a new file, choose <menuchoice><guisubmenu>File</guisubmenu>
- <guimenuitem>New</guimenuitem></menuchoice> from the menubar, or click on the
- <guibutton>New File</guibutton> button on the toolbar. A new page will
+ <guimenuitem>New</guimenuitem></menuchoice> from the menu bar, or click on the
+ <guibutton>New File</guibutton> button on the main toolbar. A new page will
appear in the editor (or a new window if the parent document is windowed).
- This new document will be named <filename>newfile#1</filename>,
+ New documents will be named <filename>newfile#1</filename>,
<filename>newfile#2</filename>, <filename>newfile#3</filename> and
so on.
</para>
@@ -28,11 +28,11 @@
<para>
A wizard can also be used to create a new file. To create a new file, choose
<menuchoice><guisubmenu>File</guisubmenu><guisubmenu>New</guisubmenu>
- <guimenuitem>File</guimenuitem></menuchoice> from the menubar.
- This will open the New File Wizard dialog. Select the file type. Enter the File name.
+ <guimenuitem>File</guimenuitem></menuchoice> from the menu bar.
+ This will open the New File dialog. Select the file type. Enter the filename.
The suffix will be automatically added.
- You can add a license information (according to your license choice) and a header.
- In case of C-C++ header file, you can also add an header template.
+ You can add license information (according to your license choice) and a header.
+ In case of a C/C++ header file, you can also add an header template.
Click <guibutton>OK</guibutton> to validate the creation.
<figure id="new-file-wizard">
<title>New File Wizard</title>
@@ -43,41 +43,41 @@
</figure>
</para>
<para>
- <application>Anjuta</application> occasionally also creates new files during some
- operations. For example, some CVS operations, such as diff, file log, file status
- etc, create new files and add the output there. These could be saved in real file
- just like normal new files.
+ <application>Anjuta</application> occasionally also creates new file windows during some
+ operations. For example, some Subversion operations such as <command>Diff</command> and
+ <command>View Log</command>
+ create new file windows and add the output there. You can save the contents of these windows
+ to real files if you like.
</para>
</sect2>
<sect2 id="inserting-macros">
<title>Inserting Macros</title>
<para>
- Macros can be used to quickly edit repetitive sequences of text.
+ You can use <emphasis>macros</emphasis> to quickly edit repetitive sequences of text.
</para>
<important>
<para>
- Macro plugin must be activated.
+ The Macro plugin must be activated.
</para>
</important>
<sect3 id="inserting">
<title>Inserting</title>
<para>
- Two types of macros are available: Anjuta macros and User macros (My macros). Anjuta macros
- are not modifiable by the user. On the other hand, User macros can be defined and modified by
- the user.
+ Two types of macros are available: Anjuta macros and user macros (displayed as "My macros"). Anjuta macros
+ are not modifiable, but you can define and modify your own user macros.
</para>
<para>
- To insert macro, move the cursor at the desired place. Select
+ To insert a macro, move the cursor to the desired place. Select
<menuchoice><guisubmenu>Edit</guisubmenu><guisubmenu>Macros</guisubmenu>
- <guimenuitem>Macros...</guimenuitem></menuchoice>. The dialog window appears. Select the
- wanted macro in the list. The result of the macro expansion is displayed in the window and a
+ <guimenuitem>Macros...</guimenuitem></menuchoice>. A dialog window appears. Select the
+ desired macro in the list. The result of the macro expansion is displayed in the window and a
summary is shown in the dialog window. Choose <guibutton>Insert</guibutton>. The expanded macro
text is inserted at the cursor position.
</para>
<para>
- Another possibility to insert macro is to select <menuchoice><guisubmenu>Edit</guisubmenu>
+ Another way to insert a macro is to select <menuchoice><guisubmenu>Edit</guisubmenu>
<guisubmenu>Macros</guisubmenu><guimenuitem>Insert Macro...</guimenuitem></menuchoice>,
- then to press the wanted macro shortcut.
+ then to press the desired macro shortcut.
<figure id="display-macro">
<title>Macro</title>
<screenshot>
@@ -90,7 +90,7 @@
<sect3 id="defining-macro">
<title>Defining Macros</title>
<para>
- From the Insert-Macro window, choose <guibutton>Add</guibutton> or select <menuchoice>
+ From the Insert Macro window, choose <guibutton>Add</guibutton> or select <menuchoice>
<guisubmenu>Edit</guisubmenu><guisubmenu>Macros</guisubmenu><guimenuitem>Add Macro...
</guimenuitem></menuchoice>. The Add/Edit window appears. Enter the macro name, choose or
define a category and enter a shortcut. Then edit text relative to your macro. The character
@@ -98,11 +98,11 @@
<guibutton>OK</guibutton>. The macro is added to the list.
</para>
<para>
- The user can also erase a macro by selecting it in the list (only My Macros) then by choosing
- <guibutton>Remove</guibutton>.
+ You can also erase a macro by selecting it in the list and choosing
+ <guibutton>Remove</guibutton>. This only works for user macros (My Macros), of course.
</para>
<para>
- Same manner, macro can be edited and modified by selecting it in the list then by choosing
+ Similarly, you can edit and modify a macro by selecting it in the list and choosing
<guibutton>Edit</guibutton>.
<figure id="add-edit-macro">
<title>Add/Edit Macro</title>
@@ -116,12 +116,12 @@
<sect3 id="macro-keyword">
<title>Macro Keywords</title>
<para>
- Macros Keywords are available. They can be integrated in the macro definitions. The names of
- these macro Keywords start and finish by the character ' @ '.
+ Macro keywords are available. They can be included in macro definitions.
+ These macro keywords start and finish with the character ' @ '.
</para>
<para>
- Available macro keywords are : @DATE_TIME@, @DATE_YMD@, @DATE_Y@, @USER_NAME@, @FILE_NAME@,
- @FILE_NAME_UP@, @FILE_NAME_UP_PREFIX@, @EMAIL@, @TABSIZE@, @INDENTSIZE@, @USETABS
+ Available macro keywords are @DATE_TIME@, @DATE_YMD@, @DATE_Y@, @USER_NAME@, @FILE_NAME@,
+ @FILE_NAME_UP@, @FILE_NAME_UP_PREFIX@, @EMAIL@, @TABSIZE@, @INDENTSIZE@, and @USETABS
<figure id="keyword-macro">
<title>Keyword Macro</title>
<screenshot>
@@ -143,7 +143,7 @@
<para>
<emphasis>Opening a file:</emphasis>
To open an existing file, choose <menuchoice><guisubmenu>File</guisubmenu>
- <guimenuitem>Open</guimenuitem></menuchoice> from the menubar, click on
+ <guimenuitem>Open</guimenuitem></menuchoice> from the menu bar, click on
the <guibutton>Open</guibutton> button on the toolbar, or press
<keycombo><keycap>Ctrl</keycap><keycap>O</keycap></keycombo>. This will
display the <interface>Open File</interface> dialog.
@@ -154,20 +154,14 @@
<graphic fileref="figures/open_file.png" format="PNG" srccredit="jnoel"></graphic>
</screenshot>
</figure>
- Select or enter the file you want to open, then click
+ Select or enter the name of file you want to open, then click
<guibutton>Open</guibutton>. To open more than one file at once, select multiple files
- to open by first pressing CTRL and clicking the files in the list and
+ to open by holding down the <keycap>Ctrl</keycap> key and clicking each file in turn; then
press <guibutton>Open</guibutton>. If you change your mind, click
<guibutton>Cancel</guibutton> to dismiss the dialog without opening
the file.
</para>
<para>
- For selecting multiple files at once,
- select a file in the dialog and press CTRL once. This will bring the file selection
- dialog in multiple-select mode and multiple files could be selected from the list.
- Multiple file select mode is similar to single file select mode, except that the file
- operation (for which the file selection was being done) will be performed for all
- the selected files.
<figure id="open-file-multiple">
<title>Open Multiple File dialog</title>
<screenshot>
@@ -177,9 +171,10 @@
</figure>
</para>
<para>
- The <emphasis>Show Hidden Files</emphasis>, if switched on (Click right), will make the hidden
- files (files starting with "."; visible in the file list. Depress it to make
- them hide. <application>Anjuta</application> file selection dialog also has inbuilt
+ You can enable the <emphasis>Show Hidden Files</emphasis> option through the pop-up menu
+ that appears when you right-click in the Open File dialog. This option will make hidden
+ files (files starting with ".") visible in the file list. Clear the option to hide hidden files.
+ The Open File dialog also has a built-in
file type filter. Select the appropriate file type filter in the dialog and the file
list will be limited to the files of the selected type only.
</para>
@@ -189,7 +184,7 @@
<para>
<emphasis>Saving a file:</emphasis>
To save a file, choose <menuchoice><guisubmenu>File</guisubmenu>
- <guimenuitem>Save</guimenuitem></menuchoice> from the menubar, click on
+ <guimenuitem>Save</guimenuitem></menuchoice> from the menu bar, click on
the <guibutton>Save</guibutton> button on the toolbar, or press
<keycombo><keycap>Ctrl</keycap><keycap>S</keycap></keycombo>. This will
save the file. If the file is new, a <interface>Save As</interface> dialog will
@@ -201,13 +196,13 @@
</screenshot>
</para>
<note>
- <title>File auto save</title>
+ <title>File autosave</title>
<para>
- If you have enabled auto-save, it will not auto-save any new files.
+ If you have enabled autosave, Anjuta will not autosave any new files.
You must first save them manually. The same applies to the
- <guimenuitem>Save All</guimenuitem> option: it will not save new files,
+ <guimenuitem>Save All</guimenuitem> option: Anjuta will not save new files,
if you haven't saved them first manually. <emphasis>You must save a file manually
- before auto-save or <guimenuitem>Save All</guimenuitem> will work with it.</emphasis>
+ before autosave or <guimenuitem>Save All</guimenuitem> will work with it.</emphasis>
</para>
</note>
</listitem>
@@ -217,7 +212,7 @@
<emphasis>Saving a file with a different name:</emphasis>
You can explicitly save a file with a new filename. To do this, choose
<menuchoice><guisubmenu>File</guisubmenu><guimenuitem>Save As</guimenuitem></menuchoice>
- from the menubar. A <interface>Save As</interface> dialog will appear prompting you to
+ from the menu bar. A <interface>Save As</interface> dialog will appear prompting you to
enter the new filename. Enter the name and click <guibutton>Save</guibutton>.
</para>
<note>
@@ -226,7 +221,7 @@
When you use <guimenuitem>Save As</guimenuitem> with an existing file,
the original is not deleted. It is left unchanged since the last save.
If a file with the new filename already exists, a confirmation dialog
- will appear, to ensure that you want to overwrite it. Clicking
+ will appear to ensure that you want to overwrite it. Clicking
<guibutton>Yes</guibutton> will overwrite the file with the file you
are saving.
</para>
@@ -237,9 +232,9 @@
<para>
<emphasis>Closing a file:</emphasis>
To close a file, choose <menuchoice><guisubmenu>File</guisubmenu>
- <guimenuitem>Close</guimenuitem></menuchoice> from the menubar, or click on the
- <guibutton>Close</guibutton> button on the toolbar. The file could also be closed
- by clicking the <guibutton>cross</guibutton> in the filename tab. This will close
+ <guimenuitem>Close</guimenuitem></menuchoice> from the menu bar, or click on the
+ <guibutton>Close</guibutton> button on the toolbar. (You can also close a file
+ by clicking the X in its filename tab.) This will close
the current file. If the file is not saved, or is a new file, then
<application>Anjuta</application> will prompt you to save the file before
closing it.
@@ -253,18 +248,18 @@
<sect1 id="editing-files">
<title>Editing Files</title>
<para>
- <application>Anjuta</application> has a number of helpful features which aid in
- editing and working with source files. The following sections describe how to use
+ <application>Anjuta</application> has a number of features which help you
+ edit and work with source files. The following sections describe how to use
some of the interesting features available.
</para>
<sect2 id="editor-margins-sec">
<title>Editor Margins</title>
- <para><emphasis>Editor Margins:</emphasis> Editor margins are the small area on the
- left of the editor for some special purposes. There are three editor margins available
- and all of them may not be available when you first start <application>anjuta</application>.
- They are Line numbers margin, Markers margin and Code fold margin.
- By default (that is, when you run <application>anjuta</application> for the first time) only
- the code fold margin will be visible. The rest could be made visible from
+ <para><emphasis>Editor Margins:</emphasis> Editor margins appear to the
+ left of the editor and are used for some special purposes. There are three editor margins available:
+ the <emphasis>line number margin</emphasis>, the <emphasis>marker margin</emphasis>
+ and the <emphasis>code fold margin</emphasis>.
+ By default (that is, when you run <application>Anjuta</application> for the first time) only
+ the code fold margin will be visible. The rest can be made visible via
<menuchoice><guimenu>View</guimenu><guisubmenu>Editor</guisubmenu></menuchoice>.
<figure id="editor-margins">
<title>Editor Margins</title>
@@ -275,47 +270,47 @@
</figure>
</para>
<para>
- The <emphasis>Line Numbers Margin</emphasis> is largest of all the three margins (and slightly
- darker then rest) and displays the document's line numbers.
- <emphasis>Line Number Margin</emphasis> could be made visible
- or invisible by toggling <menuchoice><guimenu>View</guimenu><guisubmenu>Editor</guisubmenu>
- <guimenuitem>Line Numbers Margin</guimenuitem></menuchoice>. Single left clicking on this margin
- will select the whole line (including the last newline, if present). You can set the font
- properties for line number margin in the preferences.
+ The <emphasis>line number margin</emphasis> is largest of all the three margins (and is slightly
+ darker then rest) and displays a document's line numbers.
+ The <emphasis>line number margin</emphasis> can be shown or hidden
+ by toggling <menuchoice><guimenu>View</guimenu><guisubmenu>Editor</guisubmenu>
+ <guimenuitem>Line Numbers Margin</guimenuitem></menuchoice>. Left-clicking on this margin
+ will select an entire line (including the trailing newline, if present). You can set font
+ properties for the line number margin in the preferences.
</para>
- <para><emphasis>Markers Margin</emphasis> is the next margin which can be made visible or
- invisible by selecting <menuchoice><guimenu>View</guimenu><guisubmenu>Editor</guisubmenu>
+ <para>The <emphasis>marker margin</emphasis> can be shown or hidden
+ via <menuchoice><guimenu>View</guimenu><guisubmenu>Editor</guisubmenu>
<guimenuitem>Markers Margin</guimenuitem></menuchoice>. This margin displays graphical icons
- to mark the given line. The markers which will be displayed in this margin are Bookmark marker
- (rectangular blue colored icon), Breakpoint marker (circular red colored) and Line indicator
- (pointed arrow yellow colored). Bookmark marker is used to indicate bookmarked lines which could
- be toggled from <menuchoice><guimenu>Goto</guimenu><guisubmenu>Bookmark</guisubmenu><guimenuitem>
+ to mark the given line. The margin may display bookmark markers
+ (blue and rectangular), breakpoint markers (red and circular)
+ and line indicator markers (which look like a yellow pointed arrow).
+ A bookmark marker indicates a bookmarked line, and can
+ be toggled via <menuchoice><guimenu>Goto</guimenu><guisubmenu>Bookmark</guisubmenu><guimenuitem>
Toggle Bookmark</guimenuitem></menuchoice>
- with the cursor placed in that line. The breakpoint marker is used in debugger to mark the
- line with debugging breakpoints (see debugging section for more details). The line indicator
- marker is used to indicate a line when we do a jump from another part, for example when
- navigating the bookmarks and during single stepping in debugger.
+ with the cursor placed on that line. A breakpoint marker is used in the debugger to indicate a
+ debugging breakpoint (see the Debugging section for more details). A line indicator
+ marker is used to indicate the current program position in the debugger.
</para>
<para>
- <emphasis>Code folding margin</emphasis> is where the folding tree is visible. Clicking
- on these folding tree nodes will fold or unfold the code blocks. An underline will also
- be drawn below the folded line to make it more obvious that a block of code has been
+ The <emphasis>code fold margin</emphasis> is where the folding tree is visible. Clicking
+ on folding tree nodes will fold or unfold code blocks. An underline will also
+ be drawn below a folded line to make it more obvious that a block of code has been
folded below the line. For more details on code folding, see the section <emphasis>Code Folding</emphasis>
below.
</para>
<note>
<title>Invisible margin marker</title>
<para>
- If the marker margin is not visible, the markers will be displayed by changing the
- background color of the line. For example, if there a breakpoint marker is set in
- a line and the marker margin is not visible, that line will be displayed with red
- background. Similarly, for bookmark marker and line indication marker, the background
+ If the marker margin is not visible, Anjuta displays markers by changing the
+ background color of a line. For example, if a breakpoint marker is set in
+ a line and the marker margin is not visible, that line will be displayed with a red
+ background. Similarly, for a bookmark marker and a line indicator marker the background
color of the line will be sky blue and yellow, respectively. If you do not like this
- (perhaps due to some contrasting themes), enable the <emphasis>Markers Margins</emphasis>
- from <menuchoice><guimenu>View</guimenu><guisubmenu>Editor</guisubmenu>
- <guimenuitem>Markers Margin</guimenuitem></menuchoice>.
+ (perhaps due to some contrasting themes), enable the marker margin
+ via <menuchoice><guimenu>View</guimenu><guisubmenu>Editor</guisubmenu>
+ <guimenuitem>Marker Margin</guimenuitem></menuchoice>.
<figure id="editor-markers">
- <title>Editor markers when markers margin is invisible</title>
+ <title>Editor markers when the marker margin is invisible</title>
<screenshot>
<screeninfo>The Tags toolbar</screeninfo>
<graphic fileref="figures/editor_markers.png" format="PNG" srccredit="naba"></graphic>
@@ -326,14 +321,13 @@
</sect2>
<sect2 id="editor-guides-sec">
<title>Editor Guides</title>
- <para>The editor could be made to make certain document information, which otherwise are
- normally not visible. <emphasis>Indentation guides, white spaces and line end characters</emphasis>
- are such information which could be made visible for editing comfort. They could be make
+ <para>The editor can be set to display certain document information which is
+ normally invisible, including <emphasis>indentation guides</emphasis>, <emphasis>white space</emphasis>
+ and <emphasis>line end characters</emphasis>. They can be make
visible or invisible by toggling the menu items in <menuchoice><guimenu>View</guimenu>
- <guisubmenu>Editor</guisubmenu></menuchoice>. Indentation guides are the small dotted lines
- drawn to connect the matching braces in the source code. When the cursor is over one such
- matching braces, the dotted indentation guide is highlighted to give a visual region of the
- indentation.
+ <guisubmenu>Editor</guisubmenu></menuchoice>. Indentation guides are small dotted lines
+ drawn to connect matching braces in source code. When the cursor is over a
+ matching brace, its dotted indentation guide is highlighted to emphasize the indentation level visually.
</para>
<figure id="editor-guides">
<title>Editor with guides</title>
@@ -346,10 +340,10 @@
<sect2 id="highlighting">
<title>Syntax highlighting</title>
<para>
- <application>Anjuta</application> can highlight many different languages.
- This is usually done automatically by determining the type of the file from the
- file extension. If <application>Anjuta</application> cannot determine the type of
- the file, there will be no syntax highlighting. You can explicitly force a particular
+ <application>Anjuta</application> can highlight the syntax of many different languages.
+ This is usually done automatically by determining the type of a file from its
+ extension. If <application>Anjuta</application> cannot determine the type of
+ a file, there will be no syntax highlighting. You can explicitly force a particular
highlight style by selecting the style from the menu
<menuchoice><guimenu>View</guimenu><guisubmenu>Editor</guisubmenu><guisubmenu>
Highlight Mode</guisubmenu></menuchoice>.
@@ -358,11 +352,11 @@
<para>
Anjuta uses a properties file named
<filename>$prefix/share/anjuta/properties/anjuta.properties</filename>,
- it has the same format than SciTE properties file but do not use
+ which has the same format as a SciTE properties file but does not use
all properties. The style of each element for all languages is
defined in a file named
<filename>$prefix/share/anjuta/properties/styles.properties</filename>.
- It uses some common properties defined by Anjuta GUI in the file
+ It uses some common properties defined by Anjuta in the file
<filename>$home/.config/anjuta/scintilla/editor-style.properties</filename>.
</para>
</note>
@@ -370,34 +364,33 @@
<sect2 id="codefolding">
<title>Code folding</title>
<para>
- Source files which have block coding properties (such as C, C++, Pascal, Java etc.),
- have the advantage of working with <emphasis>code folds</emphasis>. All of
- the code blocks in the source file can be folded or unfolded by clicking on the
- fold points in the fold margin of the <interface>Editor window</interface>
+ Anjuta can display <emphasis>code folds</emphasis> for source files in block-structured
+ languages (such as C, C++, Pascal, and Java).
+ All code blocks in a source file can be folded or unfolded by clicking on the
+ fold points in the code fold margin of the <interface>Editor</interface> window
(usually a +/- symbol or up/down arrow). These fold points automatically appear for
source files which use code blocks.
</para>
<para>
- Code folding is especially useful when editing big source files that run to
- thousands of lines. Once the folds are closed, the document appears to become
+ Code folding is especially useful when editing large source files with
+ thousands of lines. Once the folds are closed, a document appears to become
smaller, facilitating easy browsing and editing of the file.
</para>
<note>
<para>
Please note that code folding and editor guides are only available in
- the scintilla based editor.
+ the Scintilla-based editor.
</para>
</note>
</sect2>
<sect2 id="autoformat">
<title>Auto-formatting source code</title>
<para>
- If the current file is a C or C++ source or header file, then it is possible to
- automatically indent (auto-format) the file. This gives a clean look to
+ Anjuta can automatically indent (auto-format) C or C++ source or header files. This gives a clean look to
the source code, increases legibility, reduces the likelihood of syntax errors,
- and above all it saves time. This can be performed by choosing
+ and above all saves time. To auto-indent the current source file, choose
<menuchoice><guimenu>Edit</guimenu><guimenuitem>Auto Indent
- </guimenuitem></menuchoice> on the menubar. Change the style of formatting by customizing the
+ </guimenuitem></menuchoice> on the menu bar. You can change the style of formatting by customizing the
choices in the preferences.
</para>
</sect2>
@@ -405,57 +398,29 @@
<!-- ============= File operations: Browsing with the tags browser === -->
<sect1 id="browsing-files">
- <title>Symbol browser and Browsing Files</title>
+ <title>The Symbol Browser</title>
<para>
- All C and C++ source and header files can be browsed using the tags in the files.
- All of the open C and C++ source and header files are scanned for available tags
- (a "tag" refers to a function definition, structure, macro, etc.). Please note that
- Tag and Symbol is used synonymously in this manual, except when referring to Tags
- browser and Symbol browser, which two different interfaces.
+ You can browse C and C++ source and header files using <emphasis>tags</emphasis> in the files.
+ A tag (or <emphasis>symbol</emphasis>) refers to a named entity such as a function definition, structure, or macro.
+ Anjuta scans open C and C++ source and header files for available tags.
</para>
- <orderedlist>
- <listitem>
- <para><emphasis>Tags Browser:</emphasis> Tags browser is available on the
- Browser toolbar. It shows a list of tags available in the currently active
- file (source file). If there is no tags (or symbols) available in the file,
- the tags list will be invisible and a "No Tags" will be displayed instead. The tags
- in this list are shown along with the line numbers where they are found. If there are
- multiple symbols with the same name, they will be shown with different line numbers.
- <figure id="tags-toolbar">
- <title>Tags toolbar</title>
- <screenshot>
- <screeninfo>The Tags toolbar</screeninfo>
- <graphic fileref="figures/toolbar_browser.png" format="PNG" srccredit="jhs"></graphic>
- </screenshot>
- </figure>
- <tip><title>Function symbols</title>
- <para>Function prototype and definition, if present in the same file, can be usually
- distinguished from the corresponding line numbers. Prototypes usually comes before the
- definition, so they are likely to have smaller line numbers.
- </para>
- </tip>
- </para>
- </listitem>
- <listitem>
- <para><emphasis>Symbol Browser:</emphasis>
- If there is a project open, <application>Anjuta</application> will scan for tags
- in all of the source and header files of the project. This way it is possible
- to go to any function definition, structure definition, class definition etc.
- without manually opening the file. You don't even have to know which file that
- tag is found in (except in the case of function definitions). The symbol browser
- lists all the available symbols in the project.
- <figure id="symbol-browser">
- <title>Tags toolbar</title>
- <screenshot>
- <screeninfo>Symbol browser</screeninfo>
- <graphic fileref="figures/symbol_browser.png" format="PNG" srccredit="jhs"></graphic>
- </screenshot>
- </figure>
- </para>
- </listitem>
- </orderedlist>
+ <para>
+ <application>Anjuta</application> will automatically scan for tags
+ in all of the source and header files of any open project. You can
+ jump to any function definition, structure definition, class definition or other tag
+ without manually opening the containing file. You don't even have to know which file the
+ tag is found in. The symbol browser
+ lists all available symbols in the project.
+ <figure id="symbol-browser">
+ <title>Symbol browser</title>
+ <screenshot>
+ <screeninfo>Symbol browser</screeninfo>
+ <graphic fileref="figures/symbol_browser.png" format="PNG" srccredit="jhs"></graphic>
+ </screenshot>
+ </figure>
+ </para>
<tip>
- <title>Tags synchronization</title>
+ <title>Tag synchronization</title>
<para>
You don't have to worry about the synchronization and update of the tag
database. <application>Anjuta</application> will take care of everything.
@@ -471,30 +436,30 @@
<sect2 id="searching">
<title>Searching</title>
<para>
- To search for a <emphasis>text</emphasis> or <emphasis>regular expression</emphasis>
- string in the current file, choose <menuchoice><guimenu>Edit</guimenu>
+ To search for a <emphasis>string</emphasis> or <emphasis>regular expression</emphasis>
+ in the current file, choose <menuchoice><guimenu>Edit</guimenu>
<guisubmenu>Search</guisubmenu><guimenuitem>Find</guimenuitem></menuchoice>
- or press <keycombo><keycap>Ctrl</keycap><keycap>F</keycap></keycombo>.
+ or press <keycombo><keycap>Ctrl</keycap><keycap>Alt</keycap><keycap>F</keycap></keycombo>.
This will open the <interface>Find</interface> dialog.
</para>
<para>
Use the text box to specify the string to search for, and select whether it is a normal
- string or a regular expression (RegExp). It is also possible to specify the direction of
+ string or a regular expression. You can also specify the direction of
search, whether the search is case-sensitive or not, and the scope of the search. Click
<guibutton>Search</guibutton> to start searching.
</para>
<para>
- If the search is successful, the matched text in the document will be highlighted, marked...
- (according to the search action choice). If the search is not successful,
- a <emphasis>The match "search text" was not found</emphasis> message will be displayed.
+ If the search is successful, Anjuta will jump to the matched text or perform another action
+ (according to the <guilabel>Search Action</guilabel> you choose in the <guilabel>Search Target</guilabel> tab). If the search is not successful, Anjuta will display
+ a message indicating that the search text was not found.
</para>
<para>
- If you want to search again, click on the <guibutton>Search</guibutton> button on the main
- toolbar or press <keycombo><keycap>Ctrl</keycap><keycap>G</keycap></keycombo>. This will
- find the next match (<keycombo><keycap>Shift</keycap><keycap>Ctrl</keycap>
+ If you want to search again, click the <guibutton>Search</guibutton> button again
+ or press <keycombo><keycap>Ctrl</keycap><keycap>G</keycap></keycombo>. This will
+ find the next match (use <keycombo><keycap>Shift</keycap><keycap>Ctrl</keycap>
<keycap>G</keycap></keycombo> for the previous match). You can even
- change the search text when you do this. Enter the new string in the
- <guilabel>Search Expression</guilabel> text box in the main toolbar.
+ change the search text when you do this; enter the new string in the
+ <guilabel>Search Expression</guilabel> text box in the search dialog.
</para>
<figure id="search-expr">
<title>Search Text dialog</title>
@@ -503,27 +468,17 @@
</screenshot>
</figure>
<para>
- To stop a long research, choose <guibutton>Stop</guibutton> button.
+ To stop a long search, press the <guibutton>Stop</guibutton> button.
</para>
- <para>
- If the "Basic Search" option is selected in the Setting window,
- the search direction can be chosen from the Expression window.
- </para>
- <figure id="search-expr-basic">
- <title>Basic Search Text dialog</title>
- <screenshot>
- <graphic fileref="figures/search_expr_basic.png" format="PNG" srccredit="jhs"></graphic>
- </screenshot>
- </figure>
</sect2>
<sect2 id="search-range">
<title>Specifying Search Range</title>
<para>
- In the "Search Target dialog", define the search location and the action
- to be done in case of search success.
+ In the <interface>Search Target</interface> tab, define the search location and the action
+ to be performed if the search succeeds.
</para>
<para>
- The maximum number actions can be defined by User.
+ You can define the maximum number of actions to be performed.
</para>
<figure id="search-target">
<title>Search Target dialog</title>
@@ -532,7 +487,7 @@
</screenshot>
</figure>
<para>
- The user can select where the text will be searched.
+ You can select which text will be searched.
</para>
<figure id="search-target-in">
<title>Search Target In choice</title>
@@ -543,17 +498,17 @@
<sect3 id="search-file">
<title>Searching in Files</title>
<para>
- To find text in your project, select "search in" <menuchoice><guimenu>
- All Project Files</guimenu></menuchoice>.
+ To find text in your project, set <guilabel>Search In</guilabel> to
+ All Project Files.
</para>
<para>
- Enter the text you want to search and specify search options (case-sensitive,
- complete words ...).
+ In the <guilabel>Search Expression</guilabel> tab, enter the text you want to search for and specify search options, such as the <guilabel>Match case</guilabel>
+ or <guilabel>Match complete words</guilabel> options.
Click <guibutton>Search</guibutton> to start searching.
</para>
<para>
- To find text in File list, select "search in" <menuchoice><guimenu>
- Specifying File List</guimenu></menuchoice>. Define the Search variables.
+ To find text in a set of files, set <guilabel>Search In</guilabel> to
+ Specify File Patterns. Define the search variables.
Click <guibutton>Search</guibutton> to start searching.
</para>
<figure id="search-file-pattern">
@@ -567,13 +522,14 @@
</sect2>
<sect2 id="search-action">
- <title>Specifying Search Action</title>
+ <title>Specifying a Search Action</title>
<para>
- The user selects which action will be done in case of search success.
+ You can select which action will be performed when a search succeeds.
</para>
<para>
- According to the previous selections (Search in, Search direction ...),
- some actions could be unavailable.
+ Depending on the previous selections (<guilabel>Search In</guilabel>, <guilabel>Search Direction</guilabel>
+ , and so on),
+ some actions may be unavailable.
</para>
<figure id="search-target-action">
<title>Search Target Action choice</title>
@@ -586,9 +542,9 @@
<sect2 id="replacing">
<title>Replacing</title>
<para>
- Search and replace is similar to just finding text, except that you
- also specify the replace text in the <guilabel>Replace With:</guilabel> text box,
- and whether or not you want to be prompted before the replace takes place
+ Searching and replacing is similar to just finding text, except that you
+ also specify the replacement text in the <guilabel>Replace With</guilabel> text box,
+ and also specify whether or not you want to be prompted before each replacement takes place
(Replace First Match or Replace All Matches).
</para>
<figure id="replace">
@@ -606,11 +562,11 @@
<sect2 id="search-setting">
<title>Search Setting</title>
<para>
- The user has the possibility of saving the setting of his search options.
+ You may also save search options.
</para>
<para>
- Item highlighted in red is the active item. Item by default is the search
- setting which is loaded at Anjuta launching.
+ The item highlighted in red is the active item. The default item specifies search
+ settings which are loaded when Anjuta launches.
</para>
<figure id="search-setting-fig">
<title>Search Setting dialog</title>
@@ -626,12 +582,12 @@
<sect1 id="printing">
<title>Printing a file</title>
<para>
- Print preview could be taken by selecting
+ You can perform a print preview by selecting
<menuchoice><guisubmenu>File</guisubmenu><guimenuitem>Print Preview</guimenuitem></menuchoice>.
- It will render the current file and present a preview of the print. Source codes which
- are highlighted in the editor are also highlighted similarly in the print (or preview). Additional
- options are available to print with the line numbers, wrapped lines and/or headers in the
- <guilabel>Printing</guilabel> tab of your editor plugin preferences.
+ This will render the current file and present a preview of the print. Source code which
+ is highlighted in the editor is also highlighted similarly in the preview (and subsequent print). The
+ <guilabel>Printing</guilabel> tab of your editor plugin preferences contains additional
+ options which let you print with line numbers, wrapped lines and/or headers.
<figure>
<title>Print preview of a C file</title>
<screenshot>
@@ -653,13 +609,13 @@
When you are ready to print and satisfied with the preview, select
<menuchoice><guisubmenu>File</guisubmenu><guimenuitem>Print</guimenuitem></menuchoice>
or <guibutton>Print</guibutton> from the print preview window. This will bring up the
- actual print dialog as shown below. Select the appropriate print parameters and print
- the file with <guibutton>Print</guibutton> on it.
+ actual print dialog as shown below. Select the appropriate print parameters and press
+ <guibutton>Print</guibutton> to print the file.
</para>
<para>
- Landscaped or portrait page layout, paper size, page orientation
- and paper type could also be set. Remember to set them up properly according to your printer,
- otherwise printing may not come up properly.
+ You can also set landscaped or portrait page layout and the paper size, page orientation
+ and paper type. Remember to set them up properly according to your printer,
+ otherwise printing may not look correct.
</para>
<para>
<figure>
@@ -672,3 +628,4 @@
</para>
</sect1>
</chapter>
+
Modified: trunk/manuals/anjuta-manual/C/interface.xml
==============================================================================
--- trunk/manuals/anjuta-manual/C/interface.xml (original)
+++ trunk/manuals/anjuta-manual/C/interface.xml Tue Dec 23 09:39:25 2008
@@ -4,10 +4,10 @@
<sect1 id="menu-and-shortcuts">
<title>Menus and shortcuts</title>
<para>
- At the top of the <application>Anjuta</application> main window is the menubar.
- Almost all of the functions are available by activating the appropriate
- menu item. The functions have been grouped according to their type. For
- example, the file operations have been grouped into
+ At the top of the <application>Anjuta</application> main window is the menu bar.
+ You can access almost all of Anjuta's functionality through
+ menu items. Operations have been grouped according to their type. For
+ example, file operations have been grouped into
the <guisubmenu>File</guisubmenu> menu.
</para>
@@ -19,12 +19,6 @@
</screenshot>
</figure>
- <para>
- Most of the menus and submenus can be detached. Click on the detach bar
- (the dashed line just above the first menu item). Once the menu is
- detached, it will become an independent window.
- </para>
-
<figure id="file-menu">
<title>File menu</title>
<screenshot>
@@ -34,51 +28,53 @@
</figure>
<para>
- Shortcut keys are available for many of the menu options. All of the shortcut
- keys are shown alongside the corresponding menu items. A useful reference to
- the shortcut keys which are not directly attached with the menu is also available
- in the next section. Some useful shortcuts are listed here.
+ Shortcut keys are available for many menu items. All shortcut
+ keys are shown alongside the corresponding menu items. Some other useful shortcuts are listed here.
</para>
<para>
<itemizedlist>
<listitem>
<para>
- <emphasis>Switch Editor page:</emphasis> CTRL-TAB (forward) and CTRL-SHIFT-TAB (backward) -- The pages could
- also be switched by right clicking on the notebook tabs and selecting an editor tab
- (useful when all the tabs in the editor are not visible at once). Some desktop configuration
+ <emphasis>Switch Editor Page:</emphasis> <keycombo><keycap>Ctrl</keycap><keycap>Tab</keycap></keycombo>
+ (forward) and <keycombo><keycap>Ctrl</keycap><keycap>Shift</keycap><keycap>Tab</keycap></keycombo>
+ (backward). You can
+ also switch pages by right-clicking on the notebook tabs and selecting a filename from the pop-up menu
+ (useful when all the tabs in the editor are not visible at once). Some desktop configurations
may already have these shortcut keys assigned. In that case, you will need to reconfigure them
- (not in anjuta, because they are fixed) if you want to avail these shortcuts.
+ (not in Anjuta, because they are fixed) if you want to use these shortcuts.
</para>
</listitem>
<listitem>
<para>
- <emphasis>Context Help:</emphasis> SHIFT-F1 -- Keep the cursor on the word (for example, the
- function name) for which you want to get the API help and press the shortcut. Context help
- only works if you have <application>DevHelp</application> installed. If you do not have
- <application>DevHelp</application> installed, the context help menu and toolbar button
- will be inactive. You can get it from <application>DevHelp</application>
- website. You will also have to install the related <application>DevHelp</application> books.
+ <emphasis>Context Help:</emphasis> <keycombo><keycap>Shift</keycap><keycap>F1</keycap></keycombo>.
+ Place the cursor on the word (for example, the
+ function name) for which you want to get API help and type this shortcut. Context help
+ only works if you have <application>Devhelp</application> installed; otherwise,
+ the context help menu and toolbar button
+ will be inactive. You can get Devhelp from the <application>Devhelp</application>
+ website. You will also have to install the related <application>Devhelp</application> books.
</para>
</listitem>
<listitem>
<para>
- <emphasis>Auto complete:</emphasis> CTRL-ENTER -- Press the shortcut with the cursor placed
- at the end of incomplete word and a list of words matching the remaining part will appear.
+ <emphasis>Autocomplete:</emphasis> <keycombo><keycap>Ctrl</keycap><keycap>Enter</keycap></keycombo>.
+ Type this shortcut with the cursor placed
+ at the end of an incomplete word and a list of words matching the remaining part will appear.
Scroll and select the right word from the list if you find one.
</para>
</listitem>
<listitem>
<para>
- <emphasis>More shortcuts:</emphasis> Look for the shortcut keys displayed on right side
- of the menu item labels. They could also be changed as explained in the tip below.
+ <emphasis>More shortcuts:</emphasis> Look for the shortcut keys displayed on the right side
+ of menu item labels. Shortcuts can also be changed as explained in the tip below.
</para>
</listitem>
</itemizedlist>
<tip>
<title>Customize shortcuts</title>
<para>
- You can change the default shortcuts by using <menuchoice><guisubmenu>Edit</guisubmenu>
+ You can change the default shortcuts by choosing <menuchoice><guisubmenu>Edit</guisubmenu>
<guimenuitem>Preferences</guimenuitem></menuchoice> and selecting the <interface>
Shortcuts</interface> tab.
</para>
@@ -90,7 +86,7 @@
<sect1 id="main-win">
<title>Main Window</title>
<para>
- In the main window, there are several views which can be reordered by
+ The main window contains several view windows which can be rearranged by
dragging on their title bars. They can also be minimized by clicking on the
minimize buttons on the left of title bars.
</para>
@@ -101,8 +97,8 @@
<para>
The <interface>Documents window</interface>
will have one document active at a time (if there are any files opened). All
- of the file commands will apply to this active document. You can switch to
- any page by clicking on the page tab. You can do the same by right-clicking
+ file commands will apply to this active document. You can switch to
+ any document by clicking on its tab. You can do the same by right-clicking
on the page tabs and choosing the document from the pop-up menu that will
appear. This is especially useful when you have a lot of files opened, but not
all of them are visible in the page tab area.
@@ -110,7 +106,7 @@
</listitem>
<listitem>
<para>
- The <interface>Project window</interface> shows a tree of the project files if
+ The <interface>Project window</interface> shows a tree of project files if
you have a project opened. Otherwise, the <interface>Project window</interface>
is usually hidden. Double-clicking on any item in the
<interface>Project window</interface> will open that file.
@@ -119,16 +115,16 @@
<listitem>
<para>
The <interface>Files window</interface> shows a file tree. If no project is open, the file
- tree usually points to the file system root but you can change it in the preferences. If a project is
- open it shows all files inside the project. Double clicking opens a file in the appropriate application
- as configured in the gnome mime preferences. Right click opens a popup-menu which gives you
- choices how to open the file.
+ tree usually points to the file system root but you can change this in the preferences. If a project is
+ open, the window shows all files in the project. Double-clicking opens a file in the appropriate application
+ as configured in the GNOME MIME preferences. Right-clicking opens a context menu which gives you
+ choices about how to open the file.
</para>
</listitem>
<listitem>
<para>
- The <interface>Symbols window</interface> shows shows a tree of available symbols in the project
- generated from ctags parser. Double clicking opens an editor window with the corresponding file
+ The <interface>Symbols window</interface> shows a tree of available symbols in the project
+ generated from the <application>ctags</application> parser. Double-clicking opens an editor window with the corresponding file
and line.
</para>
<para>
@@ -147,14 +143,14 @@
</para>
<para>
The colors used to display the messages are important. Messages
- displayed in the standard foreground color (usually Black) are normal
- messages. Those displayed in Blue are important messages such as errors or
- other information. Messages shown in Red are <emphasis>Hot Linked</emphasis>.
- Double-clicking on such a message will take you to the particular file and
+ displayed in the standard foreground color (usually black) are normal
+ messages. Messages displayed in orange are warnings, and those displayed in red are errors.
+ Warning and error messages are <emphasis>linked</emphasis>:
+ double-clicking on such a message will take you to the particular file and
line number specified in the message.
</para>
<para>
- For example, when you compile a file which contains bugs, some red
+ For example, when you compile a file which contains errors, some red
messages will appear showing what the problems are, and where they occur.
Double-clicking on such messages will open the file and highlight the
line containing the error.
@@ -162,8 +158,8 @@
</listitem>
<listitem>
<para>
- The <interface>Terminal window</interface> is a terminal emulation where you can type commands
- just like in the gnome-terminal.
+ The <interface>Terminal window</interface> is a terminal emulator where you can type commands
+ just like in the GNOME Terminal application.
</para>
</listitem>
</orderedlist>
@@ -171,7 +167,7 @@
<note>
<title>Session management</title>
<para>
- All of the settings, including the window sizes and window positions, are
+ All settings, including window sizes and positions, are
saved when you exit <application>Anjuta</application>. Session management is still
under development, so you should not exit <application>Anjuta</application> with
any unsaved documents. <application>Anjuta</application> will display a warning
Modified: trunk/manuals/anjuta-manual/C/introduction.xml
==============================================================================
--- trunk/manuals/anjuta-manual/C/introduction.xml (original)
+++ trunk/manuals/anjuta-manual/C/introduction.xml Tue Dec 23 09:39:25 2008
@@ -4,24 +4,26 @@
<para>
<application>Anjuta</application> is a versatile Integrated Development
Environment (IDE) for the GNOME desktop. It features a number of advanced
- programming facilities that include project management, application
- wizards, an on-board interactive debugger, an integrated glade UI designer,
- integrated devhelp API help, an integrated valgrind memory profiler,
+ programming facilities includes project management, application
+ wizards, an interactive debugger, an integrated Glade UI designer,
+ integrated Devhelp API help, an integrated Valgrind memory profiler,
an integrated gprof performance profiler, a class generator, a powerful
- source editor, source browsing, and more. is a versatile Integrated
- Development Environment
+ source editor, source browsing, and more.
</para>
<para>
Anjuta DevStudio has been designed to be simple to operate yet powerful enough
- to fulfill all your programming needs. Many features have evolved since the
- early days and several very attractive ones added. Our focus is on delivering
- power and usability at the same time without overloading your senses and
- making your software development a pleasurable process. We will always be
- busy getting you one of the best IDE experiences by straighting up all
- the neat features and stabilizing it. We hope you will have a good time
+ to fulfill all your programming needs. We've added many new features to Anjuta
+ over the course of its development. Our focus is on delivering
+ power and usability at the same time and
+ making your software development enjoyable without overloading your senses. We intend to
+ continue improving and stabilizing Anjuta to give you the best IDE experience possible.
+ We hope you will have a good time
using Anjuta. If not, please help us make it better by reporting bugs and
- suggestions. Here are some of the things you will find in Anjuta.
+ suggestions.
+ </para>
+ <para>
+ The following screenshot illustrates some of the things you will find in Anjuta.
</para>
<para>
@@ -35,18 +37,18 @@
</para>
<para>
- Anjuta has a very flexible and advanced docking system that allows you to
- layout all views in whatever way you like. You can drag and drop the views
- using drag bars and re-arrange the layout. The layouts are persistent for
- each project so you can maintain different layouts required by projects.
- All dock views are minimizable to avoid clutter in main window. Minimized
- views appear as icons on left side of main window. All menu actions are
- configurable either by type-in-the-menu (the usual GNOME way) or by
- a dedicated shortcuts configuration UI.
+ Anjuta has a flexible and advanced docking system that allows you to
+ lay out all views in whatever way you like. You can drag and drop the views
+ using drag bars and rearrange the layout. The layouts are persistent for
+ each project so you can maintain different layouts for different projects.
+ All dock views are minimizable to avoid clutter in the main window. Minimized
+ views appear as icons on the left side of the main window. You can configure all menu actions
+ either by typing when the cursor is over a menu item (the usual GNOME way) or through
+ a dedicated shortcut configuration user interface.
</para>
<para>
Please report any problems with <application>Anjuta</application> - this will help to
- improve the software, as well as helping the Open Source community.
+ improve the software, as well as helping the open source community.
</para>
</chapter>
Modified: trunk/manuals/anjuta-manual/C/preferences.xml
==============================================================================
--- trunk/manuals/anjuta-manual/C/preferences.xml (original)
+++ trunk/manuals/anjuta-manual/C/preferences.xml Tue Dec 23 09:39:25 2008
@@ -2,25 +2,22 @@
<chapter id="preferences">
<title>Preferences</title>
<para>
- Preferences are ways to customize <application>anjuta</application> to suit
- your tastes. Activate <menuchoice><guimenu>Settings</guimenu><guimenuitem>Preferences</guimenuitem>
- </menuchoice> to bring up the preferences dialog. If you want to reset the preferences to their
- default values, it can be done from <menuchoice><guimenu>Settings</guimenu><guimenuitem>
- Set Default Preferences</guimenuitem></menuchoice>. Some are explained below.
+ Preferences are ways to customize <application>Anjuta</application> to suit
+ your tastes. Activate <menuchoice><guimenu>Edit</guimenu><guimenuitem>Preferences</guimenuitem>
+ </menuchoice> to bring up the preferences dialog. Some preferences are explained below.
</para>
<sect1 id="prefs-general"><title>General</title>
<orderedlist>
<listitem><para>
<emphasis>Project Directory</emphasis> is the path where you plan to put all your projects.
- Application wizard creates new projects in this directory only. The default project directory
- is ~/Projects and generally, this is just fine for most people. Also, when Open project is
- activated, this is the base directory where the file selection will start.
+ The application wizard creates new projects in this directory only. The default project directory
+ is ~/Projects and generally this is fine for most people.
</para>
</listitem>
<listitem><para>
- <emphasis>User Info:</emphasis> Provide your correct Name and Email address here. They are not
- used to do software registration (pun), rather they are used to create ChangeLog entries and other
- insert text bits.</para>
+ <emphasis>User Info:</emphasis> Provide your name and email address here. These are not
+ used to do software registration; rather, they are used to create ChangeLog entries and other
+ text insertions.</para>
</listitem>
</orderedlist>
</sect1>
@@ -28,12 +25,12 @@
<orderedlist>
<listitem><para>
<emphasis>Root directory if no project is open</emphasis> is the path where
- the root of the file manager points to if no project is currently open.
+ the root of the file manager points if no project is currently open.
</para>
</listitem>
<listitem><para>
- <emphasis>File Filter:</emphasis> It is possible to filter out some file from the file tree, for example
- hidden files or files that are ignored by the version control system which usually means they are
+ <emphasis>File Filter:</emphasis> You can filter out some files from the file tree, for example,
+ hidden files, or files that are ignored by the version control system which usually means they are
generated at build time and should not be changed.
</para>
</listitem>
Modified: trunk/manuals/anjuta-manual/C/projects.xml
==============================================================================
--- trunk/manuals/anjuta-manual/C/projects.xml (original)
+++ trunk/manuals/anjuta-manual/C/projects.xml Tue Dec 23 09:39:25 2008
@@ -4,20 +4,20 @@
<para>
Anjuta has a powerful Project Manager plugin which can open most
- <ulink type="info" url="info:automake">automake/autoconf</ulink> based projects.
+ <ulink type="info" url="info:automake">automake/autoconf</ulink>-based projects.
It might fail on some
- oddly configured projects, but as long as the project is done by using
+ oddly-configured projects, but as long as the project uses
automake/autoconf in a typical way, it should work.
</para>
<para>
- The neat thing is that it does not store any project information beyond what
- is already available in project structure. That is, there is no separate
- project data maintained by Anjuta and all project processing are done
- directly within the project structure. This allows the project to be
- maintained or developed outside Anjuta without having to so-called
- 'porting' or 'switching' to a new platform. Since technically Anjuta
- projects are just automake projects, mixed development of it (Anjuta and
+ The neat thing is that Anjuta does not store any project information beyond what
+ is already available in the project structure. That is, there is no separate
+ project data maintained by Anjuta and all project processing is done
+ directly within the project structure. This allows a project to be
+ maintained or developed outside Anjuta without any need to convert to or from
+ an Anjuta-specific format. Since technically Anjuta
+ projects are just automake projects, mixed development (with both Anjuta and
non-Anjuta users) or switching back and forth between Anjuta and other
tools is quite possible without any hindrance.
</para>
@@ -25,40 +25,40 @@
<sect1 id="new-project">
<title>Creating a New Project</title>
<sect2 id="new-project-from-template">
- <title>New project from template</title>
+ <title>Creating a project from a template</title>
<para>
The project wizard plugin uses a powerful template processing engine
called <application>autogen</application>. All new projects are created from
templates that
- are written in <application>autogen</application> syntax. Project wizard
+ are written in <application>autogen</application> syntax. The project wizard
lets you create new
projects from a selection of project templates. The selection includes
- simple generic, flat (no subdirectory), gtk+, gnome, java, python
+ simple generic, flat (no subdirectory), GTK+, GNOME, Java, Python
projects and more. New templates can be easily downloaded and
- installed since they are just a collection of text files.
+ installed since each template is just a collection of text files.
</para>
<para>
- Choose the menu item <menuchoice><guisubmenu>File</guisubmenu><guisubmenu>New</guisubmenu>
+ To create a project, choose the menu item <menuchoice><guisubmenu>File</guisubmenu><guisubmenu>New</guisubmenu>
<guimenuitem>Project …</guimenuitem></menuchoice>
to start the application wizard.
- Read the <interface>first page</interface> carefully. Click on
+ Read the first page carefully. Click on
<guibutton>Next</guibutton> to proceed.
</para>
<para>
Select the type of application you want to create in the
- <interface>second page</interface>.
+ second page.
Click on <guibutton>Next</guibutton> to proceed.
</para>
<para>
- On the next pages, enter all necessary
- details for your project. You can change these settings later also, but
- it is advisable to put them right in first run to maintain the project's
+ On the following pages, enter all necessary
+ details for your project. You can change these settings later, but
+ it is advisable to set them right initially in order to maintain the project's
integrity.
White spaces or any non-alphanumeric characters, except
underscore (_) and dash (-), are not allowed in many of the entry boxes
- that would follow (except perhaps the
+ that follow (except perhaps the
<guilabel>Author</guilabel> text box).
</para>
@@ -68,14 +68,14 @@
using <application>gettext</application> (read the
<ulink type="info" url="info:gettext">gettext info page</ulink> for
more details). This gives your project multilingual support for
- different regional languages such as English, French, Dutch etc..
+ different languages such as English, French and Dutch.
The rest of the options are for setting whether the GNU copyright
- statement should appear in the comments at the top of each file, and
+ statement should appear in the comments at the top of each file, and for
enabling GNOME desktop menu information if necessary. Shared library
- support allows adding shared library modules later in the project. If
- you plan to have libraries in your project, it would be good to enable.
- Depending on the project type that is being created, there would be
- other information requested.
+ support allows you to add shared library modules later on. If
+ you plan to have libraries in your project, it would be good to enable this.
+ Depending on the project type that is being created, Anjuta may request
+ additional information.
</para>
<para>
@@ -84,26 +84,26 @@
</para>
<para>
- Once project generation is over, you can try it out by
- building the project and executing it.
+ Once the project has been generated, you can try it out by
+ building it and executing it.
</para>
</sect2>
<sect2 id="importing-project">
<title>Importing Projects</title>
<para>
- The import project feature is used to import an already existing project and convert it into
- <application>anjuta</application> project. Activate the import project wizard from
+ The import project feature is used to import an already existing project and convert it into an
+ <application>Anjuta</application> project. Activate the import project wizard via
<menuchoice><guimenu>File</guimenu><guimenu>New</guimenu>
<guimenuitem>Project from existing sources</guimenuitem></menuchoice>
- and follow instructions dictated by the wizard. Once the project is imported, it could be
- opened in <application>anjuta</application> subsequently just like any other <application>
- anjuta</application> project.
+ and follow the instructions dictated by the wizard. Once a project has been imported, it can be
+ opened in <application>Anjuta</application> subsequently just like any other <application>
+ Anjuta</application> project.
</para>
<note>
<para>
- The import project features only works if your existing project is
- using <ulink type="info" url="info:automake">autoconf/automake</ulink> and,
- to a very limited extend, plain makefiles.
+ The import project feature only works if your existing project uses
+ <ulink type="info" url="info:automake">autoconf/automake</ulink> or,
+ to a very limited extent, a plain Makefile.
</para>
</note>
</sect2>
@@ -123,21 +123,20 @@
<para>
If the project has recently been opened, then you will find it listed in the
menu <menuchoice><guisubmenu>File</guisubmenu><guisubmenu>Recent</guisubmenu></menuchoice>.
- Choose the project file from the list, and the project will be opened.
+ Choose the project filename from the list, and the project will be opened.
</para>
<para>
As soon as a project is opened, <application>Anjuta</application> will enter
<emphasis>Project mode</emphasis>. There are three panes in the project window. The
- first is the project pane and lists the project files organized in file types. The second
- is the symbol browser, which has already been discussed in section <emphasis>Symbol
- Browser and tags Browser</emphasis>. The third pane is the file view of the project and
- is more or less similar to a mini file-manager. In file view, all the files present
- in the project tree is visible. Right clicking on these files will pop up the file
- <guimenu>Operation menu</guimenu>.
+ first is the project pane and lists project files organized by file type. The second
+ is the symbol browser, which has already been discussed in the section <emphasis>The Symbol Browser</emphasis>. The third pane is the file view of the project and
+ is more or less similar to a mini file-manager. In the file view, all the files present
+ in the project tree are visible. Right-clicking on these files will pop up a
+ context menu with file operations.
</para>
<para>
If the project is also a CVS tree, then corresponding file revision numbers are also
- listing on the right of file names in the file view pane.
+ listed to the right of file names in the file view pane.
</para>
</sect2>
<sect2 id="saving-project">
@@ -152,8 +151,8 @@
<sect1 id="projects-structure">
<title>Project structure</title>
<para>
- Here is the <interface>Project window</interface> with the
- the <guimenu>Operation menu</guimenu>
+ Here is the <interface>Project window</interface> with its
+ context menu
(accessible by clicking on the right mouse button).
<figure id="project-window">
<title>Project window</title>
@@ -164,19 +163,19 @@
</figure>
</para>
<para>
- <interface>Project window</interface> lists the project in standard
+ The <interface>Project window</interface> displays the project's
<ulink type="info" url="info:automake"><application>automake</application></ulink>
hierarchy organized
- into groups of targets. <emphasis>Groups</emphasis> correspond to
- directories in your project and <emphasis>targets</emphasis>
+ into <emphasis>groups</emphasis> of <emphasis>targets</emphasis>. Groups correspond to
+ directories in your project and targets
correspond to normal <application>automake</application> targets (not to be confused
- with make targets). <interface>Project window</interface> actually
- has two parts; one part
- (lower one) shows complete project hierarchy and the other part (upper one)
- lists important targets directly. Important targets constitute executable
- and library targets -- making them very accessible in from the view.
- This is particularly useful in big projects where the hierarchy
- could be deep and hard to navigate from the tree alone. Targets are, in
+ with make targets). The <interface>Project window</interface> actually
+ has two parts: the lower part
+ shows the complete project hierarchy and the upper part
+ lists important targets directly. Important targets include executable
+ and library targets; the view makes these easily accessible.
+ This is particularly useful in large projects where the hierarchy
+ can be deep and hard to navigate from the tree alone. Targets are, in
turn, composed of source files.
</para>
@@ -185,59 +184,59 @@
<listitem>
<para>
<emphasis>Groups</emphasis> are used to logically organize targets.
- A project can contain any number of groups. Each group can have sub-groups
- as well as targets. In automake projects, groups are just sub-directories
- in the project. The top level group is called root and is always "/".
+ A project can contain any number of groups. Each group can have subgroups
+ as well as targets. In automake projects, groups are just subdirectories
+ in the project. The top-level group is always labeled "/".
</para>
</listitem>
<listitem>
<para>
- <emphasis>Targets</emphasis> are the build targets in project, such as
- programs (executable binaries), scripts, libraries, miscellaneous data
- etc. Not all target types are built from sources, but exist just to
- organize the sources and therefore may not exist physically (e.g.
- Miscellaneous data target).
+ <emphasis>Targets</emphasis> are the build targets in the project, such as
+ programs (executable binaries), scripts, libraries and miscellaneous data.
+ Not all target types are built from sources; some exist just to
+ organize sources and therefore may not exist physically (e.g. a
+ Miscellaneous Data target).
Targets exist under groups. See <link linkend="adding-target">"Adding targets"</link> for
- full list of available target types.
+ a full list of available target types.
</para>
</listitem>
<listitem>
<para>
- <emphasis>Source files</emphasis> are the files used to build the targets
- or just to be part of it. They exist only under targets. Many target types
- expect certain type of source files (e.g. programs and libraries target
- types), but some can accept any file (e.g. Miscellaneous data target).
+ <emphasis>Source files</emphasis> may be used to build targets, though some source files
+ simply belong to targets. They exist only under targets. Many target types
+ expect certain type of source files (e.g. the Programs and Libraries target
+ types), but some can accept any file (e.g. a Miscellaneous Data target).
</para>
</listitem>
</itemizedlist>
</para>
<para>
- Each of the project groups and targets is configurable in standard
- <application>automake</application> way. You can set complier and linker
- flags directly for each target, or set configure variables. Groups allow
- setting installation destinations for its targets.
+ Each project group and target is configurable in the standard
+ <application>automake</application> way. You can set compiler and linker
+ flags directly for each target, or set <application>configure</application> variables. Groups allow
+ you to set an installation destination for their targets.
</para>
<para>
- Just like file manager, project manager view also has convenience actions
- (accessible from the <guimenu>Operation menu</guimenu>) for the source
+ Just like the file manager, the project manager view also has convenience actions
+ (accessible from the context menu) for source
files and targets.
</para>
<para>
Many command-line tools are available to maintain and manage a project,
and each tool has its own specific rules and capabilities.
- <application>Anjuta</application> tries to automate most of the common
+ <application>Anjuta</application> tries to automate most common
operations using plugins. However, you might occasionally still need
- to do them manually.
+ to perform certain operations manually.
</para>
<para>
- It is possible to make use of other tools or hand edit the project
- files simultaneously. It doesn't matter if the project is loaded in
+ You may modify a project's structure using external tools or by hand-editing the project
+ files. It doesn't matter whether the project is loaded in
<application>Anjuta</application> or not. <application>Anjuta</application>
- would update itself with any external changes made to project.
+ will update itself with any external changes made to a project.
</para>
</sect1>
@@ -247,31 +246,32 @@
<sect2 id="adding-groups">
<title>Adding Groups</title>
<para>
- To add a new group (a directory in automake based projects):
+ To add a new group (which is a directory in automake-based projects):
<itemizedlist>
<listitem>
<para>
Select <menuchoice><guisubmenu>Project</guisubmenu>
<guimenuitem>Add Group</guimenuitem></menuchoice> and a dialog to
- add a new group would popup.
+ add a new group will pop up.
</para>
</listitem>
<listitem>
- <para>Select the group under which to add new group.</para>
+ <para>Select the group under which to add the new group.</para>
</listitem>
<listitem>
- <para>Give a name of the new group and click Ok.</para>
+ <para>Enter the name of the new group and click <guibutton>Add</guibutton>.</para>
</listitem>
</itemizedlist>
+ </para>
+ <para>
With automake projects,
- a new directory with the given name would be created under the parent
+ a new directory with the given name will be created under the parent
group's directory.
</para>
<para>
- New group can also be added from the <guimenu>Operation menu</guimenu>
- in <interface>Project window</interface> by
- selecting <guimenuitem>Add Group</guimenuitem>. First select the group
- under which to add the group in <interface>Project window</interface>.
+ You can also add a new group from the <interface>Project</interface> window directly. Right-click the group
+ under which to add the new group, then choose
+ <guimenuitem>Add Group</guimenuitem> from the context menu.
</para>
</sect2>
@@ -281,16 +281,18 @@
To remove a group:
<itemizedlist>
<listitem>
- <para>Select the target in <interface>Project Manager view</interface>.</para>
+ <para>Right-click the group in the <interface>Project Manager</interface> view.</para>
</listitem>
<listitem>
<para>Select <guimenuitem>Remove</guimenuitem> from the
- <guimenu>Operation menu</guimenu>.</para>
+ context menu.</para>
</listitem>
</itemizedlist>
+ </para>
+ <para>
The target and sources associated
- with the group will also be removed from the project (they are not
- deleted from the file system, though. You can still add them later).
+ with the group will also be removed from the project. (They are not
+ deleted from the file system, though. You can add them to the project again later if you like.)
</para>
</sect2>
@@ -302,7 +304,7 @@
<listitem>
<para>Select <menuchoice><guisubmenu>Project</guisubmenu>
<guimenuitem>Add Target</guimenuitem></menuchoice> and a dialog to
- add a new target would popup.</para>
+ add a new target will popup.</para>
</listitem>
<listitem>
<para>Select the group under which to add the target.</para>
@@ -311,104 +313,102 @@
<para>Select the target type.</para>
</listitem>
<listitem>
- <para>Give a name of the new target and click Ok.</para>
+ <para>Enter a name for the new target and click <guibutton>Add</guibutton>.</para>
</listitem>
</itemizedlist>
</para>
<para>
- New target can also be added from the <guimenu>Operation menu</guimenu>
- in <interface>Project window</interface> by
- selecting <guimenuitem>Add target</guimenuitem>. First select the group
- under which to add the target in <interface>Project window</interface>.
+ You can also add a new target from the <interface>Project</interface> window directly.
+ Right-click the group
+ under which to add the target, then select
+ <guimenuitem>Add target</guimenuitem> from the context menu.
</para>
<para>
Target names usually require some standard prefix and suffix, depending
- on the type of target. Anjuta would warn if the name is not valid and
- may give an example of a name.
+ on the type of target. Anjuta will warn you if a name is not valid and
+ may provide an example of a valid name.
</para>
<para>
- There are several target types for automake project. They are:
+ There are several target types for automake projects. They are:
<itemizedlist>
<listitem>
<para>
- <emphasis>Program</emphasis> target type is for executable binaries. Select
- this if you want to add an executable to the project. By default, all program
- targets would be installed in standard executable directory, e.g.
- /usr/bin or /usr/local/bin. You can override it by specifying a different
- installation directory in its group properties.
+ The <emphasis>Program</emphasis> target type is for executable binaries. Select
+ this type if you want to add an executable to the project. By default, all program
+ targets will be installed in the standard executable directory, e.g.
+ /usr/bin or /usr/local/bin. You can override this by specifying a different
+ installation directory in the properties of the group containing the target.
</para>
</listitem>
<listitem>
<para>
- <emphasis>Shared Library</emphasis> target type is for shared or dynamic libraries.
- Select this if you are adding a shared library to the project. By default, all
- shared libraries are installed in standard libraries directory, e.g.
- /usr/lib or /usr/local/lib. You can override it by specifying a different
- installation directory in its group properties.
+ The <emphasis>Shared Library</emphasis> target type is for shared or dynamic libraries.
+ Select this type if you are adding a shared library to the project. By default, all
+ shared libraries are installed in the standard libraries directory, e.g.
+ /usr/lib or /usr/local/lib. You can override this by specifying a different
+ installation directory in the properties of the group containing the target.
</para>
</listitem>
<listitem>
<para>
- <emphasis>Static Library</emphasis> target type is for static library.
- Select this if you are adding a static library to the project. By default,
- all static libraries are installed in standard libraries directory, e.g.
- /usr/lib or /usr/local/lib. You can override it by specifying a different
- installation directory in its group properties.
+ The <emphasis>Static Library</emphasis> target type is for static libraries.
+ Select this type if you are adding a static library to the project. By default,
+ all static libraries are installed in the standard libraries directory, e.g.
+ /usr/lib or /usr/local/lib. You can override this by specifying a different
+ installation directory in the properties of the group containing the target.
</para>
</listitem>
<listitem>
<para>
- <emphasis>Java module</emphasis> target type is for java module. Select
- this if you are grouping java sources into a module. You need to provide
+ The <emphasis>Java Module</emphasis> target type is for Java modules. Select
+ this type if you are grouping Java sources into a module. You need to provide
an installation directory for this target where the .class files will
- be installed. It can be set in group properties of the group where this
- target belongs.
+ be installed. It can be set in the properties of the group containing the target.
</para>
<note>
<para>
- There can really be only one java module in a group. This is a
- restriction put by automake. Please read automake info page for more
+ There can really be only one Java module in a group. This is a
+ restriction made by automake. Please read the automake info page for more
details.
</para>
</note>
</listitem>
<listitem>
<para>
- <emphasis>Python module</emphasis> target type is for python module. Select
- this if you are grouping python sources into a module. You need to provide
+ The <emphasis>Python Module</emphasis> target type is for Python modules. Select
+ this type if you are grouping Python sources into a module. You need to provide
an installation directory for this target where the sources will
- be installed. It can be set in group properties of the group where this
- target belongs.
+ be installed. It can be set in the properties of the group containing the target.
</para>
</listitem>
<listitem>
<para>
- <emphasis>Scripts</emphasis> target is to group scripts. They will be
- installed in standard executable directory.
+ The <emphasis>Scripts</emphasis> target type is for grouping scripts. They will be
+ installed in the standard executable directory.
</para>
</listitem>
<listitem>
<para>
- <emphasis>Miscellaneous Data</emphasis> target type is to group
- simple files in the project. An installation directory needs to be
- specified in its group properties.
+ The <emphasis>Miscellaneous Data</emphasis> target type is for grouping
+ simple files in a project. You must specify an installation directory
+ in the group properties.
</para>
</listitem>
<listitem>
<para>
- <emphasis>Header Files</emphasis> target type is to group C/C++
- header files that need to be installed in system (for example as part
- of library API). For header files that do not need to be installed,
- make them part of the Program target along with the sources. They will
- be installed in standard include directory unless installation path
- is specified in its group properties.
+ The <emphasis>Header Files</emphasis> target type is for grouping C/C++
+ header files that need to be installed on a system (for example as part
+ of a library API). (For header files that do not need to be installed,
+ make them part of the Program target along with the sources.) Header files will
+ be installed in the standard include directory unless an installation path
+ is specified in the group properties.
</para>
</listitem>
<listitem>
<para>
- <emphasis>Man documentation</emphasis> and <emphasis>Info documentation</emphasis>
+ The <emphasis>Man Documentation</emphasis> and <emphasis>Info Documentation</emphasis>
target types are for grouping man and info documentation respectively.
- By default, they will be installed in standard installation directories.
+ By default, documentation files will be installed in the standard installation directories.
</para>
</listitem>
</itemizedlist>
@@ -420,13 +420,15 @@
To remove a target:
<itemizedlist>
<listitem>
- <para>Select the target in <interface>Project Manager view</interface></para>
+ <para>Right-click the target in the <interface>Project Manager</interface> view.</para>
</listitem>
<listitem>
<para>Select <guimenuitem>Remove</guimenuitem> from the
- <guimenu>Operation menu</guimenu>.</para>
+ context menu.</para>
</listitem>
</itemizedlist>
+ </para>
+ <para>
The sources associated with the targets
will also be removed from the project (they are not deleted from the
file system, though).
@@ -439,40 +441,39 @@
<sect2 id="adding-sources">
<title>Adding Source Files</title>
<para>
- Select menu item <menuchoice><guisubmenu>Project</guisubmenu>
+ Select the menu item <menuchoice><guisubmenu>Project</guisubmenu>
<guimenuitem>Add Source File</guimenuitem></menuchoice>.
From the dialog, select the target to which the file should be added and
the file itself. You can add multiple files at once. To do that, select
- multiple files from the file selection dialog using either SHIFT or CONTROL
- key. Then click <guibutton>Add</guibutton> button to finally add the
- files in project.
+ multiple files from the file selection dialog using either the <keycap>Shift</keycap> or <keycap>Ctrl</keycap>
+ key. Then click <guibutton>Add</guibutton> to add the
+ files to the project.
</para>
<para>
- By default, current editor file would be preselected for addition in the
- dialog. Other convenient way to add a file is to select it in
- <interface>File Manager</interface> and choosing
+ By default, the current editor file will be preselected for addition in the
+ dialog. Another convenient way to add a file is to right-click it in the
+ <interface>File Manager</interface> and choose
<guimenuitem>Add to project</guimenuitem> from the
- <guimenu>Operation menu</guimenu>.
+ context menu.
</para>
<para>
If the file you choose has already been added to the project, then
<application>Anjuta</application> will not add it again.
- It will also give you a warning that the file is already added.
+ It will also give you a warning that the file has already been added.
</para>
<para>
If the file you choose is not in the project directory, you will be asked
to confirm that you wish to copy the file into the target's directory.
<application>Anjuta</application> cannot add files which are
- outside of target's directory.
+ outside of a target's directory without copying them in.
</para>
</sect2>
<sect2 id="removing-sources">
<title>Removing Source Files</title>
<para>
- To remove a file from the project, select the file you want to remove
- from the <interface>Project window</interface>, right-click to open the
- <guimenu>Operation menu</guimenu> and choose
- <guimenuitem>Remove</guimenuitem>.
+ To remove a file from the project, right-click the file you want to remove
+ in the <interface>Project window</interface> and
+ choose <guimenuitem>Remove</guimenuitem> from the context menu.
</para>
<para>
A confirmation dialog will appear, and the file will be removed from the
@@ -483,8 +484,8 @@
<para>
The file is not deleted from the filesystem. It still exists, and you can
add it back again later if you so wish. The file is only removed from the project
- listing, and will not take part in any of the project operations such as compiling,
- building, distribution etc..
+ listing, and will not take part in any project operations such as compiling,
+ building, or distribution.
</para>
</important>
</sect2>
@@ -494,42 +495,42 @@
<title>Project Configuration</title>
<para>
Project configuration involves setting the correct build flags for
- targets, groups and project itself. You can set these flags in their
- respective properties dialog.
+ targets, groups and the project itself. You can set these flags in their
+ respective properties dialogs.
</para>
<para>
You can freely use autoconf and automake variables that are automatically
set for the project during configuration. Apart from these automatically
- set variables, you can also defined your own variables in
- <link linkend="project-properties">Project Properties</link> use them in
+ set variables, you can also define your own variables in
+ <link linkend="project-properties">Project Properties</link> and use them in
properties. This will make it easy to update flags later, especially when
- the variable is used in several targets.
+ a variable is used in several targets.
</para>
<para>
Some of the many common variables are listed here. For full list of them
- see <ulink url="info:automake">automake info documentation</ulink>.
+ see the <ulink url="info:automake">automake info documentation</ulink>.
<itemizedlist>
<listitem>
<para>
<emphasis>$(prefix)</emphasis>: The installation prefix. The project
- is installed under various sub-directories under this prefix. By default
+ is installed under various subdirectories under this prefix. By default
it is /usr/local.
</para>
</listitem>
<listitem>
<para>
<emphasis>$(bindir)</emphasis>: The installation directory for
- executable binaries. All your executable and scripts targets would
+ executable binaries. All your executable and script targets will
be installed in this directory. By default, it is $(prefix)/bin.
</para>
</listitem>
<listitem>
<para>
<emphasis>$(libdir)</emphasis>: The installation directory for
- libraries. All your library targets (both shared and static) would
+ libraries. All your library targets (both shared and static) will
be installed in this directory or a subdirectory below it.
By default, it is $(prefix)/lib.
</para>
@@ -537,10 +538,10 @@
<listitem>
<para>
<emphasis>$(module_CFLAGS)</emphasis> and $(module_LIBS): These
- flags are set by configure for the packages that your project
+ flags are set by <application>configure</application> for the packages that your project
depends on. The packages used by the project are set in
<link linkend="project-properties">Project Properties</link>. 'module'
- is the packages group that you give in project properties.
+ is a package group that you specify in the project properties as described below.
</para>
</listitem>
</itemizedlist>
@@ -551,26 +552,26 @@
<sect2 id="project-properties">
<title>Project properties</title>
<para>
- Project properties dialog can be only brought by
+ The project properties dialog can be opened only by
choosing <menuchoice><guisubmenu>Project</guisubmenu>
- <guimenuitem>Properties</guimenuitem></menuchoice>. You can:
+ <guimenuitem>Properties</guimenuitem></menuchoice> from the toplevel menu bar. You can:
<itemizedlist>
<listitem>
<para>
- Set project name, version and URL in <guibutton>General</guibutton> page.
- Configure variables can also be use in these fields. The URL is the
+ Set the project name, version and URL in the <guibutton>General</guibutton> page.
+ <application>configure</application> variables can also be use in these fields. The URL is the
bug report URL for the project.
</para>
</listitem>
<listitem>
<para>
- Add and remove dependencies for your project in
+ Add and remove dependencies for your project in the
<guibutton>Packages</guibutton> page. See below for details.
</para>
</listitem>
<listitem>
<para>
- Create more configure variables in <guibutton>Variables</guibutton> page
+ Create more configure variables in the <guibutton>Variables</guibutton> page
to use in group and target properties.
</para>
</listitem>
@@ -578,7 +579,7 @@
</para>
<para>
Dependencies
- are external packages that the project uses and hence required
+ are external packages that the project uses and are hence required
to build it. Only packages installed using
<ulink url="info:pkg-config">pkg-config</ulink>
can be added from this interface. For others, the configure.ac file can
@@ -594,16 +595,16 @@
<para>
External package dependencies are grouped into <emphasis>modules</emphasis>,
so that their combined build flags can be conveniently added to different
- targets. <emphasis>Modules</emphasis> are just arbitrary names given to
- group the packages and can be named anything (only alphanumeric and _ are
- allowed in module name). Usually, they follow the name of
- targets they would be use in. Consequently, for small projects with single
+ targets. <emphasis>Modules</emphasis> are just arbitrary
+ groups of packages and can be named anything (only alphanumeric characters and _ are
+ allowed in module names). Usually, they follow the name of
+ targets they would be used in. Consequently, for small projects with single
targets, just one module to hold all dependencies is enough.
</para>
<para>
Each package exports a set of <emphasis>compiler flags</emphasis>
and <emphasis>libraries</emphasis>. They are aggregated together for
- all packages under a module and configure variables
+ all packages under a module, and <application>configure</application> variables
<emphasis>$(module_CFLAGS)</emphasis> and
<emphasis>$(module_LIBS)</emphasis> are defined. These variables can then
be used in <link linkend="group-properties">Group properties</link>
@@ -615,12 +616,12 @@
<listitem>
<para>
Select <menuchoice><guisubmenu>Project</guisubmenu>
- <guimenuitem>Properties</guimenuitem></menuchoice> to bring up project
+ <guimenuitem>Properties</guimenuitem></menuchoice> to bring up the project
properties dialog.
</para>
</listitem>
<listitem>
- <para>Select the tab <guibutton>Packages</guibutton> to bring up packages
+ <para>Select the tab <guibutton>Packages</guibutton> to bring up the Packages
page.</para>
</listitem>
<listitem>
@@ -628,13 +629,13 @@
Select the <emphasis>module</emphasis> to add the package to. If there
is no module created yet or there is no appropriate module, create one
by clicking <guibutton>Add module</guibutton>. Give a sensible name to the
- module, preferably in UPPERCASE to match with rest of configure variables
+ module, preferably in UPPERCASE to match other <application>configure</application> variables
(only use alphanumeric and '_' characters) and press <keycap>Enter</keycap>
to create it.
</para>
</listitem>
<listitem>
- <para>Click <guibutton>Add Package</guibutton> to bring up package selection dialog.</para>
+ <para>Click <guibutton>Add Package</guibutton> to bring up the package selection dialog.</para>
</listitem>
<listitem>
<para>Select the package to add and click <guibutton>Add</guibutton>.</para>
@@ -649,58 +650,57 @@
<sect2 id="group-properties">
<title>Group properties</title>
<para>
- To set group properties, select
- it in the <interface>Project window</interface> and active it. You can also
- bring it by selecting <menuchoice><guimenu>Operation menu</guimenu>
- <guimenuitem>Properties</guimenuitem></menuchoice>
+ To edit a group's properties, double-click the group in the
+ <interface>Project</interface> window to open the <interface>Group Properties</interface> dialog.
+ (You can alternatively right-click the group
+ and select <guimenuitem>Properties</guimenuitem> from the context menu.)
</para>
<para>
- <emphasis>Group Properties</emphasis> set to a group applies to all
- the targets under it. So any compiler or linker flags set there would
- be automatically be part of all the targets in it (in addition the
- targets individual properties). Following flags are available in group
- properties.
+ Properties set for a group apply to all
+ the targets under it. So any compiler or linker flags set for a group will
+ be automatically be part of all the targets in it (in addition to
+ each target's individual properties). The following fields are available in the Group
+ Properties dialog.
<itemizedlist>
<listitem>
<para>
<emphasis>Includes</emphasis>: Set your $(module_CFLAGS) variables
- and other include directories for your c and c++ targets.
+ and other include directories for your C and C++ targets here.
You need to provide the full include options of the compiler
- here, e.g. -I/usr/include/blah. The include paths will be use
- to find the include files in your source files. You can also
- add other sort of compiler flags here, but they are preferred
- to be set in their respective compiler flags properties
- (see below).
+ here, e.g. -I/usr/include/blah. The include paths will be used
+ to find header files included by your source files. (You can also
+ add other compiler flags here, but it's preferable
+ to set them in their respective <emphasis>compiler flags</emphasis> fields as described below.)
</para>
<para>
- Usually your configure script would also make some automatically
+ Usually your configure script will also make some automatically
determined compiler flags. The variables usually end with
_CFLAGS, e.g $(PACKAGE_CFLAGS). They are also set here.
- See setting
+ See
<link linkend="project-properties">Project properties</link>
for more details on these variables.
</para>
</listitem>
<listitem>
<para>
- <emphasis>Compiler settings</emphasis>: Set your compiler specific
+ <emphasis>Compiler flags</emphasis>: Set your compiler-specific
flags here. There are different fields for different compiler
categories. Flags that can be set here depend on the actual
- compiler used. The default compiler use for c/c++ is gcc/g++
- (gnu c compiler). Check out <ulink url="info:gcc">gcc info
+ compiler used. The default compiler used for C/C++ is gcc/g++
+ (the GNU C compiler). Check out the <ulink url="info:gcc">gcc info
documentation</ulink> for more details.
</para>
</listitem>
<listitem>
<para>
- <emphasis>Install directories</emphasis>: Targets in the group
- that require installation directories would each get a field
- to enter the installation directory. Set their installation
- directories as relative to one of the many automake
+ <emphasis>Install directories</emphasis>: The dialog will display
+ a field for each target in the group
+ that requires an installation directory. Set each installation
+ directory as relative to one of the many <application>automake</application>
directory variables, such as $(prefix), $(bindir), $(libdir),
- $(datadir) etc.
+ or $(datadir).
</para>
</listitem>
</itemizedlist>
@@ -711,34 +711,33 @@
<sect2 id="target-properties">
<title>Target properties</title>
<para>
- To set target properties, select
- it in the <interface>Project window</interface> and active it. You can also
- bring it by selecting <menuchoice><guimenu>Operation menu</guimenu>
- <guimenuitem>Properties</guimenuitem></menuchoice>
+ To set a target's properties, double-click the target
+ in the <interface>Project window</interface> to open the Target Properties dialog. (You can
+ alternatively right-click the target and select <guimenuitem>Properties</guimenuitem> from
+ the context menu.)
</para>
<para>
- <emphasis>Target Properties</emphasis> set to a target applies to that
- target. So any compiler or linker flags set there would
- be just part of it (in addition the its group properties).
- Following flags are available in target properties.
+ Any properties set for a target apply to that target only. A target also inherits
+ properties from its containing group.
+ The following fields are available in the Target Properties dialog.
<itemizedlist>
<listitem>
<para>
- <emphasis>Compiler settings</emphasis>: Set your compiler specific
+ <emphasis>Compiler settings</emphasis>: Set your compiler-specific
flags here. There are different fields for different compiler
categories. Flags that can be set here depend on the actual
- compiler used. The default compiler use for c/c++ is gcc/g++
- (gnu c compiler). Check out <ulink url="info:gcc">gcc info
+ compiler used. The default compiler used for C/C++ is gcc/g++
+ (the GNU C compiler). Check out the <ulink url="info:gcc">gcc info
documentation</ulink> for more details.
</para>
</listitem>
<listitem>
<para>
<emphasis>Linker flags</emphasis>: Set linker flags that should
- be used when linking the target. It applies only to Program
- and library targets. See <ulink url="info:ld">ld info documentation</ulink>
+ be used when linking the target. These flags apply only to Program
+ and Library targets. See the <ulink url="info:ld">ld info documentation</ulink>
for available linker options.
</para>
</listitem>
@@ -746,7 +745,7 @@
<para>
<emphasis>Libraries</emphasis>: Set the libraries that the
target depends on. Usually they are the $(module_LIBS)
- configure variables. See setting
+ configure variables. See
<link linkend="project-properties">Project properties</link>
for more details on these variables.
</para>
Modified: trunk/manuals/anjuta-manual/C/tools.xml
==============================================================================
--- trunk/manuals/anjuta-manual/C/tools.xml (original)
+++ trunk/manuals/anjuta-manual/C/tools.xml Tue Dec 23 09:39:25 2008
@@ -5,7 +5,7 @@
<sect1 id="tools-intro">
<title>Introduction</title>
<para>
- Often, you'll find the inbuilt functionality provided by Anjuta to be
+ You'll sometimes find the built-in functionality provided by Anjuta to be
insufficient. In these cases, you might be tempted to either add the
feature yourself to the Anjuta codebase or submit a feature request to
implement the feature. However, both approaches are likely to be slow
@@ -15,10 +15,10 @@
<para>
Anjuta provides a powerful framework for defining user-defined tools for
- extending it's functionality. Tools have access to almost all features of
+ extending its functionality. Tools have access to almost all features of
the IDE through the use of variables. You can add tools under any menu item,
specify input, output and error redirection within the GUI framework and
- supply command line parameters to the tool.
+ supply command-line parameters to the tool.
</para>
<note>
<para>
@@ -31,7 +31,7 @@
<title>Tools Examples</title>
<para>
This is a simple example how to use the tools plugin to integrate the GNOME ChangeLog
- generation script
+ generation script.
</para>
<figure id="tool-list">
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
