Làm thế nào để làm cho `man` hoạt động cho các lệnh và từ khóa dựng sẵn shell?

Tôi sử dụng manlệnh mọi lúc khi tôi muốn nhận thông tin về một lệnh cụ thể. Nhưng điều này không giúp tôi quá nhiều khi lệnh cụ thể đó là một shell dựng sẵn. Ví dụ:

man cd

trả về:

No manual entry for cd

Câu hỏi của tôi là: nó có thể làm mancũng làm việc cho tất cả các lệnh shell được xây dựng trong (như cd, alias, history, vv), và từ khóa (như if, while, [[, {, vv)?

Các helplệnh khi được sử dụng với -mtùy chọn có thể hiển thị thông tin về lệnh dựng sẵn trong định dạng pseudo-manpage. Ví dụ:

help -m cd | less

sẽ hiển thị thông tin về cdlệnh theo định dạng gần như chính xác trong trang thủ công.

Bắt đầu từ lệnh này, bạn có thể gói manlệnh trong một chức năng trong .bashrctệp của mình như sau:

man () {
    case "$(type -t -- "$1")" in
    builtin|keyword)
        help -m "$1" | sensible-pager
        ;;
    *)
        command man "$@"
        ;;
    esac
}

Sau này mancũng sẽ hoạt động cho tất cả các lệnh và từ khóa dựng sẵn shell. Ví dụ:

man :

sẽ hiển thị:

NAME
    : - Null command.

SYNOPSIS
    :

DESCRIPTION
    Null command.

    No effect; the command does nothing.

    Exit Status:
    Always succeeds.

SEE ALSO
    bash(1)

IMPLEMENTATION
    GNU bash, version 4.2.45(1)-release (x86_64-pc-linux-gnu)
    Copyright (C) 2011 Free Software Foundation, Inc.
    License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>

man bash-builtins

Điều này chứa các đoạn trợ giúp cho các lệnh dựng sẵn, mặc dù ở định dạng cô đọng hơn một chút so với helptương đương.

Bạn có thể cài đặt các trang thủ công về việc sử dụng hệ thống POSIX để phát triển như,

sudo apt-get install manpages-posix-dev

Nó sẽ cung cấp các trang man cho các nội dung shell.

$ type cd
cd is a shell builtin

Bây giờ cố gắng,

$ man cd
CD(P)                      POSIX Programmer's Manual                      CD(P)

NAME
   cd - change the working directory

SYNOPSIS
   cd [-L | -P] [directory]


...

Giải pháp này hoạt động hoàn toàn tốt nhưng cũng là một trò đùa vì điều đầu tiên tôi nghĩ khi đọc câu hỏi của bạn là 'Ai vẫn thực sự sử dụng con người từ dòng lệnh? Không phải tất cả mọi người chỉ cần Google trang người đàn ông họ muốn (để họ có được những thứ ưa thích như cuộn không giới hạn)? '. Sau đó, tôi nhận ra rằng các trang web tôi Google thường có cả hai loại lệnh, vậy tại sao không sử dụng chúng để cung cấp giao diện trang thống nhất cho tất cả các lệnh. Do đó, niềm vui này đã được sinh ra.

Điều này đòi hỏi phải có kết nối Internet cho bất kỳ mục nào bạn chưa tìm kiếm ít nhất một lần. Nó cũng cần hai ứng dụng nhỏ bị thiếu trong bản cài đặt mặc định của Ubuntu:

 sudo apt-get install tidy html2text

Những thứ này không thực sự cần thiết nhưng chúng giúp làm cho nó trông đẹp hơn một chút. Tidy sẽ dọn dẹp HTML và html2text sẽ định dạng html đó dưới dạng văn bản được định dạng (thường khá tầm thường vì hầu hết các trang web này đã được định dạng văn bản và chỉ được bọc trong các thẻ <pre>.

Bây giờ tất cả những gì bạn cần làm là thêm phần này vào cuối ~/.profile:

function iman() {
    if [ ! -d "/usr/share/iman" ]; then
        sudo mkdir -m a=rwx /usr/share/iman
    fi
    if [ ! -f "/usr/share/iman/$1.html" ]; then
        curl "http://unixhelp.ed.ac.uk/CGI/man-cgi?$1"| tidy -n -asxml 2>/dev/null| html2text > "/usr/share/iman/$1.html"; 
    fi
    if [ -f "/usr/share/iman/$1.html" ]; then
        cat "/usr/share/iman/$1.html";
    else
        echo "Entry not found."
    fi
}

Sau khi bạn đăng xuất và sau đó quay lại, bạn sẽ có thể nhập này:

iman cd

và nó sẽ hiển thị trang man cho cd.

Điều này sử dụng một thư mục dữ liệu (/ usr / share / iman) để giảm thiểu các yêu cầu mạng của chúng tôi (vì vậy nó sẽ hoạt động cho các mục bạn đã tìm thấy trước cả khi không có kết nối; cũng để giảm thiểu tải trên trang web linux linux ngẫu nhiên này Tôi tìm thấy với các mục hệ thống mà chúng tôi muốn trong đó là tốt). Nếu bạn không sử dụng cái này nữa, bạn sẽ muốn loại bỏ nó để phục hồi dung lượng đĩa.

Hy vọng, phần còn lại là khá thẳng về phía trước.