• Najnowsze pytania
  • Bez odpowiedzi
  • Zadaj pytanie
  • Kategorie
  • Tagi
  • Zdobyte punkty
  • Ekipa ninja
  • IRC
  • FAQ
  • Regulamin
  • Książki warte uwagi

Bash manual znaczniki

VPS Starter Arubacloud
0 głosów
415 wizyt
pytanie zadane 9 czerwca 2018 w Nasze projekty przez aram100 Użytkownik (500 p.)
edycja 9 czerwca 2018 przez aram100

Hej mam napisać man page do skryptu który napisałem do szkoły i uruchamiać go w ten sposób:

man /.mojskrypt   //mojskrypt to nazwa pliku z manualem

 

W sumie mam napisany tylko nie wiem jak dodać do niego takie "znaczniki" (nie wiem jak to się profesjonalnie nazywa) które zmienią np. kolor albo sposób prezentacji jakiegoś parametru. Muszę użyć pięciu, ale nie wiem skąd je można wziąć, szukam jakiejś listy ale nie ma nic ciekawego

mam użyte .OP, wiem że jest jeszcze .IP ale nie wiem jak go użyć

.TH i .SH to też są te znaczniki?

 

.TH man "1" "09.06.2018" "mojskrypt manual"
.SH NAME #nazwa skryptu
mojskrypt
.SH SYNOPSIS #sposob uruchamiania
mojskrypt
.OP OPTION   #tutaj "znacznik" .OP robi nam mojskrypt [OPTION] w manualu
.SH DESCRIPTION
opis mojego skryptu #nie będę pisał co to robi tutaj bo to bez sensu
##dalej tylko opis itd.

tu jest screen man'a z grepa https://imgur.com/a/8YCUSUd

Jak zrobić takie wcięcie i pokolorowanie -V albo --help "znacznikiem"?

1 odpowiedź

0 głosów
odpowiedź 9 czerwca 2018 przez RafalS VIP (122,820 p.)
edycja 9 czerwca 2018 przez RafalS

Z tego co mi się wydaje to kolorki to nie kwestia tego jak napiszesz man page tylko jak masz skonfigurowane ich wyświetlanie u siebie.

Co do reszty to po prostu wygogluj "how to create man page" i w pierwszym lepszym przykładzie masz użyte wszystkie sensowne znaczniki:

http://www.schweikhardt.net/man_page_howto.html

Jeśli nie lubisz scrolować to tu masz gotowca. Robisz na tym man i widzisz jak to działa:

.\" Process this file with
.\" groff -man -Tascii foo.1
.\"
.TH FOO 1 "MARCH 1995" Linux "User Manuals"
.SH NAME
foo \- frobnicate the bar library
.SH SYNOPSIS
.B foo [-bar] [-c
.I config-file
.B ]
.I file
.B ...
.SH DESCRIPTION
.B foo
frobnicates the bar library by tweaking internal
symbol tables. By default it parses all baz segments
and rearranges them in reverse order by time for the
.BR xyzzy (1)
linker to find them. The symdef entry is then compressed
using the WBG (Whiz-Bang-Gizmo) algorithm.
All files are processed in the order specified.
.SH OPTIONS
.IP -b
Do not write `busy' to stdout while processing.
.IP "-c config-file"
Use the alternate system wide
.I config-file
instead of
.IR /etc/foo.conf .
This overrides any
.B FOOCONF
environment variable.
.IP -a
In addition to the baz segments, also parse the
blurfl headers.
.IP -r
Recursive mode. Operates as fast as lightning
at the expense of a megabyte of virtual memory.
.SH FILES
.I /etc/foo.conf
.RS
The system wide configuration file. See
.BR foo (5)
for further details.
.RE
.I ~/.foorc
.RS
Per user configuration file. See
.BR foo (5)
for further details.
.SH ENVIRONMENT
.IP FOOCONF
If non-null the full pathname for an alternate system wide
.IR foo.conf .
Overridden by the
.B -c
option.
.SH DIAGNOSTICS
The following diagnostics may be issued on stderr:
 
Bad magic number.
.RS
The input file does not look like an archive file.
.RE
Old style baz segments.
.RS
.B foo
can only handle new style baz segments. COBOL
object libraries are not supported in this version.
.SH BUGS
The command name should have been chosen more carefully
to reflect its purpose.
.SH AUTHOR
Jens Schweikhardt <howto at schweikhardt dot net>
.SH "SEE ALSO"
.BR bar (1),
.BR foo (5),
.BR xyzzy (1)


I tak .SH i .TH to są znaczniki

PS Polecam uczyć się angielskiego i googlowania :P

Podobne pytania

0 głosów
0 odpowiedzi 296 wizyt
pytanie zadane 18 listopada 2019 w Sieci komputerowe, internet przez Przemek Gaffka Początkujący (490 p.)
0 głosów
3 odpowiedzi 445 wizyt
pytanie zadane 5 lipca 2018 w Systemy operacyjne, programy przez lameguy Użytkownik (640 p.)
0 głosów
0 odpowiedzi 165 wizyt
pytanie zadane 29 grudnia 2016 w Nasze projekty przez Michał Muzyka Pasjonat (24,080 p.)

92,452 zapytań

141,262 odpowiedzi

319,077 komentarzy

61,854 pasjonatów

Motyw:

Akcja Pajacyk

Pajacyk od wielu lat dożywia dzieci. Pomóż klikając w zielony brzuszek na stronie. Dziękujemy! ♡

Oto polecana książka warta uwagi.
Pełną listę książek znajdziesz tutaj.

Akademia Sekuraka

Akademia Sekuraka 2024 zapewnia dostęp do minimum 15 szkoleń online z bezpieczeństwa IT oraz dostęp także do materiałów z edycji Sekurak Academy z roku 2023!

Przy zakupie możecie skorzystać z kodu: pasja-akademia - użyjcie go w koszyku, a uzyskacie rabat -30% na bilety w wersji "Standard"! Więcej informacji na temat akademii 2024 znajdziecie tutaj. Dziękujemy ekipie Sekuraka za taką fajną zniżkę dla wszystkich Pasjonatów!

Akademia Sekuraka

Niedawno wystartował dodruk tej świetnej, rozchwytywanej książki (około 940 stron). Mamy dla Was kod: pasja (wpiszcie go w koszyku), dzięki któremu otrzymujemy 10% zniżki - dziękujemy zaprzyjaźnionej ekipie Sekuraka za taki bonus dla Pasjonatów! Książka to pierwszy tom z serii o ITsec, który łagodnie wprowadzi w świat bezpieczeństwa IT każdą osobę - warto, polecamy!

...