OSDN Git Service

PATCH: [ 1153905 ] Doc: Update installation help for Merge7zInstaller
authorKimmo Varis <kimmov@gmail.com>
Tue, 1 Mar 2005 15:26:28 +0000 (15:26 +0000)
committerKimmo Varis <kimmov@gmail.com>
Tue, 1 Mar 2005 15:26:28 +0000 (15:26 +0000)
Docs/Users/Manual/Install.xml
Docs/Users/Manual/readme.txt

index 7ee07f6..cd0c8cb 100644 (file)
+<?xml version="1.0" encoding="UTF-8"?>
 <sect1 id="Installing">
   <title>Getting and installing WinMerge</title>
+
   <sect2>
     <title>Getting files</title>
-    <para>Latest releases can be always downloaded from WinMerge homepage: <ulink url="http://www.winmerge.org/">WinMerge.org</ulink>. Note that there may be some delay updating homepages for releases, but project statuspage at <ulink url="https://sourceforge.net/projects/winmerge/">SourceForge.net</ulink> shows latest files. There is also mailing-list for release announcements. Stable releases are also available in several file download sites.</para>
-    <para>WinMerge can be installed using installer or by unzipping files from archive.</para>
+
+    <para>Latest releases can be always downloaded from WinMerge homepage:
+    <ulink url="http://www.winmerge.org/">WinMerge.org</ulink>. Note that
+    there may be some delay updating homepages for releases, but project
+    statuspage at <ulink
+    url="https://sourceforge.net/projects/winmerge/">SourceForge.net</ulink>
+    shows latest files. There is also mailing-list for release announcements.
+    Stable releases are also available in several file download sites.</para>
+
+    <para>WinMerge can be installed using installer or by unzipping files from
+    archive.</para>
+
     <note>
-      <para>Installer requires Admin-user rights in Windows NT4/2000/XP. If you don't have Admin-user rights you can install WinMerge by unzipping from archive file.</para>
+      <para>Installer requires Admin-user rights in Windows NT4/2000/XP. If
+      you don't have Admin-user rights you can install WinMerge by unzipping
+      from archive file.</para>
     </note>
   </sect2>
+
   <sect2>
     <title>Using installer (recommended)</title>
-    <para>This is recommeded for most users. Installer asks location where WinMerge is installed, installs files, configures shell integration and adds WinMerge to <guimenu>Start</guimenu>-menu. To install WinMerge:</para>
+
+    <para>This is recommended for most users. Installer asks location where
+    WinMerge is installed, installs files, configures shell integration and
+    adds WinMerge to <guimenu>Start</guimenu>-menu. To install
+    WinMerge:</para>
+
     <orderedlist>
       <listitem>
-        <para>Start installer executable (usually named <filename>WinMerge-<replaceable>version</replaceable>-setup.exe</filename>)</para>
+        <para>Start installer executable (usually named
+        <filename>WinMerge-<replaceable>version</replaceable>-setup.exe</filename>)</para>
       </listitem>
+
       <listitem>
-        <para>Select <guibutton>Next</guibutton>-button in welcome screen</para>
+        <para>Select <guibutton>Next</guibutton>-button in welcome
+        screen</para>
       </listitem>
+
       <listitem>
-        <para>Select <guibutton>Next</guibutton>-button in licence screen</para>
+        <para>Select <guibutton>Next</guibutton>-button in licence
+        screen</para>
       </listitem>
+
       <listitem>
-        <para>Select location for WinMerge and select <guibutton>Next</guibutton>-button. It is recommended to install WinMerge in own directory.</para>
+        <para>Select location for WinMerge and select
+        <guibutton>Next</guibutton>-button. It is recommended to install
+        WinMerge in own directory.</para>
       </listitem>
+
       <listitem>
-        <para>Select components installed or one of preconfigured combinations. <guilabel>Typical</guilabel> configuration is recommended for most users. In addition to components already selected by <guilabel>Typical</guilabel>, language file(s) could be choosed. Components are:</para>
+        <para>Select components installed or one of preconfigured
+        combinations. <guilabel>Typical</guilabel> configuration is
+        recommended for most users. In addition to components already selected
+        by <guilabel>Typical</guilabel>, language file(s) could be chosen.
+        Components are:</para>
+
         <itemizedlist>
           <listitem>
-            <para><guilabel>WinMerge core files</guilabel> - cannot be unselected - WinMerge executable files</para>
+            <para><guilabel>WinMerge core files</guilabel> - cannot be
+            unselected - WinMerge executable files</para>
           </listitem>
+
           <listitem>
