Skip to content

Commit

Permalink
Merge pull request #5 from vroncevic/dev
Browse files Browse the repository at this point in the history
[samba_manager] Updated Dockerfile, docs
  • Loading branch information
vroncevic committed Jun 24, 2020
2 parents b4f62fc + 70de44d commit ba6c596
Show file tree
Hide file tree
Showing 8 changed files with 48 additions and 51 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright 2018 Vladimir Roncevic <elektron.ronca@gmail.com>
# Copyright 2015 Vladimir Roncevic <elektron.ronca@gmail.com>
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
33 changes: 16 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Samba server management.

***samba_manager*** is shell tool for control/operating Samba Server.
**samba_manager** is shell tool for control/operating Samba Server.

Developed in bash code: ***100%***.
Developed in [bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell)) code: **100%**.

The README is used to introduce the tool and provide instructions on
how to install the tool, any machine dependencies it may have and any
Expand All @@ -14,19 +14,19 @@ other information that should be provided before the tool is installed.
<!-- START doctoc -->
**Table of Contents**

- [Installation](https://github.com/vroncevic/samba_manager#installation)
- [Usage](https://github.com/vroncevic/samba_manager#usage)
- [Dependencies](https://github.com/vroncevic/samba_manager#dependencies)
- [Shell tool structure](https://github.com/vroncevic/samba_manager#shell-tool-structure)
- [Docs](https://github.com/vroncevic/samba_manager#docs)
- [Copyright and Licence](https://github.com/vroncevic/samba_manager#copyright-and-licence)
- [Installation](#installation)
- [Usage](#usage)
- [Dependencies](#dependencies)
- [Shell tool structure](#shell-tool-structure)
- [Docs](#docs)
- [Copyright and Licence](#copyright-and-licence)
<!-- END doctoc -->

### INSTALLATION

Navigate to release [page](https://github.com/vroncevic/samba_manager/releases) download and extract release archive.

To install modules type the following:
To install **samba_manager** type the following:

```
tar xvzf samba_manager-x.y.z.tar.gz
Expand Down Expand Up @@ -55,15 +55,14 @@ samba_manager version

### DEPENDENCIES

This tool requires these other modules and libraries:

* sh_util https://github.com/vroncevic/sh_util
**samba_manager** requires next modules and libraries:
* sh_util [https://github.com/vroncevic/sh_util](https://github.com/vroncevic/sh_util)

### SHELL TOOL STRUCTURE

***samba_manager*** is based on MOP.
**samba_manager** is based on MOP.

Shell tool structure:
Code structure:
```
.
├── bin/
Expand All @@ -86,14 +85,14 @@ Shell tool structure:
[![Documentation Status](https://readthedocs.org/projects/samba_manager/badge/?version=latest)](https://samba_manager.readthedocs.io/projects/samba_manager/en/latest/?badge=latest)

More documentation and info at:

* https://samba_manager.readthedocs.io/en/latest/
* [https://samba_manager.readthedocs.io/en/latest/](https://samba_manager.readthedocs.io/en/latest/)
* [https://www.gnu.org/software/bash/manual/](https://www.gnu.org/software/bash/manual/)

### 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)

Copyright (C) 2018 by https://vroncevic.github.io/samba_manager
Copyright (C) 2015 by [vroncevic.github.io/samba_manager](https://vroncevic.github.io/samba_manager)

This tool 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/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
Binary file not shown.
21 changes: 10 additions & 11 deletions docs/build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,9 @@ SAMBA_MANAGER

self

**samba_manager** is shell tool for controlling/operating Samba Server.

samba_manager is shell tool for control/operating Samba Server.

Developed in bash code: 100%.
Developed in `bash <https://en.wikipedia.org/wiki/Bash_(Unix_shell)>`_ code: **100%**.

The README is used to introduce the tool and provide instructions on
how to install the tool, any machine dependencies it may have and any
Expand All @@ -28,11 +27,12 @@ other information that should be provided before the tool is installed.

INSTALLATION
-------------

Navigate to release `page`_ download and extract release archive.

.. _page: https://github.com/vroncevic/samba_manager/releases

To install this set of modules type the following:
To install **samba_manager** type the following:

.. code-block:: bash
Expand All @@ -44,17 +44,16 @@ To install this set of modules type the following:
DEPENDENCIES
-------------
This tool requires these other modules and libraries:

.. code-block:: bash
sh_util https://github.com/vroncevic/sh_util
**samba_manager** requires next modules and libraries:
sh_util `https://github.com/vroncevic/sh_util <https://github.com/vroncevic/sh_util>`_

SHELL TOOL STRUCTURE
---------------------
samba_manager is based on MOP.

Shell tool structure:
**samba_manager** is based on MOP.

Code structure:

.. code-block:: bash
Expand Down Expand Up @@ -84,7 +83,7 @@ COPYRIGHT AND LICENCE
.. |License: Apache 2.0| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
:target: https://opensource.org/licenses/Apache-2.0

Copyright (C) 2018 by https://vroncevic.github.io/samba_manager
Copyright (C) 2015 by `vroncevic.github.io/samba_manager <https://vroncevic.github.io/samba_manager>`_

This tool 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
20 changes: 10 additions & 10 deletions docs/build/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,8 @@
<h1>SAMBA_MANAGER<a class="headerlink" href="#samba-manager" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
</div>
<p>samba_manager is shell tool for control/operating Samba Server.</p>
<p>Developed in bash code: 100%.</p>
<p><strong>samba_manager</strong> is shell tool for controlling/operating Samba Server.</p>
<p>Developed in <a class="reference external" href="https://en.wikipedia.org/wiki/Bash_(Unix_shell)">bash</a> code: <strong>100%</strong>.</p>
<p>The README is used to introduce the tool and provide instructions on
how to install the tool, any machine dependencies it may have and any
other information that should be provided before the tool is installed.</p>
Expand All @@ -158,7 +158,7 @@ <h1>SAMBA_MANAGER<a class="headerlink" href="#samba-manager" title="Permalink to
<div class="section" id="installation">
<h1>INSTALLATION<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h1>
<p>Navigate to release <a class="reference external" href="https://github.com/vroncevic/samba_manager/releases">page</a> download and extract release archive.</p>
<p>To install this set of modules type the following:</p>
<p>To install <strong>samba_manager</strong> type the following:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>tar xvzf samba_manager-x.y.z.tar.gz
<span class="nb">cd</span> samba_manager-x.y.z
cp -R ~/sh_tool/bin/ /root/scripts/samba_manager/ver.1.0/
Expand All @@ -169,15 +169,15 @@ <h1>INSTALLATION<a class="headerlink" href="#installation" title="Permalink to t
</div>
<div class="section" id="dependencies">
<h1>DEPENDENCIES<a class="headerlink" href="#dependencies" title="Permalink to this headline"></a></h1>
<p>This tool requires these other modules and libraries:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sh_util https://github.com/vroncevic/sh_util
</pre></div>
</div>
<dl class="docutils">
<dt><strong>samba_manager</strong> requires next modules and libraries:</dt>
<dd>sh_util <a class="reference external" href="https://github.com/vroncevic/sh_util">https://github.com/vroncevic/sh_util</a></dd>
</dl>
</div>
<div class="section" id="shell-tool-structure">
<h1>SHELL TOOL STRUCTURE<a class="headerlink" href="#shell-tool-structure" title="Permalink to this headline"></a></h1>
<p>samba_manager is based on MOP.</p>
<p>Shell tool structure:</p>
<p><strong>samba_manager</strong> is based on MOP.</p>
<p>Code structure:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>.
├── bin/
│   ├── nmb_operation.sh
Expand All @@ -198,7 +198,7 @@ <h1>SHELL TOOL STRUCTURE<a class="headerlink" href="#shell-tool-structure" title
<div class="section" id="copyright-and-licence">
<h1>COPYRIGHT AND LICENCE<a class="headerlink" href="#copyright-and-licence" title="Permalink to this headline"></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>Copyright (C) 2018 by <a class="reference external" href="https://vroncevic.github.io/samba_manager">https://vroncevic.github.io/samba_manager</a></p>
<p>Copyright (C) 2015 by <a class="reference external" href="https://vroncevic.github.io/samba_manager">vroncevic.github.io/samba_manager</a></p>
<p>This tool 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,
at your option, any later version of Bash 4 you may have available.</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/searchindex.js

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

21 changes: 10 additions & 11 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,9 @@ SAMBA_MANAGER

self

**samba_manager** is shell tool for controlling/operating Samba Server.

samba_manager is shell tool for control/operating Samba Server.

Developed in bash code: 100%.
Developed in `bash <https://en.wikipedia.org/wiki/Bash_(Unix_shell)>`_ code: **100%**.

The README is used to introduce the tool and provide instructions on
how to install the tool, any machine dependencies it may have and any
Expand All @@ -28,11 +27,12 @@ other information that should be provided before the tool is installed.

INSTALLATION
-------------

Navigate to release `page`_ download and extract release archive.

.. _page: https://github.com/vroncevic/samba_manager/releases

To install this set of modules type the following:
To install **samba_manager** type the following:

.. code-block:: bash
Expand All @@ -44,17 +44,16 @@ To install this set of modules type the following:
DEPENDENCIES
-------------
This tool requires these other modules and libraries:

.. code-block:: bash
sh_util https://github.com/vroncevic/sh_util
**samba_manager** requires next modules and libraries:
sh_util `https://github.com/vroncevic/sh_util <https://github.com/vroncevic/sh_util>`_

SHELL TOOL STRUCTURE
---------------------
samba_manager is based on MOP.

Shell tool structure:
**samba_manager** is based on MOP.

Code structure:

.. code-block:: bash
Expand Down Expand Up @@ -84,7 +83,7 @@ COPYRIGHT AND LICENCE
.. |License: Apache 2.0| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
:target: https://opensource.org/licenses/Apache-2.0

Copyright (C) 2018 by https://vroncevic.github.io/samba_manager
Copyright (C) 2015 by `vroncevic.github.io/samba_manager <https://vroncevic.github.io/samba_manager>`_

This tool 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

0 comments on commit ba6c596

Please sign in to comment.