Tin tức chung·Hacker News·0 lượt xem

Ví dụ về các trang tcpdump và dig man

Examples for the tcpdump and dig man pages

Bài học rút ra lớn nhất của tôi từ những suy nghĩ của tháng trước về các trang man là các ví dụ trong các trang man thực sự tuyệt vời, vì vậy tôi đã nỗ lực thêm (hoặc cải thiện) các ví dụ vào hai trang man của công cụ yêu thích của tôi. Đây...

Xin chào! Bài học lớn của tôi rút ra từ những suy ngẫm về trang man của tháng trước có phải các ví dụ trong trang hướng dẫn thực sự tuyệt vời nên tôi đã nỗ lực thêm (hoặc cải thiện) các ví dụ cho hai trang man của công cụ yêu thích của tôi.

Họ đây:

mục tiêu: bao gồm các ví dụ cơ bản nhất

Mục đích ở đây thực sự chỉ là đưa ra những ví dụ cơ bản nhất về cách sử dụng công cụ này dành cho những người sử dụng tcpdump hoặc đào không thường xuyên (hoặc chưa bao giờ sử dụng trước đây!) và không nhớ nó hoạt động như thế nào.

Cho đến giờ tôi vẫn nói “này, tôi muốn viết một phần ví dụ cho người mới bắt đầu và những người sử dụng công cụ này không thường xuyên” đã hoạt động rất tốt. Thật dễ dàng để giải thích, tôi nghĩ mọi điều tôi đã nghe được từ người dùng về những gì họ muốn từ một trang nam và những người duy trì dường như thấy nó hấp dẫn.

Cảm ơn Denis Ovsienko, Guy Harris, Ondřej Surý và tất cả những người đã xem xét các thay đổi về tài liệu, đó là một trải nghiệm tốt và khiến tôi có động lực để thực hiện làm thêm một chút công việc trên trang man.

tại sao phải cải thiện trang man?

Tôi hiện đang quan tâm đến việc nghiên cứu tài liệu chính thức của các công cụ bởi vì:

  • Trang man thực sự có thể có thông tin chính xác gần 100%! Trải qua quá trình xem xét để đảm bảo rằng thông tin thực sự đúng có rất nhiều giá trị.
  • Ngay cả với những câu hỏi cơ bản “cờ tcpdump được sử dụng phổ biến nhất là gì”, những người bảo trì thường biết đến những tính năng hữu ích mà tôi thì không! cho ví dụ tôi đã học được khi làm việc trên các ví dụ tcpdump này nếu bạn đang lưu gói vào một tệp có tcpdump -w out.pcap, sẽ rất hữu ích nếu chuyển -v để in một bản tóm tắt trực tiếp về số lượng gói đã được ghi lại cho đến nay. Đó thực sự là hữu ích, tôi đã không biết điều đó và tôi không nghĩ mình sẽ nhận thấy nó trên của riêng tôi.

Đối với tôi, đó là một nơi kỳ lạ bởi vì thành thật mà nói, tôi luôn cho rằng tài liệu sẽ khó đọc và tôi thường bỏ qua nó và đọc một bài đăng blog hoặc bình luận Stack Overflow hoặc thay vào đó hãy hỏi một người bạn. Nhưng ngay bây giờ Tôi cảm thấy lạc quan, như thể tài liệu không hẳn là tệ? Có thể nó cũng tốt như việc đọc một bài blog thực sự hay, nhưng với lợi ích của việc cũng thực sự đúng? Tôi đã sử dụng tài liệu Django gần đây và nó thực sự tốt! Chúng ta sẽ thấy.

về việc tránh viết ngôn ngữ trang man

Trang man của công cụ dự án tcpdumpđược viết bằng ngôn ngữ roff , cái này hơi khó sử dụng và tôi thực sự không muốn học nó.

Tôi đã giải quyết vấn đề này bằng cách viết một tập lệnh markdown-to-roff rất cơ bản để chuyển đổi Markdown thành roff, sử dụng các quy ước tương tự như trang man đang dùng rồi. Có lẽ tôi vừa mới sử dụng pandoc, nhưng pandoc đầu ra được sản xuất có vẻ khá khác biệt, vì vậy tôi nghĩ tốt hơn nên viết thay vào đó là kịch bản riêng. Ai biết được.

Tôi nghĩ thật tuyệt khi có thể sử dụng thư viện Markdown hiện có khả năng phân tích cú pháp Markdown AST và sau đó triển khai việc phát mã của riêng tôi các phương pháp định dạng mọi thứ theo cách có vẻ hợp lý trong bối cảnh này.

trang man rất phức tạp

Tôi đã đi khắp nơi để tìm hiểu về lịch sử của roff, nó diễn ra như thế nào phát triển từ những năm 70 và những người đang nghiên cứu nó ngày nay, lấy cảm hứng từ việc tìm hiểu về dự án mandoc mà các hệ thống BSD (và một số Linux hệ thống và tôi nghĩ Mac OS) sử dụng để định dạng trang man. Tôi sẽ không nói thêm nhưng về chuyện đó hôm nay thì có thể vào lúc khác.

Nói chung, có vẻ như có sự khác biệt về mặt kỹ thuật và văn hóa trong cách thức tài liệu hoạt động trên BSD và Linux mà tôi vẫn chưa thực sự hiểu rõ, nhưng tôi cảm thấy tò mò về những gì đang diễn ra trong thế giới BSD.

Phần nhận xét có tại đây.

Tác giả: ibobev