#!/usr/bin/env bash
# ------------------------------------------------------------------------------
# Copyright (c) 2013-2026 Geoffray Levasseur <fatalerrors@geoffray-levasseur.org>
# Protected by the BSD3 license. Please read bellow for details.
#
# * Redistribution and use in source and binary forms,
# * with or without modification, are permitted provided
# * that the following conditions are met:
# *
# *   Redistributions of source code must retain the above
# *   copyright notice, this list of conditions and the
# *   following disclaimer.
# *
# *   Redistributions in binary form must reproduce the above
# *   copyright notice, this list of conditions and the following
# *   disclaimer in the documentation and/or other materials
# *   provided with the distribution.
# *
# *   Neither the name of the copyright holder nor the names
# *   of any other contributors may be used to endorse or
# *   promote products derived from this software without
# *   specific prior written permission.
# *
# * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
# * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
# * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
# * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
# * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
# * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
# * OF SUCH DAMAGE.
# ------------------------------------------------------------------------------

# ------------------------------------------------------------------------------
# Display list of commands and general informations
# Usage: help
help()
{
    printf "clean\t\tErase backup files\n"
    printf "disp\t\tDisplay formatted info/warning/error/debug messages\n"
    printf "dwl\t\tDownload a URL to a local file\n"
    printf "expandlist\tExpand and quote item lists\n"
    printf "file_stats\tDisplay file size statistics for a path\n"
    printf "findbig\t\tFind biggest files in the given (or current) directory\n"
    printf "finddead\tFind dead symbolic links in the given (or current) directory\n"
    printf "findzero\tFind empty files in the given (or current) directory\n"
    printf "genpwd\t\tGenerate secure passwords\n"
    printf "gpid\t\tGive the list of PIDs for the given process name\n"
    printf "isipv4\t\tTell if the given IPv4 is valid\n"
    printf "isipv6\t\tTell if the given IPv6 is valid\n"
    printf "ku\t\tKill process owned by users in parameter\n"
    printf "matrix\t\tDisplay matrix-style digital rain\n"
    printf "mcd\t\tCreate a directory and go inside\n"
    printf "meteo\t\tDisplay current weather forecast for the configured city\n"
    printf "myextip\tDisplay current external/public IP\n"
    printf "pkgs\t\tSearch for the given package in installed ones\n"
    printf "ppg\t\tDisplay process matching the given parameter\n"
    printf "ppn\t\tDisplay process matching the exact process name given in parameter\n"
    printf "ppu\t\tDisplay processes owned by the given user\n"
    printf "rain\t\tLet the rain fall\n"
    printf "rmhost\t\tRemove host (IP and/or DNS name) from current known_hosts\n"
    printf "rmspc\t\tRemove spaces from file and directory names\n"
    printf "setlocale\tSet console language to the current locale\n"
    printf "   * setc\tSet console language to C\n"
    printf "   * setfr\tSet console language to French\n"
    printf "   * setus\tSet console language to US English\n"
    printf "settrace\tActivate/deactivate call trace for script debugging\n"
    printf "showinfo\tShow welcome banner with basic system information\n"
    printf "ssr\t\tDo a root login to the given address\n"
    printf "taz\t\tCompress smartly the given files or directory\n"
    printf "urlencode\tURL-encode the given text\n"
    printf "utaz\t\tUncompress archives in the given (or current) directory\n"
    printf "ver\t\tDisplay version of your copy of profile\n\n"

    printf "\nPlease use <command> --help to obtain usage details.\n"
}
export -f help
# ------------------------------------------------------------------------------


# EOF