当前仓库属于暂停状态,部分功能使用受限,详情请查阅 仓库状态说明
1 Star 2 Fork 5

maminjie / ola
暂停

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MulanPSL-2.0

1. 简介

ola(哦啦),对,不是euler(欧拉) -_-

ola实际上是我为openEuler写的一个shell脚本框架。

ola可以让你体会到shell脚本的优雅,当然,你可以不相信,反正我着迷了……

ola采用了面向过程的编程思想,除了简单的原因,还因为我曾经是一个 C-Coder ……

2. 目录

一级目录 二级目录 说明
ola.sh 命令入口
src apps 应用(命令)脚本
plugins 插件(命令)脚本
libs 库脚本,基于标准命令实现
utils 通用脚本,框架的核心
test 测试脚本

备注:utils和libs中的脚本都是通用的,可以广泛的用在别的项目中。

3. 使用

3.1. 开发

如何开发一个功能?以helloworld.sh为例,如下:

method_def helloworld

usage_helloworld() {
    echo "helloworld (hello): Hello to the world"
}

alias_def helloworld hello
do_helloworld() {
    echo "hello world"
}
  1. 一个功能必须定义两个函数:do_helloworld,usage_helloworld

    备注:

    • do_xxx和usage_xxx后面的名字必须一致
    • usage_xxx第一行是功能的简述,通过':'分割
  2. 一个功能通过method定义后才生效:method_def helloworld

    备注:

    • method定义的方法,最终在ola中以子命令的形式存在
  3. 一个功能别名通过alias定义:alias_def helloworld hello

    备注:

    • alias定义的别名,最终在ola中也以子命令的形式存在
    • ailas可以定义多个别名,比如:alias_def helloworld hello hw

3.2. 执行

通过执行ola.sh脚本来执行不同的功能。

  1. 查看所有帮助信息
bash ola.sh [-h|--help]
  1. 查看命令帮助信息
bash ola.sh h helloworld
bash ola.sh h hello
  1. 执行命令
bash ola.sh helloworld
bash ola.sh hello

3.3. 环境

功能中会使用一些非系统内嵌的命令,这些命令可能需要单独进行安装,通过下面命令可以检测当前系统中是否存在用到的相关命令:

bash ola.sh checkenv
bash ola.sh ce

3.4. 配置

有些命令需要先配置信息,ola的配置模板文件在config/ola.conf中,通过变量CONFIG_FILE指定配置文件。

ola提供了两个命令用来管理配置文件:init,set

bash ola.sh init
bash ola.sh set

init:初始化配置文件

set:设置/编辑配置文件

3.5. 参数

  1. 复数

    有的命令可能需要支持批量操作,一种是循环调用命令,另一种是支持复数参数(命令内部根据复数循环),参数一般使用空格进行分割,某个参数如果是复数也使用空格进行分割的话,将会和命令参数冲突,下面有两种方法解决冲突问题:

    1)将复数参数用双引号括起来当成一个命令参数,然后双引号内用空格分割,如:"a b c d"。

    2)将文件名当成一个命令参数,然后文件中保存批量数据,数据可以一行一个,也可以用空格分割每个数据,如:file1,内容如下:

    a b
    c
    d

    方法1)可以用来临时性的批量操作,比较快速和方便;方法2)可以固化命令格式,只需要根据实际修改文件内容。

    提示:目前批量数据必须是连续有效字符,不能中间出现空白字符,否则会被解析为多个数据。

3.6. 调试

  1. 正常shell程序的调试方法

    bash -x ola.sh ...
  2. 通过设置调试变量SH_DEBUG

    有一种更好的使用ola的方法是,在用户bin或系统bin目录下创建指向ola.sh的软连接ola,然后就可以在任意目录下像执行系统命令一样执行ola,如下所示:

    ln -s /xx/yy../ola.sh ola
    ...
    ola -h

    如果执行ola命令,那么就无法通过bash来执行ola,为了方便调试增加了调试变量SH_DEBUG,像如下方式执行,也可以进行调试:

    SH_DEBUG=1 ola ...

4. 结语

更多功能请自行解锁!

木兰宽松许可证, 第2版 木兰宽松许可证, 第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

简介

A fancy shell command-line tools framework 后续将维护shcanpool的projects/ola 展开 收起
Perl 等 3 种语言
MulanPSL-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/maminjie/ola.git
git@gitee.com:maminjie/ola.git
maminjie
ola
ola
master

搜索帮助