Πώς να δημιουργήσετε μια σελίδα Linux Man

Η εντολή άνδρας στο Linux είναι ενσωματωμένο στη μυϊκή μνήμη κάθε προγραμματιστή και χρήστη Linux. Χρησιμοποιείται κυριολεκτικά από όλους. από ερασιτέχνες και αρχάριους προγραμματιστές μέχρι επαγγελματίες και ειδικούς Linux.

Χρησιμοποιείται για την ανάγνωση της σελίδας του εγχειριδίου γραμμής εντολών για εντολή Linux, αρχείο διαμόρφωσης ή οποιαδήποτε άλλη δυνατότητα. Οι μη αυτόματες σελίδες συνήθως εγκαθίστανται μαζί με την εγκατάσταση ενός λογισμικού στο Linux. Υπάρχει μια καθορισμένη σύνταξη για μη αυτόματες σελίδες, η οποία αναλύεται από την εντολή.

Ας δημιουργήσουμε μια σελίδα ανθρώπου για το παρακάτω σενάριο bash που έχω γράψει:

#!/bin/bash if [ "$1" == "h" ]; τότε ηχώ "Hello" fi if [ "$1" = "b" ]; μετά ηχώ "Αντίο" fi

Αυτό το σενάριο κάνει μόνο δύο πράγματα: Εκτυπώνει "Hello" εάν η επιλογή "h" έχει καθοριστεί ως όρισμα και εκτυπώνει "Bye" εάν η επιλογή "b" έχει καθοριστεί ως όρισμα.

Ας δημιουργήσουμε μια σελίδα ανθρώπου για αυτό το πρόγραμμα. Χρήση δύναμη ή οποιοδήποτε πρόγραμμα επεξεργασίας της επιλογής σας για να δημιουργήσετε ένα αρχείο κειμένου.

vim test.1

Η επέκταση '.1' υποδηλώνει ότι αυτή η σελίδα ανθρώπου προορίζεται για μια εκτελέσιμη εντολή. Δεν είναι καταναγκασμός, αλλά μάλλον μια ευρέως ακολουθούμενη σύμβαση κατά τη συγγραφή σελίδων man. Η σελίδα του εγχειριδίου για τον άνθρωπο (άντρας άνθρωπος !) παραθέτει τις κατηγορίες:

 1 Εκτελέσιμα προγράμματα ή εντολές φλοιού 2 Κλήσεις συστήματος (συναρτήσεις παρέχονται από τον πυρήνα) 3 Κλήσεις βιβλιοθήκης (λειτουργίες εντός βιβλιοθηκών προγραμμάτων) 4 Ειδικά αρχεία (συνήθως βρίσκονται στο /dev) 5 Μορφές και συμβάσεις αρχείων π.χ. /etc/passwd 6 Παιχνίδια 7 Διάφορα ( συμπεριλαμβανομένων πακέτων μακροεντολών και συμβάσεων), π.χ man(7), groff(7) 8 εντολές διαχείρισης συστήματος (συνήθως μόνο για root) 9 ρουτίνες πυρήνα [Μη τυπική]

Δημιουργείται μια σελίδα ανθρώπου χρησιμοποιώντας την πολύ παλιά γλώσσα σήμανσης roff. Διαθέτει εντολές (δείκτες ανάγνωσης) για διάφορους τίτλους και ενότητες.

  • – Αυτή πρέπει να είναι η πρώτη εντολή στο αρχείο man. Χρησιμοποιείται για τον καθορισμό της επικεφαλίδας τίτλου της σελίδας man.
  • .SH – Επικεφαλίδα Ενότητας.
  • .ΣΙ – Χρησιμοποιείται για την εμφάνιση του κειμένου δίπλα του με έντονη γραφή.
  • .Τ.Π – Χρησιμοποιείται για την εμφάνιση πληροφοριών σχετικά με ένα όρισμα (σημαία) στην εντολή.
  • .BR – Χρησιμοποιείται για την εμφάνιση κειμένου με έντονη γραφή και με κανονική ρωμαϊκή γραμματοσειρά.

Ακολουθεί η σελίδα man για το πρόγραμμά μου που δημιουργήθηκε χρησιμοποιώντας μόνο τις παραπάνω (απλές) εντολές roff.

.TH test.sh 1 .SH NAME test.sh \- Εκτύπωση Hello or Bye .SH SYNOPSIS .B test.sh [ h ] [ b ] .SH ΠΕΡΙΓΡΑΦΗ .B test.sh Αυτό είναι ένα δείγμα σεναρίου που κάνει μόνο 2 πράγματα . Εκτυπώνει είτε "Hello" εάν το όρισμα είναι "h" είτε εκτυπώνει "Bye" εάν το όρισμα είναι "b" .SH OPTIONS .TP .BR h Εκτύπωση Hello .TP .BR b Εκτύπωση αντίο

Αποθηκεύστε το αρχείο πατώντας πρώτα το ESC πλήκτρο και μετά πληκτρολογήστε :wq για να αποθηκεύσετε το αρχείο και να βγείτε από την κονσόλα vim.

Δοκιμάστε τη σελίδα man που μόλις δημιουργήσαμε χρησιμοποιώντας την παρακάτω εντολή:

άνθρωπος ./τεστ.1

Για περισσότερες πληροφορίες σχετικά με άνδρας χρήση, τρέξιμο man-pages εντολή στο τερματικό σας.

? Υπόδειξη

Αυτή είναι η βασική σύνταξη για τη σύνταξη σελίδων man. Για να διευκολύνετε τα πράγματα, θα μπορούσατε να χρησιμοποιήσετε εργαλεία όπως το txt2man να μετατρέψετε ένα αρχείο σε κάποια μορφή γλώσσας σήμανσης σε μορφή roff.

Κατηγορία: Linux