Rename README.txt to README.rst and convert to reStructuredText

Author: Peter Åstrand (astrand)

README.txt README.rst

@@ -19,7 +19,7 @@ JPEG codec.
 Legal
 =====
 
-Incomplete and generally out of date copyright list:
+Incomplete and generally out of date copyright list::
 
         Copyright (C) 1999 AT&T Laboratories Cambridge
         Copyright (C) 2002-2005 RealVNC Ltd.
@@ -50,7 +50,7 @@ All Platforms
 
 All versions of TigerVNC contain the following programs:
 
-  vncviewer - the cross-platform TigerVNC Viewer, written using FLTK.
+* vncviewer - the cross-platform TigerVNC Viewer, written using FLTK.
               vncviewer connects to a VNC server and allows you to interact
               with the remote desktop being displayed by the VNC server.  The
               VNC server can be running on a Windows or a Unix/Linux machine.
@@ -61,7 +61,7 @@ Windows-Specific
 
 The Windows version of TigerVNC contains the following programs:
 
-  winvnc - the TigerVNC Server for Windows.  winvnc allows a Windows desktop to
+* winvnc - the TigerVNC Server for Windows.  winvnc allows a Windows desktop to
            be accessed remotely using a VNC viewer.
 
 winvnc may not work if the Fast User Switching or Remote Desktop features are
@@ -73,23 +73,23 @@ Unix/Linux-Specific (not Mac)
 
 The Unix/Linux version of TigerVNC contains the following programs:
 
-  Xvnc - the TigerVNC Server for Unix.  Xvnc is both a VNC server and an X
+* Xvnc - the TigerVNC Server for Unix.  Xvnc is both a VNC server and an X
          server with a "virtual" framebuffer.  You should normally use the
          vncserver script to start Xvnc.
 
-  vncserver - a wrapper script which makes starting Xvnc more convenient.
+* vncserver - a wrapper script which makes starting Xvnc more convenient.
               vncserver requires Perl.
 
-  vncpasswd - a program which allows you to change the VNC password used to
+* vncpasswd - a program which allows you to change the VNC password used to
               access your VNC server sessions (assuming that VNC authentication
               is being used.)  The vncserver script will automatically launch
               this program if it detects that VNC authentication is in use and
               a VNC password has not yet been configured.
 
-  vncconfig - a program which is used to configure and control a running
+* vncconfig - a program which is used to configure and control a running
               instance of Xvnc.
 
-  x0vncserver - an inefficient VNC server which continuously polls any X
+* x0vncserver - an inefficient VNC server which continuously polls any X
                 display, allowing it to be controlled via VNC.  It is intended
                 mainly as a demonstration of a simple VNC server.
 

cmake/BuildPackages.cmake

@@ -87,4 +87,4 @@ endif() #UNIX
 #
 
 install(FILES ${CMAKE_SOURCE_DIR}/LICENCE.TXT DESTINATION ${DOC_DIR})
-install(FILES ${CMAKE_SOURCE_DIR}/README.txt DESTINATION ${DOC_DIR})
+install(FILES ${CMAKE_SOURCE_DIR}/README.rst DESTINATION ${DOC_DIR})

contrib/packages/rpm/el5/SPECS/tigervnc.spec

@@ -1000,7 +1000,7 @@ fi
 
 %files -f %{name}.lang
 %defattr(-,root,root,-)
