summaryrefslogtreecommitdiff
path: root/help2man.fi.1
blob: f8257d7b2fe7a314d3608149ca7100881c9c198d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.5.
.TH HELP2MAN "1" "syyskuu 2017" "help2man 1.47.5" "Käyttäjän sovellukset"
.SH NIMI
help2man \- luo yksinkertainen man-sivu
.SH YLEISKATSAUS
.B help2man
[\fI\,VALITSIMET\/\fR]... \fI\,OHJELMA\/\fR
.SH KUVAUS
”help2man” luo man\-sivun ”\-\-help”\- ja ”\-\-version”\-tulosteista.
.TP
\fB\-n\fR, \fB\-\-name\fR=\fI\,MERKKIJONO\/\fR
kuvaus kappaleeseen NIMI
.TP
\fB\-s\fR, \fB\-\-section\fR=\fI\,LUOKKA\/\fR
manuaalisivun luokan numero (1, 6, 8)
.TP
\fB\-m\fR, \fB\-\-manual\fR=\fI\,TEKSTI\/\fR
manuaalin nimi (Käyttäjän sovellukset, ...)
.TP
\fB\-S\fR, \fB\-\-source\fR=\fI\,TEKSTI\/\fR
ohjelman lähde (FSF, Debian, ...)
.TP
\fB\-L\fR, \fB\-\-locale\fR=\fI\,MERKKIJONO\/\fR
valitse maa\-asetusto (oletus on "C")
.TP
\fB\-i\fR, \fB\-\-include\fR=\fI\,TIEDOSTO\/\fR
sisällytä materiaali TIEDOSTOsta
.TP
\fB\-I\fR, \fB\-\-opt\-include\fR=\fI\,TIEDOSTO\/\fR
sisällytä materiaali TIEDOSTOsta mikäli
se on olemassa
.TP
\fB\-o\fR, \fB\-\-output\fR=\fI\,TIEDOSTO\/\fR
kirjoita tuloste TIEDOSTOon
.TP
\fB\-p\fR, \fB\-\-info\-page\fR=\fI\,MERKKIJONO\/\fR
Texinfo\-manuaalin nimi
.TP
\fB\-N\fR, \fB\-\-no\-info\fR
jätä pois viittaus Texinfo\-manuaaliin
.TP
\fB\-l\fR, \fB\-\-libtool\fR
jätä pois ”lt\-” ohjelman nimestä
.TP
\fB\-\-help\fR
näytä tämä ohje ja poistu
.TP
\fB\-\-version\fR
tulosta versiotiedot ja poistu
.PP
OHJELMAn tulee hyväksyä sekä ”\-\-help”\- että ”\-\-version”\-valitsimet,
mutta vaihtoehtoiset valitsimet voi määrittää valitsimilla:
.TP
\fB\-h\fR, \fB\-\-help\-option\fR=\fI\,MERKKIJONO\/\fR
ohjevalitsin
.TP
\fB\-v\fR, \fB\-\-version\-option\fR=\fI\,MERKKIJONO\/\fR
versiotietovalitsin
.TP
\fB\-\-version\-string\fR=\fI\,MERKKIJONO\/\fR
versiotieto
.TP
\fB\-\-no\-discard\-stderr\fR
sisällytä vakiovirhetuloste jäsennettäessä
tulostetta
.PP
Lähetä ilmoitukset ohjelmistovioista (englanniksi) osoitteeseen
<bug\-help2man@gnu.org>.
.SH "SISÄLLYTÄ TIEDOSTOJA"
Lisämateriaalia voi sisällyttää luotavaan tulosteeseen valitsimilla
.B \-\-include
ja
.BR \-\-opt\-include .
Muoto on yksinkertainen:

    [kappale]
    teksti

    /hakuehto/
    teksti

Kappaleita puhdasta *roff-tekstiä lisätään tulosteeseen joko kun alkaa
.BI [ kappale ]
(kirjainkoko merkitsevä) tai sellaisen kappaleen jälkeen, joka täsmää
säännölliseen lausekkeeseen

.BI / hakuehto /\fR.

Hakuehdoissa käytetään Perlin säännöllisten lausekkeiden syntaksia, ja
niiden perässä voi olla
.IR i ,
.I s
tai
.I m
muuntimet (katso
.BR perlre (1)).

Rivit ennen ensimmäistä kappaletta tai hakuehtoa, jotka alkavat "\-",
käsitellään valitsimina. Kaikki muu ohitetaan, joten ne voivat olla
käyttäjän kommentteja, RCS-avainsanoja ja muuta sellaista.

Kappaleiden tulostusjärjestys on:

    NIMI
    YLEISKATSAUS
    KUVAUS
    VALITSIMET
    YMPÄRISTÖ
    TIEDOSTOT
    ESIMERKKEJÄ
    \fImuut\fR
    TEKIJÄ
    VIRHEISTÄ ILMOITTAMINEN
    TEKIJÄNOIKEUDET
    KATSO MYÖS

Kappale
.B [NIMI]
tai
.BR [YLEISKATSAUS] ,
joka löytyy sisällytystiedostosta, korvaa muutoin automaattisesti
tuotettavan osan (vaikka tämänkin voi korvata
.B \-\-name
-valitsimella tarvittaessa).

Muut kappaleet aloittavat automaattisesti tuotetun tulosteen aiemmin
mainituille vakiokappaleille, tai ne sisällytetään kohtaan
.I muut
samassa järjestyksessä kuin ne esiintyvät sisällytystiedostossa.

Tekstin sijaintia kappaleen sisällä voidaan eksplisiittisesti pyytää käyttäen
syntaksia
.RI [< kappale ],
.RI [= kappale ]
tai
.RI [> kappale ]
lisätekstin sijoittamiseksi vastaavasti oletustuloksen eteen, sijalle, tai jälkeen.
.SH SAATAVUUS
Tuorein versio tästä sovelluksesta on saatavilla verkossa osoitteesta:

    ftp://ftp.gnu.org/gnu/help2man/
.SH TEKIJÄ
Kirjoittanut Brendan O'Dea <bod@debian.org>
.SH TEKIJÄNOIKEUDET
Copyright \(co 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017 Free Software Foundation, Inc.
Tämä on vapaa ohjelmist; katsokaa kopiointiehdot lähdekoodista. Takuuta EI OLE;
ei edes KAUPALLISESTI HYVÄKSYTTÄVÄSTÄ LAADUSTA tai SOPIVUUDESTA TIETTYYN
TARKOITUKSEEN.
.SH "KATSO MYÖS"
Ohjelman
.B help2man
täydellinen dokumentaatio ylläpidetään Texinfo-manuaalissa. Mikäli
ohjelmat
.B info
ja
.B help2man
on täysin asennettu, komennon
.B info help2man
.PP
pitäisi antaa täydellinen manuaali luettavaksi.