tldr

tldr-เพจคืออะไร?

โปรเจ็กต์ tldr-pages คือชุดของหน้าความช่วยเหลือที่ดูแลโดยชุมชนสำหรับเครื่องมือบรรทัดคำสั่ง ซึ่งมีจุดมุ่งหมายเพื่อให้เป็นส่วนเสริมที่เรียบง่ายและเข้าถึงได้มากขึ้นจากหน้าคู่มือแบบดั้งเดิม

บางทีคุณอาจยังใหม่กับโลกบรรทัดคำสั่ง บางทีคุณอาจมีสนิมนิดหน่อยหรือจำข้อโต้แย้งสำหรับคำสั่งเช่น lsof หรือ tar ไม่ได้เสมอไป

แน่นอนว่าในอดีตตัวเลือกแรกที่อธิบายไว้ใน man tar ก็ไม่ได้ช่วยอะไรคือ:

$ man tar
...
-b blocksize
   Specify the block size, in 512-byte records, for tape drive I/O.
   As a rule, this argument is only needed when reading from or writing to tape drives,
   and usually not even then as the default block size of 20 records (10240 bytes) is very common.
...

มีพื้นที่สำหรับหน้าความช่วยเหลือที่เรียบง่ายซึ่งเน้นไปที่ตัวอย่างที่ใช้งานได้จริง แล้ว:

พื้นที่เก็บข้อมูลนี้เป็นเพียงนั้น: คอลเลกชันตัวอย่างที่เพิ่มขึ้นเรื่อยๆ สำหรับเครื่องมือบรรทัดคำสั่ง UNIX, Linux, macOS, FreeBSD, NetBSD, OpenBSD, SunOS, Android และ Windows ที่พบบ่อยที่สุด

ฉันจะใช้มันได้อย่างไร?

เคล็ดลับ

สำหรับการเรียกดูโดยไม่ต้องติดตั้งไคลเอ็นต์บนคอมพิวเตอร์ของคุณ โปรดดูเว็บไคลเอ็นต์ที่ https://tldr.inbrowser.app (พร้อมการสนับสนุนออฟไลน์โดยใช้ PWA)

วิธีที่ได้รับความนิยมและสะดวกในการเข้าถึงหน้าเหล่านี้บนคอมพิวเตอร์ของคุณคือการติดตั้งไคลเอนต์ Node.js อย่างเป็นทางการ:

npm install -g tldr

หรือคุณสามารถใช้ไคลเอนต์ Python อย่างเป็นทางการซึ่งสามารถติดตั้งผ่าน pip3 (หรือตัวจัดการแพ็คเกจอื่น ๆ ):

pip3 install tldr

ผู้ใช้ Linux และ Mac ยังสามารถติดตั้ง Rust Client อย่างเป็นทางการโดยใช้ Homebrew (หรือตัวจัดการแพ็คเกจอื่น ๆ บนระบบปฏิบัติการอื่น):

brew install tlrc

จากนั้น คุณจะสามารถเข้าถึงวิธีใช้คำสั่งที่เรียบง่ายและอ่านง่ายได้โดยตรง เช่น tar ซึ่งสามารถเข้าถึงได้ผ่านการพิมพ์ tldr tar แทนที่จะเป็น man tar มาตรฐาน

หากคุณไม่ต้องการติดตั้งซอฟต์แวร์ใดๆ ให้ดูเวอร์ชัน PDF แทน

บันทึก

PDF สำหรับการแปลมีให้บริการสำหรับภาษาส่วนใหญ่ คุณสามารถค้นหาได้ในเนื้อหาที่เผยแพร่ของรุ่นล่าสุด

นอกจากนี้ยังมี ไคลเอนต์อื่น ๆ อีกมากมาย ที่ชุมชนมอบให้ ทั้งสำหรับบรรทัดคำสั่งและสำหรับแพลตฟอร์มอื่น ๆ สำหรับรายชื่อลูกค้าที่ครอบคลุม โปรดไปที่ Wiki ของเรา

ฉันจะมีส่วนร่วมใน tldr-pages ได้อย่างไร

ยินดีต้อนรับทุกการมีส่วนร่วม!

วิธีการบางส่วนในการมีส่วนร่วม ได้แก่ :

