pull up r18864 from trunk
authorTom Yu <tlyu@mit.edu>
Tue, 28 Nov 2006 23:02:31 +0000 (23:02 +0000)
committerTom Yu <tlyu@mit.edu>
Tue, 28 Nov 2006 23:02:31 +0000 (23:02 +0000)
 r18864@cathode-dark-space:  jaltman | 2006-11-27 13:59:21 -0500
 ticket: new
 subject: documentation updates for KFW 3.1
 tags: pullup

   Documentation updates including new screen shots for KFW 3.1

ticket: 4921
version_fixed: 1.4.5

git-svn-id: svn://anonsvn.mit.edu/krb5/branches/krb5-1-4@18868 dc483132-0cff-0310-8789-dd5450dbe970

16 files changed:
src/windows/identity/doc/netidmgr.doc
src/windows/identity/doc/netidmgr.pdf
src/windows/identity/help/html/concept_identity.htm
src/windows/identity/help/html/images/screen_app_icon.bmp
src/windows/identity/help/html/images/screen_config_general.bmp [new file with mode: 0644]
src/windows/identity/help/html/images/screen_config_ident.bmp [new file with mode: 0644]
src/windows/identity/help/html/images/screen_config_idents.bmp [new file with mode: 0644]
src/windows/identity/help/html/images/screen_main_wnd.bmp
src/windows/identity/help/html/images/screen_menu_view_cols.bmp
src/windows/identity/help/html/images/screen_new_creds.bmp
src/windows/identity/help/html/images/screen_new_creds_exp.bmp
src/windows/identity/help/html/use_config.htm [new file with mode: 0644]
src/windows/identity/help/html/use_layout.htm
src/windows/identity/help/html/using.htm
src/windows/identity/help/html/wnd_main.htm
src/windows/identity/help/toc.hhc

index 8e9c1e0f8072eea0076e265846ed600a242e3ded..41a0cdad718330d157312e680c0cd6227a9000ef 100755 (executable)
Binary files a/src/windows/identity/doc/netidmgr.doc and b/src/windows/identity/doc/netidmgr.doc differ
index 8ec23bdef28118e61b297b3f6c051009dff73dd0..f28e57786ea209906112b9660355fb2bbeae63cc 100755 (executable)
Binary files a/src/windows/identity/doc/netidmgr.pdf and b/src/windows/identity/doc/netidmgr.pdf differ
index bb11746dd516a2a39e9bf9d311c6cd2db25091ad..ae2dda074acbbabafdc196b682ca353b6569d1e0 100644 (file)
@@ -20,10 +20,17 @@ considered to belong to that identity.
 <p>\r
 </p>\r
 \r
-\r
 <a name="default_identity" />\r
 <h3>Default Identity</h3>\r
 \r
+<p>The default identity is the identity that will be picked up by\r
+other applications as being the default.  For example, an application\r
+that uses Kerberos 5 can use the credentials found in the default\r
+Kerberos 5 credentials cache.  Therefore, the Kerberos 5 plug-in\r
+considers the principal that corresponds to the default credentials\r
+cache as being the default identity.\r
+</p>\r
+\r
 <p>\r
 </p>\r
 \r
