Skip to content

Commit

Permalink
Standardize on sentence case in titles
Browse files Browse the repository at this point in the history
The reason for this is to keep a consistency through out the project.
  • Loading branch information
madnicendio committed Nov 11, 2024
1 parent 4341fca commit 260a3e0
Show file tree
Hide file tree
Showing 42 changed files with 150 additions and 150 deletions.
54 changes: 27 additions & 27 deletions BUILDING.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@


================================
Build Requirements (All Systems)
Build requirements (all systems)
================================

-- CMake (http://www.cmake.org) v3.10 or later
Expand Down Expand Up @@ -36,7 +36,7 @@ Development kits for the following packages:


=========================
Build Requirements (Unix)
Build requirements (Unix)
=========================

-- Non-Mac platforms:
Expand All @@ -59,7 +59,7 @@ Build Requirements (Unix)
* libpwquality

============================
Build Requirements (Windows)
Build requirements (Windows)
============================

-- MinGW or MinGW-w64
Expand All @@ -75,16 +75,16 @@ Build Requirements (Windows)


=========================
Build Requirements (Java)
Build requirements (Java)
=========================

-- Sun/Oracle JDK 1.7 or later or OpenJDK 7 or later

-- See "Building Java Support" below.
-- See "Building Java support" below.


==================
Out-of-Tree Builds
Out-of-tree builds
==================

Binary objects, libraries, and executables are generated in the same directory
Expand All @@ -102,21 +102,21 @@ Building TigerVNC
=================


Building the TigerVNC Viewer on Unix/Mac Systems
Building the TigerVNC viewer on Unix/Mac systems
------------------------------------------------

The following procedure will build the TigerVNC Viewer on Linux and Unix
The following procedure will build the TigerVNC viewer on Linux and Unix
systems.

cd {build_directory}
cmake -G "Unix Makefiles" [additional CMake flags] {source_directory}
make


Building the TigerVNC Server on Unix/Linux Systems
Building the TigerVNC server on Unix/Linux systems
--------------------------------------------------

Building the TigerVNC Server (Xvnc) is a bit trickier. Xvnc is typically built
Building the TigerVNC server (Xvnc) is a bit trickier. Xvnc is typically built
to use the X11 shared libraries provided with the system. The procedure for
this is system-specific, since it requires specifying such things as font
directories, but the general outline is as follows (this procedure assumes
Expand Down Expand Up @@ -162,7 +162,7 @@ that the viewer has already been built, per above.)
(NOTE: Use absolute paths for source_directory and build_directory)


Building the Windows TigerVNC Viewer with MinGW
Building the Windows TigerVNC viewer with MinGW
-----------------------------------------------

If building the Windows version of TigerVNC on a Windows build system, use
Expand All @@ -176,13 +176,13 @@ If cross-compiling on a Unix/Linux system, then see the "Build Recipes" section
below.


Debug Build
Debug build
-----------

Add "-DCMAKE_BUILD_TYPE=Debug" to the CMake command line.


Portable (semi-static) Build
Portable (semi-static) build
----------------------------

TigerVNC can under favourble circumstances be built in a way that allows
Expand All @@ -199,7 +199,7 @@ specific system.


=====================
Building Java Support
Building Java support
=====================

TigerVNC includes a Java version of the TigerVNC Viewer, which can be used on
Expand All @@ -221,10 +221,10 @@ tools are needed to sign the JAR file, which is necessary to enable certain
functionality (such as clipboard transfers) when the Java viewer is used as an
applet.

If the Java viewer is built along with the Windows TigerVNC Server (WinVNC),
If the Java viewer is built along with the Windows TigerVNC server (WinVNC),
then the build system will embed the Java viewer into WinVNC4.exe so that it
will automatically be served up using WinVNC's built-in HTTP server.
Similarly, if the Java viewer is built along with the Unix TigerVNC Server
Similarly, if the Java viewer is built along with the Unix TigerVNC server
(Xvnc), then the build system will include the Java viewer in the server
tarball.

Expand Down Expand Up @@ -252,7 +252,7 @@ or ":file " (see the jarsigner documentation for more info):


======================================
Building TLS Support
Building TLS support
======================================

TLS requires GnuTLS, which is supplied with most Linux distributions and
Expand All @@ -272,7 +272,7 @@ libgnutls located under /usr/local.


======================================
Building Native Language Support (NLS)
Building native language support (NLS)
======================================

NLS requires gettext, which is supplied with most Linux distributions and
Expand Down Expand Up @@ -314,7 +314,7 @@ c:\Program Files\TigerVNC on Windows and /usr/local on Unix.


=========================
Creating Release Packages
Creating release packages
=========================

The following commands can be used to create various types of release packages:
Expand All @@ -325,16 +325,16 @@ Unix

make tarball

Create a binary tarball containing the TigerVNC Viewer
Create a binary tarball containing the TigerVNC viewer

make servertarball

Create a binary tarball containing both the TigerVNC Server and Viewer
Create a binary tarball containing both the TigerVNC server and viewer

make dmg

Create Macintosh disk image file that contains an application bundle of the
TigerVNC Viewer
TigerVNC viewer


Windows
Expand All @@ -347,11 +347,11 @@ make installer


=============
Build Recipes
Build recipes
=============


MinGW Build on Cygwin
MinGW build on Cygwin
---------------------

cd {build_directory}
Expand All @@ -367,7 +367,7 @@ other Cygwin DLL's. The mingw64-x86_64-gcc-core and mingw64-x86_64-gcc-g++
packages (and their dependencies) must be installed.


MinGW-w64 Build on Windows
MinGW-w64 build on Windows
--------------------------

This produces a build of TigerVNC using the "native" MinGW-w64 toolchain
Expand All @@ -384,7 +384,7 @@ This produces a build of TigerVNC using the "native" MinGW-w64 toolchain
make


MinGW Build on Linux
MinGW build on Linux
--------------------

cd {build_directory}
Expand All @@ -399,7 +399,7 @@ MinGW Build on Linux


===============================
Distribution-Specific Packaging
Distribution-specific packaging
===============================

Configuration for building packages for current versions of RHEL/CentOS
Expand Down
10 changes: 5 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,26 +56,26 @@ All versions of TigerVNC contain the following programs:
VNC server can be running on a Windows or a Unix/Linux machine.


Windows-Specific
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.

WARNING: winvnc is currently unmaintained and and may not function correctly.

winvnc may not work if the Fast User Switching or Remote Desktop features are
winvnc may not work if the Fast user switching or Remote desktop features are
in use.


Unix/Linux-Specific (not Mac)
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 service to start Xvnc.

Expand Down
2 changes: 1 addition & 1 deletion common/rfb/TightEncoder.cxx
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ struct TightConf {
// settings for each of 10 compression levels (0..9).
//
// NOTE: The parameters used in this encoder are the result of painstaking
// research by The VirtualGL Project using RFB session captures from a variety
// research by The VirtualGL project using RFB session captures from a variety
// of both 2D and 3D applications. See http://www.VirtualGL.org for the full
// reports.

Expand Down
2 changes: 1 addition & 1 deletion common/rfb/TightJPEGEncoder.cxx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ struct TightJPEGConfiguration {
};

// NOTE: The JPEG quality and subsampling levels below were obtained
// experimentally by the VirtualGL Project. They represent the approximate
// experimentally by the VirtualGL project. They represent the approximate
// average compression ratios listed below, as measured across the set of
// every 10th frame in the SPECviewperf 9 benchmark suite.
//
Expand Down
2 changes: 1 addition & 1 deletion common/rfb/VNCServerST.cxx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
* USA.
*/

// -=- Single-Threaded VNC Server implementation
// -=- Single-Threaded VNC server implementation


// Note about how sockets get closed:
Expand Down
2 changes: 1 addition & 1 deletion java/cmake/SignJar.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ else()
execute_process(COMMAND
${KEYTOOL} -genkey -alias TigerVNC -keystore tigervnc.keystore -keyalg RSA
-storepass tigervnc -keypass tigervnc -validity 7300
-dname "CN=TigerVNC, OU=Software Development, O=The TigerVNC Project, L=Austin, S=Texas, C=US"
-dname "CN=TigerVNC, OU=Software development, O=The TigerVNC project, L=Austin, S=Texas, C=US"
RESULT_VARIABLE RESULT OUTPUT_VARIABLE OUTPUT ERROR_VARIABLE ERROR)
if(NOT RESULT EQUAL 0)
message(FATAL_ERROR "${KEYTOOL} failed:\n${ERROR}")
Expand Down
2 changes: 1 addition & 1 deletion java/com/tigervnc/vncviewer/LICENCE.TXT
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,7 @@ POSSIBILITY OF SUCH DAMAGES.

END OF TERMS AND CONDITIONS

Appendix: How to Apply These Terms to Your New Programs
Appendix: How to apply these terms to your new programs

If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
Expand Down
2 changes: 1 addition & 1 deletion java/com/tigervnc/vncviewer/MANIFEST.MF
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Manifest-Version: 1.0
Main-Class: com.tigervnc.vncviewer.VncViewer
Application-Name: TigerVNC Viewer
Application-Name: TigerVNC viewer
Permissions: all-permissions
Codebase: *
2 changes: 1 addition & 1 deletion java/com/tigervnc/vncviewer/OptionsDialog.java
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ protected void processFocusEvent(final FocusEvent e) {
@SuppressWarnings({"rawtypes","unchecked"})
public OptionsDialog() {
super(true);
setTitle("VNC Viewer Options");
setTitle("VNC viewer options");
setResizable(false);

getContentPane().setLayout(
Expand Down
2 changes: 1 addition & 1 deletion java/com/tigervnc/vncviewer/Parameters.java
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ public class Parameters {
"specified from the point of view of the gateway machine, "+
"e.g. \"localhost\" denotes the gateway, "+
"not the machine on which the viewer was launched. "+
"See the System Properties section below for "+
"See the System properties section below for "+
"information on configuring the -Via option.", "");

public static BoolParameter tunnel
Expand Down
8 changes: 4 additions & 4 deletions java/com/tigervnc/vncviewer/README
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

TigerVNC Java Viewer
TigerVNC Java viewer
====================

This distribution is based on the standard VNC source and includes new
Expand Down Expand Up @@ -27,9 +27,9 @@ available.
Installation
============

The TigerVNC Java Viewer requires installation of either a JRE (Java
The TigerVNC Java viewer requires installation of either a JRE (Java
Runtime Environment) or a JDK (Java Development Kit). If VncViewer.jar is
in the current directory, then the TigerVNC Java Viewer can be launched
in the current directory, then the TigerVNC Java viewer can be launched
with the following command line:

java -jar VncViewer.jar [parameters]
Expand All @@ -41,7 +41,7 @@ optional parameters supported by VncViewer.
Parameters
==========

The TigerVNC Java Viewer accepts a number of optional parameters, allowing you
The TigerVNC Java viewer accepts a number of optional parameters, allowing you
to customize its behavior. Example:

java -jar VncViewer.jar Port=5901 ScalingFactor=50
Expand Down
2 changes: 1 addition & 1 deletion java/com/tigervnc/vncviewer/ServerDialog.java
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public ServerDialog(String defaultServerName,
super(true);
this.vncServerName = vncServerName;
setDefaultCloseOperation(DO_NOTHING_ON_CLOSE);
setTitle("VNC Viewer: Connection Details");
setTitle("VNC viewer: Connection details");
setResizable(false);
addWindowListener(new WindowAdapter() {
public void windowClosing(WindowEvent e) {
Expand Down
8 changes: 4 additions & 4 deletions java/com/tigervnc/vncviewer/VncViewer.java
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
public class VncViewer implements Runnable {

public static final String aboutText =
new String("TigerVNC Java Viewer v%s (%s)%n"+
new String("TigerVNC Java viewer v%s (%s)%n"+
"Built on %s at %s%n"+
"Copyright (C) 1999-2024 TigerVNC Team and many others (see README.rst)%n"+
"See https://www.tigervnc.org for information on TigerVNC.");
Expand Down Expand Up @@ -237,7 +237,7 @@ public static void usage() {

Configuration.listParams(79, 14);
String propertiesString = ("\n"+
"System Properties (adapted from the TurboVNC vncviewer man page)\n"+
"System properties (adapted from the TurboVNC vncviewer man page)\n"+
" When started with the -via option, vncviewer reads the VNC_VIA_CMD\n"+
" System property, expands patterns beginning with the \"%\" character,\n"+
" and uses the resulting command line to establish the secure tunnel\n"+
Expand Down Expand Up @@ -359,7 +359,7 @@ public static void about_vncviewer(Container parent) {
JOptionPane op =
new JOptionPane(msg, JOptionPane.INFORMATION_MESSAGE,
JOptionPane.DEFAULT_OPTION, VncViewer.logoIcon, options);
JDialog dlg = op.createDialog(parent, "About TigerVNC Viewer for Java");
JDialog dlg = op.createDialog(parent, "About TigerVNC viewer for Java");
dlg.setIconImage(VncViewer.frameIcon);
dlg.setAlwaysOnTop(true);
dlg.setVisible(true);
Expand All @@ -378,7 +378,7 @@ public void exit(int n) {
void reportException(java.lang.Exception e) {
String title, msg = e.getMessage();
int msgType = JOptionPane.ERROR_MESSAGE;
title = "TigerVNC Viewer : Error";
title = "TigerVNC viewer : Error";
e.printStackTrace();
JOptionPane.showMessageDialog(null, msg, title, msgType);
}
Expand Down
Loading

0 comments on commit 260a3e0

Please sign in to comment.