Hva er et her-dokument?

I forhold til datamaskiner og dataprogrammering er et her dokument en liste over tekst som brukes til å definere innspill som skal sendes til et program ved bruk av en spesiell operatør, slik at eksepsjonelt lange blokker med kommandoer eller tekst lettere kan sendes. "Her dokument", eller "heredoc", er mer et generelt begrep fordi den eksakte implementeringen av hvordan et her dokument fungerer og hva det kan inneholde vil variere fra ett operativsystem, applikasjon eller programmeringsspråk til det neste. Til tross for hva navnet tilsier, er et her-dokument vanligvis ikke en egen fil, men er i stedet en tekstblokk i et skript eller på en eller annen måte skrevet eller satt inn direkte på slutten av en programkommando. Hovedbruken for et her-dokument kommer når programmer kjøres gjennom et skript eller en batch-fil fra kommandolinjen, der heredoksen inneholder enten en liste over instruksjoner for et program å utføre eller legge inn for programmet å behandle. Avhengig av mange faktorer, kan et her dokument være en enkel liste over ord, eller det kan inkludere komplekse variabler eller programmeringskode som operativsystemet eller målapplikasjonen kan tyde.

I de mest grunnleggende begrepene er et her-dokument bare en liste med tekst som inkluderer formateringstegn som faner, vognretur og linjeskift. Det er en praktisk måte å overføre argumenter til et program som kjøres fra kommandolinjen, spesielt hvis det brukes en innpakningsfil som et skript eller en batchfil. Teksten i en heredoc blir sendt til utførende program som om den ble skrevet inn av brukeren nøyaktig slik den ser ut. Dette gjør at en enkelt heredok kan brukes om og om igjen for å gi et program den samme inngangen, slik at den kan utføre de samme oppgavene gjentatte ganger uten å kreve at brukeren faktisk må legge inn alt manuelt.

Et eksempel på hvordan et her-dokument fungerer kan sees med et enkelt kommandolinjens sendmail-program som sender e-post. Når det kjøres, ber sendmail-programmet først brukeren om å oppgi destinasjons-e-postadressen; den ber deretter om emnet til e-posten og til slutt teksten til e-posten. Hvis den kjøres fra kommandolinjen, vil brukeren svare på hver ledetekst ved å skrive inn informasjonen, trykke på returtasten og vente på at programmet skal svare. Når en heredoc brukes i en innpakningsfil, kan all informasjonen som skal gis til sendmail-programmet, skrives ut på forhånd, inkludert returtastene og lagres i innpakningsfilen. På denne måten, når sendmail-programmet utføres med heredoc, blir inngangen automatisk matet til programmet og en e-post blir sendt uten at brukeren krever noe mer.