index 78fd535644d994912150bf5c5d7f5f50b29e90f5..49e2fb026d3a2e9478e1665dd541d6d4cd0931e2 100644 (file)
Binary files a/src/windows/identity/help/html/images/screen_app_icon.bmp and b/src/windows/identity/help/html/images/screen_app_icon.bmp differ
diff --git a/src/windows/identity/help/html/images/screen_config_general.bmp b/src/windows/identity/help/html/images/screen_config_general.bmp
new file mode 100644 (file)
index 0000000..6c6e57e
Binary files /dev/null and b/src/windows/identity/help/html/images/screen_config_general.bmp differ
diff --git a/src/windows/identity/help/html/images/screen_config_ident.bmp b/src/windows/identity/help/html/images/screen_config_ident.bmp
new file mode 100644 (file)
index 0000000..2ac15fe
Binary files /dev/null and b/src/windows/identity/help/html/images/screen_config_ident.bmp differ
diff --git a/src/windows/identity/help/html/images/screen_config_idents.bmp b/src/windows/identity/help/html/images/screen_config_idents.bmp
new file mode 100644 (file)
index 0000000..8f55a05
Binary files /dev/null and b/src/windows/identity/help/html/images/screen_config_idents.bmp differ
index 77ab8befd1d99a2cfd67aede6c41fa4361cce65d..0763318d988ef5d4e12f48ab2822f6760fef00f5 100644 (file)
Binary files a/src/windows/identity/help/html/images/screen_main_wnd.bmp and b/src/windows/identity/help/html/images/screen_main_wnd.bmp differ
index 75775e2d5b597480681cb69c48ba61bf45a0f7da..25779bfcc7f6dc2b76f2f0de5358568cd822f443 100644 (file)
Binary files a/src/windows/identity/help/html/images/screen_menu_view_cols.bmp and b/src/windows/identity/help/html/images/screen_menu_view_cols.bmp differ
index 7d7335ab78e34b5596afd8b79eb9900f0b459ff0..bf5be3113ceaef3cc5220dc9bcd75799698e8c88 100755 (executable)
Binary files a/src/windows/identity/help/html/images/screen_new_creds.bmp and b/src/windows/identity/help/html/images/screen_new_creds.bmp differ
index b1711a70fbe1f47fd7c2173c77d142f1a60249bb..5caa6328e7bb73be31f03192295f907069c73ec3 100755 (executable)
Binary files a/src/windows/identity/help/html/images/screen_new_creds_exp.bmp and b/src/windows/identity/help/html/images/screen_new_creds_exp.bmp differ
diff --git a/src/windows/identity/help/html/use_config.htm b/src/windows/identity/help/html/use_config.htm
new file mode 100644 (file)
index 0000000..6d4cbeb
--- /dev/null
@@ -0,0 +1,132 @@
+<html>\r
+<head>\r
+  <title>Configuring NetIDMgr and identities</title>\r
+  <meta name="description" content="">\r
+  <meta name="keywords" content="configuration">\r
+  <link rel="stylesheet" type="text/css" href="nidmgr.css">\r
+</head>\r
+<body>\r
+\r
+<h1>Configuring NetIDMgr and identities</h1>\r
+\r
+<p>All NetIDMgr configuration options can be accessed via the <span\r
+class="pre">Options</span> menu.  The available configuration panels\r
+are:\r
+</p>\r
+\r
+<p>\r
+<ul>\r
+  <li><p><span class="title">General</span>: General application options\r
+  for NetIDMgr.</p>\r
+\r
+  <ul>\r
+\r
+    <li><p><span class="title">Obtain new credentials at\r
+    startup</span>: If checked, NetIDMgr will check there are initial\r
+    credentials for the default identity.  If no such credentials are\r
+    found, NetIDMgr will display a new credentials dialog.</p> </li>\r
+\r
+    <li><p><span class="title">Run NetIDMgr in system tray after\r
+    window close</span>: If checked, NetIDMgr will continue running in\r
+    the system notification area (sometimes referred to as the system\r
+    tray) after you close the NetIDMgr window.</p> </li>\r
+\r
+    <li><p><span class="title">Monitor network connectivity</span>: When\r
+    changes to network connectivity are detected, NetIDMgr can notify\r
+    individual plug-ins about these changes.  Doing so allows each\r
+    plug-in to respond to the change by obtaining new credentials etc.\r
+    If this option is cleared, no such notifications are sent and the\r
+    application would not respond to network changes.</p></li>\r
+\r
+    <li><p><span class="title">Log trace events</span>: NetIDMgr can\r
+    generate debugging information during the course of performing\r
+    certain actions.  This information aids the developers in fixing\r
+    problems that you may encounter while using NetIDMgr.</p> </li>\r
+\r
+  </ul>\r
+\r
+  </li>\r
+\r
+  <li><p><span class="title">Appearance</span>: Allows you to set the\r
+  font used by NetIDMgr.</p></li>\r
+\r
+  <li><p><span class="title">Identities</span>: Default settings for all\r
+  identities and settings for each identity.  Details <a\r
+  href="#cfg_idents">below</a>.</p></li>\r
+\r
+  <li><p><span class="title">Notifications</span>: Notification and timer\r
+  options.  NetIDMgr can issue warnings when credentials are about to\r
+  expire. This configuration panel allows you to set the thresholds at\r
+  which these warnings are issued.  For example, if the warning\r
+  timeout is set for 10 minutes, NetIDMgr will issue a warning 10\r
+  minutes before a credential expires.</p>\r
+\r
+  <p>The panel also allows you to control the credentials renew timer.\r
+  If the timer is disabled, NetIDMgr will not automatically attempt to\r
+  renew credentials.  If the <span class="pre">Renew at half life\r
+  intervals when possible</span> option is set, then the timer will\r
+  expire after the credential has less than half its lifetime left.\r
+  If the renewal operation fails, it will attempt another renwal after\r
+  half of the remaining liftime is over (i.e. when the credential has\r
+  less than 1/4 of its original lifetime left) and so on.\r
+  </p>\r
+\r
+  </li>\r
+\r
+  <li><p><span class="title">Plugins</span>: Enable/disable and check\r
+  the status of registered plug-ins.  Enabling or disabling a plug-in\r
+  only takes effect after a restart of NetIDMgr.</p></li>\r
+\r
+</ul>\r
+</p>\r
+\r
+<p><img src="images/screen_config_general.bmp" />\r
+</p>\r
+\r
+<a name="cfg_idents" />\r
+<h3>Configuration of default settings for all identities</h3>\r
+\r
+<p>The <span class="pre">Identities</span> configuration panel allows\r
+you to set the defaults that will be used for all identities.\r
+However, most of the settings displayed here can be overridden with\r
+specific per-identity settings.\r
+</p>\r
+\r
+<p>The panel will have a number of sub panels (or tabs) corresponding\r
+to each plug-in that maintains per-identity configuration.\r
+</p>\r
+\r
+<p>A list of identities for which configuration information is\r
+maintained will be shown under the main <span\r
+class="pre">Identities</span> configuration panel name.  Each of these\r
+correspond to a <a href="#cfg_ident">per identity</a> configuration\r
+panel.\r
+</p>\r
+\r
+<p>Note that adding or removing an identity in the configuration panel\r
+only has the effect of adding or removing the identity to or from the\r
+list of identities for which configuration information is maintained.\r
+</p>\r
+\r
+<p><img src="images/screen_config_idents.bmp" />\r
+</p>\r
+\r
+<a name="cfg_ident" />\r
+<h3>Per identity configuration</h3>\r
+\r
+<p>You can access the per-identity configuration panel for a specific\r
+identity by selecting the identity name from the list of configuration\r
+panels in the configuration dialog.\r
+</p>\r
+\r
+<p>These panels are similar to the <span class="pre">Identities</span>\r
+configuration panel, but they change per-identity settings.  Changes\r
+you make in these panels will override the defaults set in the <span\r
+class="pre">Identities</span> panel.\r
+</p>\r
+\r
+<p><img src="images/screen_config_ident.bmp" />\r
+</p>\r
+\r
+</body>\r
+</html>\r
index 2d87bc90c39e43baaeea87d0776b03300e651114..7a0d0705aece0cd9acdbdcb2ff3d6b0d6df2d4ce 100644 (file)
@@ -18,7 +18,7 @@ sorting the list of credentials can be customized. </p>
 customizations that can be performed:</p>\r
 \r
 <ul>\r
