探究 Xcode 命令行用法一:Xcode 构建必备认知

本篇是 adat 项目的延伸文章,也是后续 Xcode 构建实操文章的铺垫,目的是让本系列的读者都有一个共同的认知,当读到某个章节时,不至于对某些概念产生疑惑。这些基础共识,如果你感觉有点模糊,请一定认真读完,如果已经具备,不妨再扫一眼,也许有惊喜哦。


内容概览

  • 命令行用法文档
  • 命令行使用手册
  • 如何利用文档写一条命令
  • Target、Configuration 和 Scheme 到底是什么东西?
  • Project、Workspace 又是什么东西?
  • xcodebuild 基础命令
  • 精彩预告

命令行用法文档

这里的 “用法” 取自英文的 “Usage”,是用法的简要形式。获取命令的 “用法文档” 取决于命令自身,因此没有固定的写法,工作经验告诉我们有下面几种常见写法(注意 <命令> 后有空格):

  • <命令> -h
  • <命令> help
  • <命令> --help
  • <命令> -usage

或者直接使用空命令尝试,如果命令出错,输出错误信息的同时一般会输出正确的用法。如果命令没有出错,表示该命令无需参数或使用了默认参数,可以通过阅读使用手册来获取。如果还是找不到,最后寻求官方网站的帮助。

示例,查看git命令的用法文档:

$ git --help

命令执行后,会将简要用法直接输出在当前界面:

$ git --help
usage: git [--version] [--help] [-C <path>] [-c <name>=<value>]
           [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]
           [-p | --paginate | -P | --no-pager] [--no-replace-objects] [--bare]
           [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]
           <command> [<args>]
...
See 'git help git' for an overview of the system.

用法文档适用于快速查看命令用法。比如工作中突然忘记了一些选项,或某些选项是组合单词太长,不确定是否输入正确,就可以快速看一眼,然后继续工作。


命令行使用手册

这里的 “使用手册” 取自英文的 “Manual”,是一种更为详细的文档形式。macOS 使用BSD General Commands Manual,一般包含NAMESYNOPSISDESCRIPTIONEXAMPLESSEE ALSO 等常用的部分。

含义 描述
NAME 名字 一句话描述命令的名称
SYNOPSIS 概要 遵循命令行语法的格式,列举常用功能对应的命令行写法
DESCRIPTION 描述 命令的详细说明,一一列举每个参数的名称、简写方式、意义、组合用法、注意点等,参数包括:选项 option、标记 flag、值 value
EXAMPLES 示例 实现某个功能的具体写法示例
SEE ALSO 参见 相关联的其他命令

使用方式:

man <命令>

示例,查看echo命令的使用手册:

$ man echo

命令执行后,自动切换到vim命令模式,并输出文档详情:

ECHO(1)    BSD General Commands Manual    ECHO(1)

NAME
     echo -- write arguments to the standard output

SYNOPSIS
     echo [-n] [string ...]

DESCRIPTION
     The echo utility writes any specified operands, separated by single blank (` ') characters and followed by a newline (`\n') character, to the standard output.

     The following option is available:

     -n    Do not print the trailing newline character.  This may also be achieved by appending `\c' to the end of the string, as is done by iBCS2 compatible systems.
...

SEE ALSO
     builtin(1), csh(1), printf(1), sh(1)
...

BSD    April 12, 2003    BSD
(END)

在命令模式下输入字母q退出命令模式,同时退出了使用手册界面。注意字母 q 输入成功后会立即退出。

尝试用 man git 获取使用手册,再用 git --help 获取用法文档,对比两者有何不同。

使用手册适用于学

  • 5
    点赞
  • 5
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值