จะทำให้ `คนทำงานได้อย่างไรสำหรับคำสั่งและคำหลักของเชลล์บิวด์อิน?

ฉันใช้manคำสั่งตลอดเวลาเมื่อฉันต้องการรับข้อมูลเกี่ยวกับคำสั่งเฉพาะ แต่สิ่งนี้ไม่ได้ช่วยฉันมากเกินไปเมื่อคำสั่งเฉพาะนั้นเป็นเชลล์ในตัว ตัวอย่างเช่น:

man cd

ผลตอบแทน:

No manual entry for cd

คำถามของฉันคือมันเป็นไปได้ที่จะทำให้การmanทำงานสำหรับทุกคำสั่งเชลล์ builtin (เช่นcd, alias, historyฯลฯ ) และคำหลัก (เช่นif, while, [[, {ฯลฯ )?

helpคำสั่งเมื่อใช้กับ-mตัวเลือกที่สามารถแสดงข้อมูลเกี่ยวกับ builtin คำสั่งในรูปแบบหลอก manpage ตัวอย่างเช่น:

help -m cd | less

จะแสดงข้อมูลเกี่ยวกับcdคำสั่งในรูปแบบเกือบจะเหมือนกับในหน้าคู่มือ

เริ่มต้นจากคำสั่งนี้คุณสามารถตัดmanคำสั่งในฟังก์ชั่นเดียวใน.bashrcไฟล์ของคุณดังต่อไปนี้:

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

หลังจากนี้manจะทำงานสำหรับคำสั่งและคำหลักของเชลล์ builtin ทั้งหมดด้วย ตัวอย่างเช่น:

man :

จะแสดง:

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

สิ่งนี้มีตัวอย่างความช่วยเหลือสำหรับคำสั่ง builtin แม้ว่าจะอยู่ในรูปแบบย่อมากกว่าที่helpเทียบเท่าเล็กน้อย

คุณสามารถติดตั้งหน้าคู่มือเกี่ยวกับการใช้ระบบ POSIX เพื่อการพัฒนาเป็น,

sudo apt-get install manpages-posix-dev

มันจะให้หน้าคนสำหรับ shell builtins

$ type cd
cd is a shell builtin

ตอนนี้ลอง

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

NAME
   cd - change the working directory

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


...

วิธีแก้ปัญหานี้ทำงานได้อย่างสมบูรณ์แบบ แต่ก็เป็นเรื่องตลกเช่นกันเพราะสิ่งแรกที่ฉันคิดว่าเมื่อฉันอ่านคำถามของคุณคือ 'ใครยังคงใช้มนุษย์จากบรรทัดคำสั่งอย่างแท้จริง? ทุกคนไม่ใช่แค่ Google เท่านั้นที่เป็นหน้าคนที่พวกเขาต้องการ จากนั้นฉันก็รู้ว่าไซต์ที่ฉัน Google มักจะมีทั้งคำสั่งทั้งสองประเภทดังนั้นทำไมไม่เพียงแค่ใช้มันเพื่อจัดเตรียมอินเทอร์เฟซของ man page ที่เหมือนกันในทุกคำสั่ง ดังนั้นความสนุกนี้จึงเกิดขึ้น

ต้องใช้การเชื่อมต่ออินเทอร์เน็ตสำหรับรายการใด ๆ ที่คุณยังไม่ได้ค้นหาอย่างน้อยหนึ่งครั้ง นอกจากนี้ยังต้องการแอพเล็ก ๆ สองตัวที่หายไปจากการติดตั้งเริ่มต้นของ Ubuntu:

 sudo apt-get install tidy html2text

สิ่งเหล่านี้ไม่จำเป็นจริงๆ แต่ช่วยทำให้ดูดีขึ้นหน่อย Tidy จะทำความสะอาด HTML และ html2text จะจัดรูปแบบ html นั้นเป็นข้อความที่จัดรูปแบบ (ซึ่งมักไม่ค่อยน่าสนใจเนื่องจากไซต์เหล่านี้ส่วนใหญ่มีการจัดรูปแบบข้อความแล้วและเพิ่งถูกห่อด้วยแท็ก <pre>

ตอนนี้สิ่งที่คุณต้องทำคือการเพิ่มนี้ในตอนท้ายของ~/.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
}

หลังจากที่คุณออกจากระบบแล้วกลับมาคุณควรจะพิมพ์สิ่งนี้:

iman cd

cdและมันจะแสดงหน้าคนสำหรับ

นี้ใช้ไดเรกทอรีข้อมูล (/ usr / share / iman) เพื่อลดความต้องการเครือข่ายของเรา (ดังนั้นมันจะทำงานสำหรับรายการที่คุณเคยพบมาก่อนแม้จะไม่มีการเชื่อมต่อยังลดภาระบนไซต์ man linux แบบสุ่มนี้ ฉันพบกับรายการระบบที่เราต้องการเช่นกัน) หากคุณไม่ได้ใช้สิ่งนี้อีกต่อไปคุณจะต้องลบสิ่งนั้นเพื่อกู้คืนพื้นที่ว่างในดิสก์

หวังว่าส่วนที่เหลือจะค่อนข้างตรงไปข้างหน้า