-  <li><a href="#predef">Predefined layouts</a><li>\r
+  <li><a href="#predef">Predefined layouts</a></li>\r
   <li><a href="#addcol">Adding and removing columns.</a></li>\r
   <li><a href="#sort">Sorting by a column.</a></li>\r
   <li><a href="#group">Grouping by a column.</a></li>\r
@@ -27,13 +27,13 @@ customizations that can be performed:</p>
 <a name="predef" />\r
 <h3>Predefined layouts</h3>\r
 \r
-<p>The predefined layouts in NetIDMgr are: </p>\r
+<p>The predefined layouts in NetIDMgr are:</p>\r
 \r
 <ul>\r
 \r
   <li><span class="title">By Identity</span>: Credentials grouped by\r
-  identity and credentials type, and finally sorted by credential\r
-  name.</li>\r
+  identity, credentials type and location, and finally sorted by\r
+  credential name.</li>\r
 \r
   <li><span class="title">By Type</span>: Credentials grouped by\r
   credentials type and then by identity.</li>\r
@@ -68,7 +68,7 @@ is shown below.</p>
 <p>Clicking on a column header will change the sort order of the\r
 column if it is already being used as a sort key.  If the colunm is\r
 not currently being used as a sort key, clicking on the column header\r
-will start sorting in increasing order by that column. </p>\r
+will start sorting in increasing order by that column.</p>\r
 \r
 <p>Double-clicking a column that is not used for grouping will stop\r
 sorting by that column.</p>\r