-%doc README.txt
+%doc README.rst
 %{_bindir}/vncviewer
 %{_datadir}/applications/*
 %{_mandir}/man1/vncviewer.1*

contrib/packages/rpm/el6/SPECS/tigervnc.spec

@@ -408,7 +408,7 @@ fi
 
 %files -f %{name}.lang
 %defattr(-,root,root,-)
-%doc README.txt
+%doc README.rst
 %{_bindir}/vncviewer
 %{_datadir}/applications/*
 %{_mandir}/man1/vncviewer.1*

contrib/packages/rpm/el7/SPECS/tigervnc.spec

@@ -340,7 +340,7 @@ fi
 
 %files -f %{name}.lang
 %defattr(-,root,root,-)
-%doc %{_docdir}/%{name}-%{version}/README.txt
+%doc %{_docdir}/%{name}-%{version}/README.rst
 %{_bindir}/vncviewer
 %{_datadir}/applications/*
 %{_mandir}/man1/vncviewer.1*

java/com/tigervnc/vncviewer/VncViewer.java

@@ -65,7 +65,7 @@ public class VncViewer extends javax.swing.JApplet
   public static final String aboutText =
     new String("TigerVNC Java Viewer v%s (%s)%n"+
                "Built on %s at %s%n"+
-               "Copyright (C) 1999-2017 TigerVNC Team and many others (see README.txt)%n"+
+               "Copyright (C) 1999-2017 TigerVNC Team and many others (see README.rst)%n"+
                "See http://www.tigervnc.org for information on TigerVNC.");
 
   public static String version = null;

po/CMakeLists.txt

@@ -24,7 +24,7 @@ if (GETTEXT_XGETTEXT_EXECUTABLE)
       --keyword=_
       --keyword=p_:1c,2
       --keyword=N_
-      "--copyright-holder=TigerVNC Team and many others \(see README.txt\)"
+      "--copyright-holder=TigerVNC Team and many others \(see README.rst\)"
       [email protected]
       --sort-by-file
       --add-location

po/tigervnc.pot

@@ -1,5 +1,5 @@
 # SOME DESCRIPTIVE TITLE.
-# Copyright (C) YEAR TigerVNC Team and many others (see README.txt)
+# Copyright (C) YEAR TigerVNC Team and many others (see README.rst)
 # This file is distributed under the same license as the PACKAGE package.
 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
 #
@@ -560,7 +560,7 @@ msgstr ""
 msgid ""
 "TigerVNC Viewer %d-bit v%s\n"
 "Built on: %s\n"
-"Copyright (C) 1999-%d TigerVNC Team and many others (see README.txt)\n"
+"Copyright (C) 1999-%d TigerVNC Team and many others (see README.rst)\n"
 "See http://www.tigervnc.org for information on TigerVNC."
 msgstr ""
 

release/makemacapp.in

@@ -65,7 +65,7 @@ install -m 644 $SRCDIR/release/tigervnc.icns "$APPROOT/Contents/Resources/"
 install -m 644 release/Info.plist "$APPROOT/Contents/"
 
 install -m 644 $SRCDIR/LICENCE.TXT $TMPDIR/dmg/
-install -m 644 $SRCDIR/README.txt $TMPDIR/dmg/
+install -m 644 $SRCDIR/README.rst $TMPDIR/dmg/
 
 hdiutil create -fs HFS+ -volname $PACKAGE_NAME-$VERSION \
 	-srcfolder "$TMPDIR/dmg" \

release/tigervnc.iss.in

@@ -30,7 +30,7 @@ Source: "@CMAKE_CURRENT_BINARY_DIR@\win\wm_hooks\wm_hooks.dll"; DestDir: "{app}"
 Source: "@CMAKE_CURRENT_BINARY_DIR@\win\vncconfig\vncconfig.exe"; DestDir: "{app}"; Flags: ignoreversion restartreplace; 
 #endif
 Source: "@CMAKE_CURRENT_BINARY_DIR@\vncviewer\vncviewer.exe"; DestDir: "{app}"; Flags: ignoreversion restartreplace; 
-Source: "@CMAKE_SOURCE_DIR@\README.txt"; DestDir: "{app}"; Flags: ignoreversion
+Source: "@CMAKE_SOURCE_DIR@\README.rst"; DestDir: "{app}"; Flags: ignoreversion
 Source: "@CMAKE_SOURCE_DIR@\LICENCE.TXT"; DestDir: "{app}"; Flags: ignoreversion
 
 
@@ -49,7 +49,7 @@ Name: "{group}\VNC Server (Service-Mode)\Start VNC Service"; FileName: "{app}\wi
 Name: "{group}\VNC Server (Service-Mode)\Stop VNC Service"; FileName: "{app}\winvnc4.exe"; Parameters: "-noconsole -stop";
 #endif
 Name: "{group}\License"; FileName: "write.exe"; Parameters: "LICENCE.TXT"; WorkingDir: "{app}"; Flags: "useapppaths"
-Name: "{group}\Read Me"; FileName: "write.exe"; Parameters: "README.txt"; WorkingDir: "{app}"; Flags: "useapppaths"
+Name: "{group}\Read Me"; FileName: "write.exe"; Parameters: "README.rst"; WorkingDir: "{app}"; Flags: "useapppaths"
 Name: "{group}\Uninstall TigerVNC"; FileName: "{uninstallexe}"; WorkingDir: "{app}";
 
 #ifdef BUILD_WINVNC

unix/xserver/hw/vnc/xvnc.c

@@ -86,7 +86,7 @@ from the X Consortium.
 #include "site.h"
 
 #define XVNCVERSION "TigerVNC 1.8.80"
-#define XVNCCOPYRIGHT ("Copyright (C) 1999-2017 TigerVNC Team and many others (see README.txt)\n" \
+#define XVNCCOPYRIGHT ("Copyright (C) 1999-2017 TigerVNC Team and many others (see README.rst)\n" \
                        "See http://www.tigervnc.org for information on TigerVNC.\n")
 
 #define VFB_DEFAULT_WIDTH  1024

vncviewer/vncviewer.cxx

@@ -99,7 +99,7 @@ static const char *about_text()
   snprintf(buffer, sizeof(buffer),
            _("TigerVNC Viewer %d-bit v%s\n"
              "Built on: %s\n"
-             "Copyright (C) 1999-%d TigerVNC Team and many others (see README.txt)\n"
+             "Copyright (C) 1999-%d TigerVNC Team and many others (see README.rst)\n"
              "See http://www.tigervnc.org for information on TigerVNC."),
            (int)sizeof(size_t)*8, PACKAGE_VERSION,
            BUILD_TIMESTAMP, 2017);

vncviewer/vncviewer.rc.in

@@ -52,7 +52,7 @@ BEGIN
             #endif
             VALUE "FileVersion", "@RCVERSION@\0"
             VALUE "InternalName", "vncviewer\0"
-            VALUE "LegalCopyright", "Copyright (C) 1999-2017 TigerVNC Team and many others (see README.txt)\0"
+            VALUE "LegalCopyright", "Copyright (C) 1999-2017 TigerVNC Team and many others (see README.rst)\0"
             VALUE "LegalTrademarks", "TigerVNC\0"
             VALUE "OriginalFilename", "vncviewer.exe\0"
             VALUE "PrivateBuild", "\0"

win/vncconfig/vncconfig.rc

@@ -472,7 +472,7 @@ BEGIN
             #endif
             VALUE "FileVersion", __RCVERSIONSTR
             VALUE "InternalName", "vncconfig\0"
-            VALUE "LegalCopyright", "Copyright (C) 1999-2017 TigerVNC Team and many others (see README.txt)\0"
+            VALUE "LegalCopyright", "Copyright (C) 1999-2017 TigerVNC Team and many others (see README.rst)\0"
             VALUE "LegalTrademarks", "TigerVNC\0"
             VALUE "OriginalFilename", "vncconfig.exe\0"
             VALUE "PrivateBuild", "\0"

win/winvnc/winvnc.rc.in

@@ -86,7 +86,7 @@ BEGIN
             #endif
             VALUE "FileVersion", __RCVERSIONSTR
             VALUE "InternalName", "winvnc\0"
-            VALUE "LegalCopyright", "Copyright (C) 1999-2017 TigerVNC Team and many others (see README.txt)\0"
+            VALUE "LegalCopyright", "Copyright (C) 1999-2017 TigerVNC Team and many others (see README.rst)\0"
             VALUE "LegalTrademarks", "TigerVNC\0"
             VALUE "OriginalFilename", "winvnc4.exe\0"
             VALUE "PrivateBuild", "\0"