99e1441fb4926887bed133b6ff52d2595aafdef6
[platform/upstream/help2man.git] / help2man.fi.1
1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.9.
2 .TH HELP2MAN "1" "maaliskuu 2019" "help2man 1.47.9" "Käyttäjän sovellukset"
3 .SH NIMI
4 help2man \- luo yksinkertainen man-sivu
5 .SH YLEISKATSAUS
6 .B help2man
7 [\fI\,VALITSIMET\/\fR]... \fI\,OHJELMA\/\fR
8 .SH KUVAUS
9 ”help2man” luo man\-sivun ”\-\-help”\- ja ”\-\-version”\-tulosteista.
10 .TP
11 \fB\-n\fR, \fB\-\-name\fR=\fI\,MERKKIJONO\/\fR
12 kuvaus kappaleeseen NIMI
13 .TP
14 \fB\-s\fR, \fB\-\-section\fR=\fI\,LUOKKA\/\fR
15 manuaalisivun luokan numero (1, 6, 8)
16 .TP
17 \fB\-m\fR, \fB\-\-manual\fR=\fI\,TEKSTI\/\fR
18 manuaalin nimi (Käyttäjän sovellukset, ...)
19 .TP
20 \fB\-S\fR, \fB\-\-source\fR=\fI\,TEKSTI\/\fR
21 ohjelman lähde (FSF, Debian, ...)
22 .TP
23 \fB\-L\fR, \fB\-\-locale\fR=\fI\,MERKKIJONO\/\fR
24 valitse maa\-asetusto (oletus on "C")
25 .TP
26 \fB\-i\fR, \fB\-\-include\fR=\fI\,TIEDOSTO\/\fR
27 sisällytä materiaali TIEDOSTOsta
28 .TP
29 \fB\-I\fR, \fB\-\-opt\-include\fR=\fI\,TIEDOSTO\/\fR
30 sisällytä materiaali TIEDOSTOsta mikäli
31 se on olemassa
32 .TP
33 \fB\-o\fR, \fB\-\-output\fR=\fI\,TIEDOSTO\/\fR
34 kirjoita tuloste TIEDOSTOon
35 .TP
36 \fB\-p\fR, \fB\-\-info\-page\fR=\fI\,MERKKIJONO\/\fR
37 Texinfo\-manuaalin nimi
38 .TP
39 \fB\-N\fR, \fB\-\-no\-info\fR
40 jätä pois viittaus Texinfo\-manuaaliin
41 .TP
42 \fB\-l\fR, \fB\-\-libtool\fR
43 jätä pois ”lt\-” ohjelman nimestä
44 .TP
45 \fB\-\-help\fR
46 näytä tämä ohje ja poistu
47 .TP
48 \fB\-\-version\fR
49 tulosta versiotiedot ja poistu
50 .PP
51 OHJELMAn tulee hyväksyä sekä ”\-\-help”\- että ”\-\-version”\-valitsimet,
52 mutta vaihtoehtoiset valitsimet voi määrittää valitsimilla:
53 .TP
54 \fB\-h\fR, \fB\-\-help\-option\fR=\fI\,MERKKIJONO\/\fR
55 ohjevalitsin
56 .TP
57 \fB\-v\fR, \fB\-\-version\-option\fR=\fI\,MERKKIJONO\/\fR
58 versiotietovalitsin
59 .TP
60 \fB\-\-version\-string\fR=\fI\,MERKKIJONO\/\fR
61 versiotieto
62 .TP
63 \fB\-\-no\-discard\-stderr\fR
64 sisällytä vakiovirhetuloste jäsennettäessä
65 tulostetta
66 .PP
67 Lähetä ilmoitukset ohjelmistovioista (englanniksi) osoitteeseen
68 <bug\-help2man@gnu.org>.
69 .SH "SISÄLLYTÄ TIEDOSTOJA"
70 Lisämateriaalia voi sisällyttää luotavaan tulosteeseen valitsimilla
71 .B \-\-include
72 ja
73 .BR \-\-opt\-include .
74 Muoto on yksinkertainen:
75
76     [kappale]
77     teksti
78
79     /hakuehto/
80     teksti
81
82 Kappaleita puhdasta *roff-tekstiä lisätään tulosteeseen joko kun alkaa
83 .BI [ kappale ]
84 (kirjainkoko merkitsevä) tai sellaisen kappaleen jälkeen, joka täsmää
85 säännölliseen lausekkeeseen
86
87 .BI / hakuehto /\fR.
88
89 Hakuehdoissa käytetään Perlin säännöllisten lausekkeiden syntaksia, ja
90 niiden perässä voi olla
91 .IR i ,
92 .I s
93 tai
94 .I m
95 muuntimet (katso
96 .BR perlre (1)).
97
98 Rivit ennen ensimmäistä kappaletta tai hakuehtoa, jotka alkavat "\-",
99 käsitellään valitsimina. Kaikki muu ohitetaan, joten ne voivat olla
100 käyttäjän kommentteja, RCS-avainsanoja ja muuta sellaista.
101
102 Kappaleiden tulostusjärjestys on:
103
104     NIMI
105     YLEISKATSAUS
106     KUVAUS
107     VALITSIMET
108     YMPÄRISTÖ
109     TIEDOSTOT
110     ESIMERKKEJÄ
111     \fImuut\fR
112     TEKIJÄ
113     VIRHEISTÄ ILMOITTAMINEN
114     TEKIJÄNOIKEUDET
115     KATSO MYÖS
116
117 Kappale
118 .B [NIMI]
119 tai
120 .BR [YLEISKATSAUS] ,
121 joka löytyy sisällytystiedostosta, korvaa muutoin automaattisesti
122 tuotettavan osan (vaikka tämänkin voi korvata
123 .B \-\-name
124 -valitsimella tarvittaessa).
125
126 Muut kappaleet aloittavat automaattisesti tuotetun tulosteen aiemmin
127 mainituille vakiokappaleille, tai ne sisällytetään kohtaan
128 .I muut
129 samassa järjestyksessä kuin ne esiintyvät sisällytystiedostossa.
130
131 Tekstin sijaintia kappaleen sisällä voidaan eksplisiittisesti pyytää käyttäen
132 syntaksia
133 .RI [< kappale ],
134 .RI [= kappale ]
135 tai
136 .RI [> kappale ]
137 lisätekstin sijoittamiseksi vastaavasti oletustuloksen eteen, sijalle, tai jälkeen.
138 .SH SAATAVUUS
139 Tuorein versio tästä sovelluksesta on saatavilla verkossa osoitteesta:
140
141     ftp://ftp.gnu.org/gnu/help2man/
142 .SH TEKIJÄ
143 Kirjoittanut Brendan O'Dea <bod@debian.org>
144 .SH TEKIJÄNOIKEUDET
145 Copyright \(co 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010,
146 2011, 2012, 2013, 2014, 2015, 2016, 2017 Free Software Foundation, Inc.
147 Tämä on vapaa ohjelmist; katsokaa kopiointiehdot lähdekoodista. Takuuta EI OLE;
148 ei edes KAUPALLISESTI HYVÄKSYTTÄVÄSTÄ LAADUSTA tai SOPIVUUDESTA TIETTYYN
149 TARKOITUKSEEN.
150 .SH "KATSO MYÖS"
151 Ohjelman
152 .B help2man
153 täydellinen dokumentaatio ylläpidetään Texinfo-manuaalissa. Mikäli
154 ohjelmat
155 .B info
156 ja
157 .B help2man
158 on täysin asennettu, komennon
159 .B info help2man
160 .PP
161 pitäisi antaa täydellinen manuaali luettavaksi.