Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Standardize on sentence case #1865

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Standardize on sentence case #1865

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
260a3e0
Standardize on sentence case in titles
madnicendio Nov 4, 2024
5b74bf1
Standardize log message prefix format
madnicendio Nov 4, 2024
58257d3
Capitalize first letter in log, exception & error
madnicendio Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 27 additions & 27 deletions BUILDING.txt
View file
Open in desktop
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
2 changes: 1 addition & 1 deletion CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ set(CMAKE_REQUIRED_FLAGS)
set(CMAKE_REQUIRED_DEFINITIONS)

if(NOT FOUND_LIBJPEG_TURBO)
message(STATUS "WARNING: You are not using libjpeg-turbo. Performance will suffer.")
message(STATUS "Warning: You are not using libjpeg-turbo. Performance will suffer.")
endif()

option(BUILD_JAVA "Build Java version of the TigerVNC Viewer" FALSE)
Expand Down
10 changes: 5 additions & 5 deletions README.rst
View file
Open in desktop
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
24 changes: 12 additions & 12 deletions common/network/TcpSocket.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ const char* TcpSocket::getPeerAddress() {
socklen_t sa_size = sizeof(sa);

if (getpeername(getFd(), &sa.u.sa, &sa_size) != 0) {
vlog.error("unable to get peer name for socket");
vlog.error("Unable to get peer name for socket");
return "(N/A)";
}

Expand All @@ -231,7 +231,7 @@ const char* TcpSocket::getPeerAddress() {
buffer + 1, sizeof(buffer) - 2, nullptr, 0,
NI_NUMERICHOST);
if (ret != 0) {
vlog.error("unable to convert peer name to a string");
vlog.error("Unable to convert peer name to a string");
return "(N/A)";
}

Expand All @@ -245,14 +245,14 @@ const char* TcpSocket::getPeerAddress() {

name = inet_ntoa(sa.u.sin.sin_addr);
if (name == nullptr) {
vlog.error("unable to convert peer name to a string");
vlog.error("Unable to convert peer name to a string");
return "(N/A)";
}

return name;
}

vlog.error("unknown address family for socket");
vlog.error("Unknown address family for socket");
return "";
}

Expand Down Expand Up @@ -281,7 +281,7 @@ bool TcpSocket::enableNagles(bool enable) {
if (setsockopt(getFd(), IPPROTO_TCP, TCP_NODELAY,
(char *)&one, sizeof(one)) < 0) {
int e = errorNumber;
vlog.error("unable to setsockopt TCP_NODELAY: %d", e);
vlog.error("Unable to setsockopt TCP_NODELAY: %d", e);
return false;
}
return true;
Expand All @@ -299,15 +299,15 @@ TcpListener::TcpListener(const struct sockaddr *listenaddr,
int sock;

if ((sock = socket (listenaddr->sa_family, SOCK_STREAM, 0)) < 0)
throw SocketException("unable to create listening socket", errorNumber);
throw SocketException("Unable to create listening socket", errorNumber);

memcpy (&sa, listenaddr, listenaddrlen);
#ifdef IPV6_V6ONLY
if (listenaddr->sa_family == AF_INET6) {
if (setsockopt (sock, IPPROTO_IPV6, IPV6_V6ONLY, (char*)&one, sizeof(one))) {
int e = errorNumber;
closesocket(sock);
throw SocketException("unable to set IPV6_V6ONLY", e);
throw SocketException("Unable to set IPV6_V6ONLY", e);
}
}
#endif /* defined(IPV6_V6ONLY) */
Expand All @@ -325,14 +325,14 @@ TcpListener::TcpListener(const struct sockaddr *listenaddr,
(char *)&one, sizeof(one)) < 0) {
int e = errorNumber;
closesocket(sock);
throw SocketException("unable to create listening socket", e);
throw SocketException("Unable to create listening socket", e);
}
#endif

if (bind(sock, &sa.u.sa, listenaddrlen) == -1) {
int e = errorNumber;
closesocket(sock);
throw SocketException("failed to bind socket", e);
throw SocketException("Failed to bind socket", e);
}

listen(sock);
Expand Down Expand Up @@ -443,7 +443,7 @@ void network::createTcpListeners(std::list<SocketListener*> *listeners,
snprintf (service, sizeof (service) - 1, "%d", port);
service[sizeof (service) - 1] = '\0';
if ((result = getaddrinfo(addr, service, &hints, &ai)) != 0)
throw GAIException("unable to resolve listening address", result);
throw GAIException("Unable to resolve listening address", result);

try {
createTcpListeners(listeners, ai);
Expand Down Expand Up @@ -630,7 +630,7 @@ TcpFilter::Pattern TcpFilter::parsePattern(const char* p) {
}

if ((result = getaddrinfo (parts[0].c_str(), nullptr, &hints, &ai)) != 0) {
throw GAIException("unable to resolve host by name", result);
throw GAIException("Unable to resolve host by name", result);
}

memcpy (&pattern.address.u.sa, ai->ai_addr, ai->ai_addrlen);
Expand All @@ -641,7 +641,7 @@ TcpFilter::Pattern TcpFilter::parsePattern(const char* p) {
if (parts.size() > 1) {
if (family == AF_INET &&
(parts[1].find('.') != std::string::npos)) {
throw Exception("mask no longer supported for filter, "
throw Exception("Mask no longer supported for filter, "
"use prefix instead");
}

Expand Down
Loading