Skip to content

[gen_man] Update display logo, version, docs #21

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

Merged
vroncevic merged 1 commit into from
Dec 11, 2025
Merged

[gen_man] Update display logo, version, docs #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 7 additions & 7 deletions Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,12 @@ RUN rm -Rf v1.0.zip sh_util-1.0
RUN mkdir /sh_tool/
COPY sh_tool /sh_tool/
RUN find /sh_tool/ -name "*.editorconfig" -type f -exec rm -Rf {} \;
RUN mkdir -p /root/scripts/gen_man/ver.3.0/
RUN mkdir -p /root/scripts/gen_man/ver.4.0/
RUN mkdir /root/bin/
RUN cp -R /sh_tool/bin/ /root/scripts/gen_man/ver.3.0/
RUN cp -R /sh_tool/conf/ /root/scripts/gen_man/ver.3.0/
RUN cp -R /sh_tool/log/ /root/scripts/gen_man/ver.3.0/
RUN cp -R /sh_tool/bin/ /root/scripts/gen_man/ver.4.0/
RUN cp -R /sh_tool/conf/ /root/scripts/gen_man/ver.4.0/
RUN cp -R /sh_tool/log/ /root/scripts/gen_man/ver.4.0/
RUN rm -Rf /sh_tool/
RUN chmod -R 755 /root/scripts/gen_man/ver.3.0/
RUN ln -s /root/scripts/gen_man/ver.3.0/bin/gen_man.sh /root/bin/gen_man
RUN tree /root/scripts/gen_man/ver.3.0/
RUN chmod -R 755 /root/scripts/gen_man/ver.4.0/
RUN ln -s /root/scripts/gen_man/ver.4.0/bin/gen_man.sh /root/bin/gen_man
RUN tree /root/scripts/gen_man/ver.4.0/
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ Navigate to release **[page](https://github.com/vroncevic/gen_man/releases)** do
To install **gen_man** type the following:

```bash
tar xvzf gen_man-3.0.tar.gz
cd gen_man-3.0
cp -R ~/sh_tool/bin/ /root/scripts/gen_man/ver.3.0/
cp -R ~/sh_tool/conf/ /root/scripts/gen_man/ver.3.0/
cp -R ~/sh_tool/log/ /root/scripts/gen_man/ver.3.0/
tar xvzf gen_man-4.0.tar.gz
cd gen_man-4.0
cp -R ~/sh_tool/bin/ /root/scripts/gen_man/ver.4.0/
cp -R ~/sh_tool/conf/ /root/scripts/gen_man/ver.4.0/
cp -R ~/sh_tool/log/ /root/scripts/gen_man/ver.4.0/
```

![alt tag](https://raw.githubusercontent.com/vroncevic/gen_man/dev/docs/setup_tree.png)
Expand All @@ -49,7 +49,7 @@ Or You can use docker to create image/container.

```bash
# Create symlink for shell tool
ln -s /root/scripts/gen_man/ver.3.0/bin/gen_man.sh /root/bin/gen_man
ln -s /root/scripts/gen_man/ver.4.0/bin/gen_man.sh /root/bin/gen_man

# Setting PATH
export PATH=${PATH}:/root/bin/
Expand Down Expand Up @@ -95,7 +95,7 @@ More documentation and info at:

### Copyright and licence

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-4.0) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

Copyright (C) 2017 - 2026 by [vroncevic.github.io/gen_man](https://vroncevic.github.io/gen_man)

Expand Down
Binary file modified docs/build/doctrees/environment.pickle
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
View file
Open in desktop
Binary file not shown.
12 changes: 6 additions & 6 deletions docs/build/html/_sources/index.rst.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ To install **gen_man** type the following:

.. code-block:: bash

tar xvzf gen_man-3.0.tar.gz
cd gen_man-3.0
cp -R ~/sh_tool/bin/ /root/scripts/gen_man/ver.3.0/
cp -R ~/sh_tool/conf/ /root/scripts/gen_man/ver.3.0/
cp -R ~/sh_tool/log/ /root/scripts/gen_man/ver.3.0/
tar xvzf gen_man-4.0.tar.gz
cd gen_man-4.0
cp -R ~/sh_tool/bin/ /root/scripts/gen_man/ver.4.0/
cp -R ~/sh_tool/conf/ /root/scripts/gen_man/ver.4.0/
cp -R ~/sh_tool/log/ /root/scripts/gen_man/ver.4.0/

Or You can use Docker to create image/container.

Expand Down Expand Up @@ -84,7 +84,7 @@ Copyright and licence
|License: GPL v3| |License: Apache 2.0|

.. |License: GPL v3| image:: https://img.shields.io/badge/License-GPLv3-blue.svg
:target: https://www.gnu.org/licenses/gpl-3.0
:target: https://www.gnu.org/licenses/gpl-4.0

.. |License: Apache 2.0| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
:target: https://opensource.org/licenses/Apache-2.0
Expand Down
12 changes: 6 additions & 6 deletions docs/build/html/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@ <h1>gen_man<a class="headerlink" href="#gen-man" title="Link to this heading">¶
<h1>Installation<a class="headerlink" href="#installation" title="Link to this heading">¶</a></h1>
<p>Navigate to release <a class="reference external" href="https://github.com/vroncevic/gen_man/releases">page</a> download and extract release archive.</p>
<p>To install <strong>gen_man</strong> type the following:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>tar<span class="w"> </span>xvzf<span class="w"> </span>gen_man-3.0.tar.gz
<span class="nb">cd</span><span class="w"> </span>gen_man-3.0
cp<span class="w"> </span>-R<span class="w"> </span>~/sh_tool/bin/<span class="w"> </span>/root/scripts/gen_man/ver.3.0/
cp<span class="w"> </span>-R<span class="w"> </span>~/sh_tool/conf/<span class="w"> </span>/root/scripts/gen_man/ver.3.0/
cp<span class="w"> </span>-R<span class="w"> </span>~/sh_tool/log/<span class="w"> </span>/root/scripts/gen_man/ver.3.0/
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>tar<span class="w"> </span>xvzf<span class="w"> </span>gen_man-4.0.tar.gz
<span class="nb">cd</span><span class="w"> </span>gen_man-4.0
cp<span class="w"> </span>-R<span class="w"> </span>~/sh_tool/bin/<span class="w"> </span>/root/scripts/gen_man/ver.4.0/
cp<span class="w"> </span>-R<span class="w"> </span>~/sh_tool/conf/<span class="w"> </span>/root/scripts/gen_man/ver.4.0/
cp<span class="w"> </span>-R<span class="w"> </span>~/sh_tool/log/<span class="w"> </span>/root/scripts/gen_man/ver.4.0/
</pre></div>
</div>
<p>Or You can use Docker to create image/container.</p>
Expand Down Expand Up @@ -85,7 +85,7 @@ <h1>Shell tool structure<a class="headerlink" href="#shell-tool-structure" title
</section>
<section id="copyright-and-licence">
<h1>Copyright and licence<a class="headerlink" href="#copyright-and-licence" title="Link to this heading">¶</a></h1>
<p><a class="reference external" href="https://www.gnu.org/licenses/gpl-3.0"><img alt="License: GPL v3" src="https://img.shields.io/badge/License-GPLv3-blue.svg" /></a> <a class="reference external" href="https://opensource.org/licenses/Apache-2.0"><img alt="License: Apache 2.0" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" /></a></p>
<p><a class="reference external" href="https://www.gnu.org/licenses/gpl-4.0"><img alt="License: GPL v3" src="https://img.shields.io/badge/License-GPLv3-blue.svg" /></a> <a class="reference external" href="https://opensource.org/licenses/Apache-2.0"><img alt="License: Apache 2.0" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" /></a></p>
<p>Copyright (C) 2017 - 2026 by <a class="reference external" href="https://vroncevic.github.io/gen_man">vroncevic.github.io/gen_man</a></p>
<p><strong>gen_man</strong> is free software; you can redistribute it and/or modify it
under the same terms as Bash itself, either Bash version 4.2.47 or,
Expand Down
Binary file modified docs/build/html/objects.inv
View file
Open in desktop
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/searchindex.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
project: str = 'gen_man'
project_copyright: str = '2026, Vladimir Roncevic <elektron.ronca@gmail.com>'
author: str = 'Vladimir Roncevic <elektron.ronca@gmail.com>'
version: str = '3.0'
version: str = '4.0'
release: str = 'https://github.com/vroncevic/gen_man/releases'
extensions: List[str] = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
templates_path: List[str] = ['_templates']
Expand Down
12 changes: 6 additions & 6 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ To install **gen_man** type the following:

.. code-block:: bash

tar xvzf gen_man-3.0.tar.gz
cd gen_man-3.0
cp -R ~/sh_tool/bin/ /root/scripts/gen_man/ver.3.0/
cp -R ~/sh_tool/conf/ /root/scripts/gen_man/ver.3.0/
cp -R ~/sh_tool/log/ /root/scripts/gen_man/ver.3.0/
tar xvzf gen_man-4.0.tar.gz
cd gen_man-4.0
cp -R ~/sh_tool/bin/ /root/scripts/gen_man/ver.4.0/
cp -R ~/sh_tool/conf/ /root/scripts/gen_man/ver.4.0/
cp -R ~/sh_tool/log/ /root/scripts/gen_man/ver.4.0/

Or You can use Docker to create image/container.

Expand Down Expand Up @@ -84,7 +84,7 @@ Copyright and licence
|License: GPL v3| |License: Apache 2.0|

.. |License: GPL v3| image:: https://img.shields.io/badge/License-GPLv3-blue.svg
:target: https://www.gnu.org/licenses/gpl-3.0
:target: https://www.gnu.org/licenses/gpl-4.0

.. |License: Apache 2.0| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
:target: https://opensource.org/licenses/Apache-2.0
Expand Down
39 changes: 19 additions & 20 deletions sh_tool/bin/create_man.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/bash
#
# @brief Creating Man Page
# @version ver.3.0
# @version ver.4.0
# @date Tue Feb 7 08:49:43 CET 2017
# @company None, free software to use 2017
# @author Vladimir Roncevic <elektron.ronca@gmail.com>
Expand All @@ -11,11 +11,10 @@ UTIL_VERSION=ver.1.0
UTIL=${UTIL_ROOT}/sh_util/${UTIL_VERSION}
UTIL_LOG=${UTIL}/log

. ${UTIL}/bin/devel.sh
. ${UTIL}/bin/usage.sh

GEN_MAN_TOOL=gen_man
GEN_MAN_VERSION=ver.3.0
GEN_MAN_VERSION=ver.4.0
GEN_MAN_HOME=${UTIL_ROOT}/${GEN_MAN_TOOL}/${GEN_MAN_VERSION}

declare -A GEN_MAN_CREATE_USAGE=(
Expand Down Expand Up @@ -51,23 +50,23 @@ declare -A GEN_MAN_CREATE_USAGE=(
function __create_man {
local MFILE=$1 MT=$2 AUTHOR=$3
local FUNC=${FUNCNAME[0]} MSG="None" DATE=`date` ML
if [[ -n "${MFILE}" && -n "${MT}" && -n "${AUTHOR}" ]]; then
MSG="Creating man page!"
info_debug_message "$MSG" "$FUNC" "$GEN_MAN_TOOL"
local MTF="${GEN_MAN_HOME}/conf/${MT}"
MSG="Generating file [${MFILE}.1]"
info_debug_message "$MSG" "$FUNC" "$GEN_MAN_TOOL"
while read ML
do
eval echo "${ML}" >> ${MFILE}.1
done < ${MTF}
MSG="Set permission!"
info_debug_message "$MSG" "$FUNC" "$GEN_MAN_TOOL"
eval "chmod 755 ${MFILE}.1"
info_debug_message_end "Done" "$FUNC" "$GEN_MAN_TOOL"
return $SUCCESS
if [[ -z "${MFILE}" || -z "${MT}" || -z "${AUTHOR}" ]]; then
usage GEN_MAN_CREATE_USAGE
return $NOT_SUCCESS
fi
usage GEN_MAN_CREATE_USAGE
return $NOT_SUCCESS
MSG="Creating man page!"
info_debug_message "$MSG" "$FUNC" "$GEN_MAN_TOOL"
local MTF="${GEN_MAN_HOME}/conf/${MT}"
MSG="Generating file [${MFILE}.1]"
info_debug_message "$MSG" "$FUNC" "$GEN_MAN_TOOL"
while read ML
do
eval echo "${ML}" >> ${MFILE}.1
done < ${MTF}
MSG="Set permission!"
info_debug_message "$MSG" "$FUNC" "$GEN_MAN_TOOL"
eval "chmod 755 ${MFILE}.1"
info_debug_message_end "Done" "$FUNC" "$GEN_MAN_TOOL"
return $SUCCESS
}

121 changes: 63 additions & 58 deletions sh_tool/bin/gen_man.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/bash
#
# @brief Generate and install man page
# @version ver.3.0
# @version ver.4.0
# @date Tue Feb 7 08:49:43 CET 2017
# @company None, free software to use 2017
# @author Vladimir Roncevic <elektron.ronca@gmail.com>
Expand All @@ -11,8 +11,6 @@ UTIL_VERSION=ver.1.0
UTIL=${UTIL_ROOT}/sh_util/${UTIL_VERSION}
UTIL_LOG=${UTIL}/log

. ${UTIL}/bin/devel.sh
. ${UTIL}/bin/usage.sh
. ${UTIL}/bin/check_root.sh
. ${UTIL}/bin/check_tool.sh
. ${UTIL}/bin/logging.sh
Expand All @@ -22,7 +20,7 @@ UTIL_LOG=${UTIL}/log
. ${UTIL}/bin/display_logo.sh

GEN_MAN_TOOL=gen_man
GEN_MAN_VERSION=ver.3.0
GEN_MAN_VERSION=ver.4.0
GEN_MAN_HOME=${UTIL_ROOT}/${GEN_MAN_TOOL}/${GEN_MAN_VERSION}
GEN_MAN_CFG=${GEN_MAN_HOME}/conf/${GEN_MAN_TOOL}.cfg
GEN_MAN_UTIL_CFG=${GEN_MAN_HOME}/conf/${GEN_MAN_TOOL}_util.cfg
Expand Down Expand Up @@ -53,6 +51,13 @@ declare -A PB_STRUCTURE=(
[SLEEP]=0.01
)

declare -A GEN_MAN_LOGO_DATA=(
[OWNER]="vroncevic"
[REPO]="${GEN_MAN_TOOL}"
[VERSION]="${GEN_MAN_VERSION}"
[LOGO]="${GEN_MAN_LOGO}"
)

TOOL_DBG="false"
TOOL_LOG="false"
TOOL_NOTIFY="false"
Expand Down Expand Up @@ -82,69 +87,69 @@ TOOL_NOTIFY="false"
#
function __gen_man {
local OP=$1 MFILE=$2
if [[ -n "${OP}" && -n "${MFILE}" ]]; then
display_logo "vroncevic" "${GEN_MAN_TOOL}" "${GEN_MAN_VERSION}" "${GEN_MAN_LOGO}"
local FUNC=${FUNCNAME[0]} MSG="None"
local STATUS_CONF STATUS_CONF_UTIL STATUS
MSG="Loading basic and util configuration!"
info_debug_message "$MSG" "$FUNC" "$GEN_MAN_TOOL"
progress_bar PB_STRUCTURE
declare -A config_gen_man=()
load_conf "$GEN_MAN_CFG" config_gen_man
STATUS_CONF=$?
declare -A config_gen_man_util=()
load_util_conf "$GEN_MAN_UTIL_CFG" config_gen_man_util
STATUS_CONF_UTIL=$?
declare -A STATUS_STRUCTURE=(
[1]=$STATUS_CONF [2]=$STATUS_CONF_UTIL
)
check_status STATUS_STRUCTURE
if [[ -z "${OP}" || -z "${MFILE}" ]]; then
usage GEN_MAN_USAGE
exit 128
fi
display_logo GEN_MAN_LOGO_DATA
local FUNC=${FUNCNAME[0]} MSG="None"
local STATUS_CONF STATUS_CONF_UTIL STATUS
MSG="Loading basic and util configuration!"
info_debug_message "$MSG" "$FUNC" "$GEN_MAN_TOOL"
progress_bar PB_STRUCTURE
declare -A config_gen_man=()
load_conf "$GEN_MAN_CFG" config_gen_man
STATUS_CONF=$?
declare -A config_gen_man_util=()
load_util_conf "$GEN_MAN_UTIL_CFG" config_gen_man_util
STATUS_CONF_UTIL=$?
declare -A STATUS_STRUCTURE=(
[1]=$STATUS_CONF [2]=$STATUS_CONF_UTIL
)
check_status STATUS_STRUCTURE
STATUS=$?
if [ $STATUS -eq $NOT_SUCCESS ]; then
MSG="Force exit!"
info_debug_message_end "$MSG" "$FUNC" "$GEN_MAN_TOOL"
exit 129
fi
TOOL_LOG=${config_gen_man[LOGGING]}
TOOL_DBG=${config_gen_man[DEBUGGING]}
TOOL_NOTIFY=${config_gen_man[EMAILING]}
if [ "${OP}" == "create" ]; then
local MAN_PAGE=${config_gen_man_util[MAN_PAGE]}
local AUTHOR=${config_gen_man_util[AUTHOR]}
__create_man ${MFILE} ${MAN_PAGE} ${AUTHOR}
STATUS=$?
if [ $STATUS -eq $NOT_SUCCESS ]; then
MSG="Force exit!"
info_debug_message_end "$MSG" "$FUNC" "$GEN_MAN_TOOL"
exit 129
exit 130
fi
TOOL_LOG=${config_gen_man[LOGGING]}
TOOL_DBG=${config_gen_man[DEBUGGING]}
TOOL_NOTIFY=${config_gen_man[EMAILING]}
if [ "${OP}" == "create" ]; then
local MAN_PAGE=${config_gen_man_util[MAN_PAGE]}
local AUTHOR=${config_gen_man_util[AUTHOR]}
__create_man ${MFILE} ${MAN_PAGE} ${AUTHOR}
STATUS=$?
if [ $STATUS -eq $NOT_SUCCESS ]; then
MSG="Force exit!"
info_debug_message_end "$MSG" "$FUNC" "$GEN_MAN_TOOL"
exit 130
fi
MSG="Created MAN Page: ${MFILE}.1"
GEN_MAN_LOGGING[LOG_MSGE]=$MSG
logging GEN_MAN_LOGGING
elif [ "${OP}" == "install" ]; then
local INSTALL=${config_gen_man_util[INSTALL]}
local HPAGES=${config_gen_man_util[MAN_HOME_PAGES]}
__install_man ${MFILE} ${INSTALL} ${HPAGES}
STATUS=$?
if [ $STATUS -eq $NOT_SUCCESS ]; then
MSG="Force exit!"
info_debug_message_end "$MSG" "$FUNC" "$GEN_MAN_TOOL"
exit 131
fi
MSG="Installed MAN Page: ${MFILE}.1"
GEN_MAN_LOGGING[LOG_MSGE]=$MSG
logging GEN_MAN_LOGGING
else
MSG="Not supported option [${OP}]"
info_debug_message "$MSG" "$FUNC" "$GEN_MAN_TOOL"
MSG="Created MAN Page: ${MFILE}.1"
GEN_MAN_LOGGING[LOG_MSGE]=$MSG
logging GEN_MAN_LOGGING
elif [ "${OP}" == "install" ]; then
local INSTALL=${config_gen_man_util[INSTALL]}
local HPAGES=${config_gen_man_util[MAN_HOME_PAGES]}
__install_man ${MFILE} ${INSTALL} ${HPAGES}
STATUS=$?
if [ $STATUS -eq $NOT_SUCCESS ]; then
MSG="Force exit!"
info_debug_message_end "$MSG" "$FUNC" "$GEN_MAN_TOOL"
exit 132
exit 131
fi
exit 0
MSG="Installed MAN Page: ${MFILE}.1"
GEN_MAN_LOGGING[LOG_MSGE]=$MSG
logging GEN_MAN_LOGGING
else
MSG="Not supported option [${OP}]"
info_debug_message "$MSG" "$FUNC" "$GEN_MAN_TOOL"
MSG="Force exit!"
info_debug_message_end "$MSG" "$FUNC" "$GEN_MAN_TOOL"
exit 132
fi
usage GEN_MAN_USAGE
exit 128
exit 0
}

#
Expand Down
Loading