/usr/share/doc/subcommander/html/ch02s01.html is in subcommander-doc 2.0.0~b5p2-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>The Main Window</title><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="The Subcommander Guide"><link rel="up" href="ch02.html" title="Chapter 2. subcommander"><link rel="prev" href="ch02.html" title="Chapter 2. subcommander"><link rel="next" href="ch02s02.html" title="Projects & Bookmarks"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">The Main Window</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch02.html">Prev</a> </td><th width="60%" align="center">Chapter 2. subcommander</th><td width="20%" align="right"> <a accesskey="n" href="ch02s02.html">Next</a></td></tr></table><hr></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sc_MainWindow"></a>The Main Window</h2></div></div></div><p>The screen shot below (<a class="xref" href="ch02s01.html#sc_pic_MainWindowOverview" title="Figure 2.1. subcommander Main Window">Figure 2.1, “subcommander Main Window”</a>)
shows subcommanders main window. It has three major items. On the left is
the <span class="bold"><strong>Project Folder View</strong></span><a class="indexterm" name="idm135"></a>. It is a tree view that shows all configured projects as
top level items.</p><p>On the right is either a <span class="bold"><strong>Repository
View</strong></span><a class="indexterm" name="idm139"></a> or a <span class="bold"><strong>Working Copy
View</strong></span><a class="indexterm" name="idm142"></a>. Which one is displayed depends on the current selection in
the Project Folder View. The Repository View displays detailed information
about the items (files and folders) in the
<span class="emphasis"><em>repository</em></span>. The Working Copy View shows details about
the items in the <span class="emphasis"><em>working copy</em></span>.</p><p>Since the Working Copy View is the most used display we take a
closer look at it now and summarize the most important information that is
also hidden elsewhere in this documentation.</p><p>The working copy display depends on a few options which can be set
or unset in the tool bar (<a class="xref" href="ch02s01.html#sc_ToolBar" title="Tool Bar">the section called “Tool Bar”</a>). Most interesting
are <span class="bold"><strong>All</strong></span> and <span class="bold"><strong>Recursive</strong></span> (the third and fourth toolbar
button).</p><p>On first start All will be off and Recursive on. All on means
display all files and dirs. All off means display only the modified items
(with background colors indicating the type of modification). Recursive On
will show a flat view (a simple list) and Recursive off will show a tree
view.</p><p>The combination All off/Recursive on will show only the modified
items, recursive in a flat view. It will simply list any modified item at
any depth in the working copy tree. You will only see what is important.
Typically this is the list of items your are currently working on. If you
are familiar with the subversion command line client you will recognize
that it is the same information displayed by <code class="literal">svn
status</code>. It is subcommanders preferred view.</p><p>If you have a clean working copy it will only show the working copy
root, ie. the "." entry. Modify something and reload the view (rightmost
toolbar button) to see the item you have just modified.</p><p>The combination All on/Recursive off will show a tree view similar
to a file explorer. You have to open or enter a dir to view any changes in
that folder (enter by double click, go back by double click on the "."
item, this also works in the flat view).</p><p>Subcommander does not mark a folder in the tree view as modified if
anything below it is modified (like TortoiseSVN does with its overlay
icons).</p><p>The combination All off/Recursive off is similar to the previous
tree view display but will only list the modified files. It will show all
folders because without folders it would be impossible to navigate the
tree... :)</p><p>Back to the main window. At the bottom of the main window is the
<span class="bold"><strong>Log Output View</strong></span><a class="indexterm" name="idm160"></a>. Subcommander writes information about each command it runs
on a repository or a working copy to it.</p><div class="figure"><a name="sc_pic_MainWindowOverview"></a><p class="title"><b>Figure 2.1. subcommander Main Window</b></p><div class="figure-contents"><div class="mediaobject" align="center"><img src="images/Subcommander-MainWindow-Overview.png" align="middle" alt="subcommander Main Window"></div></div></div><br class="figure-break"><p>The three views are separated by splitter widgets. Special about
them is that clicking on the handle does hide one on of the split widgets.
Clicking the vertical splitter handle hides (or shows) the Project Folder
View. Clicking the horizontal handle hides (or shows) the Log Output
View.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm168"></a>Main Window Menus</h3></div></div></div><p>Subcommander has a couple of menus that contain all the commands
which you can use to handle your projects.</p><p>The <span class="bold"><strong>Project</strong></span> menu, the <span class="bold"><strong>ReposFolder</strong></span> menu and the <span class="bold"><strong>WcFolder</strong></span> menu list the commands you can run on
project items, repository items or working copy items in the Project
Folder View. The commands in each menu are only enabled if a
corresponding item is selected in the Project Folder View. Each menu is
also available as a context menu on a selected item.</p><p>The <span class="bold"><strong>Repos</strong></span> menu contains the
commands you can run on items in the Repository View and the <span class="bold"><strong>Wc</strong></span> menu contains the commands available in the
Working Copy View. Both menus are also available as context
menus.</p><p>If this guide is refering to a command in a specific menu you can
in most cases run the command also from the context menu of the selected
item.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm179"></a>Project Folder View</h3></div></div></div><a class="indexterm" name="idm181"></a><p>Opening a project in the Project Folder View will normally show a
couple of sub items. These sub items bookmark repository URLs or working
copy paths. Usually you will have bookmarks that represent the
<span class="emphasis"><em>trunk</em></span> folder, the <span class="emphasis"><em>branches</em></span>
folder, the <span class="emphasis"><em>tags</em></span> folder and bookmarks that link to
the <span class="emphasis"><em>working copies</em></span> of the project. The trunk,
branches and tags bookmarks are special bookmarks which tell
subcommander the layout of your project. You don't have to use them but
they are usefull for creating branches and tags. If you provide the
layout URLs you don't have to tell subcommander where to place a branch
or tag. You just have to give a name for the new branch or tag and
subcommander will create it in the configured branches or tags folder.
While you can have only one of each of the special bookmarks you can
have any number of repository and working copy bookmarks. Moving the
mouse pointer over a bookmark shows its repository URL or in case of a
working copy bookmark its local file system path in the status
bar.</p><div class="simplesect"><div class="titlepage"><div><div><h4 class="title"><a name="idm188"></a>Browsing the Repository</h4></div></div></div><a class="indexterm" name="idm190"></a><p>You can browse a repository by selecting the corresponding
bookmark. The right view will change to the Repository View displaying
the content of the selected bookmark. You can now browse the
repository in the same manner as you would browse a file system path
in a file manager. By double clicking a folder in the Repository View
you can navigate into that folder. By double clicking the "." (the
current folder) you will move back to its parent folder.</p><p>Using the ReposFolder menu you can run several commands on the
selected repository item. The different commands are described in
<a class="xref" href="ch02s03.html" title="The Commands">the section called “The Commands”</a>.</p></div><div class="simplesect"><div class="titlepage"><div><div><h4 class="title"><a name="idm196"></a>Viewing the Working Copy Status</h4></div></div></div><a class="indexterm" name="idm198"></a><p>Selecting a working copy bookmark of a project displays the
<span class="emphasis"><em>status</em></span> of the working copy. The right side of the
main window turns to the Working Copy View where it shows detailed
information about the modifications to your working copy (See also the
next section and <a class="xref" href="ch02s01.html#sc_WorkingCopyView" title="Working Copy View">the section called “Working Copy View”</a>). By double
clicking a folder you can navigate into that folder. By double
clicking the "." (the current folder) you will move back to its parent
folder. Disabling the recursive working copy option will display the
working copy in a tree view instead of a flat (recursive) view. When
you run subcommander for the first time, working copies will be
displayed in a <span class="emphasis"><em>flat</em></span> view which only displays
modified items, i.e. if your working copy doesn't have any
modifications you will only see a single "." entry wich represents the
working copy root.</p><p>The WcFolder menu contains the different commands (<a class="xref" href="ch02s01.html#sc_WorkingCopyView" title="Working Copy View">the section called “Working Copy View”</a>) you can run on the selected working
copy item(s).</p></div><div class="simplesect"><div class="titlepage"><div><div><h4 class="title"><a name="sc_ToolBar"></a>Tool Bar</h4></div></div></div><a class="indexterm" name="idm209"></a><p>The tool bar (<a class="xref" href="ch02s01.html#sc_pic_ToolBar" title="Figure 2.2. subcommander Tool Bar">Figure 2.2, “subcommander Tool Bar”</a>) contains
options which control the working copy status display in the Working
Copy View, general options that influence several commands and a
reload button to refresh the Working Copy View or the Repository View.
The toolbar is grouped in three blocks. The leftmost block control the
working copy status display (working copy options), the middle block
contains the general options which are used by most commands as the
preselcted value. The righmost block contains the reload button that
refreshes a repository view or working copy view by re-running the
list or status command.</p><p>By default subcommanders status display shows all items (files
and folders) with modifications in a <span class="emphasis"><em>flat</em></span> view.
It displays any modification of an item no matter at what level
(..below the selected folder) it is in the directory hierarchy of the
working copy. It does not display any unchanged item.</p><p>The flat view is enabled when (Wc Status) <span class="bold"><strong>
Recursive</strong></span> <a class="indexterm" name="idm217"></a> is enabled. If Recursive is disabled subcommander
displays only the modifications of the direct children of the selected
working copy item.</p><p>The (all Commands) <span class="bold"><strong>Recursive</strong></span>
option is used by most commands that work on a working copy. For
example adding a folder with recursive enabled does add the folder and
all its sub items. Without recursive it does only add the
folder.</p><div class="figure"><a name="sc_pic_ToolBar"></a><p class="title"><b>Figure 2.2. subcommander Tool Bar</b></p><div class="figure-contents"><div class="mediaobject" align="center"><img src="images/Subcommander-Toolbar.png" align="middle" alt="subcommander Tool Bar"></div></div></div><br class="figure-break"><p>Enabling <span class="bold"><strong>View All</strong></span> <a class="indexterm" name="idm229"></a>displays all items in a working copy. With or without
modifications. View All is most useful if (Wc Status) Recursive is
disabled. If both are enabled subcommander shows a flat view of all
items in your working copy. This can get very slow...</p><p>Enabling <span class="bold"><strong>View Ignored</strong></span><a class="indexterm" name="idm234"></a> lets you see the files or folders in the working copy
you have added to the <code class="literal">svn:ignore</code>
<span class="emphasis"><em>property</em></span> (see also <a class="xref" href="ch02s03.html#sc_sec_ignore" title="Add Items to the svn:ignore Property">the section called “Add Items to the svn:ignore Property”</a>).</p><p>With <span class="bold"><strong>View Updates</strong></span><a class="indexterm" name="idm242"></a> you can tell subcommander to show you the items in the
working copy that have a newer revision in the repository than the
latest revision you received from the repository by a checkout or by
an update of your working copy.</p><p>In normal usage the subversion library prevents you from running
certain operations (for example: moving a modified file). You can
<span class="bold"><strong>Force</strong></span><a class="indexterm" name="idm247"></a> the operation to run if you know what you are
doing.</p><p>Changing the state of one or more tool buttons doesn't
automatically update the view. You have to press <span class="bold"><strong>Reload</strong></span> <a class="indexterm" name="idm252"></a>to make subcommander use the new configuration in the
Project Folder and the Working Copy View.</p><div class="important" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Important</h3><p>The <span class="bold"><strong>Reload</strong></span> button is not
limited to changes of the configuration. You have to press Reload to
update the display of the current repository or working copy after
any command you issue from subcommander. That means after adding,
deleting, renaming or moving etc. you need to Reload to get an
up-to-date display. That is like running the
<code class="literal">status</code> command with the subversion command line
client in the shell after modifying your working copy.</p></div><div class="sidebar"><div class="titlepage"><div><div><p class="title"><b>Wc Status Recursive and View All</b></p></div></div></div><p>The note above about View All being most useful in combination
with not Recursive is most important for very large working copies.
If your working copy has hundreds of files and folders the flat
status display will be very slooow...</p><p>In most cases you will be interested only in the status for a
part of your working copy. By toggling Recursive (to not recursive)
and View All (to view all) you can quickly navigate to the place of
interest and switch back to the normal flat status display.</p><p>Another reason to toggle is to locate an item you want to
delete or move. If the item is unchanged it is not shown in the
normal (flat, no view all) status view. By toggling you can easily
navigate to the item, delete or move it and then turn back to normal
status view.</p></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm264"></a>Repository View</h3></div></div></div><a class="indexterm" name="idm266"></a><p>If you select a repository bookmark in the Project Folder View the
right side of the main window switches to the <span class="bold"><strong>Repository View</strong></span> (<a class="xref" href="ch02s01.html#sc_pic_RepositoryView" title="Figure 2.3. subcommander Repository View">Figure 2.3, “subcommander Repository View”</a>). It displays all items which are
children of the selected repository item.</p><div class="figure"><a name="sc_pic_RepositoryView"></a><p class="title"><b>Figure 2.3. subcommander Repository View</b></p><div class="figure-contents"><div class="mediaobject" align="center"><img src="images/Subcommander-Repository.png" align="middle" alt="subcommander Repository View"></div></div></div><br class="figure-break"><p>For each item it shows its name and some additional information.
This is the same information you receive if you run the
<code class="literal">list</code> command with subversions command line
client.</p><p>The <span class="bold"><strong>File Size</strong></span> column displays the
size of the file.</p><p>The columns <span class="bold"><strong>Revision of last
Commit</strong></span>, <span class="bold"><strong>Time of last Commit</strong></span>
and <span class="bold"><strong>Author of last Commit</strong></span> show
information about the last committed change to the item. The revision
the last change was committed, at what time it was committed and who was
the committee.</p><p>The <span class="bold"><strong>has Properties?</strong></span> Column tells
you if the item has properties (<a class="xref" href="ch02s03.html#sc_sec_Properties" title="Set, Edit and Delete Properties in a Working Copy">the section called “Set, Edit and Delete Properties in a Working Copy”</a>).</p><p>By opening the context menu or the <span class="bold"><strong>Repos</strong></span> top level menu you can select different
commands you can run on the currently selected item(s). The commands are
described in <a class="xref" href="ch02s03.html" title="The Commands">the section called “The Commands”</a>.</p><div class="sidebar"><div class="titlepage"><div><div><p class="title"><b>Column Configuration</b></p></div></div></div><p>If you prefer another column order you can move the columns
around by dragging a column header and dropping it on a new position.
Subcommander will save your configuration and restore the column order
when you run subcommander the next time.</p></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="sc_WorkingCopyView"></a>Working Copy View</h3></div></div></div><a class="indexterm" name="idm295"></a><p>Selecting the working copy item of a project turns the right side
of the main window to the <span class="bold"><strong>Working Copy
View</strong></span> (<a class="xref" href="ch02s01.html#sc_pic_WorkingCopyView" title="Figure 2.4. subcommander Working Copy View">Figure 2.4, “subcommander Working Copy View”</a>). It displays
the details about your working copy. That is the same information you
receive by running the <code class="literal">status</code> command with
subversions command line tool on your working copy.</p><div class="figure"><a name="sc_pic_WorkingCopyView"></a><p class="title"><b>Figure 2.4. subcommander Working Copy View</b></p><div class="figure-contents"><div class="mediaobject" align="center"><img src="images/Subcommander-WorkingCopy.png" align="middle" alt="subcommander Working Copy View"></div></div></div><br class="figure-break"><p>With the tool bar buttons you have a few options to modify what
subcommander displays in the Working Copy View. The tool bar buttons are
described in <a class="xref" href="ch02s01.html#sc_ToolBar" title="Tool Bar">the section called “Tool Bar”</a>.</p><p>To get a better and quicker overview of the current status,
subcommander uses different background colors to highlight certain file
states like <span class="emphasis"><em>added</em></span>, <span class="emphasis"><em>deleted</em></span> or
<span class="emphasis"><em>modified</em></span>. The states and their colors are listed in
<a class="xref" href="ch02s01.html#tab_WcColors" title="Table 2.1. Working Copy Colors">Table 2.1, “Working Copy Colors”</a>. If you prefer other colors you can
change them in the settings dialog.</p><p>The <span class="bold"><strong>Text</strong></span> column displays if an
item (file or folder) is changed. It uses the same codes as subversions
<code class="literal">status</code> command. For the more common codes
subcommander uses different background colors as described in the
previous paragraph.</p><p><span class="bold"><strong>Properties</strong></span> shows the status of
the items properties. This column also uses the
<code class="literal">status</code> codes.</p><p><span class="bold"><strong>WC Locked</strong></span> shows if a working copy
item is locked by another activity on the working copy. This has nothing
to do with locks on files to prevent concurrent editing.</p><p><span class="bold"><strong>Added with History</strong></span> shows a plus
sign if the item was added by copying it from another item in the
working copy.</p><p><span class="bold"><strong>Switched</strong></span> shows an S if the item
is switched relative to its parent folder.</p><p><span class="bold"><strong>Locked</strong></span> shows if a file is locked
to prevent concurrent editing. It uses the same codes as subversions
<code class="literal">status</code> command.</p><p><span class="bold"><strong>Update</strong></span> tells you if there is a
more recent version of an item in the repository than in your working
copy. You have to enable this feature in the tool bar (<a class="xref" href="ch02s01.html#sc_ToolBar" title="Tool Bar">the section called “Tool Bar”</a>). Note that this needs a connection to your
repository.</p><p>After the name of a working copy item in the Project Folders View
you can see its working copy <span class="bold"><strong>Revision</strong></span>.
This is the same information provided by running subversions
<code class="literal">svnversion</code> tool on the selected working copy
path.</p><p>By pressing <span class="keycap"><strong>SHIFT</strong></span> <span class="keycap"><strong>F1</strong></span> in the
Working Copy View you can see a more detailed description of the
columns, the colors and the displayed information.</p><div class="sidebar"><div class="titlepage"><div><div><p class="title"><b>Column Configuration</b></p></div></div></div><p>If you prefer another column order in the working copy view you
can move the columns around by dragging a column header and dropping
it on the new position. Subcommander will save your configuration and
restore the column order when you run subcommander the next
time.</p></div><div class="table"><a name="tab_WcColors"></a><p class="title"><b>Table 2.1. Working Copy Colors</b></p><div class="table-contents"><table class="table" summary="Working Copy Colors" border="1"><colgroup><col align="center"><col align="center"></colgroup><thead><tr><th align="center">State</th><th align="center">Background Color</th></tr></thead><tbody><tr><td align="center">unchanged</td><td align="center">white</td></tr><tr><td align="center">unknown (not under version control)</td><td align="center">light grey</td></tr><tr><td align="center">ignored</td><td align="center">grey</td></tr><tr><td align="center">added</td><td align="center">blue</td></tr><tr><td align="center">modified</td><td align="center">green</td></tr><tr><td align="center">deleted</td><td align="center">red</td></tr></tbody></table></div></div><br class="table-break"></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch02.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch02.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch02s02.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 2. subcommander </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Projects & Bookmarks</td></tr></table></div></body></html>
|