# how

**Repository Path**: fuckpy/how

## Basic Information

- **Project Name**: how
- **Description**: 📝 Impressive Linux commands cheat sheet (Python).
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-03-11
- **Last Updated**: 2021-03-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
    <img src="https://user-images.githubusercontent.com/19553554/61995478-bd21e980-b0bb-11e9-8206-5a5958e27b25.png" alt="Linux logo" width=180 />
</p>

<h1 align="center">📝 how</h1>
<p align="center">
    <em>Impressive Linux commands cheat sheet.</em>
</p>

<p align="center">
    <a href="https://badge.fury.io/py/how">
        <img src="https://badge.fury.io/py/how.svg" alt="PyPI - Python Version">
    </a>
    <a href="https://pypi.org/project/how/">
        <img src="https://img.shields.io/pypi/pyversions/how.svg?colorB=brightgreen" alt="PyPI - Python Version">
    </a>
    <a href="https://opensource.org/licenses/MIT">
        <img src="https://img.shields.io/badge/License-MIT-brightgreen.svg" alt="MIT License">
    </a>
</p>

### 💡 IDEA

Linux 是每位开发者必备的技能，如何高效地掌握 Linux 命令就成为一件很重要的事了。[jaywcjlove/linux-command](https://github.com/jaywcjlove/linux-command) 项目收集和整理了 500+ 的 Linux 命令使用文档，不过缺少了一个命令行版本，`how` 决定来填补这个空缺。

* Golang 版本: [chenjiandongx/pls](https://github.com/chenjiandongx/pls)

### 🔰 安装

**pip 安装**
```bash
$ pip install how
```

**源码安装**
```bash
$ git clone https://github.com/chenjiandongx/how.git
$ cd how
$ pip install -r requirements.txt
$ python setup.py install
```

### 📏 使用

```bash
$ how
usage: how [-h] [-i] [-v] [COMMAND [COMMAND ...]]

Lovely Linux commands cheat sheet.

positional arguments:
  COMMAND        the puzzling command

optional arguments:
  -h, --help     show this help message and exit
  -i, --init     initialize all commands
  -v, --version  displays the current version of `how`
```

> Note: 建议第一次使用 `how` 时先初始化所有的命令文档，`how -i`，该命令会将 https://github.com/jaywcjlove/linux-command 的 .md 文档下载到 `~/.command` 本地路径下。不过这个操作不是必须的，因为如果 `how some-command` 在本地路径中查询不到的话，会尝试先向远程地址下载。

### 🔖 示例

初始化所有文档，同时也是更新所有文档的命令
```shell
$ how -i
Initializing commands: 96/562 
```

查询如何使用 `man` 命令
```shell
$ how man
# man

查看 Linux 中的指令帮助

##  补充说明

man 命令 是 Linux 下的帮助指令，通过 man 指令可以查看
Linux 中的指令帮助、配置文件帮助和编程帮助等信息。

###  语法

man(选项)(参数)

###  选项

-a：在所有的 man 帮助手册中搜索；
-f：等价于 whatis 指令，显示给定关键字的简短描述信息；
-P：指定内容时使用分页程序；
-M：指定 man 手册搜索的路径。

###  参数

- 数字：指定从哪本 man 手册中搜索帮助；
- 关键字：指定要搜索帮助的关键字。

###  数字代表内容

1：用户在 shell 环境可操作的命令或执行文件；
2：系统内核可调用的函数与工具等
3：一些常用的函数(function) 与函数库(library)，大部分为 C
的函数库(libc)
4：设备文件说明，通常在/dev 下的文件
5：配置文件或某些文件格式
6：游戏(games)
7：惯例与协议等，如 Linux 文件系统，网络协议，ASCII code
等说明
8：系统管理员可用的管理命令
9：跟 kernel 有关的文件

###  实例

我们输入 man ls，它会在最左上角显示“LS（1）”，在这里，“LS”表示手
册名称，而“（1）”表示该手册位于第一节章，同样，我们输 man
ifconfig
它会在最左上角显示“IFCONFIG（8）”。也可以这样输入命令：“man
[章节号] 手册名称”。

man 是按照手册的章节号的顺序进行搜索的，比如：

man sleep

只会显示 sleep 命令的手册,如果想查看库函数 sleep，就要输入:

man 3 sleep
```

### 📅 Changelog

#### V0.1.0 - 2019-07-28

* Alpha: 第一个正式版发布

### 📃 LICENSE

MIT [©chenjiandongx](https://github.com/chenjiandongx)