linux help命令编写,Linux shell命令帮助格式详解
前言
linux shell命令通常可以通过-h或--help来打印帮助说明,或者通过man命令来查看帮助,有时候我们也会给自己的程序写简单的帮助说明,其实帮助说明格式是有规律可循的
帮助示例
下面是git reset命令的帮助说明,通过man git-reset可以查看
git reset [-q] [] [--] ...
git reset (--patch | -p) [] [--] [...]
git reset [--soft | --mixed | --hard | --merge | --keep] [-q] []
对于命令和参数大致有如下几种类型
没有任何修饰符参数 : 原生参数
<> : 占位参数
[] : 可选组合
() : 必选组合
| : 互斥参数
... : 可重复指定前一个参数
-- : 标记后续参数类型
下面来一一介绍
参数类型解读
原生参数
说明文档里的字符即为命令需要使用的字符,比如以上命令的
git reset
这种参数在使用时必需指定,且和说明文档里的一致
占位参数
表示方式: <>
和原生参数类似,都是必需指定的,只不过占位参数的实际字符是在使用时指定的,同时为了方便阅读会用一个描述词汇来表示,并以<>包围,比如
表示路径,使用时可以指定为具体的路径,而paths只是起一个说明作用,有些帮助说明里也会用大写来表示占位参数,比如将以上参数说明写成PATHS
可选组合
表示方式: []
括号里的参数为可选参数,比如usage第二个里面的[-q],则-q为可选参数
可选项和占位参数也可以同时使用,如
[]
表示该参数可以指定某次提交,也可以不指定
必选组合
表示方式: ()
括号里的参数必需指定,通常里面会是一些互斥参数,比如
(--patch | -p)
表示--patch和-p这两个参数必需指定一个
互斥参数
表示方式: |
互斥参数一般都在()和[]里,表示该参数只能指定其中一个,比如
[--mixed | --soft | --hard | --merge | --keep]
重复参数
表示方式:...
表示前一个参数可以被指定多个,比如
...
是一个占位参数,使用时必需指定为路径,...并表示可以指定多个路径。重复参数的一个典型使用场景就是移动文件,将多个文件移动到一个目录下,比如如下命令
git mv [] ...
我们可以这样使用
git mv -f a.cpp b.py dir
此时options对应为-f参数,source对应为a.cpp b.py,destination对应为dir
标记后续参数类型
表示方式: --
表示后续参数的某种类型,比如这里如果使用如下命令
git reset -p -- xx
对比第一个命令,这里的xx对应的应该是参数,当我们指定--之后,则git会认为xx就是一个路径,那怕它是特殊符号或者路径并不存在。这是shell命令的一个通用方式,比如我们有一个文件名为-h,如果想删除这个文件,执行
rm -h
肯定是无法删除的,因为这时-h会被认为是rm的一个参数选项,应该使用
rm -- -h
这时shell会将-h解释为一个文件名传递给rm命令
解读实战
最后来解释一个比较复杂的帮助说明
git cat-file (-t [--allow-unknown-type]|-s [--allow-unknown-type]|-e|-p||--textconv)
该命令参数由四个部分,其中git和cat-file为原生参数,()里的为可选组合, 为占位参数
组合又由6部分组成,为互斥关系
-t [--allow-unknown-type]
-s [--allow-unknown-type]
-e
-p
--textconv
因此该命令的帮助说明可以拆分如下
git cat-file -t
git cat-file -t --allow-unknown-type
git cat-file -s
git cat-file -s --allow-unknown-type
git cat-file -e
git cat-file -p
git cat-file
git cat-file --textconv
总结
以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作能带来一定的帮助,如果有疑问大家可以留言交流。
linux help命令编写,Linux shell命令帮助格式详解相关推荐
- 【Linux网络编程】TCP 和 UDP 数据报格式详解
TCP 报文格式 TCP(Transmission Control Protocol 传输控制协议)是一种面向连接的.可靠的.基于字节流的传输层通信协议. TCP 报文段的报头有 10 个必需的字段和 ...
- Linux学习系列五:Shell命令脚本的基本语法
这个系列的Linux教程主要参考刘遄老师的<Linux就该这么学>.用的系统是RHEL8,如果遇见一些命令出现问题,请首先检查自己的系统是否一致,如果不一致,可网上查一下系统间某些命令之间 ...
- Linux 基础操作、常用shell命令、vi常用命令、man帮助手册
Linux 基础操作.常用shell命令.vi常用命令.man帮助手册 一.简述 记录简单的Linux 基础操作.常用shell命令.vi编辑器常用命令.man帮助手册的使用. 二.Linux 基础操 ...
- 【转载】Linux命令-自动挂载文件/etc/fstab功能详解[转]
博客园 首页 新随笔 联系 订阅 管理 随笔 - 322 文章 - 0 评论 - 19 Linux命令-自动挂载文件/etc/fstab功能详解[转] 一./etc/fstab文件的作用 ...
- php fping,【Linux 命令】fping ping 包间隔时间详解
服务器间检查会用到fping的命令,期间遇到了一个问题,需要将ping包间的间隔时间设置为100毫秒,查看fping -h看下,找到了-i和-p两个参数: 看到这两个参数,我当时的表情是这样的: 看不 ...
- linux使用vscode运行c,Linux中使用VS Code编译调试C++项目详解
前言 关于VS Code在Linux下的安装这里就不提了,不管是CentOS还是Ubuntu,如果不懂且搜问题足够的情况下,你会解决的. 一.前置知识--gcc/g++的编译链接过程 在Windows ...
- linux系统四个组成部分,Linux系统由哪几部分组成?系统详解(干货)
原标题:Linux系统由哪几部分组成?系统详解(干货) 我们常说的Linux一般指的是系统内核,基于Linux系统内核的操作系统叫Linux发行版操作系统,像redhat.centos.ubuntu和 ...
- 技巧:Linux 动态库与静态库制作及使用详解
http://www.ibm.com/developerworks/cn/linux/l-cn-linklib/ 技巧:Linux 动态库与静态库制作及使用详解 标准库的三种连接方式及静态库制作与使用 ...
- linux输出文件没有找到,Linux环境下标准输入、输出、错误信息详解
Linux环境下标准输入.输出.错误信息详解 下面我们介绍在Linux环境下标准输入.输出.错误设备.标准输入设备代号为0, 用来显示输入信息,标准输出设备代号为1,用来显示正常信息,标准错误设备代号 ...
- Ffmpeg快速命令使用 Ffmpeg选项详解 Ffmepg格式详解 常见视频文件格式详解
http://www.ffmpeg.com.cn/index.php/%E9%A6%96%E9%A1%B5 Ffmpeg快速命令使用 From Ffmpeg工程组 Jump to: navigatio ...
最新文章
- 小波的秘密9_图像处理应用:图像增强
- mysql修改存储引擎报错_MySQL查看修改存储引擎总结
- wxWidgets:制作渲染循环
- 设计模式之间的关联关系和对比
- ubuntu让/etc/hosts修改后立刻生效
- c语言EOF0x99,C语言选择题99道.doc
- 域内计算机策略应用顺序
- python 获取当前目录,上级目录,上上级目录,N级目录
- python文件目录操作-2
- erdas2015几何校正模块在哪_几何校正和正射校正,怎样用erdas做几何校正?
- C语言格式化输出函数printf详解——C语言基础知识
- 触动小精灵似乎已断开与互联网的连接解决方法
- unity python做热更_Unity热更方案汇总
- Git Clone时报错解决方法
- 微信开发必备工具:利用cpolar在公网上测试本地Web网站或移动应用程序
- 登录网络计算机提示用户名错误,局域网访问共享时提示登录失败:未知的用户名或错误密码 怎么回事...
- 洛谷P1001题解--zhengjun
- C语言free空空指针,dmc: Dynamic Memory Check (DMC) , 解决C语言空指针、悬空指针、越界访问、野指针问题的一个方案。...
- ORACLE 培训教程(1)
- XP sp3共享最大连接数修改工具 EvID4226Patch.exe
热门文章
- 什么是 ecommerce 的 distributor 概念以及如何实现 website redirect
- SAP Spartacus 默认路由配置的工作原理
- Spring Beans 自动装配
- SAP Commerce(原Hybris)的订单处理框架和SAP CRM One Order框架
- All cached global options setting for WordPress
- where is ConstraintViolationException raised
- Spark集群的启动日志
- 使用Excel导入数据到SAP Cloud for Customer系统
- 使用Cloud Application Programming模型开发OData的一个实际例子
- hybris commerce storefront的产品搜索功能