-            <para><guilabel>Application Runtimes</guilabel> - cannot be unselected - needed DLL files</para>
+            <para><guilabel>Application Runtimes</guilabel> - cannot be
+            unselected - needed DLL files</para>
           </listitem>
+
           <listitem>
-            <para><guilabel>User's Guide</guilabel> - HTML user guide/manual - if it is not installed WinMerge opens manual from <ulink url="http://www.winmerge.org/">WinMerge.org</ulink></para>
+            <para><guilabel>User's Guide</guilabel> - HTML user guide/manual -
+            if it is not installed WinMerge opens manual from <ulink
+            url="http://www.winmerge.org/">WinMerge.org</ulink></para>
           </listitem>
+
           <listitem>
             <para><guilabel>Filters</guilabel> - file filter files</para>
           </listitem>
+
           <listitem>
             <para><guilabel>Plugins</guilabel> - plugins and scripts</para>
           </listitem>
+
           <listitem>
-            <para><guilabel>Languages</guilabel> - WinMerge translation files. After installing translation file user interface language can be selected from menu <menuchoice>
+            <para><guilabel>Languages</guilabel> - WinMerge translation files.
+            After installing translation file user interface language can be
+            selected from menu <menuchoice>
                 <guimenu>View</guimenu>
+
                 <guimenuitem>Language</guimenuitem>
               </menuchoice>.</para>
           </listitem>
         </itemizedlist>
       </listitem>
+
       <listitem>
-        <para>Select <guimenu>Start</guimenu>-menu folder or disable creating it.</para>
+        <para>Select <guimenu>Start</guimenu>-menu folder or disable creating
+        it.</para>
       </listitem>
+
       <listitem>
         <para>Select additional tasks:<itemizedlist>
             <listitem>
-              <para><guilabel>Enable Explorer context menu integration</guilabel> - Enables basic WinMerge shell integration (can be later enabled from options).</para>
+              <para><guilabel>Enable Explorer context menu
+              integration</guilabel> - Enables basic WinMerge shell
+              integration (can be later enabled from options).</para>
             </listitem>
+
             <listitem>
-              <para><guilabel>Integrate with TortoiseCVS</guilabel> - sets WinMerge to TortoiseCVS diff application.</para>
+              <para><guilabel>Integrate with TortoiseCVS</guilabel> - sets
+              WinMerge to TortoiseCVS diff application.</para>
             </listitem>
+
             <listitem>
-              <para><guilabel>Create a Desktop Icon</guilabel> - adds WinMerge icon to Desktop</para>
+              <para><guilabel>Create a Desktop Icon</guilabel> - adds WinMerge
+              icon to Desktop</para>
             </listitem>
+
             <listitem>
-              <para><guilabel>Create a Quick Launch Icon</guilabel> - adds WinMerge icon to Quick Launch bar</para>
+              <para><guilabel>Create a Quick Launch Icon</guilabel> - adds
+              WinMerge icon to Quick Launch bar</para>
             </listitem>
           </itemizedlist></para>
       </listitem>
+
       <listitem>
-        <para>Verify install selections and select <guibutton>Install</guibutton> button to continue.</para>
+        <para>Verify install selections and select
+        <guibutton>Install</guibutton> button to continue.</para>
       </listitem>
+
       <listitem>
-        <para>After installer has copied files final screen appears with two checkboxes asking if created WinMerge Start-menu folder should be opened and if WinMerge application should be started.</para>
+        <para>After installer has copied files final screen appears with two
+        checkboxes asking if created WinMerge Start-menu folder should be
+        opened and if WinMerge application should be started.</para>
       </listitem>
     </orderedlist>
   </sect2>
+
   <sect2>
     <title>Installing from archive</title>
