ABOUT
    This is the Patching Tool's help message.
    Run: "patching-tool help <command-name>" if you need more information about
    a certain command.

NAME
    Liferay Patching Tool: Manages patching of Liferay products.

SYNOPSIS
    patching-tool(.bat|.sh) [command] [arguments]

EXAMPLES (MOST COMMONLY USED)
    (Unzip the Patching Tool to the application server's root directory to be
    able to use the "auto-discovery" command)

    patching-tool help              Displays this help message

    patching-tool auto-discovery    Generates a valid default profile if the
                                    application server's root can be found
                                    at "../"

    patching-tool help install      Displays detailed help message of the
                                    <install> command

    patching-tool install [patch]   Attempts to install the specified patch.
                                    If the patch is not found in the "patches"
                                    folder, then the patching-tool will try
                                    to download it from the remote Liferay
                                    repository.

    patching-tool install -force    Installs patches even if the patches to
                                    install are older than the currently
                                    installed ones
                                    (Useful if you want to uninstall only one
                                    patch)

    patching-tool revert            Uninstalls all the patches

    patching-tool info              Prints the current patch state of the
                                    application server

DESCRIPTION
    Liferay Patching Tool is a program which handles the patching of Liferay
    products.

    You need to shut down the application server which runs the Liferay instance
    before using this tool because the server might lock some of the files and
    the patching process would fail unfinished.

COMMANDS - Run: patching-tool help <command_name> for detailed information
    auto-discovery:      Automatically configures the Patching Tool
    help:                Shows this message
    info:                Gives information about the patch level
    install:             Installs patches which are in the patches directory
    modules-info:        Gives information about the deployed OSGi modules
    revert:              Removes all patches installed
    server-status:       Runs a script to check if the server is running
    setup:               Updates portal configuration of the Patching Tool
    support-info:        Runs the commands: info, list-plugins,
                                            list-customizations, 
                                            list-collisions, system-info
    system-info:         Prints system information
    version:             Prints the version of the tool

CONFIGURATION
    In case "auto-discovery" is not applicable in your environment or you would
    like to use different configurations, you can add a configuration manually.

    Create a text file with ".properties" extension in the Patching Tool's
    directory and add the following properties:

    war.path:            The path to the Liferay war file (original or unpacked
                         depending on your app. server's deploying methodolgy)
    global.lib.path:     The path to the application server's global lib
                         directory (where portal-kernel.jar [portal-service.jar
                         in Liferay 6] lives)
    liferay.home:        Specify the location where by default the data, osgi,
                         and tools folders reside.

	If auto-discovery found your Liferay Home folder, the location of Liferay's
	OSGi-based module framework can be calculated from this. If, however, you
	customized the folder structure, you'll have to specify manually the
	following properties:

    Example from a Tomcat installation:
        global.lib.path=../tomcat/webapps/ROOT/WEB-INF/shielded-container-lib/
        glowroot.path=../glowroot
        liferay.home=../
        tools.path=../tools/
        war.path=../tomcat/webapps/ROOT/

FURTHER DOCUMENTATION
    https://learn.liferay.com/en/w/dxp/installation-and-upgrades/maintaining-a-liferay-installation/reference/installing-the-patching-tool
    