Perldoc
perldoc - Visa Perl-dokumentation
`perldoc` är ett verktyg som används för att visa dokumentation för Perl och dess moduler. Det kan visa POD (Plain Old Documentation) från Perl-källfiler, moduler och distribuerad dokumentation.
NAMN
perldoc - Visa Perl-dokumentation
SYNOPSIS
perldoc [alternativ] ämne
BESKRIVNING
`perldoc` används för att visa dokumentation för Perl-programmeringsspråket och dess moduler. Det kan visa dokumentation från Perl-källfiler, moduler och distribuerad dokumentation i form av POD (Plain Old Documentation).
ALTERNATIV
Här är de vanligaste alternativen som stöds av `perldoc`:
- -h, --help - Visa hjälpmeddelande och avsluta.
- -v, --version - Visa versionsinformation och avsluta.
- -f, --functions - Visa dokumentation för en Perl-funktion.
- -q, --faq - Sök i Perl FAQ efter ett ämne.
- -m, --module - Visa källkoden för en modul.
- -l, --location - Visa filvägen till en modul eller ett skript.
- -u, --unformatted - Visa rå POD-text utan formatering.
- -t, --text - Visa dokumentation som ren text.
- -T, --terse - Visa dokumentation utan rubriker.
- -d, --directory - Ange katalogen för temporära filer.
- -o, --output - Skriv ut till en angiven fil istället för standardutdata.
- -M, --manifest - Visa modulmanifest.
- -L, --language - Ange språket för dokumentation.
ANVÄNDNING
Här är flera exempel på hur man använder `perldoc` för att visa dokumentation:
Visa dokumentation för en Perl-modul
För att visa dokumentation för en specifik Perl-modul:
perldoc File::Basename
Detta kommando visar dokumentationen för modulen `File::Basename`.
Visa dokumentation för en Perl-funktion
För att visa dokumentation för en specifik Perl-funktion:
perldoc -f printf
Detta kommando visar dokumentationen för funktionen `printf`.
Visa Perl FAQ
För att söka i Perl FAQ efter ett specifikt ämne:
perldoc -q array
Detta kommando söker i Perl FAQ efter ämnen relaterade till "array".
Visa källkoden för en modul
För att visa källkoden för en specifik modul:
perldoc -m File::Basename
Detta kommando visar källkoden för modulen `File::Basename`.
Visa filvägen till en modul eller ett skript
För att visa filvägen till en specifik modul eller ett skript:
perldoc -l File::Basename
Detta kommando visar filvägen till modulen `File::Basename`.
Visa rå POD-text utan formatering
För att visa rå POD-text utan formatering:
perldoc -u File::Basename
Detta kommando visar den råa POD-texten för modulen `File::Basename`.
Visa dokumentation som ren text
För att visa dokumentation som ren text utan formatering:
perldoc -t File::Basename
Detta kommando visar dokumentationen för modulen `File::Basename` som ren text.
Ange katalogen för temporära filer
För att ange en specifik katalog för temporära filer:
perldoc -d /path/to/temp File::Basename
Detta kommando anger att temporära filer ska sparas i `/path/to/temp` när dokumentationen för `File::Basename` visas.
Skriv ut till en angiven fil
För att skriva ut dokumentationen till en specifik fil istället för standardutdata:
perldoc -o output.txt File::Basename
Detta kommando skriver ut dokumentationen för `File::Basename` till filen `output.txt`.
Visa modulmanifest
För att visa manifestet för en specifik modul:
perldoc -M File::Basename
Detta kommando visar manifestet för modulen `File::Basename`.
Ange språket för dokumentation
För att ange ett specifikt språk för dokumentationen:
perldoc -L sv File::Basename
Detta kommando visar dokumentationen för `File::Basename` på svenska (om tillgängligt).
SKILLNADER MELLAN macOS OCH LINUX
Det finns vissa skillnader att tänka på när man använder `perldoc` på macOS jämfört med Linux:
- macOS: Perl är förinstallerat på macOS, och `perldoc` är tillgängligt som en del av Perl-installationen. Dokumentationen som visas kan dock vara äldre än den senaste versionen som finns tillgänglig på CPAN. Använd `perlbrew` för att installera och hantera nyare Perl-versioner och deras dokumentation.
- Linux: Perl och `perldoc` är vanligtvis förinstallerade på de flesta Linux-distributioner. Dokumentationen uppdateras regelbundet via distributionspaketförvaltaren. På Linux kan du enkelt uppdatera Perl-moduler och deras dokumentation med `cpan` eller `cpanm`.
FELSÖKNING
Om du får ett felmeddelande när du använder `perldoc`, kontrollera följande:
Att du använder rätt syntax och alternativ för ditt specifika kommando. Att alla nödvändiga moduler är installerade och laddade. Att du har tillräckliga användarrättigheter för att visa dokumentationen.
Vanliga fel och deras lösningar:
- Felmeddelande: "No documentation found for":
* Lösning: Kontrollera att du har stavat modulnamnet korrekt och att modulen är installerad.
- Felmeddelande: "Can't locate module in @INC":
* Lösning: Kontrollera att modulen är installerad och att den finns i `@INC`-sökvägarna. Du kan installera moduler från CPAN med `cpan` eller `cpanm`.
- Felmeddelande: "Permission denied":
* Lösning: Kontrollera att du har nödvändiga behörigheter för att visa dokumentationen. Använd `sudo` om nödvändigt.
AVANCERAD ANVÄNDNING
`perldoc` erbjuder avancerade funktioner för att visa och hantera Perl-dokumentation mer effektivt. Här är några exempel:
Visa detaljerad modulinformation
För att visa detaljerad information om en modul:
EXEMPEL
perldoc -m File::Basename
Detta kommando visar källkoden för modulen `File::Basename`.
Visa dokumentation för flera ämnen
För att visa dokumentation för flera ämnen i ett enda kommando:
EXEMPEL
perldoc -f printf -f sprintf
Detta kommando visar dokumentationen för funktionerna `printf` och `sprintf`.
Sök i Perl-dokumentation
För att söka i Perl-dokumentation efter ett specifikt ord eller fras:
EXEMPEL
perldoc -q 'open file'
Detta kommando söker i Perl FAQ efter ämnen relaterade till "open file".
Anpassa utdataformat
För att anpassa utdataformatet för dokumentationen:
EXEMPEL
perldoc -t -T File::Basename
Detta kommando visar dokumentationen för `File::Basename` som ren text utan rubriker.
SE ÄVEN
- perl - Perl-skriptverktyget.
- cpan - Hantering av Perl-moduler.
- perlop - Perl-operatörer och specialtecken.
- perlfunc - Perl-byggerfunktioner.
FÖRFATTARE
`perldoc` är en del av Perl-programmeringsspråket och har utvecklats och underhållits av många bidragsgivare genom åren.
KOLOFON
Denna sida är en del av dokumentationen för Perl-programmeringsspråket. Mer information om projektet finns på ⟨https://www.perl.org⟩. Om du har en buggrapport för denna manualsida, se ⟨https://github.com/Perl/perl5/issues⟩. Denna sida erhölls från projektets upstream Git-repository ⟨https://github.com/Perl/perl5.git⟩ den 2023-12-22. Om du upptäcker några renderingsproblem i denna HTML-version av sidan, eller om du tror att det finns en bättre eller mer uppdaterad källa för sidan, eller om du har korrigeringar eller förbättringar av informationen i denna KOLOFON (som inte är en del av den ursprungliga manualsidan), skicka ett e-postmeddelande till man-pages@man7.org.