-    <para>WinMerge is pretty much independent from other system components. It doesn't integrate tightly to Windows or use lots of dlls. <filename>WinMerge[U].exe</filename> itself is dependent of <filename>MFC42[U].dll</filename> (and <filename>MSVCRT.dll</filename>) in addition to some system DLLs. So if mentioned DLLs already are installed to system, only <filename>WinMerge[U].exe</filename> is needed to run WinMerge.</para>
-    <para>Archive files have correct folder structure (except for <filename>ShellExtension.dll</filename> see note below). WinMerge should be unzipped preserving folder structure to destination folder, for example <filename class="directory">C:\Program Files\</filename>. Root folder created has name <filename class="directory">/WinMerge-<replaceable>version</replaceable></filename>, for example <filename class="directory">/WinMerge-2.2.0</filename>. This folder can be renamed or files copied to other folder (preserving folder structure!).</para>
+
+    <para>WinMerge is pretty much independent from other system components. It
+    doesn't integrate tightly to Windows or use lots of dlls.
+    <filename>WinMerge[U].exe</filename> itself is dependent of
+    <filename>MFC42[U].dll</filename> (and <filename>MSVCRT.dll</filename>) in
+    addition to some system DLLs. So if mentioned DLLs already are installed
+    to system, only <filename>WinMerge[U].exe</filename> is needed to run
+    WinMerge.</para>
+
+    <para>Archive files have correct folder structure (except for
+    <filename>ShellExtension.dll</filename> see note below). WinMerge should
+    be unzipped preserving folder structure to destination folder, for example
+    <filename class="directory">C:\Program Files\</filename>. Root folder
+    created has name <filename
+    class="directory">/WinMerge-<replaceable>version</replaceable></filename>,
+    for example <filename class="directory">/WinMerge-2.2.0</filename>. This
+    folder can be renamed or files copied to other folder (preserving folder
+    structure!).</para>
+
     <note>
-      <para><filename>ShellExtension.dll</filename> is in two subfolders, <filename class="directory">/ShellExtension_Ansi</filename> and <filename class="directory">/ShellExtension_Unicode</filename>. For most users file in <filename class="directory">ShellExtension_Ansi</filename> is good choise. That file must be copied to same directory with <filename>WinMerge.exe</filename>.</para>
+      <para><filename>ShellExtension.dll</filename> is in two subfolders,
+      <filename class="directory">/ShellExtension_Ansi</filename> and
+      <filename class="directory">/ShellExtension_Unicode</filename>. For most
+      users file in <filename class="directory">ShellExtension_Ansi</filename>
+      is good choice. That file must be copied to same directory with
+      <filename>WinMerge.exe</filename>.</para>
     </note>
-    <para>After unzipping files WinMerge is ready to run! ShellExtension and Archive Integration may need additional steps (see below).</para>
+
+    <para>After unzipping files WinMerge is ready to run! ShellExtension and
+    Archive Integration may need additional steps (see below).</para>
   </sect2>
+
   <sect2>
     <title>Shell integration</title>
-    <para>Choose "<guilabel>Enable Explorer context menu integration</guilabel>" from installer's additional features to install shell integration.</para>
-    <para>If install program is not used, shell integration dll (<filename>ShellExtension.dll</filename>) must be registered separately. This is done by running <filename>register.bat</filename> from WinMerge directory.</para>
-    <para>Updating shell integreation outside installer requires first uninstalling current version. Uninstalling can be done by running <filename>uninstall.bat</filename> from WinMerge directory. After that computer should be restarted so Windows completes uninstallation. Then new version can be installed like described above.</para>
+
+    <para>Choose "<guilabel>Enable Explorer context menu
+    integration</guilabel>" from installer's additional features to install
+    shell integration.</para>
+
+    <para>If install program is not used, shell integration dll
+    (<filename>ShellExtension.dll</filename>) must be registered separately.
+    This is done by running <filename>register.bat</filename> from WinMerge
+    directory.</para>
+
+    <para>Updating shell integration outside installer requires first
+    uninstalling current version. Uninstalling can be done by running
+    <filename>uninstall.bat</filename> from WinMerge directory. After that
+    computer should be restarted so Windows completes uninstallation. Then new
+    version can be installed like described above.</para>
   </sect2>
+
   <sect2>
     <title>7-Zip and archive support</title>
