Mis on siinne dokument?

Seoses arvutite ja arvutiprogrammeerimisega on siinne dokument tekstide loend, mida kasutatakse spetsiaalse operaatori abil programmile edastatava sisendi määratlemiseks, nii et erakordselt pikki käsu- või tekstiplokke saab hõlpsamini edastada. “Here document” või “heredoc” on pigem üldmõiste, kuna siinse dokumendi toimimise ja selle sisu täpne teostus on operatsioonisüsteemist, rakendusest või programmeerimiskeelest erinev. Vaatamata sellele, mida nimi viitab, ei ole siinne dokument tavaliselt eraldi fail, vaid see on skripti tekstiplokk või miskipärast trükitud või sisestatud otse programmikäsu lõppu. Peamiselt kasutatakse siin dokumenti, kui programme käivitatakse käsurealt skripti või pakkfaili kaudu, kus heredoc pakub kas programmi käivitamiseks vajalike juhiste loendit või sisendit, mida programm töödelda. Olenevalt paljudest teguritest võib siinne dokument olla lihtne sõnade loend või see võib sisaldada keerulisi muutujaid või programmeerimiskoodi, mida operatsioonisüsteem või sihtrakendus saab dešifreerida.

Kõige lihtsamates tingimustes on siinne dokument lihtsalt tekstiloend, mis sisaldab vormindamismärke, nagu tabeldusmärke, käru tagastusi ja reavahetusi. See on mugav viis käsurealt käivitatavale programmile argumentide edastamiseks, eriti kui kasutatakse ümbrisfaili, näiteks skripti või pakkfaili. Heredocis sisalduv tekst saadetakse täitvale programmile nii, nagu oleks kasutaja selle sisestanud täpselt sellisena, nagu see paistab. See võimaldab ühte heredoci kasutada ikka ja jälle, et anda programmile sama sisend, et see saaks korduvalt samu ülesandeid täita ilma, et kasutaja peaks tegelikult kõike käsitsi uuesti sisestama.

Üks näide siinse dokumendi toimimisest on näha lihtsa käsurea sendmail programmiga, mis saadab e-kirju. Käivitamisel palub sendmail programm esmalt kasutajal sisestada sihtkoha meiliaadress; seejärel küsib see meili teemat ja lõpuks meili teksti. Kui käivitada käsurealt, vastab kasutaja igale viipale teabe sisestamisega, vajutades tagastusklahvi ja oodates, kuni programm reageerib. Kui ümbrisfailis kasutatakse heredoci, saab kogu sendmaili programmile antava teabe eelnevalt välja trükkida, kaasa arvatud tagastusklahvi vajutused, ja salvestada ümbrisfaili. Sel viisil, kui sendmaili programm käivitatakse koos heredociga, suunatakse sisend automaatselt programmi ja saadetakse e-kiri ilma, et kasutaja peaks midagi enamat tegema.