index c09558e9117ad45b542aff68fe86047cba86dc46..96c132c8e704a7860f4e6595dd1d1e02cdd7bbbd 100644 (file)
@@ -37,6 +37,7 @@ Brief overviews of how to perform common tasks are linked below:
   <li><a href="act_renew_creds.htm">Renew credentials</a></li>\r
   <li><a href="act_chpw.htm">Change password</a></li>\r
   <li><a href="use_layout.htm">Managing the credentials view layout</a></li>\r
+  <li><a href="use_config.htm">Configuring NetIDMgr and identities</a></li>\r
 </ul>\r
 \r
 <p>\r
index 575e7ba3f3f65fa010425eea07df8f254989e881..c4de155dbb7ffcd958bbd797eeef68c3e103f505 100644 (file)
 \r
 <p>The main window of Network Identity Manager is structured as follows</p>\r
 \r
-<map id="main_wnd_map">\r
-  <area shape = "rect" coords = "7,34,243,56" href = "menu_all.htm" />\r
-  <area shape = "rect" coords = "6,56,364,90" href = "tb_standard.htm" />\r
-  <area shape = "rect" coords = "6,112,613,164" href = "#cred1" />\r
-  <area shape = "rect" coords = "246,162,288,197" href = "#cred2" />\r
-  <area shape = "rect" coords = "72,196,107,245" href = "#credtype1" />\r
-  <area shape = "rect" coords = "69,278,107,315" href = "#credtype2" />\r
-  <area shape = "rect" coords = "236,332,294,367" href = "#cred3" />\r
-</map>\r
-\r
 <img src="images/screen_main_wnd.bmp" usemap="#main_wnd_map"/>\r
 \r
 <ol>\r
   <li>Menu bar</li>\r
   <li>Tool bar</li>\r
-\r
-  <li><a name="cred1" /> An identity with a valid Kerberos 5 initial\r
-  ticket</li>\r
-\r
-  <li><a name="cred2" /> An identity with valid Kerberos 5 tickets and\r
-  AFS tokens</li> \r
-\r
-  <li><a name="credtype1" /> A set of Kerberos 5 tickets</li>\r
-\r
-  <li><a name="credtype2" /> A set of AFS tokens</li>\r
-\r
-  <li>An identity with expired Kerberos 5 tickets</li>\r
+  <li>Credentials list</li>\r
 \r
 </ol>\r
 \r
index c2239b834c73d4e90c9e40810caf199d0af1e03f..6c3876ef1464d5c076e09f2dbe6d4133598c088b 100644 (file)
                         <param name="Name" value="Managing the credentials view layout">\r
                         <param name="Local" value="html\use_layout.htm">\r
                         </OBJECT>\r
+\r
+                <LI> <OBJECT type="text/sitemap">\r
+                        <param name="Name" value="Configuring NetIDMgr and identities">\r
+                        <param name="Local" value="html\use_config.htm">\r
+                        </OBJECT>\r
        </UL>\r
        <LI> <OBJECT type="text/sitemap">\r
                <param name="Name" value="Menus and Toolbars">\r