-    <para>Archive file support in WinMerge requires 7-Zip. WinMerge installer does not install 7-Zip. 7-Zip installer can be downloaded from <ulink url="http://www.7-zip.org/">7-Zip.org</ulink>.</para>
-    <para>WinMerge automatically detects installed 7-zip in system, there is no need to any configuration. But WinMerge supports only certain versions of 7-Zip. Please check 7-zip version compatibility from <filename>Read Me.rft</filename>-file. </para>
-    <para>7-zip integration needs compatible <filename>Merge7z*.dll</filename> in WinMerge program directory. <filename>*</filename> comes from 7-zip version installed. For example 7-zip version 3.13 needs <filename>Merge7z313.dll</filename>. And if <filename>WinMergeU.exe</filename> (unicode version) is used, then "<filename>U</filename>" is also added to filename: <filename>Merge7z313U.dll</filename>. <filename>Merge7z*.dll</filename> files for compatible 7-zip versions are installed by WinMerge installer. If needed dll file is for some reason missing it can be copied to WinMerge directory, for example from zip-archive downloadable in WinMerge download page.</para>
-    <para>If <filename>Merge7z*.dll</filename> file is missing, WinMerge informs user with message showing filename of needed file and recommended version of 7-zip. This message can also be opened from <guimenu>Help</guimenu>-menu item "<guimenuitem>Archive Support Disabled</guimenuitem>".</para>
+
+    <para>Archive file support in WinMerge requires <ulink
+    url="http://www.7-zip.org/">7-Zip</ulink>. WinMerge installer does not
+    install 7-Zip. 7-Zip installer can be downloaded from <ulink
+    url="http://www.7-zip.org/">7-Zip.org</ulink>.</para>
+
+    <para>WinMerge automatically detects installed 7-zip in system, there is
+    no need to any configuration. But WinMerge supports only certain versions
+    of 7-Zip. Please check 7-Zip version compatibility from <filename>Read
+    Me.rft</filename>-file.</para>
+
+    <para>7-zip integration needs compatible <filename>Merge7z*.dll</filename>
+    in WinMerge program directory. <filename>*</filename> comes from 7-Zip
+    version installed. For example 7-Zip version 3.13 needs
+    <filename>Merge7z313.dll</filename>. And if
+    <filename>WinMergeU.exe</filename> (unicode version) is used, then
+    "<filename>U</filename>" is also added to filename:
+    <filename>Merge7z313U.dll</filename>. If needed dll file is for some
+    reason missing it can be copied to WinMerge directory, for example from
+    zip-archive downloadable in WinMerge download page.</para>
+
+    <para>If <filename>Merge7z*.dll</filename> file is missing, WinMerge
+    informs user with message showing filename of needed file and recommended
+    version of 7-Zip. This message can also be opened from
+    <guimenu>Help</guimenu>-menu item "<guimenuitem>Archive Support
+    Disabled</guimenuitem>".</para>
+
+    <sect3>
+      <title>Merge7zInstaller</title>
+
+      <para>This is stand-alone installer for 7-Zip integration. New WinMerge
+      releases do not install archive support anymore.</para>
+
+      <para>This separate installer is much more flexible since we can update
+      it whenever 7-Zip is updated. And we don't add files users don't need to
+      base installer.</para>
+
+      <para>Latest version is always available in our downloads at
+      SourceForge.net: <ulink
+      url="https://sourceforge.net/project/showfiles.php?group_id=13216&amp;package_id=143957"
+      userlevel="">7-Zip plugin</ulink>.</para>
+
+      <tip>
+        <para>If you want to know immediately when we release new versions,
+        you can Monitor our releases. When monitoring release, you get sent
+        e-mail notifications about new releases when they happen.</para>
+      </tip>
+
+      <para>Running installer is simple:</para>
+
+      <para><orderedlist>
+          <listitem>
+            <para>Start installer
+            (<filename>Merge7zInstallerXXX-YYY-ZZZ.exe</filename>) Where XXX
+            is build number, YYY earliest 7-Zip version supported and ZZZ
+            latest 7-Zip version supported. For example
+            Merge7zInstaller0010-311-415.exe means build version 10, and
+            support for 7-Zip versions 3.11 - 4.15</para>
+          </listitem>
+
+          <listitem>
+            <para>Select installation type and dlls to install</para>
+
+            <itemizedlist>
+              <listitem>
+                <para><guilabel>Install to system directory</guilabel> copies
+                7-Zip integration files to system directory so they can be
+                shared between multiple WinMerge installations and other
+                programs using them</para>
+              </listitem>
+
+              <listitem>
+                <para><guilabel>Install to program directory</guilabel> copies
+                7-zip integration files to program directory. Files are then
+                usable only by that specific program.</para>
+
+                <para>This selection requires user to select executable in
+                directory where integration files are installer. Select
+                WinMerge executable when installing to WinMerge
+                directory.</para>
+              </listitem>
+
+              <listitem>
+                <para><guilabel>Enable standalone operation</guilabel>
+                installs also required 7-Zip files. This allows minimal
+                installation of 7-Zip to program directory without need to
+                install whole 7-zip.</para>
+              </listitem>
+            </itemizedlist>
+          </listitem>
+        </orderedlist></para>
+    </sect3>
   </sect2>
-</sect1>
+</sect1>
\ No newline at end of file
index 1ee4a36..0c959cd 100644 (file)
@@ -1,3 +1,7 @@
+2005-03-01 Kimmo
+ PATCH: [ 1153905 ] Doc: Update installation help for Merge7zInstaller
+  Manual: Install.xml
+
 2005-02-23 Kimmo
  PATCH: [ 1145560 ] Docs: Add link to updated developer-pages
   Manual: Introduction.xml