• เพิ่มคำสั่งที่คุณชื่นชอบที่ไม่ครอบคลุม
• การเพิ่มตัวอย่างหรือการปรับปรุงเนื้อหาของเพจที่มีอยู่
• การเพิ่มหน้าที่ร้องขอจากปัญหาของเราพร้อมป้ายกำกับต้องการความช่วยเหลือ
• การแปลหน้าเว็บเป็นภาษาต่างๆ

หน้า tldr ทั้งหมดเขียนด้วย Markdown เพื่อให้สามารถแก้ไขได้อย่างง่ายดายและสามารถส่งการเปลี่ยนแปลงในคำขอดึงได้ที่นี่โดยใช้ Git บนบรรทัดคำสั่งหรือใช้เว็บอินเตอร์เฟส GitHub

เรามุ่งมั่นที่จะรักษาชุมชนที่เป็นมิตรและร่วมมือกัน หากนี่เป็นครั้งแรกที่คุณมีส่วนร่วม โปรดดูหลักเกณฑ์การบริจาคแล้วดำเนินการต่อ!

หากคุณต้องการมีส่วนร่วมในการแปล คุณสามารถไปที่ https://lukwebsforge.github.io/tldri18n/ เพื่อดูความคืบหน้าโดยรวมของการแปลทั้งหมด และการแปลใดบ้างที่ขาดหายไปหรือล้าสมัย

คุณยังยินดีที่จะเข้าร่วมกับเราในห้องสนทนาเมทริกซ์!

โครงการที่คล้ายกัน

• หน้าอินเทอร์เฟซบรรทัดคำสั่งช่วยให้คุณสามารถเขียนหน้าวิธีใช้มาตรฐานสำหรับ CLI ไดเร็กทอรี และการกำหนดค่าได้

• สูตรโกงช่วยให้คุณสร้างและดูสูตรโกงแบบโต้ตอบได้บนบรรทัดคำสั่ง ได้รับการออกแบบมาเพื่อช่วยเตือนผู้ดูแลระบบ Unix เกี่ยวกับตัวเลือกสำหรับคำสั่งที่พวกเขาใช้บ่อย แต่ไม่บ่อยพอที่จะจำได้

• cheat.sh รวมสูตรโกงจากหลายแหล่ง (รวมถึง tldr-pages) ให้เป็น 1 อินเทอร์เฟซแบบรวม

• โปรแกรมโกงของ Rico ไม่ได้เน้นไปที่บรรทัดคำสั่งเท่านั้น แต่ยังรวมถึงโปรแกรมโกงอื่นๆ ที่เกี่ยวข้องกับการเขียนโปรแกรมอีกมากมาย

• เช่น ให้ตัวอย่างโดยละเอียดพร้อมคำอธิบายในบรรทัดคำสั่ง ตัวอย่างมาจากพื้นที่เก็บข้อมูล แต่ eg รองรับการแสดงตัวอย่างและคำสั่งที่กำหนดเองควบคู่ไปกับค่าเริ่มต้น

• kb เป็นตัวจัดการฐานความรู้บรรทัดคำสั่งที่เรียบง่าย kb สามารถใช้เพื่อจัดระเบียบบันทึกย่อและสูตรโกงของคุณในแบบเรียบง่ายและสะอาดตา นอกจากนี้ยังรองรับไฟล์ที่ไม่ใช่ข้อความ

• navi เป็นเครื่องมือ cheatsheet แบบโต้ตอบ ซึ่งช่วยให้คุณสามารถเรียกดูตัวอย่างเฉพาะหรือคำสั่งที่สมบูรณ์ได้ทันที

• bropages (เลิกใช้แล้ว) เป็นส่วนเสริมที่สามารถอ่านได้ง่ายสำหรับหน้า man มันแสดงตัวอย่างกรณีทั่วไปที่กระชับสำหรับคำสั่ง Unix ตัวอย่างถูกส่งโดยฐานผู้ใช้ และสามารถโหวตขึ้นหรือลงได้ รายการที่ดีที่สุดคือสิ่งที่ผู้คนเห็นเป็นอันดับแรกเมื่อค้นหาคำสั่ง

"tldr" หมายถึงอะไร?

TL; DR ย่อมาจาก "ยาวเกินไป ไม่ได้อ่าน" มีต้นกำเนิดมาจากคำแสลงทางอินเทอร์เน็ต ซึ่งใช้เพื่อระบุว่าข้อความยาว (หรือบางส่วน) ถูกข้ามไปเนื่องจากยาวเกินไป อ่านเพิ่มเติมในบทความของ How-To Geek