| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813228142281522816228172281822819228202282122822228232282422825228262282722828228292283022831228322283322834228352283622837228382283922840228412284222843228442284522846228472284822849228502285122852228532285422855228562285722858228592286022861228622286322864228652286622867228682286922870228712287222873228742287522876228772287822879228802288122882228832288422885228862288722888228892289022891228922289322894228952289622897228982289922900229012290222903229042290522906229072290822909229102291122912229132291422915229162291722918229192292022921229222292322924229252292622927229282292922930229312293222933229342293522936229372293822939229402294122942229432294422945229462294722948229492295022951229522295322954229552295622957229582295922960229612296222963229642296522966229672296822969229702297122972229732297422975229762297722978229792298022981229822298322984229852298622987229882298922990229912299222993229942299522996229972299822999230002300123002230032300423005230062300723008230092301023011230122301323014230152301623017230182301923020230212302223023230242302523026230272302823029230302303123032230332303423035230362303723038230392304023041230422304323044230452304623047230482304923050230512305223053230542305523056230572305823059230602306123062230632306423065230662306723068230692307023071230722307323074230752307623077230782307923080230812308223083230842308523086230872308823089230902309123092230932309423095230962309723098230992310023101231022310323104231052310623107231082310923110231112311223113231142311523116231172311823119231202312123122231232312423125231262312723128231292313023131231322313323134231352313623137231382313923140231412314223143231442314523146231472314823149231502315123152231532315423155231562315723158231592316023161231622316323164231652316623167231682316923170231712317223173231742317523176231772317823179231802318123182231832318423185231862318723188231892319023191231922319323194231952319623197231982319923200232012320223203232042320523206232072320823209232102321123212232132321423215232162321723218232192322023221232222322323224232252322623227232282322923230232312323223233232342323523236232372323823239232402324123242232432324423245232462324723248232492325023251232522325323254232552325623257232582325923260232612326223263232642326523266232672326823269232702327123272232732327423275232762327723278232792328023281232822328323284232852328623287232882328923290232912329223293232942329523296232972329823299233002330123302233032330423305233062330723308233092331023311233122331323314233152331623317233182331923320233212332223323233242332523326233272332823329233302333123332233332333423335233362333723338233392334023341233422334323344233452334623347233482334923350233512335223353233542335523356233572335823359233602336123362233632336423365233662336723368233692337023371233722337323374233752337623377233782337923380233812338223383233842338523386233872338823389233902339123392233932339423395233962339723398233992340023401234022340323404234052340623407234082340923410234112341223413234142341523416234172341823419234202342123422234232342423425234262342723428234292343023431234322343323434234352343623437234382343923440234412344223443234442344523446234472344823449234502345123452234532345423455234562345723458234592346023461234622346323464234652346623467234682346923470234712347223473234742347523476234772347823479234802348123482234832348423485234862348723488234892349023491234922349323494234952349623497234982349923500235012350223503235042350523506235072350823509235102351123512235132351423515235162351723518235192352023521235222352323524235252352623527235282352923530235312353223533235342353523536235372353823539235402354123542235432354423545235462354723548235492355023551235522355323554235552355623557235582355923560235612356223563235642356523566235672356823569235702357123572235732357423575235762357723578235792358023581235822358323584235852358623587235882358923590235912359223593235942359523596235972359823599236002360123602236032360423605236062360723608236092361023611236122361323614236152361623617236182361923620236212362223623236242362523626236272362823629236302363123632236332363423635236362363723638236392364023641236422364323644236452364623647236482364923650236512365223653236542365523656236572365823659236602366123662236632366423665236662366723668236692367023671236722367323674236752367623677236782367923680236812368223683236842368523686236872368823689236902369123692236932369423695236962369723698236992370023701237022370323704237052370623707237082370923710237112371223713237142371523716237172371823719237202372123722237232372423725237262372723728237292373023731237322373323734237352373623737237382373923740237412374223743237442374523746237472374823749237502375123752237532375423755237562375723758237592376023761237622376323764237652376623767237682376923770237712377223773237742377523776237772377823779237802378123782237832378423785237862378723788237892379023791237922379323794237952379623797237982379923800238012380223803238042380523806238072380823809238102381123812238132381423815238162381723818238192382023821238222382323824238252382623827238282382923830238312383223833238342383523836238372383823839238402384123842238432384423845238462384723848238492385023851238522385323854238552385623857238582385923860238612386223863238642386523866238672386823869238702387123872238732387423875238762387723878238792388023881238822388323884238852388623887238882388923890238912389223893238942389523896238972389823899239002390123902239032390423905239062390723908239092391023911239122391323914239152391623917239182391923920239212392223923239242392523926239272392823929239302393123932239332393423935239362393723938239392394023941239422394323944239452394623947239482394923950239512395223953239542395523956239572395823959239602396123962239632396423965239662396723968239692397023971239722397323974239752397623977239782397923980239812398223983239842398523986239872398823989239902399123992239932399423995239962399723998239992400024001240022400324004240052400624007240082400924010240112401224013240142401524016240172401824019240202402124022240232402424025240262402724028240292403024031240322403324034240352403624037240382403924040240412404224043240442404524046240472404824049240502405124052240532405424055240562405724058240592406024061240622406324064240652406624067240682406924070240712407224073240742407524076240772407824079240802408124082240832408424085240862408724088240892409024091240922409324094240952409624097240982409924100241012410224103241042410524106241072410824109241102411124112241132411424115241162411724118241192412024121241222412324124241252412624127241282412924130241312413224133241342413524136241372413824139241402414124142241432414424145241462414724148241492415024151241522415324154241552415624157241582415924160241612416224163241642416524166241672416824169241702417124172241732417424175241762417724178241792418024181241822418324184241852418624187241882418924190241912419224193241942419524196241972419824199242002420124202242032420424205242062420724208242092421024211242122421324214242152421624217242182421924220242212422224223242242422524226242272422824229242302423124232242332423424235242362423724238242392424024241242422424324244242452424624247242482424924250242512425224253242542425524256242572425824259242602426124262242632426424265242662426724268242692427024271242722427324274242752427624277242782427924280242812428224283242842428524286242872428824289242902429124292242932429424295242962429724298242992430024301243022430324304243052430624307243082430924310243112431224313243142431524316243172431824319243202432124322243232432424325243262432724328243292433024331243322433324334243352433624337243382433924340243412434224343243442434524346243472434824349243502435124352243532435424355243562435724358243592436024361243622436324364243652436624367243682436924370243712437224373243742437524376243772437824379243802438124382243832438424385243862438724388243892439024391243922439324394243952439624397243982439924400244012440224403244042440524406244072440824409244102441124412244132441424415244162441724418244192442024421244222442324424244252442624427244282442924430244312443224433244342443524436244372443824439244402444124442244432444424445244462444724448244492445024451244522445324454244552445624457244582445924460244612446224463244642446524466244672446824469244702447124472244732447424475244762447724478244792448024481244822448324484244852448624487244882448924490244912449224493244942449524496244972449824499245002450124502245032450424505245062450724508245092451024511245122451324514245152451624517245182451924520245212452224523245242452524526245272452824529245302453124532245332453424535245362453724538245392454024541245422454324544245452454624547245482454924550245512455224553245542455524556245572455824559245602456124562245632456424565245662456724568245692457024571245722457324574245752457624577245782457924580245812458224583245842458524586245872458824589245902459124592245932459424595245962459724598245992460024601246022460324604246052460624607246082460924610246112461224613246142461524616246172461824619246202462124622246232462424625246262462724628246292463024631246322463324634246352463624637246382463924640246412464224643246442464524646246472464824649246502465124652246532465424655246562465724658246592466024661246622466324664246652466624667246682466924670246712467224673246742467524676246772467824679246802468124682246832468424685246862468724688246892469024691246922469324694246952469624697246982469924700247012470224703247042470524706247072470824709247102471124712247132471424715247162471724718247192472024721247222472324724247252472624727247282472924730247312473224733247342473524736247372473824739247402474124742247432474424745247462474724748247492475024751247522475324754247552475624757247582475924760247612476224763247642476524766247672476824769247702477124772247732477424775247762477724778247792478024781247822478324784247852478624787247882478924790247912479224793247942479524796247972479824799248002480124802248032480424805248062480724808248092481024811248122481324814248152481624817248182481924820248212482224823248242482524826248272482824829248302483124832248332483424835248362483724838248392484024841248422484324844248452484624847248482484924850248512485224853248542485524856248572485824859248602486124862248632486424865248662486724868248692487024871248722487324874248752487624877248782487924880248812488224883248842488524886248872488824889248902489124892248932489424895248962489724898248992490024901249022490324904249052490624907249082490924910249112491224913249142491524916249172491824919249202492124922249232492424925249262492724928249292493024931249322493324934249352493624937249382493924940249412494224943249442494524946249472494824949249502495124952249532495424955249562495724958249592496024961249622496324964249652496624967249682496924970249712497224973249742497524976249772497824979249802498124982249832498424985249862498724988249892499024991249922499324994249952499624997249982499925000250012500225003250042500525006250072500825009250102501125012250132501425015250162501725018250192502025021250222502325024250252502625027250282502925030250312503225033250342503525036250372503825039250402504125042250432504425045250462504725048250492505025051250522505325054250552505625057250582505925060250612506225063250642506525066250672506825069250702507125072250732507425075250762507725078250792508025081250822508325084250852508625087250882508925090250912509225093250942509525096250972509825099251002510125102251032510425105251062510725108251092511025111251122511325114251152511625117251182511925120251212512225123251242512525126251272512825129251302513125132251332513425135251362513725138251392514025141251422514325144251452514625147251482514925150251512515225153251542515525156251572515825159251602516125162251632516425165251662516725168251692517025171251722517325174251752517625177251782517925180251812518225183251842518525186251872518825189251902519125192251932519425195251962519725198251992520025201252022520325204252052520625207252082520925210252112521225213252142521525216252172521825219252202522125222252232522425225252262522725228252292523025231252322523325234252352523625237252382523925240252412524225243252442524525246252472524825249252502525125252252532525425255252562525725258252592526025261252622526325264252652526625267252682526925270252712527225273252742527525276252772527825279252802528125282252832528425285252862528725288252892529025291252922529325294252952529625297252982529925300253012530225303253042530525306253072530825309253102531125312253132531425315253162531725318253192532025321253222532325324253252532625327253282532925330253312533225333253342533525336253372533825339253402534125342253432534425345253462534725348253492535025351253522535325354253552535625357253582535925360253612536225363253642536525366253672536825369253702537125372253732537425375253762537725378253792538025381253822538325384253852538625387253882538925390253912539225393253942539525396253972539825399254002540125402254032540425405254062540725408254092541025411254122541325414254152541625417254182541925420254212542225423254242542525426254272542825429254302543125432254332543425435254362543725438254392544025441254422544325444254452544625447254482544925450254512545225453254542545525456254572545825459254602546125462254632546425465254662546725468254692547025471254722547325474254752547625477254782547925480254812548225483254842548525486254872548825489254902549125492254932549425495254962549725498254992550025501255022550325504255052550625507255082550925510255112551225513255142551525516255172551825519255202552125522255232552425525255262552725528255292553025531255322553325534255352553625537255382553925540255412554225543255442554525546255472554825549255502555125552255532555425555255562555725558255592556025561255622556325564255652556625567255682556925570255712557225573255742557525576255772557825579255802558125582255832558425585255862558725588255892559025591255922559325594255952559625597255982559925600256012560225603256042560525606256072560825609256102561125612256132561425615256162561725618256192562025621256222562325624256252562625627256282562925630256312563225633256342563525636256372563825639256402564125642256432564425645256462564725648256492565025651256522565325654256552565625657256582565925660256612566225663256642566525666256672566825669256702567125672256732567425675256762567725678256792568025681256822568325684256852568625687256882568925690256912569225693256942569525696256972569825699257002570125702257032570425705257062570725708257092571025711257122571325714257152571625717257182571925720257212572225723257242572525726257272572825729257302573125732257332573425735257362573725738257392574025741257422574325744257452574625747257482574925750257512575225753257542575525756257572575825759257602576125762257632576425765257662576725768257692577025771257722577325774257752577625777257782577925780257812578225783257842578525786257872578825789257902579125792257932579425795257962579725798257992580025801258022580325804258052580625807258082580925810258112581225813258142581525816258172581825819258202582125822258232582425825258262582725828258292583025831258322583325834258352583625837258382583925840258412584225843258442584525846258472584825849258502585125852258532585425855258562585725858258592586025861258622586325864258652586625867258682586925870258712587225873258742587525876258772587825879258802588125882258832588425885258862588725888258892589025891258922589325894258952589625897258982589925900259012590225903259042590525906259072590825909259102591125912259132591425915259162591725918259192592025921259222592325924259252592625927259282592925930259312593225933259342593525936259372593825939259402594125942259432594425945259462594725948259492595025951259522595325954259552595625957259582595925960259612596225963259642596525966259672596825969259702597125972259732597425975259762597725978259792598025981259822598325984259852598625987259882598925990259912599225993259942599525996259972599825999260002600126002260032600426005260062600726008260092601026011260122601326014260152601626017260182601926020260212602226023260242602526026260272602826029260302603126032260332603426035260362603726038260392604026041260422604326044260452604626047260482604926050260512605226053260542605526056260572605826059260602606126062260632606426065260662606726068260692607026071260722607326074260752607626077260782607926080260812608226083260842608526086260872608826089260902609126092260932609426095260962609726098260992610026101261022610326104261052610626107261082610926110261112611226113261142611526116261172611826119261202612126122261232612426125261262612726128261292613026131261322613326134261352613626137261382613926140261412614226143261442614526146261472614826149261502615126152261532615426155261562615726158261592616026161261622616326164261652616626167261682616926170261712617226173261742617526176261772617826179261802618126182261832618426185261862618726188261892619026191261922619326194261952619626197261982619926200262012620226203262042620526206262072620826209262102621126212262132621426215262162621726218262192622026221262222622326224262252622626227262282622926230262312623226233262342623526236262372623826239262402624126242262432624426245262462624726248262492625026251262522625326254262552625626257262582625926260262612626226263262642626526266262672626826269262702627126272262732627426275262762627726278262792628026281262822628326284262852628626287262882628926290262912629226293262942629526296262972629826299263002630126302263032630426305263062630726308263092631026311263122631326314263152631626317263182631926320263212632226323263242632526326263272632826329263302633126332263332633426335263362633726338263392634026341263422634326344263452634626347263482634926350263512635226353263542635526356263572635826359263602636126362263632636426365263662636726368263692637026371263722637326374263752637626377263782637926380263812638226383263842638526386263872638826389263902639126392263932639426395263962639726398263992640026401264022640326404264052640626407264082640926410264112641226413264142641526416264172641826419264202642126422264232642426425264262642726428264292643026431264322643326434264352643626437264382643926440264412644226443264442644526446264472644826449264502645126452264532645426455264562645726458264592646026461264622646326464264652646626467264682646926470264712647226473264742647526476264772647826479264802648126482264832648426485264862648726488264892649026491264922649326494264952649626497264982649926500265012650226503265042650526506265072650826509265102651126512265132651426515265162651726518265192652026521265222652326524265252652626527265282652926530265312653226533265342653526536265372653826539265402654126542265432654426545265462654726548265492655026551265522655326554265552655626557265582655926560265612656226563265642656526566265672656826569265702657126572265732657426575265762657726578265792658026581265822658326584265852658626587265882658926590265912659226593265942659526596265972659826599266002660126602266032660426605266062660726608266092661026611266122661326614266152661626617266182661926620266212662226623266242662526626266272662826629266302663126632266332663426635266362663726638266392664026641266422664326644266452664626647266482664926650266512665226653266542665526656266572665826659266602666126662266632666426665266662666726668266692667026671266722667326674266752667626677266782667926680266812668226683266842668526686266872668826689266902669126692266932669426695266962669726698266992670026701267022670326704267052670626707267082670926710267112671226713267142671526716267172671826719267202672126722267232672426725267262672726728267292673026731267322673326734267352673626737267382673926740267412674226743267442674526746267472674826749267502675126752267532675426755267562675726758267592676026761267622676326764267652676626767267682676926770267712677226773267742677526776267772677826779267802678126782267832678426785267862678726788267892679026791267922679326794267952679626797267982679926800268012680226803268042680526806268072680826809268102681126812268132681426815268162681726818268192682026821268222682326824268252682626827268282682926830268312683226833268342683526836268372683826839268402684126842268432684426845268462684726848268492685026851268522685326854268552685626857268582685926860268612686226863268642686526866268672686826869268702687126872268732687426875268762687726878268792688026881268822688326884268852688626887268882688926890268912689226893268942689526896268972689826899269002690126902269032690426905269062690726908269092691026911269122691326914269152691626917269182691926920269212692226923269242692526926269272692826929269302693126932269332693426935269362693726938269392694026941269422694326944269452694626947269482694926950269512695226953269542695526956269572695826959269602696126962269632696426965269662696726968269692697026971269722697326974269752697626977269782697926980269812698226983269842698526986269872698826989269902699126992269932699426995269962699726998269992700027001270022700327004270052700627007270082700927010270112701227013270142701527016270172701827019270202702127022270232702427025270262702727028270292703027031270322703327034270352703627037270382703927040270412704227043270442704527046270472704827049270502705127052270532705427055270562705727058270592706027061270622706327064270652706627067270682706927070270712707227073270742707527076270772707827079270802708127082270832708427085270862708727088270892709027091270922709327094270952709627097270982709927100271012710227103271042710527106271072710827109271102711127112271132711427115271162711727118271192712027121271222712327124271252712627127271282712927130271312713227133271342713527136271372713827139271402714127142271432714427145271462714727148271492715027151271522715327154271552715627157271582715927160271612716227163271642716527166271672716827169271702717127172271732717427175271762717727178271792718027181271822718327184271852718627187271882718927190271912719227193271942719527196271972719827199272002720127202272032720427205272062720727208272092721027211272122721327214272152721627217272182721927220272212722227223272242722527226272272722827229272302723127232272332723427235272362723727238272392724027241272422724327244272452724627247272482724927250272512725227253272542725527256272572725827259272602726127262272632726427265272662726727268272692727027271272722727327274272752727627277272782727927280272812728227283272842728527286272872728827289272902729127292272932729427295272962729727298272992730027301273022730327304273052730627307273082730927310273112731227313273142731527316273172731827319273202732127322273232732427325273262732727328273292733027331273322733327334273352733627337273382733927340273412734227343273442734527346273472734827349273502735127352273532735427355273562735727358273592736027361273622736327364273652736627367273682736927370273712737227373273742737527376273772737827379273802738127382273832738427385273862738727388273892739027391273922739327394273952739627397273982739927400274012740227403274042740527406274072740827409274102741127412274132741427415274162741727418274192742027421274222742327424274252742627427274282742927430274312743227433274342743527436274372743827439274402744127442274432744427445274462744727448274492745027451274522745327454274552745627457274582745927460274612746227463274642746527466274672746827469274702747127472274732747427475274762747727478274792748027481274822748327484274852748627487274882748927490274912749227493274942749527496274972749827499275002750127502275032750427505275062750727508275092751027511275122751327514275152751627517275182751927520275212752227523275242752527526275272752827529275302753127532275332753427535275362753727538275392754027541275422754327544275452754627547275482754927550275512755227553275542755527556275572755827559275602756127562275632756427565275662756727568275692757027571275722757327574275752757627577275782757927580275812758227583275842758527586275872758827589275902759127592275932759427595275962759727598275992760027601276022760327604276052760627607276082760927610276112761227613276142761527616276172761827619276202762127622276232762427625276262762727628276292763027631276322763327634276352763627637276382763927640276412764227643276442764527646276472764827649276502765127652276532765427655276562765727658276592766027661276622766327664276652766627667276682766927670276712767227673276742767527676276772767827679276802768127682276832768427685276862768727688276892769027691276922769327694276952769627697276982769927700277012770227703277042770527706277072770827709277102771127712277132771427715277162771727718277192772027721277222772327724277252772627727277282772927730277312773227733277342773527736277372773827739277402774127742277432774427745277462774727748277492775027751277522775327754277552775627757277582775927760277612776227763277642776527766277672776827769277702777127772277732777427775277762777727778277792778027781277822778327784277852778627787277882778927790277912779227793277942779527796277972779827799278002780127802278032780427805278062780727808278092781027811278122781327814278152781627817278182781927820278212782227823278242782527826278272782827829278302783127832278332783427835278362783727838278392784027841278422784327844278452784627847278482784927850278512785227853278542785527856278572785827859278602786127862278632786427865278662786727868278692787027871278722787327874278752787627877278782787927880278812788227883278842788527886278872788827889278902789127892278932789427895278962789727898278992790027901279022790327904279052790627907279082790927910279112791227913279142791527916279172791827919279202792127922279232792427925279262792727928279292793027931279322793327934279352793627937279382793927940279412794227943279442794527946279472794827949279502795127952279532795427955279562795727958279592796027961279622796327964279652796627967279682796927970279712797227973279742797527976279772797827979279802798127982279832798427985279862798727988279892799027991279922799327994279952799627997279982799928000280012800228003280042800528006280072800828009280102801128012280132801428015280162801728018280192802028021280222802328024280252802628027280282802928030280312803228033280342803528036280372803828039280402804128042280432804428045280462804728048280492805028051280522805328054280552805628057280582805928060280612806228063280642806528066280672806828069280702807128072280732807428075280762807728078280792808028081280822808328084280852808628087280882808928090280912809228093280942809528096280972809828099281002810128102281032810428105281062810728108281092811028111281122811328114281152811628117281182811928120281212812228123281242812528126281272812828129281302813128132281332813428135281362813728138281392814028141281422814328144281452814628147281482814928150281512815228153281542815528156281572815828159281602816128162281632816428165281662816728168281692817028171281722817328174281752817628177281782817928180281812818228183281842818528186281872818828189281902819128192281932819428195281962819728198281992820028201282022820328204282052820628207282082820928210282112821228213282142821528216282172821828219282202822128222282232822428225282262822728228282292823028231282322823328234282352823628237282382823928240282412824228243282442824528246282472824828249282502825128252282532825428255282562825728258282592826028261282622826328264282652826628267282682826928270282712827228273282742827528276282772827828279282802828128282282832828428285282862828728288282892829028291282922829328294282952829628297282982829928300283012830228303283042830528306283072830828309283102831128312283132831428315283162831728318283192832028321283222832328324283252832628327283282832928330283312833228333283342833528336283372833828339283402834128342283432834428345283462834728348283492835028351283522835328354283552835628357283582835928360283612836228363283642836528366283672836828369283702837128372283732837428375283762837728378283792838028381283822838328384283852838628387283882838928390283912839228393283942839528396283972839828399284002840128402284032840428405284062840728408284092841028411284122841328414284152841628417284182841928420284212842228423284242842528426284272842828429284302843128432284332843428435284362843728438284392844028441284422844328444284452844628447284482844928450284512845228453284542845528456284572845828459284602846128462284632846428465284662846728468284692847028471284722847328474284752847628477284782847928480284812848228483284842848528486284872848828489284902849128492284932849428495284962849728498284992850028501285022850328504285052850628507285082850928510285112851228513285142851528516285172851828519285202852128522285232852428525285262852728528285292853028531285322853328534285352853628537285382853928540285412854228543285442854528546285472854828549285502855128552285532855428555285562855728558285592856028561285622856328564285652856628567285682856928570285712857228573285742857528576285772857828579285802858128582285832858428585285862858728588285892859028591285922859328594285952859628597285982859928600286012860228603286042860528606286072860828609286102861128612286132861428615286162861728618286192862028621286222862328624286252862628627286282862928630286312863228633286342863528636286372863828639286402864128642286432864428645286462864728648286492865028651286522865328654286552865628657286582865928660286612866228663286642866528666286672866828669286702867128672286732867428675286762867728678286792868028681286822868328684286852868628687286882868928690286912869228693286942869528696286972869828699287002870128702287032870428705287062870728708287092871028711287122871328714287152871628717287182871928720287212872228723287242872528726287272872828729287302873128732287332873428735287362873728738287392874028741287422874328744287452874628747287482874928750287512875228753287542875528756287572875828759287602876128762287632876428765287662876728768287692877028771287722877328774287752877628777287782877928780287812878228783287842878528786287872878828789287902879128792287932879428795287962879728798287992880028801288022880328804288052880628807288082880928810288112881228813288142881528816288172881828819288202882128822288232882428825288262882728828288292883028831288322883328834288352883628837288382883928840288412884228843288442884528846288472884828849288502885128852288532885428855288562885728858288592886028861288622886328864288652886628867288682886928870288712887228873288742887528876288772887828879288802888128882288832888428885288862888728888288892889028891288922889328894288952889628897288982889928900289012890228903289042890528906289072890828909289102891128912289132891428915289162891728918289192892028921289222892328924289252892628927289282892928930289312893228933289342893528936289372893828939289402894128942289432894428945289462894728948289492895028951289522895328954289552895628957289582895928960289612896228963289642896528966289672896828969289702897128972289732897428975289762897728978289792898028981289822898328984289852898628987289882898928990289912899228993289942899528996289972899828999290002900129002290032900429005290062900729008290092901029011290122901329014290152901629017290182901929020290212902229023290242902529026290272902829029290302903129032290332903429035290362903729038290392904029041290422904329044290452904629047290482904929050290512905229053290542905529056290572905829059290602906129062290632906429065290662906729068290692907029071290722907329074290752907629077290782907929080290812908229083290842908529086290872908829089290902909129092290932909429095290962909729098290992910029101291022910329104291052910629107291082910929110291112911229113291142911529116291172911829119291202912129122291232912429125291262912729128291292913029131291322913329134291352913629137291382913929140291412914229143291442914529146291472914829149291502915129152291532915429155291562915729158291592916029161291622916329164291652916629167291682916929170291712917229173291742917529176291772917829179291802918129182291832918429185291862918729188291892919029191291922919329194291952919629197291982919929200292012920229203292042920529206292072920829209292102921129212292132921429215292162921729218292192922029221292222922329224292252922629227292282922929230292312923229233292342923529236292372923829239292402924129242292432924429245292462924729248292492925029251292522925329254292552925629257292582925929260292612926229263292642926529266292672926829269292702927129272292732927429275292762927729278292792928029281292822928329284292852928629287292882928929290292912929229293292942929529296292972929829299293002930129302293032930429305293062930729308293092931029311293122931329314293152931629317293182931929320293212932229323293242932529326293272932829329293302933129332293332933429335293362933729338293392934029341293422934329344293452934629347293482934929350293512935229353293542935529356293572935829359293602936129362293632936429365293662936729368293692937029371293722937329374293752937629377293782937929380293812938229383293842938529386293872938829389293902939129392293932939429395293962939729398293992940029401294022940329404294052940629407294082940929410294112941229413294142941529416294172941829419294202942129422294232942429425294262942729428294292943029431294322943329434294352943629437294382943929440294412944229443294442944529446294472944829449294502945129452294532945429455294562945729458294592946029461294622946329464294652946629467294682946929470294712947229473294742947529476294772947829479294802948129482294832948429485294862948729488294892949029491294922949329494294952949629497294982949929500295012950229503295042950529506295072950829509295102951129512295132951429515295162951729518295192952029521295222952329524295252952629527295282952929530295312953229533295342953529536295372953829539295402954129542295432954429545295462954729548295492955029551295522955329554295552955629557295582955929560295612956229563295642956529566295672956829569295702957129572295732957429575295762957729578295792958029581295822958329584295852958629587295882958929590295912959229593295942959529596295972959829599296002960129602296032960429605296062960729608296092961029611296122961329614296152961629617296182961929620296212962229623296242962529626296272962829629296302963129632296332963429635296362963729638296392964029641296422964329644296452964629647296482964929650296512965229653296542965529656296572965829659296602966129662296632966429665296662966729668296692967029671296722967329674296752967629677296782967929680296812968229683296842968529686296872968829689296902969129692296932969429695296962969729698296992970029701297022970329704297052970629707297082970929710297112971229713297142971529716297172971829719297202972129722297232972429725297262972729728297292973029731297322973329734297352973629737297382973929740297412974229743297442974529746297472974829749297502975129752297532975429755297562975729758297592976029761297622976329764297652976629767297682976929770297712977229773297742977529776297772977829779297802978129782297832978429785297862978729788297892979029791297922979329794297952979629797297982979929800298012980229803298042980529806298072980829809298102981129812298132981429815298162981729818298192982029821298222982329824298252982629827298282982929830298312983229833298342983529836298372983829839298402984129842298432984429845298462984729848298492985029851298522985329854298552985629857298582985929860298612986229863298642986529866298672986829869298702987129872298732987429875298762987729878298792988029881298822988329884298852988629887298882988929890298912989229893298942989529896298972989829899299002990129902299032990429905299062990729908299092991029911299122991329914299152991629917299182991929920299212992229923299242992529926299272992829929299302993129932299332993429935299362993729938299392994029941299422994329944299452994629947299482994929950299512995229953299542995529956299572995829959299602996129962299632996429965299662996729968299692997029971299722997329974299752997629977299782997929980299812998229983299842998529986299872998829989299902999129992299932999429995299962999729998299993000030001300023000330004300053000630007300083000930010300113001230013300143001530016300173001830019300203002130022300233002430025300263002730028300293003030031300323003330034300353003630037300383003930040300413004230043300443004530046300473004830049300503005130052300533005430055300563005730058300593006030061300623006330064300653006630067300683006930070300713007230073300743007530076300773007830079300803008130082300833008430085300863008730088300893009030091300923009330094300953009630097300983009930100301013010230103301043010530106301073010830109301103011130112301133011430115301163011730118301193012030121301223012330124301253012630127301283012930130301313013230133301343013530136301373013830139301403014130142301433014430145301463014730148301493015030151301523015330154301553015630157301583015930160301613016230163301643016530166301673016830169301703017130172301733017430175301763017730178301793018030181301823018330184301853018630187301883018930190301913019230193301943019530196301973019830199302003020130202302033020430205302063020730208302093021030211302123021330214302153021630217302183021930220302213022230223302243022530226302273022830229302303023130232302333023430235302363023730238302393024030241302423024330244302453024630247302483024930250302513025230253302543025530256302573025830259302603026130262302633026430265302663026730268302693027030271302723027330274302753027630277302783027930280302813028230283302843028530286302873028830289302903029130292302933029430295302963029730298302993030030301303023030330304303053030630307303083030930310303113031230313303143031530316303173031830319303203032130322303233032430325303263032730328303293033030331303323033330334303353033630337303383033930340303413034230343303443034530346303473034830349303503035130352303533035430355303563035730358303593036030361303623036330364303653036630367303683036930370303713037230373303743037530376303773037830379303803038130382303833038430385303863038730388303893039030391303923039330394303953039630397303983039930400304013040230403304043040530406304073040830409304103041130412304133041430415304163041730418304193042030421304223042330424304253042630427304283042930430304313043230433304343043530436304373043830439304403044130442304433044430445304463044730448304493045030451304523045330454304553045630457304583045930460304613046230463304643046530466304673046830469304703047130472304733047430475304763047730478304793048030481304823048330484304853048630487304883048930490304913049230493304943049530496304973049830499305003050130502305033050430505305063050730508305093051030511305123051330514305153051630517305183051930520305213052230523305243052530526305273052830529305303053130532305333053430535305363053730538305393054030541305423054330544305453054630547305483054930550305513055230553305543055530556305573055830559305603056130562305633056430565305663056730568305693057030571305723057330574305753057630577305783057930580305813058230583305843058530586305873058830589305903059130592305933059430595305963059730598305993060030601306023060330604306053060630607306083060930610306113061230613306143061530616306173061830619306203062130622306233062430625306263062730628306293063030631306323063330634306353063630637306383063930640306413064230643306443064530646306473064830649306503065130652306533065430655306563065730658306593066030661306623066330664306653066630667306683066930670306713067230673306743067530676306773067830679306803068130682306833068430685306863068730688306893069030691306923069330694306953069630697306983069930700307013070230703307043070530706307073070830709307103071130712307133071430715307163071730718307193072030721307223072330724307253072630727307283072930730307313073230733307343073530736307373073830739307403074130742307433074430745307463074730748307493075030751307523075330754307553075630757307583075930760307613076230763307643076530766307673076830769307703077130772307733077430775307763077730778307793078030781307823078330784307853078630787307883078930790307913079230793307943079530796307973079830799308003080130802308033080430805308063080730808308093081030811308123081330814308153081630817308183081930820308213082230823308243082530826308273082830829308303083130832308333083430835308363083730838308393084030841308423084330844308453084630847308483084930850308513085230853308543085530856308573085830859308603086130862308633086430865308663086730868308693087030871308723087330874308753087630877308783087930880308813088230883308843088530886308873088830889308903089130892308933089430895308963089730898308993090030901309023090330904309053090630907309083090930910309113091230913309143091530916309173091830919309203092130922309233092430925309263092730928309293093030931309323093330934309353093630937309383093930940309413094230943309443094530946309473094830949309503095130952309533095430955309563095730958309593096030961309623096330964309653096630967309683096930970309713097230973309743097530976309773097830979309803098130982309833098430985309863098730988309893099030991309923099330994309953099630997309983099931000310013100231003310043100531006310073100831009310103101131012310133101431015310163101731018310193102031021310223102331024310253102631027310283102931030310313103231033310343103531036310373103831039310403104131042310433104431045310463104731048310493105031051310523105331054310553105631057310583105931060310613106231063310643106531066310673106831069310703107131072310733107431075310763107731078310793108031081310823108331084310853108631087310883108931090310913109231093310943109531096310973109831099311003110131102311033110431105311063110731108311093111031111311123111331114311153111631117311183111931120311213112231123311243112531126311273112831129311303113131132311333113431135311363113731138311393114031141311423114331144311453114631147311483114931150311513115231153311543115531156311573115831159311603116131162311633116431165311663116731168311693117031171311723117331174311753117631177311783117931180311813118231183311843118531186311873118831189311903119131192311933119431195311963119731198311993120031201312023120331204312053120631207312083120931210312113121231213312143121531216312173121831219312203122131222312233122431225312263122731228312293123031231312323123331234312353123631237312383123931240312413124231243312443124531246312473124831249312503125131252312533125431255312563125731258312593126031261312623126331264312653126631267312683126931270312713127231273312743127531276312773127831279312803128131282312833128431285312863128731288312893129031291312923129331294312953129631297312983129931300313013130231303313043130531306313073130831309313103131131312313133131431315313163131731318313193132031321313223132331324313253132631327313283132931330313313133231333313343133531336313373133831339313403134131342313433134431345313463134731348313493135031351313523135331354313553135631357313583135931360313613136231363313643136531366313673136831369313703137131372313733137431375313763137731378313793138031381313823138331384313853138631387313883138931390313913139231393313943139531396313973139831399314003140131402314033140431405314063140731408314093141031411314123141331414314153141631417314183141931420314213142231423314243142531426314273142831429314303143131432314333143431435314363143731438314393144031441314423144331444314453144631447314483144931450314513145231453314543145531456314573145831459314603146131462314633146431465314663146731468314693147031471314723147331474314753147631477314783147931480314813148231483314843148531486314873148831489314903149131492314933149431495314963149731498314993150031501315023150331504315053150631507315083150931510315113151231513315143151531516315173151831519315203152131522315233152431525315263152731528315293153031531315323153331534315353153631537315383153931540315413154231543315443154531546315473154831549315503155131552315533155431555315563155731558315593156031561315623156331564315653156631567315683156931570315713157231573315743157531576315773157831579315803158131582315833158431585315863158731588315893159031591315923159331594315953159631597315983159931600316013160231603316043160531606316073160831609316103161131612316133161431615316163161731618316193162031621316223162331624316253162631627316283162931630316313163231633316343163531636316373163831639316403164131642316433164431645316463164731648316493165031651316523165331654316553165631657316583165931660316613166231663316643166531666316673166831669316703167131672316733167431675316763167731678316793168031681316823168331684316853168631687316883168931690316913169231693316943169531696316973169831699317003170131702317033170431705317063170731708317093171031711317123171331714317153171631717317183171931720317213172231723317243172531726317273172831729317303173131732317333173431735317363173731738317393174031741317423174331744317453174631747317483174931750317513175231753317543175531756317573175831759317603176131762317633176431765317663176731768317693177031771317723177331774317753177631777317783177931780317813178231783317843178531786317873178831789317903179131792317933179431795317963179731798317993180031801318023180331804318053180631807318083180931810318113181231813318143181531816318173181831819318203182131822318233182431825318263182731828318293183031831318323183331834318353183631837318383183931840318413184231843318443184531846318473184831849318503185131852318533185431855318563185731858318593186031861318623186331864318653186631867318683186931870318713187231873318743187531876318773187831879318803188131882318833188431885318863188731888318893189031891318923189331894318953189631897318983189931900319013190231903319043190531906319073190831909319103191131912319133191431915319163191731918319193192031921319223192331924319253192631927319283192931930319313193231933319343193531936319373193831939319403194131942319433194431945319463194731948319493195031951319523195331954319553195631957319583195931960319613196231963319643196531966319673196831969319703197131972319733197431975319763197731978319793198031981319823198331984319853198631987319883198931990319913199231993319943199531996319973199831999320003200132002320033200432005320063200732008320093201032011320123201332014320153201632017320183201932020320213202232023320243202532026320273202832029320303203132032320333203432035320363203732038320393204032041320423204332044320453204632047320483204932050320513205232053320543205532056320573205832059320603206132062320633206432065320663206732068320693207032071320723207332074320753207632077320783207932080320813208232083320843208532086320873208832089320903209132092320933209432095320963209732098320993210032101321023210332104321053210632107321083210932110321113211232113321143211532116321173211832119321203212132122321233212432125321263212732128321293213032131321323213332134321353213632137321383213932140321413214232143321443214532146321473214832149321503215132152321533215432155321563215732158321593216032161321623216332164321653216632167321683216932170321713217232173321743217532176321773217832179321803218132182321833218432185321863218732188321893219032191321923219332194321953219632197321983219932200322013220232203322043220532206322073220832209322103221132212322133221432215322163221732218322193222032221322223222332224322253222632227322283222932230322313223232233322343223532236322373223832239322403224132242322433224432245322463224732248322493225032251322523225332254322553225632257322583225932260322613226232263322643226532266322673226832269322703227132272322733227432275322763227732278322793228032281322823228332284322853228632287322883228932290322913229232293322943229532296322973229832299323003230132302323033230432305323063230732308323093231032311323123231332314323153231632317323183231932320323213232232323323243232532326323273232832329323303233132332323333233432335323363233732338323393234032341323423234332344323453234632347323483234932350323513235232353323543235532356323573235832359323603236132362323633236432365323663236732368323693237032371323723237332374323753237632377323783237932380323813238232383323843238532386323873238832389323903239132392323933239432395323963239732398323993240032401324023240332404324053240632407324083240932410324113241232413324143241532416324173241832419324203242132422324233242432425324263242732428324293243032431324323243332434324353243632437324383243932440324413244232443324443244532446324473244832449324503245132452324533245432455324563245732458324593246032461324623246332464324653246632467324683246932470324713247232473324743247532476324773247832479324803248132482324833248432485324863248732488324893249032491324923249332494324953249632497324983249932500325013250232503325043250532506325073250832509325103251132512325133251432515325163251732518325193252032521325223252332524325253252632527325283252932530325313253232533325343253532536325373253832539325403254132542325433254432545325463254732548325493255032551325523255332554325553255632557325583255932560325613256232563325643256532566325673256832569325703257132572325733257432575325763257732578325793258032581325823258332584325853258632587325883258932590325913259232593325943259532596325973259832599326003260132602326033260432605326063260732608326093261032611326123261332614326153261632617326183261932620326213262232623326243262532626326273262832629326303263132632326333263432635326363263732638326393264032641326423264332644326453264632647326483264932650326513265232653326543265532656326573265832659326603266132662326633266432665326663266732668326693267032671326723267332674326753267632677326783267932680326813268232683326843268532686326873268832689326903269132692326933269432695326963269732698326993270032701327023270332704327053270632707327083270932710327113271232713327143271532716327173271832719327203272132722327233272432725327263272732728327293273032731327323273332734327353273632737327383273932740327413274232743327443274532746327473274832749327503275132752327533275432755327563275732758327593276032761327623276332764327653276632767327683276932770327713277232773327743277532776327773277832779327803278132782327833278432785327863278732788327893279032791327923279332794327953279632797327983279932800328013280232803328043280532806328073280832809328103281132812328133281432815328163281732818328193282032821328223282332824328253282632827328283282932830328313283232833328343283532836328373283832839328403284132842328433284432845328463284732848328493285032851328523285332854328553285632857328583285932860328613286232863328643286532866328673286832869328703287132872328733287432875328763287732878328793288032881328823288332884328853288632887328883288932890328913289232893328943289532896328973289832899329003290132902329033290432905329063290732908329093291032911329123291332914329153291632917329183291932920329213292232923329243292532926329273292832929329303293132932329333293432935329363293732938329393294032941329423294332944329453294632947329483294932950329513295232953329543295532956329573295832959329603296132962329633296432965329663296732968329693297032971329723297332974329753297632977329783297932980329813298232983329843298532986329873298832989329903299132992329933299432995329963299732998329993300033001330023300333004330053300633007330083300933010330113301233013330143301533016330173301833019330203302133022330233302433025330263302733028330293303033031330323303333034330353303633037330383303933040330413304233043330443304533046330473304833049330503305133052330533305433055330563305733058330593306033061330623306333064330653306633067330683306933070330713307233073330743307533076330773307833079330803308133082330833308433085330863308733088330893309033091330923309333094330953309633097330983309933100331013310233103331043310533106331073310833109331103311133112331133311433115331163311733118331193312033121331223312333124331253312633127331283312933130331313313233133331343313533136331373313833139331403314133142331433314433145331463314733148331493315033151331523315333154331553315633157331583315933160331613316233163331643316533166331673316833169331703317133172331733317433175331763317733178331793318033181331823318333184331853318633187331883318933190331913319233193331943319533196331973319833199332003320133202332033320433205332063320733208332093321033211332123321333214332153321633217332183321933220332213322233223332243322533226332273322833229332303323133232332333323433235332363323733238332393324033241332423324333244332453324633247332483324933250332513325233253332543325533256332573325833259332603326133262332633326433265332663326733268332693327033271332723327333274332753327633277332783327933280332813328233283332843328533286332873328833289332903329133292332933329433295332963329733298332993330033301333023330333304333053330633307333083330933310333113331233313333143331533316333173331833319333203332133322333233332433325333263332733328333293333033331333323333333334333353333633337333383333933340333413334233343333443334533346333473334833349333503335133352333533335433355333563335733358333593336033361333623336333364333653336633367333683336933370333713337233373333743337533376333773337833379333803338133382333833338433385333863338733388333893339033391333923339333394333953339633397333983339933400334013340233403334043340533406334073340833409334103341133412334133341433415334163341733418334193342033421334223342333424334253342633427334283342933430334313343233433334343343533436334373343833439334403344133442334433344433445334463344733448334493345033451334523345333454334553345633457334583345933460334613346233463334643346533466334673346833469334703347133472334733347433475334763347733478334793348033481334823348333484334853348633487334883348933490334913349233493334943349533496334973349833499335003350133502335033350433505335063350733508335093351033511335123351333514335153351633517335183351933520335213352233523335243352533526335273352833529335303353133532335333353433535335363353733538335393354033541335423354333544335453354633547335483354933550335513355233553335543355533556335573355833559335603356133562335633356433565335663356733568335693357033571335723357333574335753357633577335783357933580335813358233583335843358533586335873358833589335903359133592335933359433595335963359733598335993360033601336023360333604336053360633607336083360933610336113361233613336143361533616336173361833619336203362133622336233362433625336263362733628336293363033631336323363333634336353363633637336383363933640336413364233643336443364533646336473364833649336503365133652336533365433655336563365733658336593366033661336623366333664336653366633667336683366933670336713367233673336743367533676336773367833679336803368133682336833368433685336863368733688336893369033691336923369333694336953369633697336983369933700337013370233703337043370533706337073370833709337103371133712337133371433715337163371733718337193372033721337223372333724337253372633727337283372933730337313373233733337343373533736337373373833739337403374133742337433374433745337463374733748337493375033751337523375333754337553375633757337583375933760337613376233763337643376533766337673376833769337703377133772337733377433775337763377733778337793378033781337823378333784337853378633787337883378933790337913379233793337943379533796337973379833799338003380133802338033380433805338063380733808338093381033811338123381333814338153381633817338183381933820338213382233823338243382533826338273382833829338303383133832338333383433835338363383733838338393384033841338423384333844338453384633847338483384933850338513385233853338543385533856338573385833859338603386133862338633386433865338663386733868338693387033871338723387333874338753387633877338783387933880338813388233883338843388533886338873388833889338903389133892338933389433895338963389733898338993390033901339023390333904339053390633907339083390933910339113391233913339143391533916339173391833919339203392133922339233392433925339263392733928339293393033931339323393333934339353393633937339383393933940339413394233943339443394533946339473394833949339503395133952339533395433955339563395733958339593396033961339623396333964339653396633967339683396933970339713397233973339743397533976339773397833979339803398133982339833398433985339863398733988339893399033991339923399333994339953399633997339983399934000340013400234003340043400534006340073400834009340103401134012340133401434015340163401734018340193402034021340223402334024340253402634027340283402934030340313403234033340343403534036340373403834039340403404134042340433404434045340463404734048340493405034051340523405334054340553405634057340583405934060340613406234063340643406534066340673406834069340703407134072340733407434075340763407734078340793408034081340823408334084340853408634087340883408934090340913409234093340943409534096340973409834099341003410134102341033410434105341063410734108341093411034111341123411334114341153411634117341183411934120341213412234123341243412534126341273412834129341303413134132341333413434135341363413734138341393414034141341423414334144341453414634147341483414934150341513415234153341543415534156341573415834159341603416134162341633416434165341663416734168341693417034171341723417334174341753417634177341783417934180341813418234183341843418534186341873418834189341903419134192341933419434195341963419734198341993420034201342023420334204342053420634207342083420934210342113421234213342143421534216342173421834219342203422134222342233422434225342263422734228342293423034231342323423334234342353423634237342383423934240342413424234243342443424534246342473424834249342503425134252342533425434255342563425734258342593426034261342623426334264342653426634267342683426934270342713427234273342743427534276342773427834279342803428134282342833428434285342863428734288342893429034291342923429334294342953429634297342983429934300343013430234303343043430534306343073430834309343103431134312343133431434315343163431734318343193432034321343223432334324343253432634327343283432934330343313433234333343343433534336343373433834339343403434134342343433434434345343463434734348343493435034351343523435334354343553435634357343583435934360343613436234363343643436534366343673436834369343703437134372343733437434375343763437734378343793438034381343823438334384343853438634387343883438934390343913439234393343943439534396343973439834399344003440134402344033440434405344063440734408344093441034411344123441334414344153441634417344183441934420344213442234423344243442534426344273442834429344303443134432344333443434435344363443734438344393444034441344423444334444344453444634447344483444934450344513445234453344543445534456344573445834459344603446134462344633446434465344663446734468344693447034471344723447334474344753447634477344783447934480344813448234483344843448534486344873448834489344903449134492344933449434495344963449734498344993450034501345023450334504345053450634507345083450934510345113451234513345143451534516345173451834519345203452134522345233452434525345263452734528345293453034531345323453334534345353453634537345383453934540345413454234543345443454534546345473454834549345503455134552345533455434555345563455734558345593456034561345623456334564345653456634567345683456934570345713457234573345743457534576345773457834579345803458134582345833458434585345863458734588345893459034591345923459334594345953459634597345983459934600346013460234603346043460534606346073460834609346103461134612346133461434615346163461734618346193462034621346223462334624346253462634627346283462934630346313463234633346343463534636346373463834639346403464134642346433464434645346463464734648346493465034651346523465334654346553465634657346583465934660346613466234663346643466534666346673466834669346703467134672346733467434675346763467734678346793468034681346823468334684346853468634687346883468934690346913469234693346943469534696346973469834699347003470134702347033470434705347063470734708347093471034711347123471334714347153471634717347183471934720347213472234723347243472534726347273472834729347303473134732347333473434735347363473734738347393474034741347423474334744347453474634747347483474934750347513475234753347543475534756347573475834759347603476134762347633476434765347663476734768347693477034771347723477334774347753477634777347783477934780347813478234783347843478534786347873478834789347903479134792347933479434795347963479734798347993480034801348023480334804348053480634807348083480934810348113481234813348143481534816348173481834819348203482134822348233482434825348263482734828348293483034831348323483334834348353483634837348383483934840348413484234843348443484534846348473484834849348503485134852348533485434855348563485734858348593486034861348623486334864348653486634867348683486934870348713487234873348743487534876348773487834879348803488134882348833488434885348863488734888348893489034891348923489334894348953489634897348983489934900349013490234903349043490534906349073490834909349103491134912349133491434915349163491734918349193492034921349223492334924349253492634927349283492934930349313493234933349343493534936349373493834939349403494134942349433494434945349463494734948349493495034951349523495334954349553495634957349583495934960349613496234963349643496534966349673496834969349703497134972349733497434975349763497734978349793498034981349823498334984349853498634987349883498934990349913499234993349943499534996349973499834999350003500135002350033500435005350063500735008350093501035011350123501335014350153501635017350183501935020350213502235023350243502535026350273502835029350303503135032350333503435035350363503735038350393504035041350423504335044350453504635047350483504935050350513505235053350543505535056350573505835059350603506135062350633506435065350663506735068350693507035071350723507335074350753507635077350783507935080350813508235083350843508535086350873508835089350903509135092350933509435095350963509735098350993510035101351023510335104351053510635107351083510935110351113511235113351143511535116351173511835119351203512135122351233512435125351263512735128351293513035131351323513335134351353513635137351383513935140351413514235143351443514535146351473514835149351503515135152351533515435155351563515735158351593516035161351623516335164351653516635167351683516935170351713517235173351743517535176351773517835179351803518135182351833518435185351863518735188351893519035191351923519335194351953519635197351983519935200352013520235203352043520535206352073520835209352103521135212352133521435215352163521735218352193522035221352223522335224352253522635227352283522935230352313523235233352343523535236352373523835239352403524135242352433524435245352463524735248352493525035251352523525335254352553525635257352583525935260352613526235263352643526535266352673526835269352703527135272352733527435275352763527735278352793528035281352823528335284352853528635287352883528935290352913529235293352943529535296352973529835299353003530135302353033530435305353063530735308353093531035311353123531335314353153531635317353183531935320353213532235323353243532535326353273532835329353303533135332353333533435335353363533735338353393534035341353423534335344353453534635347353483534935350353513535235353353543535535356353573535835359353603536135362353633536435365353663536735368353693537035371353723537335374353753537635377353783537935380353813538235383353843538535386353873538835389353903539135392353933539435395353963539735398353993540035401354023540335404354053540635407354083540935410354113541235413354143541535416354173541835419354203542135422354233542435425354263542735428354293543035431354323543335434354353543635437354383543935440354413544235443354443544535446354473544835449354503545135452354533545435455354563545735458354593546035461354623546335464354653546635467354683546935470354713547235473354743547535476354773547835479354803548135482354833548435485354863548735488354893549035491354923549335494354953549635497354983549935500355013550235503355043550535506355073550835509355103551135512355133551435515355163551735518355193552035521355223552335524355253552635527355283552935530355313553235533355343553535536355373553835539355403554135542355433554435545355463554735548355493555035551355523555335554355553555635557355583555935560355613556235563355643556535566355673556835569355703557135572355733557435575355763557735578355793558035581355823558335584355853558635587355883558935590355913559235593355943559535596355973559835599356003560135602356033560435605356063560735608356093561035611356123561335614356153561635617356183561935620356213562235623356243562535626356273562835629356303563135632356333563435635356363563735638356393564035641356423564335644356453564635647356483564935650356513565235653356543565535656356573565835659356603566135662356633566435665356663566735668356693567035671356723567335674356753567635677356783567935680356813568235683356843568535686356873568835689356903569135692356933569435695356963569735698356993570035701357023570335704357053570635707357083570935710357113571235713357143571535716357173571835719357203572135722357233572435725357263572735728357293573035731357323573335734357353573635737357383573935740357413574235743357443574535746357473574835749357503575135752357533575435755357563575735758357593576035761357623576335764357653576635767357683576935770357713577235773357743577535776357773577835779357803578135782357833578435785357863578735788357893579035791357923579335794357953579635797357983579935800358013580235803358043580535806358073580835809358103581135812358133581435815358163581735818358193582035821358223582335824358253582635827358283582935830358313583235833358343583535836358373583835839358403584135842358433584435845358463584735848358493585035851358523585335854358553585635857358583585935860358613586235863358643586535866358673586835869358703587135872358733587435875358763587735878358793588035881358823588335884358853588635887358883588935890358913589235893358943589535896358973589835899359003590135902359033590435905359063590735908359093591035911359123591335914359153591635917359183591935920359213592235923359243592535926359273592835929359303593135932359333593435935359363593735938359393594035941359423594335944359453594635947359483594935950359513595235953359543595535956359573595835959359603596135962359633596435965359663596735968359693597035971359723597335974359753597635977359783597935980359813598235983359843598535986359873598835989359903599135992359933599435995359963599735998359993600036001360023600336004360053600636007360083600936010360113601236013360143601536016360173601836019360203602136022360233602436025360263602736028360293603036031360323603336034360353603636037360383603936040360413604236043360443604536046360473604836049360503605136052360533605436055360563605736058360593606036061360623606336064360653606636067360683606936070360713607236073360743607536076360773607836079360803608136082360833608436085360863608736088360893609036091360923609336094360953609636097360983609936100361013610236103361043610536106361073610836109361103611136112361133611436115361163611736118361193612036121361223612336124361253612636127361283612936130361313613236133361343613536136361373613836139361403614136142361433614436145361463614736148361493615036151361523615336154361553615636157361583615936160361613616236163361643616536166361673616836169361703617136172361733617436175361763617736178361793618036181361823618336184361853618636187361883618936190361913619236193361943619536196361973619836199362003620136202362033620436205362063620736208362093621036211362123621336214362153621636217362183621936220362213622236223362243622536226362273622836229362303623136232362333623436235362363623736238362393624036241362423624336244362453624636247362483624936250362513625236253362543625536256362573625836259362603626136262362633626436265362663626736268362693627036271362723627336274362753627636277362783627936280362813628236283362843628536286362873628836289362903629136292362933629436295362963629736298362993630036301363023630336304363053630636307363083630936310363113631236313363143631536316363173631836319363203632136322363233632436325363263632736328363293633036331363323633336334363353633636337363383633936340363413634236343363443634536346363473634836349363503635136352363533635436355363563635736358363593636036361363623636336364363653636636367363683636936370363713637236373363743637536376363773637836379363803638136382363833638436385363863638736388363893639036391363923639336394363953639636397363983639936400364013640236403364043640536406364073640836409364103641136412364133641436415364163641736418364193642036421364223642336424364253642636427364283642936430364313643236433364343643536436364373643836439364403644136442364433644436445364463644736448364493645036451364523645336454364553645636457364583645936460364613646236463364643646536466364673646836469364703647136472364733647436475364763647736478364793648036481364823648336484364853648636487364883648936490364913649236493364943649536496364973649836499365003650136502365033650436505365063650736508365093651036511365123651336514365153651636517365183651936520365213652236523365243652536526365273652836529365303653136532365333653436535365363653736538365393654036541365423654336544365453654636547365483654936550365513655236553365543655536556365573655836559365603656136562365633656436565365663656736568365693657036571365723657336574365753657636577365783657936580365813658236583365843658536586365873658836589365903659136592365933659436595365963659736598365993660036601366023660336604366053660636607366083660936610366113661236613366143661536616366173661836619366203662136622366233662436625366263662736628366293663036631366323663336634366353663636637366383663936640366413664236643366443664536646366473664836649366503665136652366533665436655366563665736658366593666036661366623666336664366653666636667366683666936670366713667236673366743667536676366773667836679366803668136682366833668436685366863668736688366893669036691366923669336694366953669636697366983669936700367013670236703367043670536706367073670836709367103671136712367133671436715367163671736718367193672036721367223672336724367253672636727367283672936730367313673236733367343673536736367373673836739367403674136742367433674436745367463674736748367493675036751367523675336754367553675636757367583675936760367613676236763367643676536766367673676836769367703677136772367733677436775367763677736778367793678036781367823678336784367853678636787367883678936790367913679236793367943679536796367973679836799368003680136802368033680436805368063680736808368093681036811368123681336814368153681636817368183681936820368213682236823368243682536826368273682836829368303683136832368333683436835368363683736838368393684036841368423684336844368453684636847368483684936850368513685236853368543685536856368573685836859368603686136862368633686436865368663686736868368693687036871368723687336874368753687636877368783687936880368813688236883368843688536886368873688836889368903689136892368933689436895368963689736898368993690036901369023690336904369053690636907369083690936910369113691236913369143691536916369173691836919369203692136922369233692436925369263692736928369293693036931369323693336934369353693636937369383693936940369413694236943369443694536946369473694836949369503695136952369533695436955369563695736958369593696036961369623696336964369653696636967369683696936970369713697236973369743697536976369773697836979369803698136982369833698436985369863698736988369893699036991369923699336994369953699636997369983699937000370013700237003370043700537006370073700837009370103701137012370133701437015370163701737018370193702037021370223702337024370253702637027370283702937030370313703237033370343703537036370373703837039370403704137042370433704437045370463704737048370493705037051370523705337054370553705637057370583705937060370613706237063370643706537066370673706837069370703707137072370733707437075370763707737078370793708037081370823708337084370853708637087370883708937090370913709237093370943709537096370973709837099371003710137102371033710437105371063710737108371093711037111371123711337114371153711637117371183711937120371213712237123371243712537126371273712837129371303713137132371333713437135371363713737138371393714037141371423714337144371453714637147371483714937150371513715237153371543715537156371573715837159371603716137162371633716437165371663716737168371693717037171371723717337174371753717637177371783717937180371813718237183371843718537186371873718837189371903719137192371933719437195371963719737198371993720037201372023720337204372053720637207372083720937210372113721237213372143721537216372173721837219372203722137222372233722437225372263722737228372293723037231372323723337234372353723637237372383723937240372413724237243372443724537246372473724837249372503725137252372533725437255372563725737258372593726037261372623726337264372653726637267372683726937270372713727237273372743727537276372773727837279372803728137282372833728437285372863728737288372893729037291372923729337294372953729637297372983729937300373013730237303373043730537306373073730837309373103731137312373133731437315373163731737318373193732037321373223732337324373253732637327373283732937330373313733237333373343733537336373373733837339373403734137342373433734437345373463734737348373493735037351373523735337354373553735637357373583735937360373613736237363373643736537366373673736837369373703737137372373733737437375373763737737378373793738037381373823738337384373853738637387373883738937390373913739237393373943739537396373973739837399374003740137402374033740437405374063740737408374093741037411374123741337414374153741637417374183741937420374213742237423374243742537426374273742837429374303743137432374333743437435374363743737438374393744037441374423744337444374453744637447374483744937450374513745237453374543745537456374573745837459374603746137462374633746437465374663746737468374693747037471374723747337474374753747637477374783747937480374813748237483374843748537486374873748837489374903749137492374933749437495374963749737498374993750037501375023750337504375053750637507375083750937510375113751237513375143751537516375173751837519375203752137522375233752437525375263752737528375293753037531375323753337534375353753637537375383753937540375413754237543375443754537546375473754837549375503755137552375533755437555375563755737558375593756037561375623756337564375653756637567375683756937570375713757237573375743757537576375773757837579375803758137582375833758437585375863758737588375893759037591375923759337594375953759637597375983759937600376013760237603376043760537606376073760837609376103761137612376133761437615376163761737618376193762037621376223762337624376253762637627376283762937630376313763237633376343763537636376373763837639376403764137642376433764437645376463764737648376493765037651376523765337654376553765637657376583765937660376613766237663376643766537666376673766837669376703767137672376733767437675376763767737678376793768037681376823768337684376853768637687376883768937690376913769237693376943769537696376973769837699377003770137702377033770437705377063770737708377093771037711377123771337714377153771637717377183771937720377213772237723377243772537726377273772837729377303773137732377333773437735377363773737738377393774037741377423774337744377453774637747377483774937750377513775237753377543775537756377573775837759377603776137762377633776437765377663776737768377693777037771377723777337774377753777637777377783777937780377813778237783377843778537786377873778837789377903779137792377933779437795377963779737798377993780037801378023780337804378053780637807378083780937810378113781237813378143781537816378173781837819378203782137822378233782437825378263782737828378293783037831378323783337834378353783637837378383783937840378413784237843378443784537846378473784837849378503785137852378533785437855378563785737858378593786037861378623786337864378653786637867378683786937870378713787237873378743787537876378773787837879378803788137882378833788437885378863788737888378893789037891378923789337894378953789637897378983789937900379013790237903379043790537906379073790837909379103791137912379133791437915379163791737918379193792037921379223792337924379253792637927379283792937930379313793237933379343793537936379373793837939379403794137942379433794437945379463794737948379493795037951379523795337954379553795637957379583795937960379613796237963379643796537966379673796837969379703797137972379733797437975379763797737978379793798037981379823798337984379853798637987379883798937990379913799237993379943799537996379973799837999380003800138002380033800438005380063800738008380093801038011380123801338014380153801638017380183801938020380213802238023380243802538026380273802838029380303803138032380333803438035380363803738038380393804038041380423804338044380453804638047380483804938050380513805238053380543805538056380573805838059380603806138062380633806438065380663806738068380693807038071380723807338074380753807638077380783807938080380813808238083380843808538086380873808838089380903809138092380933809438095380963809738098380993810038101381023810338104381053810638107381083810938110381113811238113381143811538116381173811838119381203812138122381233812438125381263812738128381293813038131381323813338134381353813638137381383813938140381413814238143381443814538146381473814838149381503815138152381533815438155381563815738158381593816038161381623816338164381653816638167381683816938170381713817238173381743817538176381773817838179381803818138182381833818438185381863818738188381893819038191381923819338194381953819638197381983819938200382013820238203382043820538206382073820838209382103821138212382133821438215382163821738218382193822038221382223822338224382253822638227382283822938230382313823238233382343823538236382373823838239382403824138242382433824438245382463824738248382493825038251382523825338254382553825638257382583825938260382613826238263382643826538266382673826838269382703827138272382733827438275382763827738278382793828038281382823828338284382853828638287382883828938290382913829238293382943829538296382973829838299383003830138302383033830438305383063830738308383093831038311383123831338314383153831638317383183831938320383213832238323383243832538326383273832838329383303833138332383333833438335383363833738338383393834038341383423834338344383453834638347383483834938350383513835238353383543835538356383573835838359383603836138362383633836438365383663836738368383693837038371383723837338374383753837638377383783837938380383813838238383383843838538386383873838838389383903839138392383933839438395383963839738398383993840038401384023840338404384053840638407384083840938410384113841238413384143841538416384173841838419384203842138422384233842438425384263842738428384293843038431384323843338434384353843638437384383843938440384413844238443384443844538446384473844838449384503845138452384533845438455384563845738458384593846038461384623846338464384653846638467384683846938470384713847238473384743847538476384773847838479384803848138482384833848438485384863848738488384893849038491384923849338494384953849638497384983849938500385013850238503385043850538506385073850838509385103851138512385133851438515385163851738518385193852038521385223852338524385253852638527385283852938530385313853238533385343853538536385373853838539385403854138542385433854438545385463854738548385493855038551385523855338554385553855638557385583855938560385613856238563385643856538566385673856838569385703857138572385733857438575385763857738578385793858038581385823858338584385853858638587385883858938590385913859238593385943859538596385973859838599386003860138602386033860438605386063860738608386093861038611386123861338614386153861638617386183861938620386213862238623386243862538626386273862838629386303863138632386333863438635386363863738638386393864038641386423864338644386453864638647386483864938650386513865238653386543865538656386573865838659386603866138662386633866438665386663866738668386693867038671386723867338674386753867638677386783867938680386813868238683386843868538686386873868838689386903869138692386933869438695386963869738698386993870038701387023870338704387053870638707387083870938710387113871238713387143871538716387173871838719387203872138722387233872438725387263872738728387293873038731387323873338734387353873638737387383873938740387413874238743387443874538746387473874838749387503875138752387533875438755387563875738758387593876038761387623876338764387653876638767387683876938770387713877238773387743877538776387773877838779387803878138782387833878438785387863878738788387893879038791387923879338794387953879638797387983879938800388013880238803388043880538806388073880838809388103881138812388133881438815388163881738818388193882038821388223882338824388253882638827388283882938830388313883238833388343883538836388373883838839388403884138842388433884438845388463884738848388493885038851388523885338854388553885638857388583885938860388613886238863388643886538866388673886838869388703887138872388733887438875388763887738878388793888038881388823888338884388853888638887388883888938890388913889238893388943889538896388973889838899389003890138902389033890438905389063890738908389093891038911389123891338914389153891638917389183891938920389213892238923389243892538926389273892838929389303893138932389333893438935389363893738938389393894038941389423894338944389453894638947389483894938950389513895238953389543895538956389573895838959389603896138962389633896438965389663896738968389693897038971389723897338974389753897638977389783897938980389813898238983389843898538986389873898838989389903899138992389933899438995389963899738998389993900039001390023900339004390053900639007390083900939010390113901239013390143901539016390173901839019390203902139022390233902439025390263902739028390293903039031390323903339034390353903639037390383903939040390413904239043390443904539046390473904839049390503905139052390533905439055390563905739058390593906039061390623906339064390653906639067390683906939070390713907239073390743907539076390773907839079390803908139082390833908439085390863908739088390893909039091390923909339094390953909639097390983909939100391013910239103391043910539106391073910839109391103911139112391133911439115391163911739118391193912039121391223912339124391253912639127391283912939130391313913239133391343913539136391373913839139391403914139142391433914439145391463914739148391493915039151391523915339154391553915639157391583915939160391613916239163391643916539166391673916839169391703917139172391733917439175391763917739178391793918039181391823918339184391853918639187391883918939190391913919239193391943919539196391973919839199392003920139202392033920439205392063920739208392093921039211392123921339214392153921639217392183921939220392213922239223392243922539226392273922839229392303923139232392333923439235392363923739238392393924039241392423924339244392453924639247392483924939250392513925239253392543925539256392573925839259392603926139262392633926439265392663926739268392693927039271392723927339274392753927639277392783927939280392813928239283392843928539286392873928839289392903929139292392933929439295392963929739298392993930039301393023930339304393053930639307393083930939310393113931239313393143931539316393173931839319393203932139322393233932439325393263932739328393293933039331393323933339334393353933639337393383933939340393413934239343393443934539346393473934839349393503935139352393533935439355393563935739358393593936039361393623936339364393653936639367393683936939370393713937239373393743937539376393773937839379393803938139382393833938439385393863938739388393893939039391393923939339394393953939639397393983939939400394013940239403394043940539406394073940839409394103941139412394133941439415394163941739418394193942039421394223942339424394253942639427394283942939430394313943239433394343943539436394373943839439394403944139442394433944439445394463944739448394493945039451394523945339454394553945639457394583945939460394613946239463394643946539466394673946839469394703947139472394733947439475394763947739478394793948039481394823948339484394853948639487394883948939490394913949239493394943949539496394973949839499395003950139502395033950439505395063950739508395093951039511395123951339514395153951639517395183951939520395213952239523395243952539526395273952839529395303953139532395333953439535395363953739538395393954039541395423954339544395453954639547395483954939550395513955239553395543955539556395573955839559395603956139562395633956439565395663956739568395693957039571395723957339574395753957639577395783957939580395813958239583395843958539586395873958839589395903959139592395933959439595395963959739598395993960039601396023960339604396053960639607396083960939610396113961239613396143961539616396173961839619396203962139622396233962439625396263962739628396293963039631396323963339634396353963639637396383963939640396413964239643396443964539646396473964839649396503965139652396533965439655396563965739658396593966039661396623966339664396653966639667396683966939670396713967239673396743967539676396773967839679396803968139682396833968439685396863968739688396893969039691396923969339694396953969639697396983969939700397013970239703397043970539706397073970839709397103971139712397133971439715397163971739718397193972039721397223972339724397253972639727397283972939730397313973239733397343973539736397373973839739397403974139742397433974439745397463974739748397493975039751397523975339754397553975639757397583975939760397613976239763397643976539766397673976839769397703977139772397733977439775397763977739778397793978039781397823978339784397853978639787397883978939790397913979239793397943979539796397973979839799398003980139802398033980439805398063980739808398093981039811398123981339814398153981639817398183981939820398213982239823398243982539826398273982839829398303983139832398333983439835398363983739838398393984039841398423984339844398453984639847398483984939850398513985239853398543985539856398573985839859398603986139862398633986439865398663986739868398693987039871398723987339874398753987639877398783987939880398813988239883398843988539886398873988839889398903989139892398933989439895398963989739898398993990039901399023990339904399053990639907399083990939910399113991239913399143991539916399173991839919399203992139922399233992439925399263992739928399293993039931399323993339934399353993639937399383993939940399413994239943399443994539946399473994839949399503995139952399533995439955399563995739958399593996039961399623996339964399653996639967399683996939970399713997239973399743997539976399773997839979399803998139982399833998439985399863998739988399893999039991399923999339994399953999639997399983999940000400014000240003400044000540006400074000840009400104001140012400134001440015400164001740018400194002040021400224002340024400254002640027400284002940030400314003240033400344003540036400374003840039400404004140042400434004440045400464004740048400494005040051400524005340054400554005640057400584005940060400614006240063400644006540066400674006840069400704007140072400734007440075400764007740078400794008040081400824008340084400854008640087400884008940090400914009240093400944009540096400974009840099401004010140102401034010440105401064010740108401094011040111401124011340114401154011640117401184011940120401214012240123401244012540126401274012840129401304013140132401334013440135401364013740138401394014040141401424014340144401454014640147401484014940150401514015240153401544015540156401574015840159401604016140162401634016440165401664016740168401694017040171401724017340174401754017640177401784017940180401814018240183401844018540186401874018840189401904019140192401934019440195401964019740198401994020040201402024020340204402054020640207402084020940210402114021240213402144021540216402174021840219402204022140222402234022440225402264022740228402294023040231402324023340234402354023640237402384023940240402414024240243402444024540246402474024840249402504025140252402534025440255402564025740258402594026040261402624026340264402654026640267402684026940270402714027240273402744027540276402774027840279402804028140282402834028440285402864028740288402894029040291402924029340294402954029640297402984029940300403014030240303403044030540306403074030840309403104031140312403134031440315403164031740318403194032040321403224032340324403254032640327403284032940330403314033240333403344033540336403374033840339403404034140342403434034440345403464034740348403494035040351403524035340354403554035640357403584035940360403614036240363403644036540366403674036840369403704037140372403734037440375403764037740378403794038040381403824038340384403854038640387403884038940390403914039240393403944039540396403974039840399404004040140402404034040440405404064040740408404094041040411404124041340414404154041640417404184041940420404214042240423404244042540426404274042840429404304043140432404334043440435404364043740438404394044040441404424044340444404454044640447404484044940450404514045240453404544045540456404574045840459404604046140462404634046440465404664046740468404694047040471404724047340474404754047640477404784047940480404814048240483404844048540486404874048840489404904049140492404934049440495404964049740498404994050040501405024050340504405054050640507405084050940510405114051240513405144051540516405174051840519405204052140522405234052440525405264052740528405294053040531405324053340534405354053640537405384053940540405414054240543405444054540546405474054840549405504055140552405534055440555405564055740558405594056040561405624056340564405654056640567405684056940570405714057240573405744057540576405774057840579405804058140582405834058440585405864058740588405894059040591405924059340594405954059640597405984059940600406014060240603406044060540606406074060840609406104061140612406134061440615406164061740618406194062040621406224062340624406254062640627406284062940630406314063240633406344063540636406374063840639406404064140642406434064440645406464064740648406494065040651406524065340654406554065640657406584065940660406614066240663406644066540666406674066840669406704067140672406734067440675406764067740678406794068040681406824068340684406854068640687406884068940690406914069240693406944069540696406974069840699407004070140702407034070440705407064070740708407094071040711407124071340714407154071640717407184071940720407214072240723407244072540726407274072840729407304073140732407334073440735407364073740738407394074040741407424074340744407454074640747407484074940750407514075240753407544075540756407574075840759407604076140762407634076440765407664076740768407694077040771407724077340774407754077640777407784077940780407814078240783407844078540786407874078840789407904079140792407934079440795407964079740798407994080040801408024080340804408054080640807408084080940810408114081240813408144081540816408174081840819408204082140822408234082440825408264082740828408294083040831408324083340834408354083640837408384083940840408414084240843408444084540846408474084840849408504085140852408534085440855408564085740858408594086040861408624086340864408654086640867408684086940870408714087240873408744087540876408774087840879408804088140882408834088440885408864088740888408894089040891408924089340894408954089640897408984089940900409014090240903409044090540906409074090840909409104091140912409134091440915409164091740918409194092040921409224092340924409254092640927409284092940930409314093240933409344093540936409374093840939409404094140942409434094440945409464094740948409494095040951409524095340954409554095640957409584095940960409614096240963409644096540966409674096840969409704097140972409734097440975409764097740978409794098040981409824098340984409854098640987409884098940990409914099240993409944099540996409974099840999410004100141002410034100441005410064100741008410094101041011410124101341014410154101641017410184101941020410214102241023410244102541026410274102841029410304103141032410334103441035410364103741038410394104041041410424104341044410454104641047410484104941050410514105241053410544105541056410574105841059410604106141062410634106441065410664106741068410694107041071410724107341074410754107641077410784107941080410814108241083410844108541086410874108841089410904109141092410934109441095410964109741098410994110041101411024110341104411054110641107411084110941110411114111241113411144111541116411174111841119411204112141122411234112441125411264112741128411294113041131411324113341134411354113641137411384113941140411414114241143411444114541146411474114841149411504115141152411534115441155411564115741158411594116041161411624116341164411654116641167411684116941170411714117241173411744117541176411774117841179411804118141182411834118441185411864118741188411894119041191411924119341194411954119641197411984119941200412014120241203412044120541206412074120841209412104121141212412134121441215412164121741218412194122041221412224122341224412254122641227412284122941230412314123241233412344123541236412374123841239412404124141242412434124441245412464124741248412494125041251412524125341254412554125641257412584125941260412614126241263412644126541266412674126841269412704127141272412734127441275412764127741278412794128041281412824128341284412854128641287412884128941290412914129241293412944129541296412974129841299413004130141302413034130441305413064130741308413094131041311413124131341314413154131641317413184131941320413214132241323413244132541326413274132841329413304133141332413334133441335413364133741338413394134041341413424134341344413454134641347413484134941350413514135241353413544135541356413574135841359413604136141362413634136441365413664136741368413694137041371413724137341374413754137641377413784137941380413814138241383413844138541386413874138841389413904139141392413934139441395413964139741398413994140041401414024140341404414054140641407414084140941410414114141241413414144141541416414174141841419414204142141422414234142441425414264142741428414294143041431414324143341434414354143641437414384143941440414414144241443414444144541446414474144841449414504145141452414534145441455414564145741458414594146041461414624146341464414654146641467414684146941470414714147241473414744147541476414774147841479414804148141482414834148441485414864148741488414894149041491414924149341494414954149641497414984149941500415014150241503415044150541506415074150841509415104151141512415134151441515415164151741518415194152041521415224152341524415254152641527415284152941530415314153241533415344153541536415374153841539415404154141542415434154441545415464154741548415494155041551415524155341554415554155641557415584155941560415614156241563415644156541566415674156841569415704157141572415734157441575415764157741578415794158041581415824158341584415854158641587415884158941590415914159241593415944159541596415974159841599416004160141602416034160441605416064160741608416094161041611416124161341614416154161641617416184161941620416214162241623416244162541626416274162841629416304163141632416334163441635416364163741638416394164041641416424164341644416454164641647416484164941650416514165241653416544165541656416574165841659416604166141662416634166441665416664166741668416694167041671416724167341674416754167641677416784167941680416814168241683416844168541686416874168841689416904169141692416934169441695416964169741698416994170041701417024170341704417054170641707417084170941710417114171241713417144171541716417174171841719417204172141722417234172441725417264172741728417294173041731417324173341734417354173641737417384173941740417414174241743417444174541746417474174841749417504175141752417534175441755417564175741758417594176041761417624176341764417654176641767417684176941770417714177241773417744177541776417774177841779417804178141782417834178441785417864178741788417894179041791417924179341794417954179641797417984179941800418014180241803418044180541806418074180841809418104181141812418134181441815418164181741818418194182041821418224182341824418254182641827418284182941830418314183241833418344183541836418374183841839418404184141842418434184441845418464184741848418494185041851418524185341854418554185641857418584185941860418614186241863418644186541866418674186841869418704187141872418734187441875418764187741878418794188041881418824188341884418854188641887418884188941890418914189241893418944189541896418974189841899419004190141902419034190441905419064190741908419094191041911419124191341914419154191641917419184191941920419214192241923419244192541926419274192841929419304193141932419334193441935419364193741938419394194041941419424194341944419454194641947419484194941950419514195241953419544195541956419574195841959419604196141962419634196441965419664196741968419694197041971419724197341974419754197641977419784197941980419814198241983419844198541986419874198841989419904199141992419934199441995419964199741998419994200042001420024200342004420054200642007420084200942010420114201242013420144201542016420174201842019420204202142022420234202442025420264202742028420294203042031420324203342034420354203642037420384203942040420414204242043420444204542046420474204842049420504205142052420534205442055420564205742058420594206042061420624206342064420654206642067420684206942070420714207242073420744207542076420774207842079420804208142082420834208442085420864208742088420894209042091420924209342094420954209642097420984209942100421014210242103421044210542106421074210842109421104211142112421134211442115421164211742118421194212042121421224212342124421254212642127421284212942130421314213242133421344213542136421374213842139421404214142142421434214442145421464214742148421494215042151421524215342154421554215642157421584215942160421614216242163421644216542166421674216842169421704217142172421734217442175421764217742178421794218042181421824218342184421854218642187421884218942190421914219242193421944219542196421974219842199422004220142202422034220442205422064220742208422094221042211422124221342214422154221642217422184221942220422214222242223422244222542226422274222842229422304223142232422334223442235422364223742238422394224042241422424224342244422454224642247422484224942250422514225242253422544225542256422574225842259422604226142262422634226442265422664226742268422694227042271422724227342274422754227642277422784227942280422814228242283422844228542286422874228842289422904229142292422934229442295422964229742298422994230042301423024230342304423054230642307423084230942310423114231242313423144231542316423174231842319423204232142322423234232442325423264232742328423294233042331423324233342334423354233642337423384233942340423414234242343423444234542346423474234842349423504235142352423534235442355423564235742358423594236042361423624236342364423654236642367423684236942370423714237242373423744237542376423774237842379423804238142382423834238442385423864238742388423894239042391423924239342394423954239642397423984239942400424014240242403424044240542406424074240842409424104241142412424134241442415424164241742418424194242042421424224242342424424254242642427424284242942430424314243242433424344243542436424374243842439424404244142442424434244442445424464244742448424494245042451424524245342454424554245642457424584245942460424614246242463424644246542466424674246842469424704247142472424734247442475424764247742478424794248042481424824248342484424854248642487424884248942490424914249242493424944249542496424974249842499425004250142502425034250442505425064250742508425094251042511425124251342514425154251642517425184251942520425214252242523425244252542526425274252842529425304253142532425334253442535425364253742538425394254042541425424254342544425454254642547425484254942550425514255242553425544255542556425574255842559425604256142562425634256442565425664256742568425694257042571425724257342574425754257642577425784257942580425814258242583425844258542586425874258842589425904259142592425934259442595425964259742598425994260042601426024260342604426054260642607426084260942610426114261242613426144261542616426174261842619426204262142622426234262442625426264262742628426294263042631426324263342634426354263642637426384263942640426414264242643426444264542646426474264842649426504265142652426534265442655426564265742658426594266042661426624266342664426654266642667426684266942670426714267242673426744267542676426774267842679426804268142682426834268442685426864268742688426894269042691426924269342694426954269642697426984269942700427014270242703427044270542706427074270842709427104271142712427134271442715427164271742718427194272042721427224272342724427254272642727427284272942730427314273242733427344273542736427374273842739427404274142742427434274442745427464274742748427494275042751427524275342754427554275642757427584275942760427614276242763427644276542766427674276842769427704277142772427734277442775427764277742778427794278042781427824278342784427854278642787427884278942790427914279242793427944279542796427974279842799428004280142802428034280442805428064280742808428094281042811428124281342814428154281642817428184281942820428214282242823428244282542826428274282842829428304283142832428334283442835428364283742838428394284042841428424284342844428454284642847428484284942850428514285242853428544285542856428574285842859428604286142862428634286442865428664286742868428694287042871428724287342874428754287642877428784287942880428814288242883428844288542886428874288842889428904289142892428934289442895428964289742898428994290042901429024290342904429054290642907429084290942910429114291242913429144291542916429174291842919429204292142922429234292442925429264292742928429294293042931429324293342934429354293642937429384293942940429414294242943429444294542946429474294842949429504295142952429534295442955429564295742958429594296042961429624296342964429654296642967429684296942970429714297242973429744297542976429774297842979429804298142982429834298442985429864298742988429894299042991429924299342994429954299642997429984299943000430014300243003430044300543006430074300843009430104301143012430134301443015430164301743018430194302043021430224302343024430254302643027430284302943030430314303243033430344303543036430374303843039430404304143042430434304443045430464304743048430494305043051430524305343054430554305643057430584305943060430614306243063430644306543066430674306843069430704307143072430734307443075430764307743078430794308043081430824308343084430854308643087430884308943090430914309243093430944309543096430974309843099431004310143102431034310443105431064310743108431094311043111431124311343114431154311643117431184311943120431214312243123431244312543126431274312843129431304313143132431334313443135431364313743138431394314043141431424314343144431454314643147431484314943150431514315243153431544315543156431574315843159431604316143162431634316443165431664316743168431694317043171431724317343174431754317643177431784317943180431814318243183431844318543186431874318843189431904319143192431934319443195431964319743198431994320043201432024320343204432054320643207432084320943210432114321243213432144321543216432174321843219432204322143222432234322443225432264322743228432294323043231432324323343234432354323643237432384323943240432414324243243432444324543246432474324843249432504325143252432534325443255432564325743258432594326043261432624326343264432654326643267432684326943270432714327243273432744327543276432774327843279432804328143282432834328443285432864328743288432894329043291432924329343294432954329643297432984329943300433014330243303433044330543306433074330843309433104331143312433134331443315433164331743318433194332043321433224332343324433254332643327433284332943330433314333243333433344333543336433374333843339433404334143342433434334443345433464334743348433494335043351433524335343354433554335643357433584335943360433614336243363433644336543366433674336843369433704337143372433734337443375433764337743378433794338043381433824338343384433854338643387433884338943390433914339243393433944339543396433974339843399434004340143402434034340443405434064340743408434094341043411434124341343414434154341643417434184341943420434214342243423434244342543426434274342843429434304343143432434334343443435434364343743438434394344043441434424344343444434454344643447434484344943450434514345243453434544345543456434574345843459434604346143462434634346443465434664346743468434694347043471434724347343474434754347643477434784347943480434814348243483434844348543486434874348843489434904349143492434934349443495434964349743498434994350043501435024350343504435054350643507435084350943510435114351243513435144351543516435174351843519435204352143522435234352443525435264352743528435294353043531435324353343534435354353643537435384353943540435414354243543435444354543546435474354843549435504355143552435534355443555435564355743558435594356043561435624356343564435654356643567435684356943570435714357243573435744357543576435774357843579435804358143582435834358443585435864358743588435894359043591435924359343594435954359643597435984359943600436014360243603436044360543606436074360843609436104361143612436134361443615436164361743618436194362043621436224362343624436254362643627436284362943630436314363243633436344363543636436374363843639436404364143642436434364443645436464364743648436494365043651436524365343654436554365643657436584365943660436614366243663436644366543666436674366843669436704367143672436734367443675436764367743678436794368043681436824368343684436854368643687436884368943690436914369243693436944369543696436974369843699437004370143702437034370443705437064370743708437094371043711437124371343714437154371643717437184371943720437214372243723437244372543726437274372843729437304373143732437334373443735437364373743738437394374043741437424374343744437454374643747437484374943750437514375243753437544375543756437574375843759437604376143762437634376443765437664376743768437694377043771437724377343774437754377643777437784377943780437814378243783437844378543786437874378843789437904379143792437934379443795437964379743798437994380043801438024380343804438054380643807438084380943810438114381243813438144381543816438174381843819438204382143822438234382443825438264382743828438294383043831438324383343834438354383643837438384383943840438414384243843438444384543846438474384843849438504385143852438534385443855438564385743858438594386043861438624386343864438654386643867438684386943870438714387243873438744387543876438774387843879438804388143882438834388443885438864388743888438894389043891438924389343894438954389643897438984389943900439014390243903439044390543906439074390843909439104391143912439134391443915439164391743918439194392043921439224392343924439254392643927439284392943930439314393243933439344393543936439374393843939439404394143942439434394443945439464394743948439494395043951439524395343954439554395643957439584395943960439614396243963439644396543966439674396843969439704397143972439734397443975439764397743978439794398043981439824398343984439854398643987439884398943990439914399243993439944399543996439974399843999440004400144002440034400444005440064400744008440094401044011440124401344014440154401644017440184401944020440214402244023440244402544026440274402844029440304403144032440334403444035440364403744038440394404044041440424404344044440454404644047440484404944050440514405244053440544405544056440574405844059440604406144062440634406444065440664406744068440694407044071440724407344074440754407644077440784407944080440814408244083440844408544086440874408844089440904409144092440934409444095440964409744098440994410044101441024410344104441054410644107441084410944110441114411244113441144411544116441174411844119441204412144122441234412444125441264412744128441294413044131441324413344134441354413644137441384413944140441414414244143441444414544146441474414844149441504415144152441534415444155441564415744158441594416044161441624416344164441654416644167441684416944170441714417244173441744417544176441774417844179441804418144182441834418444185441864418744188441894419044191441924419344194441954419644197441984419944200442014420244203442044420544206442074420844209442104421144212442134421444215442164421744218442194422044221442224422344224442254422644227442284422944230442314423244233442344423544236442374423844239442404424144242442434424444245442464424744248442494425044251442524425344254442554425644257442584425944260442614426244263442644426544266442674426844269442704427144272442734427444275442764427744278442794428044281442824428344284442854428644287442884428944290442914429244293442944429544296442974429844299443004430144302443034430444305443064430744308443094431044311443124431344314443154431644317443184431944320443214432244323443244432544326443274432844329443304433144332443334433444335443364433744338443394434044341443424434344344443454434644347443484434944350443514435244353443544435544356443574435844359443604436144362443634436444365443664436744368443694437044371443724437344374443754437644377443784437944380443814438244383443844438544386443874438844389443904439144392443934439444395443964439744398443994440044401444024440344404444054440644407444084440944410444114441244413444144441544416444174441844419444204442144422444234442444425444264442744428444294443044431444324443344434444354443644437444384443944440444414444244443444444444544446444474444844449444504445144452444534445444455444564445744458444594446044461444624446344464444654446644467444684446944470444714447244473444744447544476444774447844479444804448144482444834448444485444864448744488444894449044491444924449344494444954449644497444984449944500445014450244503445044450544506445074450844509445104451144512445134451444515445164451744518445194452044521445224452344524445254452644527445284452944530445314453244533445344453544536445374453844539445404454144542445434454444545445464454744548445494455044551445524455344554445554455644557445584455944560445614456244563445644456544566445674456844569445704457144572445734457444575445764457744578445794458044581445824458344584445854458644587445884458944590445914459244593445944459544596445974459844599446004460144602446034460444605446064460744608446094461044611446124461344614446154461644617446184461944620446214462244623446244462544626446274462844629446304463144632446334463444635446364463744638446394464044641446424464344644446454464644647446484464944650446514465244653446544465544656446574465844659446604466144662446634466444665446664466744668446694467044671446724467344674446754467644677446784467944680446814468244683446844468544686446874468844689446904469144692446934469444695446964469744698446994470044701447024470344704447054470644707447084470944710447114471244713447144471544716447174471844719447204472144722447234472444725447264472744728447294473044731447324473344734447354473644737447384473944740447414474244743447444474544746447474474844749447504475144752447534475444755447564475744758447594476044761447624476344764447654476644767447684476944770447714477244773447744477544776447774477844779447804478144782447834478444785447864478744788447894479044791447924479344794447954479644797447984479944800448014480244803448044480544806448074480844809448104481144812448134481444815448164481744818448194482044821448224482344824448254482644827448284482944830448314483244833448344483544836448374483844839448404484144842448434484444845448464484744848448494485044851448524485344854448554485644857448584485944860448614486244863448644486544866448674486844869448704487144872448734487444875448764487744878448794488044881448824488344884448854488644887448884488944890448914489244893448944489544896448974489844899449004490144902449034490444905449064490744908449094491044911449124491344914449154491644917449184491944920449214492244923449244492544926449274492844929449304493144932449334493444935449364493744938449394494044941449424494344944449454494644947449484494944950449514495244953449544495544956449574495844959449604496144962449634496444965449664496744968449694497044971449724497344974449754497644977449784497944980449814498244983449844498544986449874498844989449904499144992449934499444995449964499744998449994500045001450024500345004450054500645007450084500945010450114501245013450144501545016450174501845019450204502145022450234502445025450264502745028450294503045031450324503345034450354503645037450384503945040450414504245043450444504545046450474504845049450504505145052450534505445055450564505745058450594506045061450624506345064450654506645067450684506945070450714507245073450744507545076450774507845079450804508145082450834508445085450864508745088450894509045091450924509345094450954509645097450984509945100451014510245103451044510545106451074510845109451104511145112451134511445115451164511745118451194512045121451224512345124451254512645127451284512945130451314513245133451344513545136451374513845139451404514145142451434514445145451464514745148451494515045151451524515345154451554515645157451584515945160451614516245163451644516545166451674516845169451704517145172451734517445175451764517745178451794518045181451824518345184451854518645187451884518945190451914519245193451944519545196451974519845199452004520145202452034520445205452064520745208452094521045211452124521345214452154521645217452184521945220452214522245223452244522545226452274522845229452304523145232452334523445235452364523745238452394524045241452424524345244452454524645247452484524945250452514525245253452544525545256452574525845259452604526145262452634526445265452664526745268452694527045271452724527345274452754527645277452784527945280452814528245283452844528545286452874528845289452904529145292452934529445295452964529745298452994530045301453024530345304453054530645307453084530945310453114531245313453144531545316453174531845319453204532145322453234532445325453264532745328453294533045331453324533345334453354533645337453384533945340453414534245343453444534545346453474534845349453504535145352453534535445355453564535745358453594536045361453624536345364453654536645367453684536945370453714537245373453744537545376453774537845379453804538145382453834538445385453864538745388453894539045391453924539345394453954539645397453984539945400454014540245403454044540545406454074540845409454104541145412454134541445415454164541745418454194542045421454224542345424454254542645427454284542945430454314543245433454344543545436454374543845439454404544145442454434544445445454464544745448454494545045451454524545345454454554545645457454584545945460454614546245463454644546545466454674546845469454704547145472454734547445475454764547745478454794548045481454824548345484454854548645487454884548945490454914549245493454944549545496454974549845499455004550145502455034550445505455064550745508455094551045511455124551345514455154551645517455184551945520455214552245523455244552545526455274552845529455304553145532455334553445535455364553745538455394554045541455424554345544455454554645547455484554945550455514555245553455544555545556455574555845559455604556145562455634556445565455664556745568455694557045571455724557345574455754557645577455784557945580455814558245583455844558545586455874558845589455904559145592455934559445595455964559745598455994560045601456024560345604456054560645607456084560945610456114561245613456144561545616456174561845619456204562145622456234562445625456264562745628456294563045631456324563345634456354563645637456384563945640456414564245643456444564545646456474564845649456504565145652456534565445655456564565745658456594566045661456624566345664456654566645667456684566945670456714567245673456744567545676456774567845679456804568145682456834568445685456864568745688456894569045691456924569345694456954569645697456984569945700457014570245703457044570545706457074570845709457104571145712457134571445715457164571745718457194572045721457224572345724457254572645727457284572945730457314573245733457344573545736457374573845739457404574145742457434574445745457464574745748457494575045751457524575345754457554575645757457584575945760457614576245763457644576545766457674576845769457704577145772457734577445775457764577745778457794578045781457824578345784457854578645787457884578945790457914579245793457944579545796457974579845799458004580145802458034580445805458064580745808458094581045811458124581345814458154581645817458184581945820458214582245823458244582545826458274582845829458304583145832458334583445835458364583745838458394584045841458424584345844458454584645847458484584945850458514585245853458544585545856458574585845859458604586145862458634586445865458664586745868458694587045871458724587345874458754587645877458784587945880458814588245883458844588545886458874588845889458904589145892458934589445895458964589745898458994590045901459024590345904459054590645907459084590945910459114591245913459144591545916459174591845919459204592145922459234592445925459264592745928459294593045931459324593345934459354593645937459384593945940459414594245943459444594545946459474594845949459504595145952459534595445955459564595745958459594596045961459624596345964459654596645967459684596945970459714597245973459744597545976459774597845979459804598145982459834598445985459864598745988459894599045991459924599345994459954599645997459984599946000460014600246003460044600546006460074600846009460104601146012460134601446015460164601746018460194602046021460224602346024460254602646027460284602946030460314603246033460344603546036460374603846039460404604146042460434604446045460464604746048460494605046051460524605346054460554605646057460584605946060460614606246063460644606546066460674606846069460704607146072460734607446075460764607746078460794608046081460824608346084460854608646087460884608946090460914609246093460944609546096460974609846099461004610146102461034610446105461064610746108461094611046111461124611346114461154611646117461184611946120461214612246123461244612546126461274612846129461304613146132461334613446135461364613746138461394614046141461424614346144461454614646147461484614946150461514615246153461544615546156461574615846159461604616146162461634616446165461664616746168461694617046171461724617346174461754617646177461784617946180461814618246183461844618546186461874618846189461904619146192461934619446195461964619746198461994620046201462024620346204462054620646207462084620946210462114621246213462144621546216462174621846219462204622146222462234622446225462264622746228462294623046231462324623346234462354623646237462384623946240462414624246243462444624546246462474624846249462504625146252462534625446255462564625746258462594626046261462624626346264462654626646267462684626946270462714627246273462744627546276462774627846279462804628146282462834628446285462864628746288462894629046291462924629346294462954629646297462984629946300463014630246303463044630546306463074630846309463104631146312463134631446315463164631746318463194632046321463224632346324463254632646327463284632946330463314633246333463344633546336463374633846339463404634146342463434634446345463464634746348463494635046351463524635346354463554635646357463584635946360463614636246363463644636546366463674636846369463704637146372463734637446375463764637746378463794638046381463824638346384463854638646387463884638946390463914639246393463944639546396463974639846399464004640146402464034640446405464064640746408464094641046411464124641346414464154641646417464184641946420464214642246423464244642546426464274642846429464304643146432464334643446435464364643746438464394644046441464424644346444464454644646447464484644946450464514645246453464544645546456464574645846459464604646146462464634646446465464664646746468464694647046471464724647346474464754647646477464784647946480464814648246483464844648546486464874648846489464904649146492464934649446495464964649746498464994650046501465024650346504465054650646507465084650946510465114651246513465144651546516465174651846519465204652146522465234652446525465264652746528465294653046531465324653346534465354653646537465384653946540465414654246543465444654546546465474654846549465504655146552465534655446555465564655746558465594656046561465624656346564465654656646567465684656946570465714657246573465744657546576465774657846579465804658146582465834658446585465864658746588465894659046591465924659346594465954659646597465984659946600466014660246603466044660546606466074660846609466104661146612466134661446615466164661746618466194662046621466224662346624466254662646627466284662946630466314663246633466344663546636466374663846639466404664146642466434664446645466464664746648466494665046651466524665346654466554665646657466584665946660466614666246663466644666546666466674666846669466704667146672466734667446675466764667746678466794668046681466824668346684466854668646687466884668946690466914669246693466944669546696466974669846699467004670146702467034670446705467064670746708467094671046711467124671346714467154671646717467184671946720467214672246723467244672546726467274672846729467304673146732467334673446735467364673746738467394674046741467424674346744467454674646747467484674946750467514675246753467544675546756467574675846759467604676146762467634676446765467664676746768467694677046771467724677346774467754677646777467784677946780467814678246783467844678546786467874678846789467904679146792467934679446795467964679746798467994680046801468024680346804468054680646807468084680946810468114681246813468144681546816468174681846819468204682146822468234682446825468264682746828468294683046831468324683346834468354683646837468384683946840468414684246843468444684546846468474684846849468504685146852468534685446855468564685746858468594686046861468624686346864468654686646867468684686946870468714687246873468744687546876468774687846879468804688146882468834688446885468864688746888468894689046891468924689346894468954689646897468984689946900469014690246903469044690546906469074690846909469104691146912469134691446915469164691746918469194692046921469224692346924469254692646927469284692946930469314693246933469344693546936469374693846939469404694146942469434694446945469464694746948469494695046951469524695346954469554695646957469584695946960469614696246963469644696546966469674696846969469704697146972469734697446975469764697746978469794698046981469824698346984469854698646987469884698946990469914699246993469944699546996469974699846999470004700147002470034700447005470064700747008470094701047011470124701347014470154701647017470184701947020470214702247023470244702547026470274702847029470304703147032470334703447035470364703747038470394704047041470424704347044470454704647047470484704947050470514705247053470544705547056470574705847059470604706147062470634706447065470664706747068470694707047071470724707347074470754707647077470784707947080470814708247083470844708547086470874708847089470904709147092470934709447095470964709747098470994710047101471024710347104471054710647107471084710947110471114711247113471144711547116471174711847119471204712147122471234712447125471264712747128471294713047131471324713347134471354713647137471384713947140471414714247143471444714547146471474714847149471504715147152471534715447155471564715747158471594716047161471624716347164471654716647167471684716947170471714717247173471744717547176471774717847179471804718147182471834718447185471864718747188471894719047191471924719347194471954719647197471984719947200472014720247203472044720547206472074720847209472104721147212472134721447215472164721747218472194722047221472224722347224472254722647227472284722947230472314723247233472344723547236472374723847239472404724147242472434724447245472464724747248472494725047251472524725347254472554725647257472584725947260472614726247263472644726547266472674726847269472704727147272472734727447275472764727747278472794728047281472824728347284472854728647287472884728947290472914729247293472944729547296472974729847299473004730147302473034730447305473064730747308473094731047311473124731347314473154731647317473184731947320473214732247323473244732547326473274732847329473304733147332473334733447335473364733747338473394734047341473424734347344473454734647347473484734947350473514735247353473544735547356473574735847359473604736147362473634736447365473664736747368473694737047371473724737347374473754737647377473784737947380473814738247383473844738547386473874738847389473904739147392473934739447395473964739747398473994740047401474024740347404474054740647407474084740947410474114741247413474144741547416474174741847419474204742147422474234742447425474264742747428474294743047431474324743347434474354743647437474384743947440474414744247443474444744547446474474744847449474504745147452474534745447455474564745747458474594746047461474624746347464474654746647467474684746947470474714747247473474744747547476474774747847479474804748147482474834748447485474864748747488474894749047491474924749347494474954749647497474984749947500475014750247503475044750547506475074750847509475104751147512475134751447515475164751747518475194752047521475224752347524475254752647527475284752947530475314753247533475344753547536475374753847539475404754147542475434754447545475464754747548475494755047551475524755347554475554755647557475584755947560475614756247563475644756547566475674756847569475704757147572475734757447575475764757747578475794758047581475824758347584475854758647587475884758947590475914759247593475944759547596475974759847599476004760147602476034760447605476064760747608476094761047611476124761347614476154761647617476184761947620476214762247623476244762547626476274762847629476304763147632476334763447635476364763747638476394764047641476424764347644476454764647647476484764947650476514765247653476544765547656476574765847659476604766147662476634766447665476664766747668476694767047671476724767347674476754767647677476784767947680476814768247683476844768547686476874768847689476904769147692476934769447695476964769747698476994770047701477024770347704477054770647707477084770947710477114771247713477144771547716477174771847719477204772147722477234772447725477264772747728477294773047731477324773347734477354773647737477384773947740477414774247743477444774547746477474774847749477504775147752477534775447755477564775747758477594776047761477624776347764477654776647767477684776947770477714777247773477744777547776477774777847779477804778147782477834778447785477864778747788477894779047791477924779347794477954779647797477984779947800478014780247803478044780547806478074780847809478104781147812478134781447815478164781747818478194782047821478224782347824478254782647827478284782947830478314783247833478344783547836478374783847839478404784147842478434784447845478464784747848478494785047851478524785347854478554785647857478584785947860478614786247863478644786547866478674786847869478704787147872478734787447875478764787747878478794788047881478824788347884478854788647887478884788947890478914789247893478944789547896478974789847899479004790147902479034790447905479064790747908479094791047911479124791347914479154791647917479184791947920479214792247923479244792547926479274792847929479304793147932479334793447935479364793747938479394794047941479424794347944479454794647947479484794947950479514795247953479544795547956479574795847959479604796147962479634796447965479664796747968479694797047971479724797347974479754797647977479784797947980479814798247983479844798547986479874798847989479904799147992479934799447995479964799747998479994800048001480024800348004480054800648007480084800948010480114801248013480144801548016480174801848019480204802148022480234802448025480264802748028480294803048031480324803348034480354803648037480384803948040480414804248043480444804548046480474804848049480504805148052480534805448055480564805748058480594806048061480624806348064480654806648067480684806948070480714807248073480744807548076480774807848079480804808148082480834808448085480864808748088480894809048091480924809348094480954809648097480984809948100481014810248103481044810548106481074810848109481104811148112481134811448115481164811748118481194812048121481224812348124481254812648127481284812948130481314813248133481344813548136481374813848139481404814148142481434814448145481464814748148481494815048151481524815348154481554815648157481584815948160481614816248163481644816548166481674816848169481704817148172481734817448175481764817748178481794818048181481824818348184481854818648187481884818948190481914819248193481944819548196481974819848199482004820148202482034820448205482064820748208482094821048211482124821348214482154821648217482184821948220482214822248223482244822548226482274822848229482304823148232482334823448235482364823748238482394824048241482424824348244482454824648247482484824948250482514825248253482544825548256482574825848259482604826148262482634826448265482664826748268482694827048271482724827348274482754827648277482784827948280482814828248283482844828548286482874828848289482904829148292482934829448295482964829748298482994830048301483024830348304483054830648307483084830948310483114831248313483144831548316483174831848319483204832148322483234832448325483264832748328483294833048331483324833348334483354833648337483384833948340483414834248343483444834548346483474834848349483504835148352483534835448355483564835748358483594836048361483624836348364483654836648367483684836948370483714837248373483744837548376483774837848379483804838148382483834838448385483864838748388483894839048391483924839348394483954839648397483984839948400484014840248403484044840548406484074840848409484104841148412484134841448415484164841748418484194842048421484224842348424484254842648427484284842948430484314843248433484344843548436484374843848439484404844148442484434844448445484464844748448484494845048451484524845348454484554845648457484584845948460484614846248463484644846548466484674846848469484704847148472484734847448475484764847748478484794848048481484824848348484484854848648487484884848948490484914849248493484944849548496484974849848499485004850148502485034850448505485064850748508485094851048511485124851348514485154851648517485184851948520485214852248523485244852548526485274852848529485304853148532485334853448535485364853748538485394854048541485424854348544485454854648547485484854948550485514855248553485544855548556485574855848559485604856148562485634856448565485664856748568485694857048571485724857348574485754857648577485784857948580485814858248583485844858548586485874858848589485904859148592485934859448595485964859748598485994860048601486024860348604486054860648607486084860948610486114861248613486144861548616486174861848619486204862148622486234862448625486264862748628486294863048631486324863348634486354863648637486384863948640486414864248643486444864548646486474864848649486504865148652486534865448655486564865748658486594866048661486624866348664486654866648667486684866948670486714867248673486744867548676486774867848679486804868148682486834868448685486864868748688486894869048691486924869348694486954869648697486984869948700487014870248703487044870548706487074870848709487104871148712487134871448715487164871748718487194872048721487224872348724487254872648727487284872948730487314873248733487344873548736487374873848739487404874148742487434874448745487464874748748487494875048751487524875348754487554875648757487584875948760487614876248763487644876548766487674876848769487704877148772487734877448775487764877748778487794878048781487824878348784487854878648787487884878948790487914879248793487944879548796487974879848799488004880148802488034880448805488064880748808488094881048811488124881348814488154881648817488184881948820488214882248823488244882548826488274882848829488304883148832488334883448835488364883748838488394884048841488424884348844488454884648847488484884948850488514885248853488544885548856488574885848859488604886148862488634886448865488664886748868488694887048871488724887348874488754887648877488784887948880488814888248883488844888548886488874888848889488904889148892488934889448895488964889748898488994890048901489024890348904489054890648907489084890948910489114891248913489144891548916489174891848919489204892148922489234892448925489264892748928489294893048931489324893348934489354893648937489384893948940489414894248943489444894548946489474894848949489504895148952489534895448955489564895748958489594896048961489624896348964489654896648967489684896948970489714897248973489744897548976489774897848979489804898148982489834898448985489864898748988489894899048991489924899348994489954899648997489984899949000490014900249003490044900549006490074900849009490104901149012490134901449015490164901749018490194902049021490224902349024490254902649027490284902949030490314903249033490344903549036490374903849039490404904149042490434904449045490464904749048490494905049051490524905349054490554905649057490584905949060490614906249063490644906549066490674906849069490704907149072490734907449075490764907749078490794908049081490824908349084490854908649087490884908949090490914909249093490944909549096490974909849099491004910149102491034910449105491064910749108491094911049111491124911349114491154911649117491184911949120491214912249123491244912549126491274912849129491304913149132491334913449135491364913749138491394914049141491424914349144491454914649147491484914949150491514915249153491544915549156491574915849159491604916149162491634916449165491664916749168491694917049171491724917349174491754917649177491784917949180491814918249183491844918549186491874918849189491904919149192491934919449195491964919749198491994920049201492024920349204492054920649207492084920949210492114921249213492144921549216492174921849219492204922149222492234922449225492264922749228492294923049231492324923349234492354923649237492384923949240492414924249243492444924549246492474924849249492504925149252492534925449255492564925749258492594926049261492624926349264492654926649267492684926949270492714927249273492744927549276492774927849279492804928149282492834928449285492864928749288492894929049291492924929349294492954929649297492984929949300493014930249303493044930549306493074930849309493104931149312493134931449315493164931749318493194932049321493224932349324493254932649327493284932949330493314933249333493344933549336493374933849339493404934149342493434934449345493464934749348493494935049351493524935349354493554935649357493584935949360493614936249363493644936549366493674936849369493704937149372493734937449375493764937749378493794938049381493824938349384493854938649387493884938949390493914939249393493944939549396493974939849399494004940149402494034940449405494064940749408494094941049411494124941349414494154941649417494184941949420494214942249423494244942549426494274942849429494304943149432494334943449435494364943749438494394944049441494424944349444494454944649447494484944949450494514945249453494544945549456494574945849459494604946149462494634946449465494664946749468494694947049471494724947349474494754947649477494784947949480494814948249483494844948549486494874948849489494904949149492494934949449495494964949749498494994950049501495024950349504495054950649507495084950949510495114951249513495144951549516495174951849519495204952149522495234952449525495264952749528495294953049531495324953349534495354953649537495384953949540495414954249543495444954549546495474954849549495504955149552495534955449555495564955749558495594956049561495624956349564495654956649567495684956949570495714957249573495744957549576495774957849579495804958149582495834958449585495864958749588495894959049591495924959349594495954959649597495984959949600496014960249603496044960549606496074960849609496104961149612496134961449615496164961749618496194962049621496224962349624496254962649627496284962949630496314963249633496344963549636496374963849639496404964149642496434964449645496464964749648496494965049651496524965349654496554965649657496584965949660496614966249663496644966549666496674966849669496704967149672496734967449675496764967749678496794968049681496824968349684496854968649687496884968949690496914969249693496944969549696496974969849699497004970149702497034970449705497064970749708497094971049711497124971349714497154971649717497184971949720497214972249723497244972549726497274972849729497304973149732497334973449735497364973749738497394974049741497424974349744497454974649747497484974949750497514975249753497544975549756497574975849759497604976149762497634976449765497664976749768497694977049771497724977349774497754977649777497784977949780497814978249783497844978549786497874978849789497904979149792497934979449795497964979749798497994980049801498024980349804498054980649807498084980949810498114981249813498144981549816498174981849819498204982149822498234982449825498264982749828498294983049831498324983349834498354983649837498384983949840498414984249843498444984549846498474984849849498504985149852498534985449855498564985749858498594986049861498624986349864498654986649867498684986949870498714987249873498744987549876498774987849879498804988149882498834988449885498864988749888498894989049891498924989349894498954989649897498984989949900499014990249903499044990549906499074990849909499104991149912499134991449915499164991749918499194992049921499224992349924499254992649927499284992949930499314993249933499344993549936499374993849939499404994149942499434994449945499464994749948499494995049951499524995349954499554995649957499584995949960499614996249963499644996549966499674996849969499704997149972499734997449975499764997749978499794998049981499824998349984499854998649987499884998949990499914999249993499944999549996499974999849999500005000150002500035000450005500065000750008500095001050011500125001350014500155001650017500185001950020500215002250023500245002550026500275002850029500305003150032500335003450035500365003750038500395004050041500425004350044500455004650047500485004950050500515005250053500545005550056500575005850059500605006150062500635006450065500665006750068500695007050071500725007350074500755007650077500785007950080500815008250083500845008550086500875008850089500905009150092500935009450095500965009750098500995010050101501025010350104501055010650107501085010950110501115011250113501145011550116501175011850119501205012150122501235012450125501265012750128501295013050131501325013350134501355013650137501385013950140501415014250143501445014550146501475014850149501505015150152501535015450155501565015750158501595016050161501625016350164501655016650167501685016950170501715017250173501745017550176501775017850179501805018150182501835018450185501865018750188501895019050191501925019350194501955019650197501985019950200502015020250203502045020550206502075020850209502105021150212502135021450215502165021750218502195022050221502225022350224502255022650227502285022950230502315023250233502345023550236502375023850239502405024150242502435024450245502465024750248502495025050251502525025350254502555025650257502585025950260502615026250263502645026550266502675026850269502705027150272502735027450275502765027750278502795028050281502825028350284502855028650287502885028950290502915029250293502945029550296502975029850299503005030150302503035030450305503065030750308503095031050311503125031350314503155031650317503185031950320503215032250323503245032550326503275032850329503305033150332503335033450335503365033750338503395034050341503425034350344503455034650347503485034950350503515035250353503545035550356503575035850359503605036150362503635036450365503665036750368503695037050371503725037350374503755037650377503785037950380503815038250383503845038550386503875038850389503905039150392503935039450395503965039750398503995040050401504025040350404504055040650407504085040950410504115041250413504145041550416504175041850419504205042150422504235042450425504265042750428504295043050431504325043350434504355043650437504385043950440504415044250443504445044550446504475044850449504505045150452504535045450455504565045750458504595046050461504625046350464504655046650467504685046950470504715047250473504745047550476504775047850479504805048150482504835048450485504865048750488504895049050491504925049350494504955049650497504985049950500505015050250503505045050550506505075050850509505105051150512505135051450515505165051750518505195052050521505225052350524505255052650527505285052950530505315053250533505345053550536505375053850539505405054150542505435054450545505465054750548505495055050551505525055350554505555055650557505585055950560505615056250563505645056550566505675056850569505705057150572505735057450575505765057750578505795058050581505825058350584505855058650587505885058950590505915059250593505945059550596505975059850599506005060150602506035060450605506065060750608506095061050611506125061350614506155061650617506185061950620506215062250623506245062550626506275062850629506305063150632506335063450635506365063750638506395064050641506425064350644506455064650647506485064950650506515065250653506545065550656506575065850659506605066150662506635066450665506665066750668506695067050671506725067350674506755067650677506785067950680506815068250683506845068550686506875068850689506905069150692506935069450695506965069750698506995070050701507025070350704507055070650707507085070950710507115071250713507145071550716507175071850719507205072150722507235072450725507265072750728507295073050731507325073350734507355073650737507385073950740507415074250743507445074550746507475074850749507505075150752507535075450755507565075750758507595076050761507625076350764507655076650767507685076950770507715077250773507745077550776507775077850779507805078150782507835078450785507865078750788507895079050791507925079350794507955079650797507985079950800508015080250803508045080550806508075080850809508105081150812508135081450815508165081750818508195082050821508225082350824508255082650827508285082950830508315083250833508345083550836508375083850839508405084150842508435084450845508465084750848508495085050851508525085350854508555085650857508585085950860508615086250863508645086550866508675086850869508705087150872508735087450875508765087750878508795088050881508825088350884508855088650887508885088950890508915089250893508945089550896508975089850899509005090150902509035090450905509065090750908509095091050911509125091350914509155091650917509185091950920509215092250923509245092550926509275092850929509305093150932509335093450935509365093750938509395094050941509425094350944509455094650947509485094950950509515095250953509545095550956509575095850959509605096150962509635096450965509665096750968509695097050971509725097350974509755097650977509785097950980509815098250983509845098550986509875098850989509905099150992509935099450995509965099750998509995100051001510025100351004510055100651007510085100951010510115101251013510145101551016510175101851019510205102151022510235102451025510265102751028510295103051031510325103351034510355103651037510385103951040510415104251043510445104551046510475104851049510505105151052510535105451055510565105751058510595106051061510625106351064510655106651067510685106951070510715107251073510745107551076510775107851079510805108151082510835108451085510865108751088510895109051091510925109351094510955109651097510985109951100511015110251103511045110551106511075110851109511105111151112511135111451115511165111751118511195112051121511225112351124511255112651127511285112951130511315113251133511345113551136511375113851139511405114151142511435114451145511465114751148511495115051151511525115351154511555115651157511585115951160511615116251163511645116551166511675116851169511705117151172511735117451175511765117751178511795118051181511825118351184511855118651187511885118951190511915119251193511945119551196511975119851199512005120151202512035120451205512065120751208512095121051211512125121351214512155121651217512185121951220512215122251223512245122551226512275122851229512305123151232512335123451235512365123751238512395124051241512425124351244512455124651247512485124951250512515125251253512545125551256512575125851259512605126151262512635126451265512665126751268512695127051271512725127351274512755127651277512785127951280512815128251283512845128551286512875128851289512905129151292512935129451295512965129751298512995130051301513025130351304513055130651307513085130951310513115131251313513145131551316513175131851319513205132151322513235132451325513265132751328513295133051331513325133351334513355133651337513385133951340513415134251343513445134551346513475134851349513505135151352513535135451355513565135751358513595136051361513625136351364513655136651367513685136951370513715137251373513745137551376513775137851379513805138151382513835138451385513865138751388513895139051391513925139351394513955139651397513985139951400514015140251403514045140551406514075140851409514105141151412514135141451415514165141751418514195142051421514225142351424514255142651427514285142951430514315143251433514345143551436514375143851439514405144151442514435144451445514465144751448514495145051451514525145351454514555145651457514585145951460514615146251463514645146551466514675146851469514705147151472514735147451475514765147751478514795148051481514825148351484514855148651487514885148951490514915149251493514945149551496514975149851499515005150151502515035150451505515065150751508515095151051511515125151351514515155151651517515185151951520515215152251523515245152551526515275152851529515305153151532515335153451535515365153751538515395154051541515425154351544515455154651547515485154951550515515155251553515545155551556515575155851559515605156151562515635156451565515665156751568515695157051571515725157351574515755157651577515785157951580515815158251583515845158551586515875158851589515905159151592515935159451595515965159751598515995160051601516025160351604516055160651607516085160951610516115161251613516145161551616516175161851619516205162151622516235162451625516265162751628516295163051631516325163351634516355163651637516385163951640516415164251643516445164551646516475164851649516505165151652516535165451655516565165751658516595166051661516625166351664516655166651667516685166951670516715167251673516745167551676516775167851679516805168151682516835168451685516865168751688516895169051691516925169351694516955169651697516985169951700517015170251703517045170551706517075170851709517105171151712517135171451715517165171751718517195172051721517225172351724517255172651727517285172951730517315173251733517345173551736517375173851739517405174151742517435174451745517465174751748517495175051751517525175351754517555175651757517585175951760517615176251763517645176551766517675176851769517705177151772517735177451775517765177751778517795178051781517825178351784517855178651787517885178951790517915179251793517945179551796517975179851799518005180151802518035180451805518065180751808518095181051811518125181351814518155181651817518185181951820518215182251823518245182551826518275182851829518305183151832518335183451835518365183751838518395184051841518425184351844518455184651847518485184951850518515185251853518545185551856518575185851859518605186151862518635186451865518665186751868518695187051871518725187351874518755187651877518785187951880518815188251883518845188551886518875188851889518905189151892518935189451895518965189751898518995190051901519025190351904519055190651907519085190951910519115191251913519145191551916519175191851919519205192151922519235192451925519265192751928519295193051931519325193351934519355193651937519385193951940519415194251943519445194551946519475194851949519505195151952519535195451955519565195751958519595196051961519625196351964519655196651967519685196951970519715197251973519745197551976519775197851979519805198151982519835198451985519865198751988519895199051991519925199351994519955199651997519985199952000520015200252003520045200552006520075200852009520105201152012520135201452015520165201752018520195202052021520225202352024520255202652027520285202952030520315203252033520345203552036520375203852039520405204152042520435204452045520465204752048520495205052051520525205352054520555205652057520585205952060520615206252063520645206552066520675206852069520705207152072520735207452075520765207752078520795208052081520825208352084520855208652087520885208952090520915209252093520945209552096520975209852099521005210152102521035210452105521065210752108521095211052111521125211352114521155211652117521185211952120521215212252123521245212552126521275212852129521305213152132521335213452135521365213752138521395214052141521425214352144521455214652147521485214952150521515215252153521545215552156521575215852159521605216152162521635216452165521665216752168521695217052171521725217352174521755217652177521785217952180521815218252183521845218552186521875218852189521905219152192521935219452195521965219752198521995220052201522025220352204522055220652207522085220952210522115221252213522145221552216522175221852219522205222152222522235222452225522265222752228522295223052231522325223352234522355223652237522385223952240522415224252243522445224552246522475224852249522505225152252522535225452255522565225752258522595226052261522625226352264522655226652267522685226952270522715227252273522745227552276522775227852279522805228152282522835228452285522865228752288522895229052291522925229352294522955229652297522985229952300523015230252303523045230552306523075230852309523105231152312523135231452315523165231752318523195232052321523225232352324523255232652327523285232952330523315233252333523345233552336523375233852339523405234152342523435234452345523465234752348523495235052351523525235352354523555235652357523585235952360523615236252363523645236552366523675236852369523705237152372523735237452375523765237752378523795238052381523825238352384523855238652387523885238952390523915239252393523945239552396523975239852399524005240152402524035240452405524065240752408524095241052411524125241352414524155241652417524185241952420524215242252423524245242552426524275242852429524305243152432524335243452435524365243752438524395244052441524425244352444524455244652447524485244952450524515245252453524545245552456524575245852459524605246152462524635246452465524665246752468524695247052471524725247352474524755247652477524785247952480524815248252483524845248552486524875248852489524905249152492524935249452495524965249752498524995250052501525025250352504525055250652507525085250952510525115251252513525145251552516525175251852519525205252152522525235252452525525265252752528525295253052531525325253352534525355253652537525385253952540525415254252543525445254552546525475254852549525505255152552525535255452555525565255752558525595256052561525625256352564525655256652567525685256952570525715257252573525745257552576525775257852579525805258152582525835258452585525865258752588525895259052591525925259352594525955259652597525985259952600526015260252603526045260552606526075260852609526105261152612526135261452615526165261752618526195262052621526225262352624526255262652627526285262952630526315263252633526345263552636526375263852639526405264152642526435264452645526465264752648526495265052651526525265352654526555265652657526585265952660526615266252663526645266552666526675266852669526705267152672526735267452675526765267752678526795268052681526825268352684526855268652687526885268952690526915269252693526945269552696526975269852699527005270152702527035270452705527065270752708527095271052711527125271352714527155271652717527185271952720527215272252723527245272552726527275272852729527305273152732527335273452735527365273752738527395274052741527425274352744527455274652747527485274952750527515275252753527545275552756527575275852759527605276152762527635276452765527665276752768527695277052771527725277352774527755277652777527785277952780527815278252783527845278552786527875278852789527905279152792527935279452795527965279752798527995280052801528025280352804528055280652807528085280952810528115281252813528145281552816528175281852819528205282152822528235282452825528265282752828528295283052831528325283352834528355283652837528385283952840528415284252843528445284552846528475284852849528505285152852528535285452855528565285752858528595286052861528625286352864528655286652867528685286952870528715287252873528745287552876528775287852879528805288152882528835288452885528865288752888528895289052891528925289352894528955289652897528985289952900529015290252903529045290552906529075290852909529105291152912529135291452915529165291752918529195292052921529225292352924529255292652927529285292952930529315293252933529345293552936529375293852939529405294152942529435294452945529465294752948529495295052951529525295352954529555295652957529585295952960529615296252963529645296552966529675296852969529705297152972529735297452975529765297752978529795298052981529825298352984529855298652987529885298952990529915299252993529945299552996529975299852999530005300153002530035300453005530065300753008530095301053011530125301353014530155301653017530185301953020530215302253023530245302553026530275302853029530305303153032530335303453035530365303753038530395304053041530425304353044530455304653047530485304953050530515305253053530545305553056530575305853059530605306153062530635306453065530665306753068530695307053071530725307353074530755307653077530785307953080530815308253083530845308553086530875308853089530905309153092530935309453095530965309753098530995310053101531025310353104531055310653107531085310953110531115311253113531145311553116531175311853119531205312153122531235312453125531265312753128531295313053131531325313353134531355313653137531385313953140531415314253143531445314553146531475314853149531505315153152531535315453155531565315753158531595316053161531625316353164531655316653167531685316953170531715317253173531745317553176531775317853179531805318153182531835318453185531865318753188531895319053191531925319353194531955319653197531985319953200532015320253203532045320553206532075320853209532105321153212532135321453215532165321753218532195322053221532225322353224532255322653227532285322953230532315323253233532345323553236532375323853239532405324153242532435324453245532465324753248532495325053251532525325353254532555325653257532585325953260532615326253263532645326553266532675326853269532705327153272532735327453275532765327753278532795328053281532825328353284532855328653287532885328953290532915329253293532945329553296532975329853299533005330153302533035330453305533065330753308533095331053311533125331353314533155331653317533185331953320533215332253323533245332553326533275332853329533305333153332533335333453335533365333753338533395334053341533425334353344533455334653347533485334953350533515335253353533545335553356533575335853359533605336153362533635336453365533665336753368533695337053371533725337353374533755337653377533785337953380533815338253383533845338553386533875338853389533905339153392533935339453395533965339753398533995340053401534025340353404534055340653407534085340953410534115341253413534145341553416534175341853419534205342153422534235342453425534265342753428534295343053431534325343353434534355343653437534385343953440534415344253443534445344553446534475344853449534505345153452534535345453455534565345753458534595346053461534625346353464534655346653467534685346953470534715347253473534745347553476534775347853479534805348153482534835348453485534865348753488534895349053491534925349353494534955349653497534985349953500535015350253503535045350553506535075350853509535105351153512535135351453515535165351753518535195352053521535225352353524535255352653527535285352953530535315353253533535345353553536535375353853539535405354153542535435354453545535465354753548535495355053551535525355353554535555355653557535585355953560535615356253563535645356553566535675356853569535705357153572535735357453575535765357753578535795358053581535825358353584535855358653587535885358953590535915359253593535945359553596535975359853599536005360153602536035360453605536065360753608536095361053611536125361353614536155361653617536185361953620536215362253623536245362553626536275362853629536305363153632536335363453635536365363753638536395364053641536425364353644536455364653647536485364953650536515365253653536545365553656536575365853659536605366153662536635366453665536665366753668536695367053671536725367353674536755367653677536785367953680536815368253683536845368553686536875368853689536905369153692536935369453695536965369753698536995370053701537025370353704537055370653707537085370953710537115371253713537145371553716537175371853719537205372153722537235372453725537265372753728537295373053731537325373353734537355373653737537385373953740537415374253743537445374553746537475374853749537505375153752537535375453755537565375753758537595376053761537625376353764537655376653767537685376953770537715377253773537745377553776537775377853779537805378153782537835378453785537865378753788537895379053791537925379353794537955379653797537985379953800538015380253803538045380553806538075380853809538105381153812538135381453815538165381753818538195382053821538225382353824538255382653827538285382953830538315383253833538345383553836538375383853839538405384153842538435384453845538465384753848538495385053851538525385353854538555385653857538585385953860538615386253863538645386553866538675386853869538705387153872538735387453875538765387753878538795388053881538825388353884538855388653887538885388953890538915389253893538945389553896538975389853899539005390153902539035390453905539065390753908539095391053911539125391353914539155391653917539185391953920539215392253923539245392553926539275392853929539305393153932539335393453935539365393753938539395394053941539425394353944539455394653947539485394953950539515395253953539545395553956539575395853959539605396153962539635396453965539665396753968539695397053971539725397353974539755397653977539785397953980539815398253983539845398553986539875398853989539905399153992539935399453995539965399753998539995400054001540025400354004540055400654007540085400954010540115401254013540145401554016540175401854019540205402154022540235402454025540265402754028540295403054031540325403354034540355403654037540385403954040540415404254043540445404554046540475404854049540505405154052540535405454055540565405754058540595406054061540625406354064540655406654067540685406954070540715407254073540745407554076540775407854079540805408154082540835408454085540865408754088540895409054091540925409354094540955409654097540985409954100541015410254103541045410554106541075410854109541105411154112541135411454115541165411754118541195412054121541225412354124541255412654127541285412954130541315413254133541345413554136541375413854139541405414154142541435414454145541465414754148541495415054151541525415354154541555415654157541585415954160541615416254163541645416554166541675416854169541705417154172541735417454175541765417754178541795418054181541825418354184541855418654187541885418954190541915419254193541945419554196541975419854199542005420154202542035420454205542065420754208542095421054211542125421354214542155421654217542185421954220542215422254223542245422554226542275422854229542305423154232542335423454235542365423754238542395424054241542425424354244542455424654247542485424954250542515425254253542545425554256542575425854259542605426154262542635426454265542665426754268542695427054271542725427354274542755427654277542785427954280542815428254283542845428554286542875428854289542905429154292542935429454295542965429754298542995430054301543025430354304543055430654307543085430954310543115431254313543145431554316543175431854319543205432154322543235432454325543265432754328543295433054331543325433354334543355433654337543385433954340543415434254343543445434554346543475434854349543505435154352543535435454355543565435754358543595436054361543625436354364543655436654367543685436954370543715437254373543745437554376543775437854379543805438154382543835438454385543865438754388543895439054391543925439354394543955439654397543985439954400544015440254403544045440554406544075440854409544105441154412544135441454415544165441754418544195442054421544225442354424544255442654427544285442954430544315443254433544345443554436544375443854439544405444154442544435444454445544465444754448544495445054451544525445354454544555445654457544585445954460544615446254463544645446554466544675446854469544705447154472544735447454475544765447754478544795448054481544825448354484544855448654487544885448954490544915449254493544945449554496544975449854499545005450154502545035450454505545065450754508545095451054511545125451354514545155451654517545185451954520545215452254523545245452554526545275452854529545305453154532545335453454535545365453754538545395454054541545425454354544545455454654547545485454954550545515455254553545545455554556545575455854559545605456154562545635456454565545665456754568545695457054571545725457354574545755457654577545785457954580545815458254583545845458554586545875458854589545905459154592545935459454595545965459754598545995460054601546025460354604546055460654607546085460954610546115461254613546145461554616546175461854619546205462154622546235462454625546265462754628546295463054631546325463354634546355463654637546385463954640546415464254643546445464554646546475464854649546505465154652546535465454655546565465754658546595466054661546625466354664546655466654667546685466954670546715467254673546745467554676546775467854679546805468154682546835468454685546865468754688546895469054691546925469354694546955469654697546985469954700547015470254703547045470554706547075470854709547105471154712547135471454715547165471754718547195472054721547225472354724547255472654727547285472954730547315473254733547345473554736547375473854739547405474154742547435474454745547465474754748547495475054751547525475354754547555475654757547585475954760547615476254763547645476554766547675476854769547705477154772547735477454775547765477754778547795478054781547825478354784547855478654787547885478954790547915479254793547945479554796547975479854799548005480154802548035480454805548065480754808548095481054811548125481354814548155481654817548185481954820548215482254823548245482554826548275482854829548305483154832548335483454835548365483754838548395484054841548425484354844548455484654847548485484954850548515485254853548545485554856548575485854859548605486154862548635486454865548665486754868548695487054871548725487354874548755487654877548785487954880548815488254883548845488554886548875488854889548905489154892548935489454895548965489754898548995490054901549025490354904549055490654907549085490954910549115491254913549145491554916549175491854919549205492154922549235492454925549265492754928549295493054931549325493354934549355493654937549385493954940549415494254943549445494554946549475494854949549505495154952549535495454955549565495754958549595496054961549625496354964549655496654967549685496954970549715497254973549745497554976549775497854979549805498154982549835498454985549865498754988549895499054991549925499354994549955499654997549985499955000550015500255003550045500555006550075500855009550105501155012550135501455015550165501755018550195502055021550225502355024550255502655027550285502955030550315503255033550345503555036550375503855039550405504155042550435504455045550465504755048550495505055051550525505355054550555505655057550585505955060550615506255063550645506555066550675506855069550705507155072550735507455075550765507755078550795508055081550825508355084550855508655087550885508955090550915509255093550945509555096550975509855099551005510155102551035510455105551065510755108551095511055111551125511355114551155511655117551185511955120551215512255123551245512555126551275512855129551305513155132551335513455135551365513755138551395514055141551425514355144551455514655147551485514955150551515515255153551545515555156551575515855159551605516155162551635516455165551665516755168551695517055171551725517355174551755517655177551785517955180551815518255183551845518555186551875518855189551905519155192551935519455195551965519755198551995520055201552025520355204552055520655207552085520955210552115521255213552145521555216552175521855219552205522155222552235522455225552265522755228552295523055231552325523355234552355523655237552385523955240552415524255243552445524555246552475524855249552505525155252552535525455255552565525755258552595526055261552625526355264552655526655267552685526955270552715527255273552745527555276552775527855279552805528155282552835528455285552865528755288552895529055291552925529355294552955529655297552985529955300553015530255303553045530555306553075530855309553105531155312553135531455315553165531755318553195532055321553225532355324553255532655327553285532955330553315533255333553345533555336553375533855339553405534155342553435534455345553465534755348553495535055351553525535355354553555535655357553585535955360553615536255363553645536555366553675536855369553705537155372553735537455375553765537755378553795538055381553825538355384553855538655387553885538955390553915539255393553945539555396553975539855399554005540155402554035540455405554065540755408554095541055411554125541355414554155541655417554185541955420554215542255423554245542555426554275542855429554305543155432554335543455435554365543755438554395544055441554425544355444554455544655447554485544955450554515545255453554545545555456554575545855459554605546155462554635546455465554665546755468554695547055471554725547355474554755547655477554785547955480554815548255483554845548555486554875548855489554905549155492554935549455495554965549755498554995550055501555025550355504555055550655507555085550955510555115551255513555145551555516555175551855519555205552155522555235552455525555265552755528555295553055531555325553355534555355553655537555385553955540555415554255543555445554555546555475554855549555505555155552555535555455555555565555755558555595556055561555625556355564555655556655567555685556955570555715557255573555745557555576555775557855579555805558155582555835558455585555865558755588555895559055591555925559355594555955559655597555985559955600556015560255603556045560555606556075560855609556105561155612556135561455615556165561755618556195562055621556225562355624556255562655627556285562955630556315563255633556345563555636556375563855639556405564155642556435564455645556465564755648556495565055651556525565355654556555565655657556585565955660556615566255663556645566555666556675566855669556705567155672556735567455675556765567755678556795568055681556825568355684556855568655687556885568955690556915569255693556945569555696556975569855699557005570155702557035570455705557065570755708557095571055711557125571355714557155571655717557185571955720557215572255723557245572555726557275572855729557305573155732557335573455735557365573755738557395574055741557425574355744557455574655747557485574955750557515575255753557545575555756557575575855759557605576155762557635576455765557665576755768557695577055771557725577355774557755577655777557785577955780557815578255783557845578555786557875578855789557905579155792557935579455795557965579755798557995580055801558025580355804558055580655807558085580955810558115581255813558145581555816558175581855819558205582155822558235582455825558265582755828558295583055831558325583355834558355583655837558385583955840558415584255843558445584555846558475584855849558505585155852558535585455855558565585755858558595586055861558625586355864558655586655867558685586955870558715587255873558745587555876558775587855879558805588155882558835588455885558865588755888558895589055891558925589355894558955589655897558985589955900559015590255903559045590555906559075590855909559105591155912559135591455915559165591755918559195592055921559225592355924559255592655927559285592955930559315593255933559345593555936559375593855939559405594155942559435594455945559465594755948559495595055951559525595355954559555595655957559585595955960559615596255963559645596555966559675596855969559705597155972559735597455975559765597755978559795598055981559825598355984559855598655987559885598955990559915599255993559945599555996559975599855999560005600156002560035600456005560065600756008560095601056011560125601356014560155601656017560185601956020560215602256023560245602556026560275602856029560305603156032560335603456035560365603756038560395604056041560425604356044560455604656047560485604956050560515605256053560545605556056560575605856059560605606156062560635606456065560665606756068560695607056071560725607356074560755607656077560785607956080560815608256083560845608556086560875608856089560905609156092560935609456095560965609756098560995610056101561025610356104561055610656107561085610956110561115611256113561145611556116561175611856119561205612156122561235612456125561265612756128561295613056131561325613356134561355613656137561385613956140561415614256143561445614556146561475614856149561505615156152561535615456155561565615756158561595616056161561625616356164561655616656167561685616956170561715617256173561745617556176561775617856179561805618156182561835618456185561865618756188561895619056191561925619356194561955619656197561985619956200562015620256203562045620556206562075620856209562105621156212562135621456215562165621756218562195622056221562225622356224562255622656227562285622956230562315623256233562345623556236562375623856239562405624156242562435624456245562465624756248562495625056251562525625356254562555625656257562585625956260562615626256263562645626556266562675626856269562705627156272562735627456275562765627756278562795628056281562825628356284562855628656287562885628956290562915629256293562945629556296562975629856299563005630156302563035630456305563065630756308563095631056311563125631356314563155631656317563185631956320563215632256323563245632556326563275632856329563305633156332563335633456335563365633756338563395634056341563425634356344563455634656347563485634956350563515635256353563545635556356563575635856359563605636156362563635636456365563665636756368563695637056371563725637356374563755637656377563785637956380563815638256383563845638556386563875638856389563905639156392563935639456395563965639756398563995640056401564025640356404564055640656407564085640956410564115641256413564145641556416564175641856419564205642156422564235642456425564265642756428564295643056431564325643356434564355643656437564385643956440564415644256443564445644556446564475644856449564505645156452564535645456455564565645756458564595646056461564625646356464564655646656467564685646956470564715647256473564745647556476564775647856479564805648156482564835648456485564865648756488564895649056491564925649356494564955649656497564985649956500565015650256503565045650556506565075650856509565105651156512565135651456515565165651756518565195652056521565225652356524565255652656527565285652956530565315653256533565345653556536565375653856539565405654156542565435654456545565465654756548565495655056551565525655356554565555655656557565585655956560565615656256563565645656556566565675656856569565705657156572565735657456575565765657756578565795658056581565825658356584565855658656587565885658956590565915659256593565945659556596565975659856599566005660156602566035660456605566065660756608566095661056611566125661356614566155661656617566185661956620566215662256623566245662556626566275662856629566305663156632566335663456635566365663756638566395664056641566425664356644566455664656647566485664956650566515665256653566545665556656566575665856659566605666156662566635666456665566665666756668566695667056671566725667356674566755667656677566785667956680566815668256683566845668556686566875668856689566905669156692566935669456695566965669756698566995670056701567025670356704567055670656707567085670956710567115671256713567145671556716567175671856719567205672156722567235672456725567265672756728567295673056731567325673356734567355673656737567385673956740567415674256743567445674556746567475674856749567505675156752567535675456755567565675756758567595676056761567625676356764567655676656767567685676956770567715677256773567745677556776567775677856779567805678156782567835678456785567865678756788567895679056791567925679356794567955679656797567985679956800568015680256803568045680556806568075680856809568105681156812568135681456815568165681756818568195682056821568225682356824568255682656827568285682956830568315683256833568345683556836568375683856839568405684156842568435684456845568465684756848568495685056851568525685356854568555685656857568585685956860568615686256863568645686556866568675686856869568705687156872568735687456875568765687756878568795688056881568825688356884568855688656887568885688956890568915689256893568945689556896568975689856899569005690156902569035690456905569065690756908569095691056911569125691356914569155691656917569185691956920569215692256923569245692556926569275692856929569305693156932569335693456935569365693756938569395694056941569425694356944569455694656947569485694956950569515695256953569545695556956569575695856959569605696156962569635696456965569665696756968569695697056971569725697356974569755697656977569785697956980569815698256983569845698556986569875698856989569905699156992569935699456995569965699756998569995700057001570025700357004570055700657007570085700957010570115701257013570145701557016570175701857019570205702157022570235702457025570265702757028570295703057031570325703357034570355703657037570385703957040570415704257043570445704557046570475704857049570505705157052570535705457055570565705757058570595706057061570625706357064570655706657067570685706957070570715707257073570745707557076570775707857079570805708157082570835708457085570865708757088570895709057091570925709357094570955709657097570985709957100571015710257103571045710557106571075710857109571105711157112571135711457115571165711757118571195712057121571225712357124571255712657127571285712957130571315713257133571345713557136571375713857139571405714157142571435714457145571465714757148571495715057151571525715357154571555715657157571585715957160571615716257163571645716557166571675716857169571705717157172571735717457175571765717757178571795718057181571825718357184571855718657187571885718957190571915719257193571945719557196571975719857199572005720157202572035720457205572065720757208572095721057211572125721357214572155721657217572185721957220572215722257223572245722557226572275722857229572305723157232572335723457235572365723757238572395724057241572425724357244572455724657247572485724957250572515725257253572545725557256572575725857259572605726157262572635726457265572665726757268572695727057271572725727357274572755727657277572785727957280572815728257283572845728557286572875728857289572905729157292572935729457295572965729757298572995730057301573025730357304573055730657307573085730957310573115731257313573145731557316573175731857319573205732157322573235732457325573265732757328573295733057331573325733357334573355733657337573385733957340573415734257343573445734557346573475734857349573505735157352573535735457355573565735757358573595736057361573625736357364573655736657367573685736957370573715737257373573745737557376573775737857379573805738157382573835738457385573865738757388573895739057391573925739357394573955739657397573985739957400574015740257403574045740557406574075740857409574105741157412574135741457415574165741757418574195742057421574225742357424574255742657427574285742957430574315743257433574345743557436574375743857439574405744157442574435744457445574465744757448574495745057451574525745357454574555745657457574585745957460574615746257463574645746557466574675746857469574705747157472574735747457475574765747757478574795748057481574825748357484574855748657487574885748957490574915749257493574945749557496574975749857499575005750157502575035750457505575065750757508575095751057511575125751357514575155751657517575185751957520575215752257523575245752557526575275752857529575305753157532575335753457535575365753757538575395754057541575425754357544575455754657547575485754957550575515755257553575545755557556575575755857559575605756157562575635756457565575665756757568575695757057571575725757357574575755757657577575785757957580575815758257583575845758557586575875758857589575905759157592575935759457595575965759757598575995760057601576025760357604576055760657607576085760957610576115761257613576145761557616576175761857619576205762157622576235762457625576265762757628576295763057631576325763357634576355763657637576385763957640576415764257643576445764557646576475764857649576505765157652576535765457655576565765757658576595766057661576625766357664576655766657667576685766957670576715767257673576745767557676576775767857679576805768157682576835768457685576865768757688576895769057691576925769357694576955769657697576985769957700577015770257703577045770557706577075770857709577105771157712577135771457715577165771757718577195772057721577225772357724577255772657727577285772957730577315773257733577345773557736577375773857739577405774157742577435774457745577465774757748577495775057751577525775357754577555775657757577585775957760577615776257763577645776557766577675776857769577705777157772577735777457775577765777757778577795778057781577825778357784577855778657787577885778957790577915779257793577945779557796577975779857799578005780157802578035780457805578065780757808578095781057811578125781357814578155781657817578185781957820578215782257823578245782557826578275782857829578305783157832578335783457835578365783757838578395784057841578425784357844578455784657847578485784957850578515785257853578545785557856578575785857859578605786157862578635786457865578665786757868578695787057871578725787357874578755787657877578785787957880578815788257883578845788557886578875788857889578905789157892578935789457895578965789757898578995790057901579025790357904579055790657907579085790957910579115791257913579145791557916579175791857919579205792157922579235792457925579265792757928579295793057931579325793357934579355793657937579385793957940579415794257943579445794557946579475794857949579505795157952579535795457955579565795757958579595796057961579625796357964579655796657967579685796957970579715797257973579745797557976579775797857979579805798157982579835798457985579865798757988579895799057991579925799357994579955799657997579985799958000580015800258003580045800558006580075800858009580105801158012580135801458015580165801758018580195802058021580225802358024580255802658027580285802958030580315803258033580345803558036580375803858039580405804158042580435804458045580465804758048580495805058051580525805358054580555805658057580585805958060580615806258063580645806558066580675806858069580705807158072580735807458075580765807758078580795808058081580825808358084580855808658087580885808958090580915809258093580945809558096580975809858099581005810158102581035810458105581065810758108581095811058111581125811358114581155811658117581185811958120581215812258123581245812558126581275812858129581305813158132581335813458135581365813758138581395814058141581425814358144581455814658147581485814958150581515815258153581545815558156581575815858159581605816158162581635816458165581665816758168581695817058171581725817358174581755817658177581785817958180581815818258183581845818558186581875818858189581905819158192581935819458195581965819758198581995820058201582025820358204582055820658207582085820958210582115821258213582145821558216582175821858219582205822158222582235822458225582265822758228582295823058231582325823358234582355823658237582385823958240582415824258243582445824558246582475824858249582505825158252582535825458255582565825758258582595826058261582625826358264582655826658267582685826958270582715827258273582745827558276582775827858279582805828158282582835828458285582865828758288582895829058291582925829358294582955829658297582985829958300583015830258303583045830558306583075830858309583105831158312583135831458315583165831758318583195832058321583225832358324583255832658327583285832958330583315833258333583345833558336583375833858339583405834158342583435834458345583465834758348583495835058351583525835358354583555835658357583585835958360583615836258363583645836558366583675836858369583705837158372583735837458375583765837758378583795838058381583825838358384583855838658387583885838958390583915839258393583945839558396583975839858399584005840158402584035840458405584065840758408584095841058411584125841358414584155841658417584185841958420584215842258423584245842558426584275842858429584305843158432584335843458435584365843758438584395844058441584425844358444584455844658447584485844958450584515845258453584545845558456584575845858459584605846158462584635846458465584665846758468584695847058471584725847358474584755847658477584785847958480584815848258483584845848558486584875848858489584905849158492584935849458495584965849758498584995850058501585025850358504585055850658507585085850958510585115851258513585145851558516585175851858519585205852158522585235852458525585265852758528585295853058531585325853358534585355853658537585385853958540585415854258543585445854558546585475854858549585505855158552585535855458555585565855758558585595856058561585625856358564585655856658567585685856958570585715857258573585745857558576585775857858579585805858158582585835858458585585865858758588585895859058591585925859358594585955859658597585985859958600586015860258603586045860558606586075860858609586105861158612586135861458615586165861758618586195862058621586225862358624586255862658627586285862958630586315863258633586345863558636586375863858639586405864158642586435864458645586465864758648586495865058651586525865358654586555865658657586585865958660586615866258663586645866558666586675866858669586705867158672586735867458675586765867758678586795868058681586825868358684586855868658687586885868958690586915869258693586945869558696586975869858699587005870158702587035870458705587065870758708587095871058711587125871358714587155871658717587185871958720587215872258723587245872558726587275872858729587305873158732587335873458735587365873758738587395874058741587425874358744587455874658747587485874958750587515875258753587545875558756587575875858759587605876158762587635876458765587665876758768587695877058771587725877358774587755877658777587785877958780587815878258783587845878558786587875878858789587905879158792587935879458795587965879758798587995880058801588025880358804588055880658807588085880958810588115881258813588145881558816588175881858819588205882158822588235882458825588265882758828588295883058831588325883358834588355883658837588385883958840588415884258843588445884558846588475884858849588505885158852588535885458855588565885758858588595886058861588625886358864588655886658867588685886958870588715887258873588745887558876588775887858879588805888158882588835888458885588865888758888588895889058891588925889358894588955889658897588985889958900589015890258903589045890558906589075890858909589105891158912589135891458915589165891758918589195892058921589225892358924589255892658927589285892958930589315893258933589345893558936589375893858939589405894158942589435894458945589465894758948589495895058951589525895358954589555895658957589585895958960589615896258963589645896558966589675896858969589705897158972589735897458975589765897758978589795898058981589825898358984589855898658987589885898958990589915899258993589945899558996589975899858999590005900159002590035900459005590065900759008590095901059011590125901359014590155901659017590185901959020590215902259023590245902559026590275902859029590305903159032590335903459035590365903759038590395904059041590425904359044590455904659047590485904959050590515905259053590545905559056590575905859059590605906159062590635906459065590665906759068590695907059071590725907359074590755907659077590785907959080590815908259083590845908559086590875908859089590905909159092590935909459095590965909759098590995910059101591025910359104591055910659107591085910959110591115911259113591145911559116591175911859119591205912159122591235912459125591265912759128591295913059131591325913359134591355913659137591385913959140591415914259143591445914559146591475914859149591505915159152591535915459155591565915759158591595916059161591625916359164591655916659167591685916959170591715917259173591745917559176591775917859179591805918159182591835918459185591865918759188591895919059191591925919359194591955919659197591985919959200592015920259203592045920559206592075920859209592105921159212592135921459215592165921759218592195922059221592225922359224592255922659227592285922959230592315923259233592345923559236592375923859239592405924159242592435924459245592465924759248592495925059251592525925359254592555925659257592585925959260592615926259263592645926559266592675926859269592705927159272592735927459275592765927759278592795928059281592825928359284592855928659287592885928959290592915929259293592945929559296592975929859299593005930159302593035930459305593065930759308593095931059311593125931359314593155931659317593185931959320593215932259323593245932559326593275932859329593305933159332593335933459335593365933759338593395934059341593425934359344593455934659347593485934959350593515935259353593545935559356593575935859359593605936159362593635936459365593665936759368593695937059371593725937359374593755937659377593785937959380593815938259383593845938559386593875938859389593905939159392593935939459395593965939759398593995940059401594025940359404594055940659407594085940959410594115941259413594145941559416594175941859419594205942159422594235942459425594265942759428594295943059431594325943359434594355943659437594385943959440594415944259443594445944559446594475944859449594505945159452594535945459455594565945759458594595946059461594625946359464594655946659467594685946959470594715947259473594745947559476594775947859479594805948159482594835948459485594865948759488594895949059491594925949359494594955949659497594985949959500595015950259503595045950559506595075950859509595105951159512595135951459515595165951759518595195952059521595225952359524595255952659527595285952959530595315953259533595345953559536595375953859539595405954159542595435954459545595465954759548595495955059551595525955359554595555955659557595585955959560595615956259563595645956559566595675956859569595705957159572595735957459575595765957759578595795958059581595825958359584595855958659587595885958959590595915959259593595945959559596595975959859599596005960159602596035960459605596065960759608596095961059611596125961359614596155961659617596185961959620596215962259623596245962559626596275962859629596305963159632596335963459635596365963759638596395964059641596425964359644596455964659647596485964959650596515965259653596545965559656596575965859659596605966159662596635966459665596665966759668596695967059671596725967359674596755967659677596785967959680596815968259683596845968559686596875968859689596905969159692596935969459695596965969759698596995970059701597025970359704597055970659707597085970959710597115971259713597145971559716597175971859719597205972159722597235972459725597265972759728597295973059731597325973359734597355973659737597385973959740597415974259743597445974559746597475974859749597505975159752597535975459755597565975759758597595976059761597625976359764597655976659767597685976959770597715977259773597745977559776597775977859779597805978159782597835978459785597865978759788597895979059791597925979359794597955979659797597985979959800598015980259803598045980559806598075980859809598105981159812598135981459815598165981759818598195982059821598225982359824598255982659827598285982959830598315983259833598345983559836598375983859839598405984159842598435984459845598465984759848598495985059851598525985359854598555985659857598585985959860598615986259863598645986559866598675986859869598705987159872598735987459875598765987759878598795988059881598825988359884598855988659887598885988959890598915989259893598945989559896598975989859899599005990159902599035990459905599065990759908599095991059911599125991359914599155991659917599185991959920599215992259923599245992559926599275992859929599305993159932599335993459935599365993759938599395994059941599425994359944599455994659947599485994959950599515995259953599545995559956599575995859959599605996159962599635996459965599665996759968599695997059971599725997359974599755997659977599785997959980599815998259983599845998559986599875998859989599905999159992599935999459995599965999759998599996000060001600026000360004600056000660007600086000960010600116001260013600146001560016600176001860019600206002160022600236002460025600266002760028600296003060031600326003360034600356003660037600386003960040600416004260043600446004560046600476004860049600506005160052600536005460055600566005760058600596006060061600626006360064600656006660067600686006960070600716007260073600746007560076600776007860079600806008160082600836008460085600866008760088600896009060091600926009360094600956009660097600986009960100601016010260103601046010560106601076010860109601106011160112601136011460115601166011760118601196012060121601226012360124601256012660127601286012960130601316013260133601346013560136601376013860139601406014160142601436014460145601466014760148601496015060151601526015360154601556015660157601586015960160601616016260163601646016560166601676016860169601706017160172601736017460175601766017760178601796018060181601826018360184601856018660187601886018960190601916019260193601946019560196601976019860199602006020160202602036020460205602066020760208602096021060211602126021360214602156021660217602186021960220602216022260223602246022560226602276022860229602306023160232602336023460235602366023760238602396024060241602426024360244602456024660247602486024960250602516025260253602546025560256602576025860259602606026160262602636026460265602666026760268602696027060271602726027360274602756027660277602786027960280602816028260283602846028560286602876028860289602906029160292602936029460295602966029760298602996030060301603026030360304603056030660307603086030960310603116031260313603146031560316603176031860319603206032160322603236032460325603266032760328603296033060331603326033360334603356033660337603386033960340603416034260343603446034560346603476034860349603506035160352603536035460355603566035760358603596036060361603626036360364603656036660367603686036960370603716037260373603746037560376603776037860379603806038160382603836038460385603866038760388603896039060391603926039360394603956039660397603986039960400604016040260403604046040560406604076040860409604106041160412604136041460415604166041760418604196042060421604226042360424604256042660427604286042960430604316043260433604346043560436604376043860439604406044160442604436044460445604466044760448604496045060451604526045360454604556045660457604586045960460604616046260463604646046560466604676046860469604706047160472604736047460475604766047760478604796048060481604826048360484604856048660487604886048960490604916049260493604946049560496604976049860499605006050160502605036050460505605066050760508605096051060511605126051360514605156051660517605186051960520605216052260523605246052560526605276052860529605306053160532605336053460535605366053760538605396054060541605426054360544605456054660547605486054960550605516055260553605546055560556605576055860559605606056160562605636056460565605666056760568605696057060571605726057360574605756057660577605786057960580605816058260583605846058560586605876058860589605906059160592605936059460595605966059760598605996060060601606026060360604606056060660607606086060960610606116061260613606146061560616606176061860619606206062160622606236062460625606266062760628606296063060631606326063360634606356063660637606386063960640606416064260643606446064560646606476064860649606506065160652606536065460655606566065760658606596066060661606626066360664606656066660667606686066960670606716067260673606746067560676606776067860679606806068160682606836068460685606866068760688606896069060691606926069360694606956069660697606986069960700607016070260703607046070560706607076070860709607106071160712607136071460715607166071760718607196072060721607226072360724607256072660727607286072960730607316073260733607346073560736607376073860739607406074160742607436074460745607466074760748607496075060751607526075360754607556075660757607586075960760607616076260763607646076560766607676076860769607706077160772607736077460775607766077760778607796078060781607826078360784607856078660787607886078960790607916079260793607946079560796607976079860799608006080160802608036080460805608066080760808608096081060811608126081360814608156081660817608186081960820608216082260823608246082560826608276082860829608306083160832608336083460835608366083760838608396084060841608426084360844608456084660847608486084960850608516085260853608546085560856608576085860859608606086160862608636086460865608666086760868608696087060871608726087360874608756087660877608786087960880608816088260883608846088560886608876088860889608906089160892608936089460895608966089760898608996090060901609026090360904609056090660907609086090960910609116091260913609146091560916609176091860919609206092160922609236092460925609266092760928609296093060931609326093360934609356093660937609386093960940609416094260943609446094560946609476094860949609506095160952609536095460955609566095760958609596096060961609626096360964609656096660967609686096960970609716097260973609746097560976609776097860979609806098160982609836098460985609866098760988609896099060991609926099360994609956099660997609986099961000610016100261003610046100561006610076100861009610106101161012610136101461015610166101761018610196102061021610226102361024610256102661027610286102961030610316103261033610346103561036610376103861039610406104161042610436104461045610466104761048610496105061051610526105361054610556105661057610586105961060610616106261063610646106561066610676106861069610706107161072610736107461075610766107761078610796108061081610826108361084610856108661087610886108961090610916109261093610946109561096610976109861099611006110161102611036110461105611066110761108611096111061111611126111361114611156111661117611186111961120611216112261123611246112561126611276112861129611306113161132611336113461135611366113761138611396114061141611426114361144611456114661147611486114961150611516115261153611546115561156611576115861159611606116161162611636116461165611666116761168611696117061171611726117361174611756117661177611786117961180611816118261183611846118561186611876118861189611906119161192611936119461195611966119761198611996120061201612026120361204612056120661207612086120961210612116121261213612146121561216612176121861219612206122161222612236122461225612266122761228612296123061231612326123361234612356123661237612386123961240612416124261243612446124561246612476124861249612506125161252612536125461255612566125761258612596126061261612626126361264612656126661267612686126961270612716127261273612746127561276612776127861279612806128161282612836128461285612866128761288612896129061291612926129361294612956129661297612986129961300613016130261303613046130561306613076130861309613106131161312613136131461315613166131761318613196132061321613226132361324613256132661327613286132961330613316133261333613346133561336613376133861339613406134161342613436134461345613466134761348613496135061351613526135361354613556135661357613586135961360613616136261363613646136561366613676136861369613706137161372613736137461375613766137761378613796138061381613826138361384613856138661387613886138961390613916139261393613946139561396613976139861399614006140161402614036140461405614066140761408614096141061411614126141361414614156141661417614186141961420614216142261423614246142561426614276142861429614306143161432614336143461435614366143761438614396144061441614426144361444614456144661447614486144961450614516145261453614546145561456614576145861459614606146161462614636146461465614666146761468614696147061471614726147361474614756147661477614786147961480614816148261483614846148561486614876148861489614906149161492614936149461495614966149761498614996150061501615026150361504615056150661507615086150961510615116151261513615146151561516615176151861519615206152161522615236152461525615266152761528615296153061531615326153361534615356153661537615386153961540615416154261543615446154561546615476154861549615506155161552615536155461555615566155761558615596156061561615626156361564615656156661567615686156961570615716157261573615746157561576615776157861579615806158161582615836158461585615866158761588615896159061591615926159361594615956159661597615986159961600616016160261603616046160561606616076160861609616106161161612616136161461615616166161761618616196162061621616226162361624616256162661627616286162961630616316163261633616346163561636616376163861639616406164161642616436164461645616466164761648616496165061651616526165361654616556165661657616586165961660616616166261663616646166561666616676166861669616706167161672616736167461675616766167761678616796168061681616826168361684616856168661687616886168961690616916169261693616946169561696616976169861699617006170161702617036170461705617066170761708617096171061711617126171361714617156171661717617186171961720617216172261723617246172561726617276172861729617306173161732617336173461735617366173761738617396174061741617426174361744617456174661747617486174961750617516175261753617546175561756617576175861759617606176161762617636176461765617666176761768617696177061771617726177361774617756177661777617786177961780617816178261783617846178561786617876178861789617906179161792617936179461795617966179761798617996180061801618026180361804618056180661807618086180961810618116181261813618146181561816618176181861819618206182161822618236182461825618266182761828618296183061831618326183361834618356183661837618386183961840618416184261843618446184561846618476184861849618506185161852618536185461855618566185761858618596186061861618626186361864618656186661867618686186961870618716187261873618746187561876618776187861879618806188161882618836188461885618866188761888618896189061891618926189361894618956189661897618986189961900619016190261903619046190561906619076190861909619106191161912619136191461915619166191761918619196192061921619226192361924619256192661927619286192961930619316193261933619346193561936619376193861939619406194161942619436194461945619466194761948619496195061951619526195361954619556195661957619586195961960619616196261963619646196561966619676196861969619706197161972619736197461975619766197761978619796198061981619826198361984619856198661987619886198961990619916199261993619946199561996619976199861999620006200162002620036200462005620066200762008620096201062011620126201362014620156201662017620186201962020620216202262023620246202562026620276202862029620306203162032620336203462035620366203762038620396204062041620426204362044620456204662047620486204962050620516205262053620546205562056620576205862059620606206162062620636206462065620666206762068620696207062071620726207362074620756207662077620786207962080620816208262083620846208562086620876208862089620906209162092620936209462095620966209762098620996210062101621026210362104621056210662107621086210962110621116211262113621146211562116621176211862119621206212162122621236212462125621266212762128621296213062131621326213362134621356213662137621386213962140621416214262143621446214562146621476214862149621506215162152621536215462155621566215762158621596216062161621626216362164621656216662167621686216962170621716217262173621746217562176621776217862179621806218162182621836218462185621866218762188621896219062191621926219362194621956219662197621986219962200622016220262203622046220562206622076220862209622106221162212622136221462215622166221762218622196222062221622226222362224622256222662227622286222962230622316223262233622346223562236622376223862239622406224162242622436224462245622466224762248622496225062251622526225362254622556225662257622586225962260622616226262263622646226562266622676226862269622706227162272622736227462275622766227762278622796228062281622826228362284622856228662287622886228962290622916229262293622946229562296622976229862299623006230162302623036230462305623066230762308623096231062311623126231362314623156231662317623186231962320623216232262323623246232562326623276232862329623306233162332623336233462335623366233762338623396234062341623426234362344623456234662347623486234962350623516235262353623546235562356623576235862359623606236162362623636236462365623666236762368623696237062371623726237362374623756237662377623786237962380623816238262383623846238562386623876238862389623906239162392623936239462395623966239762398623996240062401624026240362404624056240662407624086240962410624116241262413624146241562416624176241862419624206242162422624236242462425624266242762428624296243062431624326243362434624356243662437624386243962440624416244262443624446244562446624476244862449624506245162452624536245462455624566245762458624596246062461624626246362464624656246662467624686246962470624716247262473624746247562476624776247862479624806248162482624836248462485624866248762488624896249062491624926249362494624956249662497624986249962500625016250262503625046250562506625076250862509625106251162512625136251462515625166251762518625196252062521625226252362524625256252662527625286252962530625316253262533625346253562536625376253862539625406254162542625436254462545625466254762548625496255062551625526255362554625556255662557625586255962560625616256262563625646256562566625676256862569625706257162572625736257462575625766257762578625796258062581625826258362584625856258662587625886258962590625916259262593625946259562596625976259862599626006260162602626036260462605626066260762608626096261062611626126261362614626156261662617626186261962620626216262262623626246262562626626276262862629626306263162632626336263462635626366263762638626396264062641626426264362644626456264662647626486264962650626516265262653626546265562656626576265862659626606266162662626636266462665626666266762668626696267062671626726267362674626756267662677626786267962680626816268262683626846268562686626876268862689626906269162692626936269462695626966269762698626996270062701627026270362704627056270662707627086270962710627116271262713627146271562716627176271862719627206272162722627236272462725627266272762728627296273062731627326273362734627356273662737627386273962740627416274262743627446274562746627476274862749627506275162752627536275462755627566275762758627596276062761627626276362764627656276662767627686276962770627716277262773627746277562776627776277862779627806278162782627836278462785627866278762788627896279062791627926279362794627956279662797627986279962800628016280262803628046280562806628076280862809628106281162812628136281462815628166281762818628196282062821628226282362824628256282662827628286282962830628316283262833628346283562836628376283862839628406284162842628436284462845628466284762848628496285062851628526285362854628556285662857628586285962860628616286262863628646286562866628676286862869628706287162872628736287462875628766287762878628796288062881628826288362884628856288662887628886288962890628916289262893628946289562896628976289862899629006290162902629036290462905629066290762908629096291062911629126291362914629156291662917629186291962920629216292262923629246292562926629276292862929629306293162932629336293462935629366293762938629396294062941629426294362944629456294662947629486294962950629516295262953629546295562956629576295862959629606296162962629636296462965629666296762968629696297062971629726297362974629756297662977629786297962980629816298262983629846298562986629876298862989629906299162992629936299462995629966299762998629996300063001630026300363004630056300663007630086300963010630116301263013630146301563016630176301863019630206302163022630236302463025630266302763028630296303063031630326303363034630356303663037630386303963040630416304263043630446304563046630476304863049630506305163052630536305463055630566305763058630596306063061630626306363064630656306663067630686306963070630716307263073630746307563076630776307863079630806308163082630836308463085630866308763088630896309063091630926309363094630956309663097630986309963100631016310263103631046310563106631076310863109631106311163112631136311463115631166311763118631196312063121631226312363124631256312663127631286312963130631316313263133631346313563136631376313863139631406314163142631436314463145631466314763148631496315063151631526315363154631556315663157631586315963160631616316263163631646316563166631676316863169631706317163172631736317463175631766317763178631796318063181631826318363184631856318663187631886318963190631916319263193631946319563196631976319863199632006320163202632036320463205632066320763208632096321063211632126321363214632156321663217632186321963220632216322263223632246322563226632276322863229632306323163232632336323463235632366323763238632396324063241632426324363244632456324663247632486324963250632516325263253632546325563256632576325863259632606326163262632636326463265632666326763268632696327063271632726327363274632756327663277632786327963280632816328263283632846328563286632876328863289632906329163292632936329463295632966329763298632996330063301633026330363304633056330663307633086330963310633116331263313633146331563316633176331863319633206332163322633236332463325633266332763328633296333063331633326333363334633356333663337633386333963340633416334263343633446334563346633476334863349633506335163352633536335463355633566335763358633596336063361633626336363364633656336663367633686336963370633716337263373633746337563376633776337863379633806338163382633836338463385633866338763388633896339063391633926339363394633956339663397633986339963400634016340263403634046340563406634076340863409634106341163412634136341463415634166341763418634196342063421634226342363424634256342663427634286342963430634316343263433634346343563436634376343863439634406344163442634436344463445634466344763448634496345063451634526345363454634556345663457634586345963460634616346263463634646346563466634676346863469634706347163472634736347463475634766347763478634796348063481634826348363484634856348663487634886348963490634916349263493634946349563496634976349863499635006350163502635036350463505635066350763508635096351063511635126351363514635156351663517635186351963520635216352263523635246352563526635276352863529635306353163532635336353463535635366353763538635396354063541635426354363544635456354663547635486354963550635516355263553635546355563556635576355863559635606356163562635636356463565635666356763568635696357063571635726357363574635756357663577635786357963580635816358263583635846358563586635876358863589635906359163592635936359463595635966359763598635996360063601636026360363604636056360663607636086360963610636116361263613636146361563616636176361863619636206362163622636236362463625636266362763628636296363063631636326363363634636356363663637636386363963640636416364263643636446364563646636476364863649636506365163652636536365463655636566365763658636596366063661636626366363664636656366663667636686366963670636716367263673636746367563676636776367863679636806368163682636836368463685636866368763688636896369063691636926369363694636956369663697636986369963700637016370263703637046370563706637076370863709637106371163712637136371463715637166371763718637196372063721637226372363724637256372663727637286372963730637316373263733637346373563736637376373863739637406374163742637436374463745637466374763748637496375063751637526375363754637556375663757637586375963760637616376263763637646376563766637676376863769637706377163772637736377463775637766377763778637796378063781637826378363784637856378663787637886378963790637916379263793637946379563796637976379863799638006380163802638036380463805638066380763808638096381063811638126381363814638156381663817638186381963820638216382263823638246382563826638276382863829638306383163832638336383463835638366383763838638396384063841638426384363844638456384663847638486384963850638516385263853638546385563856638576385863859638606386163862638636386463865638666386763868638696387063871638726387363874638756387663877638786387963880638816388263883638846388563886638876388863889638906389163892638936389463895638966389763898638996390063901639026390363904639056390663907639086390963910639116391263913639146391563916639176391863919639206392163922639236392463925639266392763928639296393063931639326393363934639356393663937639386393963940639416394263943639446394563946639476394863949639506395163952639536395463955639566395763958639596396063961639626396363964639656396663967639686396963970639716397263973639746397563976639776397863979639806398163982639836398463985639866398763988639896399063991639926399363994639956399663997639986399964000640016400264003640046400564006640076400864009640106401164012640136401464015640166401764018640196402064021640226402364024640256402664027640286402964030640316403264033640346403564036640376403864039640406404164042640436404464045640466404764048640496405064051640526405364054640556405664057640586405964060640616406264063640646406564066640676406864069640706407164072640736407464075640766407764078640796408064081640826408364084640856408664087640886408964090640916409264093640946409564096640976409864099641006410164102641036410464105641066410764108641096411064111641126411364114641156411664117641186411964120641216412264123641246412564126641276412864129641306413164132641336413464135641366413764138641396414064141641426414364144641456414664147641486414964150641516415264153641546415564156641576415864159641606416164162641636416464165641666416764168641696417064171641726417364174641756417664177641786417964180641816418264183641846418564186641876418864189641906419164192641936419464195641966419764198641996420064201642026420364204642056420664207642086420964210642116421264213642146421564216642176421864219642206422164222642236422464225642266422764228642296423064231642326423364234642356423664237642386423964240642416424264243642446424564246642476424864249642506425164252642536425464255642566425764258642596426064261642626426364264642656426664267642686426964270642716427264273642746427564276642776427864279642806428164282642836428464285642866428764288642896429064291642926429364294642956429664297642986429964300643016430264303643046430564306643076430864309643106431164312643136431464315643166431764318643196432064321643226432364324643256432664327643286432964330643316433264333643346433564336643376433864339643406434164342643436434464345643466434764348643496435064351643526435364354643556435664357643586435964360643616436264363643646436564366643676436864369643706437164372643736437464375643766437764378643796438064381643826438364384643856438664387643886438964390643916439264393643946439564396643976439864399644006440164402644036440464405644066440764408644096441064411644126441364414644156441664417644186441964420644216442264423644246442564426644276442864429644306443164432644336443464435644366443764438644396444064441644426444364444644456444664447644486444964450644516445264453644546445564456644576445864459644606446164462644636446464465644666446764468644696447064471644726447364474644756447664477644786447964480644816448264483644846448564486644876448864489644906449164492644936449464495644966449764498644996450064501645026450364504645056450664507645086450964510645116451264513645146451564516645176451864519645206452164522645236452464525645266452764528645296453064531645326453364534645356453664537645386453964540645416454264543645446454564546645476454864549645506455164552645536455464555645566455764558645596456064561645626456364564645656456664567645686456964570645716457264573645746457564576645776457864579645806458164582645836458464585645866458764588645896459064591645926459364594645956459664597645986459964600646016460264603646046460564606646076460864609646106461164612646136461464615646166461764618646196462064621646226462364624646256462664627646286462964630646316463264633646346463564636646376463864639646406464164642646436464464645646466464764648646496465064651646526465364654646556465664657646586465964660646616466264663646646466564666646676466864669646706467164672646736467464675646766467764678646796468064681646826468364684646856468664687646886468964690646916469264693646946469564696646976469864699647006470164702647036470464705647066470764708647096471064711647126471364714647156471664717647186471964720647216472264723647246472564726647276472864729647306473164732647336473464735647366473764738647396474064741647426474364744647456474664747647486474964750647516475264753647546475564756647576475864759647606476164762647636476464765647666476764768647696477064771647726477364774647756477664777647786477964780647816478264783647846478564786647876478864789647906479164792647936479464795647966479764798647996480064801648026480364804648056480664807648086480964810648116481264813648146481564816648176481864819648206482164822648236482464825648266482764828648296483064831648326483364834648356483664837648386483964840648416484264843648446484564846648476484864849648506485164852648536485464855648566485764858648596486064861648626486364864648656486664867648686486964870648716487264873648746487564876648776487864879648806488164882648836488464885648866488764888648896489064891648926489364894648956489664897648986489964900649016490264903649046490564906649076490864909649106491164912649136491464915649166491764918649196492064921649226492364924649256492664927649286492964930649316493264933649346493564936649376493864939649406494164942649436494464945649466494764948649496495064951649526495364954649556495664957649586495964960649616496264963649646496564966649676496864969649706497164972649736497464975649766497764978649796498064981649826498364984649856498664987649886498964990649916499264993649946499564996649976499864999650006500165002650036500465005650066500765008650096501065011650126501365014650156501665017650186501965020650216502265023650246502565026650276502865029650306503165032650336503465035650366503765038650396504065041650426504365044650456504665047650486504965050650516505265053650546505565056650576505865059650606506165062650636506465065650666506765068650696507065071650726507365074650756507665077650786507965080650816508265083650846508565086650876508865089650906509165092650936509465095650966509765098650996510065101651026510365104651056510665107651086510965110651116511265113651146511565116651176511865119651206512165122651236512465125651266512765128651296513065131651326513365134651356513665137651386513965140651416514265143651446514565146651476514865149651506515165152651536515465155651566515765158651596516065161651626516365164651656516665167651686516965170651716517265173651746517565176651776517865179651806518165182651836518465185651866518765188651896519065191651926519365194651956519665197651986519965200652016520265203652046520565206652076520865209652106521165212652136521465215652166521765218652196522065221652226522365224652256522665227652286522965230652316523265233652346523565236652376523865239652406524165242652436524465245652466524765248652496525065251652526525365254652556525665257652586525965260652616526265263652646526565266652676526865269652706527165272652736527465275652766527765278652796528065281652826528365284652856528665287652886528965290652916529265293652946529565296652976529865299653006530165302653036530465305653066530765308653096531065311653126531365314653156531665317653186531965320653216532265323653246532565326653276532865329653306533165332653336533465335653366533765338653396534065341653426534365344653456534665347653486534965350653516535265353653546535565356653576535865359653606536165362653636536465365653666536765368653696537065371653726537365374653756537665377653786537965380653816538265383653846538565386653876538865389653906539165392653936539465395653966539765398653996540065401654026540365404654056540665407654086540965410654116541265413654146541565416654176541865419654206542165422654236542465425654266542765428654296543065431654326543365434654356543665437654386543965440654416544265443654446544565446654476544865449654506545165452654536545465455654566545765458654596546065461654626546365464654656546665467654686546965470654716547265473654746547565476654776547865479654806548165482654836548465485654866548765488654896549065491654926549365494654956549665497654986549965500655016550265503655046550565506655076550865509655106551165512655136551465515655166551765518655196552065521655226552365524655256552665527655286552965530655316553265533655346553565536655376553865539655406554165542655436554465545655466554765548655496555065551655526555365554655556555665557655586555965560655616556265563655646556565566655676556865569655706557165572655736557465575655766557765578655796558065581655826558365584655856558665587655886558965590655916559265593655946559565596655976559865599656006560165602656036560465605656066560765608656096561065611656126561365614656156561665617656186561965620656216562265623656246562565626656276562865629656306563165632656336563465635656366563765638656396564065641656426564365644656456564665647656486564965650656516565265653656546565565656656576565865659656606566165662656636566465665656666566765668656696567065671656726567365674656756567665677656786567965680656816568265683656846568565686656876568865689656906569165692656936569465695656966569765698656996570065701657026570365704657056570665707657086570965710657116571265713657146571565716657176571865719657206572165722657236572465725657266572765728657296573065731657326573365734657356573665737657386573965740657416574265743657446574565746657476574865749657506575165752657536575465755657566575765758657596576065761657626576365764657656576665767657686576965770657716577265773657746577565776657776577865779657806578165782657836578465785657866578765788657896579065791657926579365794657956579665797657986579965800658016580265803658046580565806658076580865809658106581165812658136581465815658166581765818658196582065821658226582365824658256582665827658286582965830658316583265833658346583565836658376583865839658406584165842658436584465845658466584765848658496585065851658526585365854658556585665857658586585965860658616586265863658646586565866658676586865869658706587165872658736587465875658766587765878658796588065881658826588365884658856588665887658886588965890658916589265893658946589565896658976589865899659006590165902659036590465905659066590765908659096591065911659126591365914659156591665917659186591965920659216592265923659246592565926659276592865929659306593165932659336593465935659366593765938659396594065941659426594365944659456594665947659486594965950659516595265953659546595565956659576595865959659606596165962659636596465965659666596765968659696597065971659726597365974659756597665977659786597965980659816598265983659846598565986659876598865989659906599165992659936599465995659966599765998659996600066001660026600366004660056600666007660086600966010660116601266013660146601566016660176601866019660206602166022660236602466025660266602766028660296603066031660326603366034660356603666037660386603966040660416604266043660446604566046660476604866049660506605166052660536605466055660566605766058660596606066061660626606366064660656606666067660686606966070660716607266073660746607566076660776607866079660806608166082660836608466085660866608766088660896609066091660926609366094660956609666097660986609966100661016610266103661046610566106661076610866109661106611166112661136611466115661166611766118661196612066121661226612366124661256612666127661286612966130661316613266133661346613566136661376613866139661406614166142661436614466145661466614766148661496615066151661526615366154661556615666157661586615966160661616616266163661646616566166661676616866169661706617166172661736617466175661766617766178661796618066181661826618366184661856618666187661886618966190661916619266193661946619566196661976619866199662006620166202662036620466205662066620766208662096621066211662126621366214662156621666217662186621966220662216622266223662246622566226662276622866229662306623166232662336623466235662366623766238662396624066241662426624366244662456624666247662486624966250662516625266253662546625566256662576625866259662606626166262662636626466265662666626766268662696627066271662726627366274662756627666277662786627966280662816628266283662846628566286662876628866289662906629166292662936629466295662966629766298662996630066301663026630366304663056630666307663086630966310663116631266313663146631566316663176631866319663206632166322663236632466325663266632766328663296633066331663326633366334663356633666337663386633966340663416634266343663446634566346663476634866349663506635166352663536635466355663566635766358663596636066361663626636366364663656636666367663686636966370663716637266373663746637566376663776637866379663806638166382663836638466385663866638766388663896639066391663926639366394663956639666397663986639966400664016640266403664046640566406664076640866409664106641166412664136641466415664166641766418664196642066421664226642366424664256642666427664286642966430664316643266433664346643566436664376643866439664406644166442664436644466445664466644766448664496645066451664526645366454664556645666457664586645966460664616646266463664646646566466664676646866469664706647166472664736647466475664766647766478664796648066481664826648366484664856648666487664886648966490664916649266493664946649566496664976649866499665006650166502665036650466505665066650766508665096651066511665126651366514665156651666517665186651966520665216652266523665246652566526665276652866529665306653166532665336653466535665366653766538665396654066541665426654366544665456654666547665486654966550665516655266553665546655566556665576655866559665606656166562665636656466565665666656766568665696657066571665726657366574665756657666577665786657966580665816658266583665846658566586665876658866589665906659166592665936659466595665966659766598665996660066601666026660366604666056660666607666086660966610666116661266613666146661566616666176661866619666206662166622666236662466625666266662766628666296663066631666326663366634666356663666637666386663966640666416664266643666446664566646666476664866649666506665166652666536665466655666566665766658666596666066661666626666366664666656666666667666686666966670666716667266673666746667566676666776667866679666806668166682666836668466685666866668766688666896669066691666926669366694666956669666697666986669966700667016670266703667046670566706667076670866709667106671166712667136671466715667166671766718667196672066721667226672366724667256672666727667286672966730667316673266733667346673566736667376673866739667406674166742667436674466745667466674766748667496675066751667526675366754667556675666757667586675966760667616676266763667646676566766667676676866769667706677166772667736677466775667766677766778667796678066781667826678366784667856678666787667886678966790667916679266793667946679566796667976679866799668006680166802668036680466805668066680766808668096681066811668126681366814668156681666817668186681966820668216682266823668246682566826668276682866829668306683166832668336683466835668366683766838668396684066841668426684366844668456684666847668486684966850668516685266853668546685566856668576685866859668606686166862668636686466865668666686766868668696687066871668726687366874668756687666877668786687966880668816688266883668846688566886668876688866889668906689166892668936689466895668966689766898668996690066901669026690366904669056690666907669086690966910669116691266913669146691566916669176691866919669206692166922669236692466925669266692766928669296693066931669326693366934669356693666937669386693966940669416694266943669446694566946669476694866949669506695166952669536695466955669566695766958669596696066961669626696366964669656696666967669686696966970669716697266973669746697566976669776697866979669806698166982669836698466985669866698766988669896699066991669926699366994669956699666997669986699967000670016700267003670046700567006 |
- # SOME DESCRIPTIVE TITLE
- # Copyright (C) YEAR the authors of Guix (msgids) and the following authors (msgstr)
- # This file is distributed under the same license as the guix manual package.
- # Soheil Khanalipur <soheil@disroot.org>, 2021.
- # Danial Behzadi <dani.behzi@ubuntu.com>, 2021.
- msgid ""
- msgstr ""
- "Project-Id-Version: guix manual checkout\n"
- "Report-Msgid-Bugs-To: bug-guix@gnu.org\n"
- "POT-Creation-Date: 2021-12-21 15:18+0000\n"
- "PO-Revision-Date: 2021-07-15 22:27+0000\n"
- "Last-Translator: Danial Behzadi <dani.behzi@ubuntu.com>\n"
- "Language-Team: Persian <https://translate.fedoraproject.org/projects/guix/documentation-manual/fa/>\n"
- "Language: fa\n"
- "MIME-Version: 1.0\n"
- "Content-Type: text/plain; charset=UTF-8\n"
- "Content-Transfer-Encoding: 8bit\n"
- "Plural-Forms: nplurals=2; plural=n > 1;\n"
- "X-Generator: Weblate 4.7.1\n"
- #. #-#-#-#-# contributing.pot (guix manual checkout) #-#-#-#-#
- #. type: chapter
- #. #-#-#-#-# guix.pot (guix manual checkout) #-#-#-#-#
- #. type: menuentry
- #: guix-git/doc/contributing.texi:1 guix-git/doc/contributing.texi:2
- #: guix-git/doc/guix.texi:182
- #, no-wrap
- msgid "Contributing"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:9
- msgid "This project is a cooperative effort, and we need your help to make it grow! Please get in touch with us on @email{guix-devel@@gnu.org} and @code{#guix} on the Libera Chat IRC network. We welcome ideas, bug reports, patches, and anything that may be helpful to the project. We particularly welcome help on packaging (@pxref{Packaging Guidelines})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:10
- #, no-wrap
- msgid "code of conduct, of contributors"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:11
- #, no-wrap
- msgid "contributor covenant"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:17
- msgid "We want to provide a warm, friendly, and harassment-free environment, so that anyone can contribute to the best of their abilities. To this end our project uses a ``Contributor Covenant'', which was adapted from @url{https://contributor-covenant.org/}. You can find a local version in the @file{CODE-OF-CONDUCT} file in the source tree."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:21
- msgid "Contributors are not required to use their legal name in patches and on-line communication; they can use any name or pseudonym of their choice."
- msgstr ""
- #. type: section
- #: guix-git/doc/contributing.texi:33 guix-git/doc/contributing.texi:35
- #: guix-git/doc/contributing.texi:36
- #, no-wrap
- msgid "Building from Git"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/contributing.texi:33
- msgid "The latest and greatest."
- msgstr ""
- #. type: section
- #: guix-git/doc/contributing.texi:33 guix-git/doc/contributing.texi:161
- #: guix-git/doc/contributing.texi:162
- #, no-wrap
- msgid "Running Guix Before It Is Installed"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/contributing.texi:33
- msgid "Hacker tricks."
- msgstr ""
- #. type: section
- #: guix-git/doc/contributing.texi:33 guix-git/doc/contributing.texi:235
- #: guix-git/doc/contributing.texi:236
- #, no-wrap
- msgid "The Perfect Setup"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/contributing.texi:33
- msgid "The right tools."
- msgstr ""
- #. type: section
- #: guix-git/doc/contributing.texi:33 guix-git/doc/contributing.texi:326
- #: guix-git/doc/contributing.texi:327
- #, no-wrap
- msgid "Packaging Guidelines"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/contributing.texi:33
- msgid "Growing the distribution."
- msgstr ""
- #. type: section
- #: guix-git/doc/contributing.texi:33 guix-git/doc/contributing.texi:890
- #: guix-git/doc/contributing.texi:891
- #, no-wrap
- msgid "Coding Style"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/contributing.texi:33
- msgid "Hygiene of the contributor."
- msgstr ""
- #. type: section
- #: guix-git/doc/contributing.texi:33 guix-git/doc/contributing.texi:989
- #: guix-git/doc/contributing.texi:990
- #, no-wrap
- msgid "Submitting Patches"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/contributing.texi:33
- msgid "Share your work."
- msgstr ""
- #. type: section
- #: guix-git/doc/contributing.texi:33 guix-git/doc/contributing.texi:1270
- #: guix-git/doc/contributing.texi:1271
- #, no-wrap
- msgid "Tracking Bugs and Patches"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/contributing.texi:33
- msgid "Keeping it all organized."
- msgstr ""
- #. type: section
- #: guix-git/doc/contributing.texi:33 guix-git/doc/contributing.texi:1385
- #: guix-git/doc/contributing.texi:1386
- #, no-wrap
- msgid "Commit Access"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/contributing.texi:33
- msgid "Pushing to the official repository."
- msgstr ""
- #. type: section
- #: guix-git/doc/contributing.texi:33 guix-git/doc/contributing.texi:1611
- #: guix-git/doc/contributing.texi:1612
- #, no-wrap
- msgid "Updating the Guix Package"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/contributing.texi:33
- msgid "Updating the Guix package definition."
- msgstr ""
- #. type: section
- #: guix-git/doc/contributing.texi:33 guix-git/doc/contributing.texi:1652
- #: guix-git/doc/contributing.texi:1653
- #, no-wrap
- msgid "Translating Guix"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/contributing.texi:33
- msgid "Make Guix speak your native language."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:40
- msgid "If you want to hack Guix itself, it is recommended to use the latest version from the Git repository:"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:43
- #, no-wrap
- msgid "git clone https://git.savannah.gnu.org/git/guix.git\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:45
- #, no-wrap
- msgid "authentication, of a Guix checkout"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:50
- msgid "How do you ensure that you obtained a genuine copy of the repository? To do that, run @command{guix git authenticate}, passing it the commit and OpenPGP fingerprint of the @dfn{channel introduction} (@pxref{Invoking guix git authenticate}):"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:57
- #, no-wrap
- msgid ""
- "git fetch origin keyring:keyring\n"
- "guix git authenticate 9edb3f66fd807b096b48283debdcddccfea34bad \\\n"
- " \"BBB0 2DDF 2CEA F6A8 0D1D E643 A2A0 6DF2 A33A 54FA\"\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:62
- msgid "This command completes with exit code zero on success; it prints an error message and exits with a non-zero code otherwise."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:69
- msgid "As you can see, there is a chicken-and-egg problem: you first need to have Guix installed. Typically you would install Guix System (@pxref{System Installation}) or Guix on top of another distro (@pxref{Binary Installation}); in either case, you would verify the OpenPGP signature on the installation medium. This ``bootstraps'' the trust chain."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:74
- msgid "The easiest way to set up a development environment for Guix is, of course, by using Guix! The following command starts a new shell where all the dependencies and appropriate environment variables are set up to hack on Guix:"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:77
- #, no-wrap
- msgid "guix shell -D guix --pure\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:80
- msgid "@xref{Invoking guix shell}, for more information on that command."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:84
- msgid "If you are unable to use Guix when building Guix from a checkout, the following are the required packages in addition to those mentioned in the installation instructions (@pxref{Requirements})."
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:86
- #, no-wrap
- msgid "@url{https://gnu.org/software/autoconf/, GNU Autoconf};"
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:87
- #, no-wrap
- msgid "@url{https://gnu.org/software/automake/, GNU Automake};"
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:88
- #, no-wrap
- msgid "@url{https://gnu.org/software/gettext/, GNU Gettext};"
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:89
- #, no-wrap
- msgid "@url{https://gnu.org/software/texinfo/, GNU Texinfo};"
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:90
- #, no-wrap
- msgid "@url{https://www.graphviz.org/, Graphviz};"
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:91
- #, no-wrap
- msgid "@url{https://www.gnu.org/software/help2man/, GNU Help2man (optional)}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:96
- msgid "On Guix, extra dependencies can be added by instead running @command{guix shell}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:99
- #, no-wrap
- msgid "guix shell -D guix help2man git strace --pure\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:103
- msgid "Run @command{./bootstrap} to generate the build system infrastructure using Autoconf and Automake. If you get an error like this one:"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:106
- #, no-wrap
- msgid "configure.ac:46: error: possibly undefined macro: PKG_CHECK_MODULES\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:115
- msgid "it probably means that Autoconf couldn’t find @file{pkg.m4}, which is provided by pkg-config. Make sure that @file{pkg.m4} is available. The same holds for the @file{guile.m4} set of macros provided by Guile. For instance, if you installed Automake in @file{/usr/local}, it wouldn’t look for @file{.m4} files in @file{/usr/share}. In that case, you have to invoke the following command:"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:118
- #, no-wrap
- msgid "export ACLOCAL_PATH=/usr/share/aclocal\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:122
- msgid "@xref{Macro Search Path,,, automake, The GNU Automake Manual}, for more information."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:129
- msgid "Then, run @command{./configure --localstatedir=@var{directory}}, where @var{directory} is the @code{localstatedir} value used by your current installation (@pxref{The Store}, for information about this), usually @file{/var}. Note that you will probably not run @command{make install} at the end (you don't have to) but it's still important to pass the right @code{localstatedir}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:134
- msgid "Finally, you have to invoke @code{make && make check} to build Guix and run the tests (@pxref{Running the Test Suite}). If anything fails, take a look at installation instructions (@pxref{Installation}) or send a message to the @email{guix-devel@@gnu.org, mailing list}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:137
- msgid "From there on, you can authenticate all the commits included in your checkout by running:"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:140
- #, no-wrap
- msgid "make authenticate\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:143
- msgid "The first run takes a couple of minutes, but subsequent runs are faster."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:149
- msgid "Or, when your configuration for your local Git repository doesn't match the default one, you can provide the reference for the @code{keyring} branch through the variable @code{GUIX_GIT_KEYRING}. The following example assumes that you have a Git remote called @samp{myremote} pointing to the official repository:"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:152
- #, no-wrap
- msgid "make authenticate GUIX_GIT_KEYRING=myremote/keyring\n"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/contributing.texi:154 guix-git/doc/contributing.texi:1463
- #: guix-git/doc/guix.texi:594 guix-git/doc/guix.texi:643
- #: guix-git/doc/guix.texi:833 guix-git/doc/guix.texi:1813
- #: guix-git/doc/guix.texi:2060 guix-git/doc/guix.texi:2244
- #: guix-git/doc/guix.texi:2465 guix-git/doc/guix.texi:2677
- #: guix-git/doc/guix.texi:3807 guix-git/doc/guix.texi:4548
- #: guix-git/doc/guix.texi:4562 guix-git/doc/guix.texi:4644
- #: guix-git/doc/guix.texi:4874 guix-git/doc/guix.texi:5615
- #: guix-git/doc/guix.texi:6082 guix-git/doc/guix.texi:6333
- #: guix-git/doc/guix.texi:6454 guix-git/doc/guix.texi:6482
- #: guix-git/doc/guix.texi:6535 guix-git/doc/guix.texi:9391
- #: guix-git/doc/guix.texi:9461 guix-git/doc/guix.texi:11198
- #: guix-git/doc/guix.texi:11238 guix-git/doc/guix.texi:11512
- #: guix-git/doc/guix.texi:11524 guix-git/doc/guix.texi:14000
- #: guix-git/doc/guix.texi:14631 guix-git/doc/guix.texi:15521
- #: guix-git/doc/guix.texi:16507 guix-git/doc/guix.texi:19140
- #: guix-git/doc/guix.texi:19310 guix-git/doc/guix.texi:27188
- #: guix-git/doc/guix.texi:30914 guix-git/doc/guix.texi:34669
- #: guix-git/doc/guix.texi:34903 guix-git/doc/guix.texi:35073
- #: guix-git/doc/guix.texi:35232 guix-git/doc/guix.texi:35334
- #: guix-git/doc/guix.texi:35435 guix-git/doc/guix.texi:35738
- #: guix-git/doc/guix.texi:36896 guix-git/doc/guix.texi:36971
- #: guix-git/doc/guix.texi:37006 guix-git/doc/guix.texi:37056
- #: guix-git/doc/guix.texi:37143 guix-git/doc/guix.texi:37564
- #, no-wrap
- msgid "Note"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/contributing.texi:158
- msgid "You are advised to run @command{make authenticate} after every @command{git pull} invocation. This ensures you keep receiving valid changes to the repository."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:168
- msgid "In order to keep a sane working environment, you will find it useful to test the changes made in your local source tree checkout without actually installing them. So that you can distinguish between your ``end-user'' hat and your ``motley'' costume."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:179
- msgid "To that end, all the command-line tools can be used even if you have not run @code{make install}. To do that, you first need to have an environment with all the dependencies available (@pxref{Building from Git}), and then simply prefix each command with @command{./pre-inst-env} (the @file{pre-inst-env} script lives in the top build tree of Guix; it is generated by running @command{./bootstrap} followed by @command{./configure}). As an example, here is how you would build the @code{hello} package as defined in your working tree (this assumes @command{guix-daemon} is already running on your system; it's OK if it's a different version):"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:182
- #, no-wrap
- msgid "$ ./pre-inst-env guix build hello\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:186
- msgid "Similarly, an example for a Guile session using the Guix modules:"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:189
- #, no-wrap
- msgid ""
- "$ ./pre-inst-env guile -c '(use-modules (guix utils)) (pk (%current-system))'\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:191
- #, no-wrap
- msgid ";;; (\"x86_64-linux\")\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:194
- #, no-wrap
- msgid "REPL"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:195
- #, no-wrap
- msgid "read-eval-print loop"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:198
- msgid "@dots{} and for a REPL (@pxref{Using Guile Interactively,,, guile, Guile Reference Manual}):"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:213
- #, no-wrap
- msgid ""
- "$ ./pre-inst-env guile\n"
- "scheme@@(guile-user)> ,use(guix)\n"
- "scheme@@(guile-user)> ,use(gnu)\n"
- "scheme@@(guile-user)> (define snakes\n"
- " (fold-packages\n"
- " (lambda (package lst)\n"
- " (if (string-prefix? \"python\"\n"
- " (package-name package))\n"
- " (cons package lst)\n"
- " lst))\n"
- " '()))\n"
- "scheme@@(guile-user)> (length snakes)\n"
- "$1 = 361\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:221
- msgid "If you are hacking on the daemon and its supporting code or if @command{guix-daemon} is not already running on your system, you can launch it straight from the build tree@footnote{The @option{-E} flag to @command{sudo} guarantees that @code{GUILE_LOAD_PATH} is correctly set such that @command{guix-daemon} and the tools it uses can find the Guile modules they need.}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:224
- #, no-wrap
- msgid "$ sudo -E ./pre-inst-env guix-daemon --build-users-group=guixbuild\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:228
- msgid "The @command{pre-inst-env} script sets up all the environment variables necessary to support this, including @env{PATH} and @env{GUILE_LOAD_PATH}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:233
- msgid "Note that @command{./pre-inst-env guix pull} does @emph{not} upgrade the local source tree; it simply updates the @file{~/.config/guix/current} symlink (@pxref{Invoking guix pull}). Run @command{git pull} instead if you want to upgrade your local source tree."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:243
- msgid "The Perfect Setup to hack on Guix is basically the perfect setup used for Guile hacking (@pxref{Using Guile in Emacs,,, guile, Guile Reference Manual}). First, you need more than an editor, you need @url{https://www.gnu.org/software/emacs, Emacs}, empowered by the wonderful @url{https://nongnu.org/geiser/, Geiser}. To set that up, run:"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:246
- #, no-wrap
- msgid "guix package -i emacs guile emacs-geiser emacs-geiser-guile\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:255
- msgid "Geiser allows for interactive and incremental development from within Emacs: code compilation and evaluation from within buffers, access to on-line documentation (docstrings), context-sensitive completion, @kbd{M-.} to jump to an object definition, a REPL to try out your code, and more (@pxref{Introduction,,, geiser, Geiser User Manual}). For convenient Guix development, make sure to augment Guile’s load path so that it finds source files from your checkout:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/contributing.texi:260
- #, no-wrap
- msgid ""
- ";; @r{Assuming the Guix checkout is in ~/src/guix.}\n"
- "(with-eval-after-load 'geiser-guile\n"
- " (add-to-list 'geiser-guile-load-path \"~/src/guix\"))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:268
- msgid "To actually edit the code, Emacs already has a neat Scheme mode. But in addition to that, you must not miss @url{https://www.emacswiki.org/emacs/ParEdit, Paredit}. It provides facilities to directly operate on the syntax tree, such as raising an s-expression or wrapping it, swallowing or rejecting the following s-expression, etc."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:269
- #, no-wrap
- msgid "code snippets"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:270
- #, no-wrap
- msgid "templates"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:271
- #, no-wrap
- msgid "reducing boilerplate"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:278
- msgid "We also provide templates for common git commit messages and package definitions in the @file{etc/snippets} directory. These templates can be used with @url{https://joaotavora.github.io/yasnippet/, YASnippet} to expand short trigger strings to interactive text snippets. You may want to add the snippets directory to the @var{yas-snippet-dirs} variable in Emacs."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/contributing.texi:283
- #, no-wrap
- msgid ""
- ";; @r{Assuming the Guix checkout is in ~/src/guix.}\n"
- "(with-eval-after-load 'yasnippet\n"
- " (add-to-list 'yas-snippet-dirs \"~/src/guix/etc/snippets\"))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:291
- msgid "The commit message snippets depend on @url{https://magit.vc/, Magit} to display staged files. When editing a commit message type @code{add} followed by @kbd{TAB} to insert a commit message template for adding a package; type @code{update} followed by @kbd{TAB} to insert a template for updating a package; type @code{https} followed by @kbd{TAB} to insert a template for changing the home page URI of a package to HTTPS."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:297
- msgid "The main snippet for @code{scheme-mode} is triggered by typing @code{package...} followed by @kbd{TAB}. This snippet also inserts the trigger string @code{origin...}, which can be expanded further. The @code{origin} snippet in turn may insert other trigger strings ending on @code{...}, which also can be expanded further."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:298
- #, no-wrap
- msgid "insert or update copyright"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/contributing.texi:299
- #, no-wrap
- msgid "M-x guix-copyright"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/contributing.texi:300
- #, no-wrap
- msgid "M-x copyright-update"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:304
- msgid "We additionally provide insertion and automatic update of a copyright in @file{etc/copyright.el}. You may want to set your full name, mail, and load a file."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/contributing.texi:310
- #, no-wrap
- msgid ""
- "(setq user-full-name \"Alice Doe\")\n"
- "(setq user-mail-address \"alice@@mail.org\")\n"
- ";; @r{Assuming the Guix checkout is in ~/src/guix.}\n"
- "(load-file \"~/src/guix/etc/copyright.el\")\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:313
- msgid "To insert a copyright at the current line invoke @code{M-x guix-copyright}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:315
- msgid "To update a copyright you need to specify a @code{copyright-names-regexp}."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/contributing.texi:319
- #, no-wrap
- msgid ""
- "(setq copyright-names-regexp\n"
- " (format \"%s <%s>\" user-full-name user-mail-address))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:325
- msgid "You can check if your copyright is up to date by evaluating @code{M-x copyright-update}. If you want to do it automatically after each buffer save then add @code{(add-hook 'after-save-hook 'copyright-update)} in Emacs."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:329
- #, no-wrap
- msgid "packages, creating"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:333
- msgid "The GNU distribution is nascent and may well lack some of your favorite packages. This section describes how you can help make the distribution grow."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:341
- msgid "Free software packages are usually distributed in the form of @dfn{source code tarballs}---typically @file{tar.gz} files that contain all the source files. Adding a package to the distribution means essentially two things: adding a @dfn{recipe} that describes how to build the package, including a list of other packages required to build it, and adding @dfn{package metadata} along with that recipe, such as a description and licensing information."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:350
- msgid "In Guix all this information is embodied in @dfn{package definitions}. Package definitions provide a high-level view of the package. They are written using the syntax of the Scheme programming language; in fact, for each package we define a variable bound to the package definition, and export that variable from a module (@pxref{Package Modules}). However, in-depth Scheme knowledge is @emph{not} a prerequisite for creating packages. For more information on package definitions, @pxref{Defining Packages}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:356
- msgid "Once a package definition is in place, stored in a file in the Guix source tree, it can be tested using the @command{guix build} command (@pxref{Invoking guix build}). For example, assuming the new package is called @code{gnew}, you may run this command from the Guix build tree (@pxref{Running Guix Before It Is Installed}):"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:359
- #, no-wrap
- msgid "./pre-inst-env guix build gnew --keep-failed\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:365
- msgid "Using @code{--keep-failed} makes it easier to debug build failures since it provides access to the failed build tree. Another useful command-line option when debugging is @code{--log-file}, to access the build log."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:370
- msgid "If the package is unknown to the @command{guix} command, it may be that the source file contains a syntax error, or lacks a @code{define-public} clause to export the package variable. To figure it out, you may load the module from Guile to get more information about the actual error:"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:373
- #, no-wrap
- msgid "./pre-inst-env guile -c '(use-modules (gnu packages gnew))'\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:380
- msgid "Once your package builds correctly, please send us a patch (@pxref{Submitting Patches}). Well, if you need help, we will be happy to help you too. Once the patch is committed in the Guix repository, the new package automatically gets built on the supported platforms by @url{https://@value{SUBSTITUTE-SERVER-1}, our continuous integration system}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:381
- #, no-wrap
- msgid "substituter"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:388
- msgid "Users can obtain the new package definition simply by running @command{guix pull} (@pxref{Invoking guix pull}). When @code{@value{SUBSTITUTE-SERVER-1}} is done building the package, installing the package automatically downloads binaries from there (@pxref{Substitutes}). The only place where human intervention is needed is to review and apply the patch."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/contributing.texi:402 guix-git/doc/contributing.texi:404
- #: guix-git/doc/contributing.texi:405
- #, no-wrap
- msgid "Software Freedom"
- msgstr "آزادی نرمافزار"
- #. type: menuentry
- #: guix-git/doc/contributing.texi:402
- msgid "What may go into the distribution."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/contributing.texi:402 guix-git/doc/contributing.texi:432
- #: guix-git/doc/contributing.texi:433
- #, no-wrap
- msgid "Package Naming"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/contributing.texi:402
- msgid "What's in a name?"
- msgstr ""
- #. type: subsection
- #: guix-git/doc/contributing.texi:402 guix-git/doc/contributing.texi:465
- #: guix-git/doc/contributing.texi:466
- #, no-wrap
- msgid "Version Numbers"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/contributing.texi:402
- msgid "When the name is not enough."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/contributing.texi:402 guix-git/doc/contributing.texi:572
- #: guix-git/doc/contributing.texi:573
- #, no-wrap
- msgid "Synopses and Descriptions"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/contributing.texi:402
- msgid "Helping users find the right package."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/contributing.texi:402 guix-git/doc/contributing.texi:651
- #: guix-git/doc/contributing.texi:652
- #, no-wrap
- msgid "Snippets versus Phases"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/contributing.texi:402
- msgid "Whether to use a snippet, or a build phase."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/contributing.texi:402 guix-git/doc/contributing.texi:666
- #: guix-git/doc/contributing.texi:667 guix-git/doc/guix.texi:1995
- #, no-wrap
- msgid "Emacs Packages"
- msgstr "بستههای ایمکس"
- #. type: menuentry
- #: guix-git/doc/contributing.texi:402
- msgid "Your Elisp fix."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/contributing.texi:402 guix-git/doc/contributing.texi:706
- #: guix-git/doc/contributing.texi:707
- #, no-wrap
- msgid "Python Modules"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/contributing.texi:402
- msgid "A touch of British comedy."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/contributing.texi:402 guix-git/doc/contributing.texi:782
- #: guix-git/doc/contributing.texi:783
- #, no-wrap
- msgid "Perl Modules"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/contributing.texi:402
- msgid "Little pearls."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/contributing.texi:402 guix-git/doc/contributing.texi:798
- #: guix-git/doc/contributing.texi:799
- #, no-wrap
- msgid "Java Packages"
- msgstr "بستههای جاوا"
- #. type: menuentry
- #: guix-git/doc/contributing.texi:402
- msgid "Coffee break."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/contributing.texi:402 guix-git/doc/contributing.texi:818
- #: guix-git/doc/contributing.texi:819
- #, no-wrap
- msgid "Rust Crates"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/contributing.texi:402
- msgid "Beware of oxidation."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/contributing.texi:402 guix-git/doc/contributing.texi:852
- #: guix-git/doc/contributing.texi:853
- #, no-wrap
- msgid "Fonts"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/contributing.texi:402
- msgid "Fond of fonts."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:408
- #, no-wrap
- msgid "free software"
- msgstr "نرمافزار آزاد"
- #. type: Plain text
- #: guix-git/doc/contributing.texi:416
- msgid "The GNU operating system has been developed so that users can have freedom in their computing. GNU is @dfn{free software}, meaning that users have the @url{https://www.gnu.org/philosophy/free-sw.html,four essential freedoms}: to run the program, to study and change the program in source code form, to redistribute exact copies, and to distribute modified versions. Packages found in the GNU distribution provide only software that conveys these four freedoms."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:422
- msgid "In addition, the GNU distribution follow the @url{https://www.gnu.org/distros/free-system-distribution-guidelines.html,free software distribution guidelines}. Among other things, these guidelines reject non-free firmware, recommendations of non-free software, and discuss ways to deal with trademarks and patents."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:430
- msgid "Some otherwise free upstream package sources contain a small and optional subset that violates the above guidelines, for instance because this subset is itself non-free code. When that happens, the offending items are removed with appropriate patches or code snippets in the @code{origin} form of the package (@pxref{Defining Packages}). This way, @code{guix build --source} returns the ``freed'' source rather than the unmodified upstream source."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:435
- #, no-wrap
- msgid "package name"
- msgstr "نام بسته"
- #. type: Plain text
- #: guix-git/doc/contributing.texi:443
- msgid "A package actually has two names associated with it. First, there is the name of the @emph{Scheme variable}, the one following @code{define-public}. By this name, the package can be made known in the Scheme code, for instance as input to another package. Second, there is the string in the @code{name} field of a package definition. This name is used by package management commands such as @command{guix package} and @command{guix build}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:448
- msgid "Both are usually the same and correspond to the lowercase conversion of the project name chosen upstream, with underscores replaced with hyphens. For instance, GNUnet is available as @code{gnunet}, and SDL_net as @code{sdl-net}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:456
- msgid "A noteworthy exception to this rule is when the project name is only a single character, or if an older maintained project with the same name already exists---regardless of whether it has already been packaged for Guix. Use common sense to make such names unambiguous and meaningful. For example, Guix's package for the shell called ``s'' upstream is @code{s-shell} and @emph{not} @code{s}. Feel free to ask your fellow hackers for inspiration."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:461
- msgid "We do not add @code{lib} prefixes for library packages, unless these are already part of the official project name. But @pxref{Python Modules} and @ref{Perl Modules} for special rules concerning modules for the Python and Perl languages."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:463
- msgid "Font package names are handled differently, @pxref{Fonts}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:468
- #, no-wrap
- msgid "package version"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:477
- msgid "We usually package only the latest version of a given free software project. But sometimes, for instance for incompatible library versions, two (or more) versions of the same package are needed. These require different Scheme variable names. We use the name as defined in @ref{Package Naming} for the most recent version; previous versions use the same name, suffixed by @code{-} and the smallest prefix of the version number that may distinguish the two versions."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:480
- msgid "The name inside the package definition is the same for all versions of a package and does not contain any version number."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:482
- msgid "For instance, the versions 2.24.20 and 3.9.12 of GTK+ may be packaged as follows:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/contributing.texi:494
- #, no-wrap
- msgid ""
- "(define-public gtk+\n"
- " (package\n"
- " (name \"gtk+\")\n"
- " (version \"3.9.12\")\n"
- " ...))\n"
- "(define-public gtk+-2\n"
- " (package\n"
- " (name \"gtk+\")\n"
- " (version \"2.24.20\")\n"
- " ...))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:496
- msgid "If we also wanted GTK+ 3.8.2, this would be packaged as"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/contributing.texi:502
- #, no-wrap
- msgid ""
- "(define-public gtk+-3.8\n"
- " (package\n"
- " (name \"gtk+\")\n"
- " (version \"3.8.2\")\n"
- " ...))\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:506
- #, no-wrap
- msgid "version number, for VCS snapshots"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:512
- msgid "Occasionally, we package snapshots of upstream's version control system (VCS) instead of formal releases. This should remain exceptional, because it is up to upstream developers to clarify what the stable release is. Yet, it is sometimes necessary. So, what should we put in the @code{version} field?"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:520
- msgid "Clearly, we need to make the commit identifier of the VCS snapshot visible in the version string, but we also need to make sure that the version string is monotonically increasing so that @command{guix package --upgrade} can determine which version is newer. Since commit identifiers, notably with Git, are not monotonically increasing, we add a revision number that we increase each time we upgrade to a newer snapshot. The resulting version string looks like this:"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:529
- #, no-wrap
- msgid ""
- "2.0.11-3.cabba9e\n"
- " ^ ^ ^\n"
- " | | `-- upstream commit ID\n"
- " | |\n"
- " | `--- Guix package revision\n"
- " |\n"
- "latest upstream version\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:539
- msgid "It is a good idea to strip commit identifiers in the @code{version} field to, say, 7 digits. It avoids an aesthetic annoyance (assuming aesthetics have a role to play here) as well as problems related to OS limits such as the maximum shebang length (127 bytes for the Linux kernel). There are helper functions for doing this for packages using @code{git-fetch} or @code{hg-fetch} (see below). It is best to use the full commit identifiers in @code{origin}s, though, to avoid ambiguities. A typical package definition may look like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/contributing.texi:556
- #, no-wrap
- msgid ""
- "(define my-package\n"
- " (let ((commit \"c3f29bc928d5900971f65965feaae59e1272a3f7\")\n"
- " (revision \"1\")) ;Guix package revision\n"
- " (package\n"
- " (version (git-version \"0.9\" revision commit))\n"
- " (source (origin\n"
- " (method git-fetch)\n"
- " (uri (git-reference\n"
- " (url \"git://example.org/my-package.git\")\n"
- " (commit commit)))\n"
- " (sha256 (base32 \"1mbikn@dots{}\"))\n"
- " (file-name (git-file-name name version))))\n"
- " ;; @dots{}\n"
- " )))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/contributing.texi:558
- #, no-wrap
- msgid "{Scheme Procedure} git-version @var{VERSION} @var{REVISION} @var{COMMIT}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/contributing.texi:560
- msgid "Return the version string for packages using @code{git-fetch}."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/contributing.texi:564
- #, no-wrap
- msgid ""
- "(git-version \"0.2.3\" \"0\" \"93818c936ee7e2f1ba1b315578bde363a7d43d05\")\n"
- "@result{} \"0.2.3-0.93818c9\"\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/contributing.texi:567
- #, no-wrap
- msgid "{Scheme Procedure} hg-version @var{VERSION} @var{REVISION} @var{CHANGESET}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/contributing.texi:570
- msgid "Return the version string for packages using @code{hg-fetch}. It works in the same way as @code{git-version}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:575
- #, no-wrap
- msgid "package description"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:576
- #, no-wrap
- msgid "package synopsis"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:583
- msgid "As we have seen before, each package in GNU@tie{}Guix includes a synopsis and a description (@pxref{Defining Packages}). Synopses and descriptions are important: They are what @command{guix package --search} searches, and a crucial piece of information to help users determine whether a given package suits their needs. Consequently, packagers should pay attention to what goes into them."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:591
- msgid "Synopses must start with a capital letter and must not end with a period. They must not start with ``a'' or ``the'', which usually does not bring anything; for instance, prefer ``File-frobbing tool'' over ``A tool that frobs files''. The synopsis should say what the package is---e.g., ``Core GNU utilities (file, text, shell)''---or what it is used for---e.g., the synopsis for GNU@tie{}grep is ``Print lines matching a pattern''."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:601
- msgid "Keep in mind that the synopsis must be meaningful for a very wide audience. For example, ``Manipulate alignments in the SAM format'' might make sense for a seasoned bioinformatics researcher, but might be fairly unhelpful or even misleading to a non-specialized audience. It is a good idea to come up with a synopsis that gives an idea of the application domain of the package. In this example, this might give something like ``Manipulate nucleotide sequence alignments'', which hopefully gives the user a better idea of whether this is what they are looking for."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:609
- msgid "Descriptions should take between five and ten lines. Use full sentences, and avoid using acronyms without first introducing them. Please avoid marketing phrases such as ``world-leading'', ``industrial-strength'', and ``next-generation'', and avoid superlatives like ``the most advanced''---they are not helpful to users looking for a package and may even sound suspicious. Instead, try to be factual, mentioning use cases and features."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:610
- #, no-wrap
- msgid "Texinfo markup, in package descriptions"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:619
- msgid "Descriptions can include Texinfo markup, which is useful to introduce ornaments such as @code{@@code} or @code{@@dfn}, bullet lists, or hyperlinks (@pxref{Overview,,, texinfo, GNU Texinfo}). However you should be careful when using some characters for example @samp{@@} and curly braces which are the basic special characters in Texinfo (@pxref{Special Characters,,, texinfo, GNU Texinfo}). User interfaces such as @command{guix package --show} take care of rendering it appropriately."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:625
- msgid "Synopses and descriptions are translated by volunteers @uref{https://translate.fedoraproject.org/projects/guix/packages, at Weblate} so that as many users as possible can read them in their native language. User interfaces search them and display them in the language specified by the current locale."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:630
- msgid "To allow @command{xgettext} to extract them as translatable strings, synopses and descriptions @emph{must be literal strings}. This means that you cannot use @code{string-append} or @code{format} to construct these strings:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/contributing.texi:636
- #, no-wrap
- msgid ""
- "(package\n"
- " ;; @dots{}\n"
- " (synopsis \"This is translatable\")\n"
- " (description (string-append \"This is \" \"*not*\" \" translatable.\")))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:644
- msgid "Translation is a lot of work so, as a packager, please pay even more attention to your synopses and descriptions as every change may entail additional work for translators. In order to help them, it is possible to make recommendations or instructions visible to them by inserting special comments like this (@pxref{xgettext Invocation,,, gettext, GNU Gettext}):"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/contributing.texi:649
- #, no-wrap
- msgid ""
- ";; TRANSLATORS: \"X11 resize-and-rotate\" should not be translated.\n"
- "(description \"ARandR is designed to provide a simple visual front end\n"
- "for the X11 resize-and-rotate (RandR) extension. @dots{}\")\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:654
- #, no-wrap
- msgid "snippets, when to use"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:665
- msgid "The boundary between using an origin snippet versus a build phase to modify the sources of a package can be elusive. Origin snippets are typically used to remove unwanted files such as bundled libraries, nonfree sources, or to apply simple substitutions. The source derived from an origin should produce a source that can be used to build the package on any system that the upstream package supports (i.e., act as the corresponding source). In particular, origin snippets must not embed store items in the sources; such patching should rather be done using build phases. Refer to the @code{origin} record documentation for more information (@pxref{origin Reference})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:669
- #, no-wrap
- msgid "emacs, packaging"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:670
- #, no-wrap
- msgid "elisp, packaging"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:682
- msgid "Emacs packages should preferably use the Emacs build system (@pxref{emacs-build-system}), for uniformity and the benefits provided by its build phases, such as the auto-generation of the autoloads file and the byte compilation of the sources. Because there is no standardized way to run a test suite for Emacs packages, tests are disabled by default. When a test suite is available, it should be enabled by setting the @code{#:tests?} argument to @code{#true}. By default, the command to run the test is @command{make check}, but any command can be specified via the @code{#:test-command} argument. The @code{#:test-command} argument expects a list containing a command and its arguments, to be invoked during the @code{check} phase."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:687
- msgid "The Elisp dependencies of Emacs packages are typically provided as @code{propagated-inputs} when required at run time. As for other packages, build or test dependencies should be specified as @code{native-inputs}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:696
- msgid "Emacs packages sometimes depend on resources directories that should be installed along the Elisp files. The @code{#:include} argument can be used for that purpose, by specifying a list of regexps to match. The best practice when using the @code{#:include} argument is to extend rather than override its default value (accessible via the @code{%default-include} variable). As an example, a yasnippet extension package typically include a @file{snippets} directory, which could be copied to the installation directory using:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/contributing.texi:699
- #, no-wrap
- msgid "#:include (cons \"^snippets/\" %default-include)\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:705
- msgid "When encountering problems, it is wise to check for the presence of the @code{Package-Requires} extension header in the package main source file, and whether any dependencies and their versions listed therein are satisfied."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:709
- #, no-wrap
- msgid "python"
- msgstr "پایتون"
- #. type: Plain text
- #: guix-git/doc/contributing.texi:715
- msgid "We currently package Python 2 and Python 3, under the Scheme variable names @code{python-2} and @code{python} as explained in @ref{Version Numbers}. To avoid confusion and naming clashes with other programming languages, it seems desirable that the name of a package for a Python module contains the word @code{python}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:722
- msgid "Some modules are compatible with only one version of Python, others with both. If the package Foo is compiled with Python 3, we name it @code{python-foo}. If it is compiled with Python 2, we name it @code{python2-foo}. Packages should be added when they are necessary; we don't add Python 2 variants of the package unless we are going to use them."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:728
- msgid "If a project already contains the word @code{python}, we drop this; for instance, the module python-dateutil is packaged under the names @code{python-dateutil} and @code{python2-dateutil}. If the project name starts with @code{py} (e.g.@: @code{pytz}), we keep it and prefix it as described above."
- msgstr ""
- #. type: subsubsection
- #: guix-git/doc/contributing.texi:729
- #, no-wrap
- msgid "Specifying Dependencies"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:730
- #, no-wrap
- msgid "inputs, for Python packages"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:735
- msgid "Dependency information for Python packages is usually available in the package source tree, with varying degrees of accuracy: in the @file{setup.py} file, in @file{requirements.txt}, or in @file{tox.ini}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:741
- msgid "Your mission, when writing a recipe for a Python package, is to map these dependencies to the appropriate type of ``input'' (@pxref{package Reference, inputs}). Although the @code{pypi} importer normally does a good job (@pxref{Invoking guix import}), you may want to check the following check list to determine which dependency goes where."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/contributing.texi:749
- msgid "We currently package Python 2 with @code{setuptools} and @code{pip} installed like Python 3.4 has per default. Thus you don't need to specify either of these as an input. @command{guix lint} will warn you if you do."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/contributing.texi:755
- msgid "Python dependencies required at run time go into @code{propagated-inputs}. They are typically defined with the @code{install_requires} keyword in @file{setup.py}, or in the @file{requirements.txt} file."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/contributing.texi:763
- msgid "Python packages required only at build time---e.g., those listed with the @code{setup_requires} keyword in @file{setup.py}---or only for testing---e.g., those in @code{tests_require}---go into @code{native-inputs}. The rationale is that (1) they do not need to be propagated because they are not needed at run time, and (2) in a cross-compilation context, it's the ``native'' input that we'd want."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/contributing.texi:767
- msgid "Examples are the @code{pytest}, @code{mock}, and @code{nose} test frameworks. Of course if any of these packages is also required at run-time, it needs to go to @code{propagated-inputs}."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/contributing.texi:772
- msgid "Anything that does not fall in the previous categories goes to @code{inputs}, for example programs or C libraries required for building Python packages containing C extensions."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/contributing.texi:778
- msgid "If a Python package has optional dependencies (@code{extras_require}), it is up to you to decide whether to add them or not, based on their usefulness/overhead ratio (@pxref{Submitting Patches, @command{guix size}})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:785
- #, no-wrap
- msgid "perl"
- msgstr "پرل"
- #. type: Plain text
- #: guix-git/doc/contributing.texi:796
- msgid "Perl programs standing for themselves are named as any other package, using the lowercase upstream name. For Perl packages containing a single class, we use the lowercase class name, replace all occurrences of @code{::} by dashes and prepend the prefix @code{perl-}. So the class @code{XML::Parser} becomes @code{perl-xml-parser}. Modules containing several classes keep their lowercase upstream name and are also prepended by @code{perl-}. Such modules tend to have the word @code{perl} somewhere in their name, which gets dropped in favor of the prefix. For instance, @code{libwww-perl} becomes @code{perl-libwww}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:801
- #, no-wrap
- msgid "java"
- msgstr "جاوا"
- #. type: Plain text
- #: guix-git/doc/contributing.texi:804
- msgid "Java programs standing for themselves are named as any other package, using the lowercase upstream name."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:810
- msgid "To avoid confusion and naming clashes with other programming languages, it is desirable that the name of a package for a Java package is prefixed with @code{java-}. If a project already contains the word @code{java}, we drop this; for instance, the package @code{ngsjava} is packaged under the name @code{java-ngs}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:816
- msgid "For Java packages containing a single class or a small class hierarchy, we use the lowercase class name, replace all occurrences of @code{.} by dashes and prepend the prefix @code{java-}. So the class @code{apache.commons.cli} becomes package @code{java-apache-commons-cli}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:821
- #, no-wrap
- msgid "rust"
- msgstr "راست"
- #. type: Plain text
- #: guix-git/doc/contributing.texi:824
- msgid "Rust programs standing for themselves are named as any other package, using the lowercase upstream name."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:828
- msgid "To prevent namespace collisions we prefix all other Rust packages with the @code{rust-} prefix. The name should be changed to lowercase as appropriate and dashes should remain in place."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:834
- msgid "In the rust ecosystem it is common for multiple incompatible versions of a package to be used at any given time, so all package definitions should have a versioned suffix. The versioned suffix is the left-most non-zero digit (and any leading zeros, of course). This follows the ``caret'' version scheme intended by Cargo. Examples@: @code{rust-clap-2}, @code{rust-rand-0.6}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:844
- msgid "Because of the difficulty in reusing rust packages as pre-compiled inputs for other packages the Cargo build system (@pxref{Build Systems, @code{cargo-build-system}}) presents the @code{#:cargo-inputs} and @code{cargo-development-inputs} keywords as build system arguments. It would be helpful to think of these as similar to @code{propagated-inputs} and @code{native-inputs}. Rust @code{dependencies} and @code{build-dependencies} should go in @code{#:cargo-inputs}, and @code{dev-dependencies} should go in @code{#:cargo-development-inputs}. If a Rust package links to other libraries then the standard placement in @code{inputs} and the like should be used."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:850
- msgid "Care should be taken to ensure the correct version of dependencies are used; to this end we try to refrain from skipping the tests or using @code{#:skip-build?} when possible. Of course this is not always possible, as the package may be developed for a different Operating System, depend on features from the Nightly Rust compiler, or the test suite may have atrophied since it was released."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:855 guix-git/doc/guix.texi:1930
- #, no-wrap
- msgid "fonts"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:861
- msgid "For fonts that are in general not installed by a user for typesetting purposes, or that are distributed as part of a larger software package, we rely on the general packaging rules for software; for instance, this applies to the fonts delivered as part of the X.Org system or fonts that are part of TeX Live."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:865
- msgid "To make it easier for a user to search for fonts, names for other packages containing only fonts are constructed as follows, independently of the upstream package name."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:873
- msgid "The name of a package containing only one font family starts with @code{font-}; it is followed by the foundry name and a dash @code{-} if the foundry is known, and the font family name, in which spaces are replaced by dashes (and as usual, all upper case letters are transformed to lower case). For example, the Gentium font family by SIL is packaged under the name @code{font-sil-gentium}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:882
- msgid "For a package containing several font families, the name of the collection is used in the place of the font family name. For instance, the Liberation fonts consist of three families, Liberation Sans, Liberation Serif and Liberation Mono. These could be packaged separately under the names @code{font-liberation-sans} and so on; but as they are distributed together under a common name, we prefer to package them together as @code{font-liberation}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:888
- msgid "In the case where several formats of the same font family or font collection are packaged separately, a short form of the format, prepended by a dash, is added to the package name. We use @code{-ttf} for TrueType fonts, @code{-otf} for OpenType fonts and @code{-type1} for PostScript Type 1 fonts."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:896
- msgid "In general our code follows the GNU Coding Standards (@pxref{Top,,, standards, GNU Coding Standards}). However, they do not say much about Scheme, so here are some additional rules."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/contributing.texi:902 guix-git/doc/contributing.texi:904
- #: guix-git/doc/contributing.texi:905
- #, no-wrap
- msgid "Programming Paradigm"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/contributing.texi:902
- msgid "How to compose your elements."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/contributing.texi:902 guix-git/doc/contributing.texi:911
- #: guix-git/doc/contributing.texi:912
- #, no-wrap
- msgid "Modules"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/contributing.texi:902
- msgid "Where to store your code?"
- msgstr ""
- #. type: subsection
- #: guix-git/doc/contributing.texi:902 guix-git/doc/contributing.texi:922
- #: guix-git/doc/contributing.texi:923
- #, no-wrap
- msgid "Data Types and Pattern Matching"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/contributing.texi:902
- msgid "Implementing data structures."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/contributing.texi:902 guix-git/doc/contributing.texi:937
- #: guix-git/doc/contributing.texi:938
- #, no-wrap
- msgid "Formatting Code"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/contributing.texi:902
- msgid "Writing conventions."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:910
- msgid "Scheme code in Guix is written in a purely functional style. One exception is code that involves input/output, and procedures that implement low-level concepts, such as the @code{memoize} procedure."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:918
- msgid "Guile modules that are meant to be used on the builder side must live in the @code{(guix build @dots{})} name space. They must not refer to other Guix or GNU modules. However, it is OK for a ``host-side'' module to use a build-side module."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:921
- msgid "Modules that deal with the broader GNU system should be in the @code{(gnu @dots{})} name space rather than @code{(guix @dots{})}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:930
- msgid "The tendency in classical Lisp is to use lists to represent everything, and then to browse them ``by hand'' using @code{car}, @code{cdr}, @code{cadr}, and co. There are several problems with that style, notably the fact that it is hard to read, error-prone, and a hindrance to proper type error reports."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:936
- msgid "Guix code should define appropriate data types (for instance, using @code{define-record-type*}) rather than abuse lists. In addition, it should use pattern matching, via Guile’s @code{(ice-9 match)} module, especially when matching lists (@pxref{Pattern Matching,,, guile, GNU Guile Reference Manual})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:940
- #, no-wrap
- msgid "formatting code"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:941
- #, no-wrap
- msgid "coding style"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:948
- msgid "When writing Scheme code, we follow common wisdom among Scheme programmers. In general, we follow the @url{https://mumble.net/~campbell/scheme/style.txt, Riastradh's Lisp Style Rules}. This document happens to describe the conventions mostly used in Guile’s code too. It is very thoughtful and well written, so please do read it."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:955
- msgid "Some special forms introduced in Guix, such as the @code{substitute*} macro, have special indentation rules. These are defined in the @file{.dir-locals.el} file, which Emacs automatically uses. Also note that Emacs-Guix provides @code{guix-devel-mode} mode that indents and highlights Guix code properly (@pxref{Development,,, emacs-guix, The Emacs-Guix Reference Manual})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:956
- #, no-wrap
- msgid "indentation, of code"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:957
- #, no-wrap
- msgid "formatting, of code"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:960
- msgid "If you do not use Emacs, please make sure to let your editor knows these rules. To automatically indent a package definition, you can also run:"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:963
- #, no-wrap
- msgid "./etc/indent-code.el gnu/packages/@var{file}.scm @var{package}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:969
- msgid "This automatically indents the definition of @var{package} in @file{gnu/packages/@var{file}.scm} by running Emacs in batch mode. To indent a whole file, omit the second argument:"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:972
- #, no-wrap
- msgid "./etc/indent-code.el gnu/services/@var{file}.scm\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:974
- #, no-wrap
- msgid "Vim, Scheme code editing"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:980
- msgid "If you are editing code with Vim, we recommend that you run @code{:set autoindent} so that your code is automatically indented as you type. Additionally, @uref{https://www.vim.org/scripts/script.php?script_id=3998, @code{paredit.vim}} may help you deal with all these parentheses."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:984
- msgid "We require all top-level procedures to carry a docstring. This requirement can be relaxed for simple private procedures in the @code{(guix build @dots{})} name space, though."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:987
- msgid "Procedures should not have more than four positional parameters. Use keyword parameters for procedures that take more than four parameters."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1001
- msgid "Development is done using the Git distributed version control system. Thus, access to the repository is not strictly necessary. We welcome contributions in the form of patches as produced by @code{git format-patch} sent to the @email{guix-patches@@gnu.org} mailing list (@pxref{submitting patches,, Submitting patches to a project, git, Git User Manual}). Contributors are encouraged to take a moment to set some Git repository options (@pxref{Configuring Git}) first, which can improve the readability of patches. Seasoned Guix developers may also want to look at the section on commit access (@pxref{Commit Access})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1008
- msgid "This mailing list is backed by a Debbugs instance, which allows us to keep track of submissions (@pxref{Tracking Bugs and Patches}). Each message sent to that mailing list gets a new tracking number assigned; people can then follow up on the submission by sending email to @code{@var{NNN}@@debbugs.gnu.org}, where @var{NNN} is the tracking number (@pxref{Sending a Patch Series})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1012
- msgid "Please write commit logs in the ChangeLog format (@pxref{Change Logs,,, standards, GNU Coding Standards}); you can check the commit history for examples."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1015
- msgid "Before submitting a patch that adds or modifies a package definition, please run through this check list:"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/contributing.texi:1017 guix-git/doc/contributing.texi:1223
- #, no-wrap
- msgid "git format-patch"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/contributing.texi:1018
- #, no-wrap
- msgid "git-format-patch"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1025
- msgid "When generating your patches with @code{git format-patch} or @code{git send-email}, we recommend using the option @code{--base=}, perhaps with the value @code{auto}. This option adds a note to the patch stating which commit the patch is based on. This helps reviewers understand how to apply and review your patches."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1031
- msgid "If the authors of the packaged software provide a cryptographic signature for the release tarball, make an effort to verify the authenticity of the archive. For a detached GPG signature file this would be done with the @code{gpg --verify} command."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1035
- msgid "Take some time to provide an adequate synopsis and description for the package. @xref{Synopses and Descriptions}, for some guidelines."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1040
- msgid "Run @code{guix lint @var{package}}, where @var{package} is the name of the new or modified package, and fix any errors it reports (@pxref{Invoking guix lint})."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1044
- msgid "Make sure the package builds on your platform, using @code{guix build @var{package}}."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1052
- msgid "We recommend you also try building the package on other supported platforms. As you may not have access to actual hardware platforms, we recommend using the @code{qemu-binfmt-service-type} to emulate them. In order to enable it, add the @code{virtualization} service module and the following service to the list of services in your @code{operating-system} configuration:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/contributing.texi:1057
- #, no-wrap
- msgid ""
- "(service qemu-binfmt-service-type\n"
- " (qemu-binfmt-configuration\n"
- " (platforms (lookup-qemu-platforms \"arm\" \"aarch64\"))))\n"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1060
- msgid "Then reconfigure your system."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1065
- msgid "You can then build packages for different platforms by specifying the @code{--system} option. For example, to build the \"hello\" package for the armhf or aarch64 architectures, you would run the following commands, respectively:"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:1068
- #, no-wrap
- msgid ""
- "guix build --system=armhf-linux --rounds=2 hello\n"
- "guix build --system=aarch64-linux --rounds=2 hello\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:1071
- #, no-wrap
- msgid "bundling"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1074
- msgid "Make sure the package does not use bundled copies of software already available as separate packages."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1083
- msgid "Sometimes, packages include copies of the source code of their dependencies as a convenience for users. However, as a distribution, we want to make sure that such packages end up using the copy we already have in the distribution, if there is one. This improves resource usage (the dependency is built and stored only once), and allows the distribution to make transverse changes such as applying security updates for a given software package in a single place and have them affect the whole system---something that bundled copies prevent."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1092
- msgid "Take a look at the profile reported by @command{guix size} (@pxref{Invoking guix size}). This will allow you to notice references to other packages unwillingly retained. It may also help determine whether to split the package (@pxref{Packages with Multiple Outputs}), and which optional dependencies should be used. In particular, avoid adding @code{texlive} as a dependency: because of its extreme size, use the @code{texlive-tiny} package or @code{texlive-union} procedure instead."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1097
- msgid "For important changes, check that dependent packages (if applicable) are not affected by the change; @code{guix refresh --list-dependent @var{package}} will help you do that (@pxref{Invoking guix refresh})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:1099
- #, no-wrap
- msgid "branching strategy"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:1100
- #, no-wrap
- msgid "rebuild scheduling strategy"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1103
- msgid "Depending on the number of dependent packages and thus the amount of rebuilding induced, commits go to different branches, along these lines:"
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1105
- #, no-wrap
- msgid "300 dependent packages or less"
- msgstr ""
- #. type: table
- #: guix-git/doc/contributing.texi:1107
- msgid "@code{master} branch (non-disruptive changes)."
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1108
- #, no-wrap
- msgid "between 300 and 1,800 dependent packages"
- msgstr ""
- #. type: table
- #: guix-git/doc/contributing.texi:1114
- msgid "@code{staging} branch (non-disruptive changes). This branch is intended to be merged in @code{master} every 6 weeks or so. Topical changes (e.g., an update of the GNOME stack) can instead go to a specific branch (say, @code{gnome-updates}). This branch is not expected to be buildable or usable until late in its development process."
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1115
- #, no-wrap
- msgid "more than 1,800 dependent packages"
- msgstr ""
- #. type: table
- #: guix-git/doc/contributing.texi:1120
- msgid "@code{core-updates} branch (may include major and potentially disruptive changes). This branch is intended to be merged in @code{master} every 6 months or so. This branch is not expected to be buildable or usable until late in its development process."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1127
- msgid "All these branches are @uref{https://@value{SUBSTITUTE-SERVER-1}, tracked by our build farm} and merged into @code{master} once everything has been successfully built. This allows us to fix issues before they hit users, and to reduce the window during which pre-built binaries are not available."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1136
- msgid "When we decide to start building the @code{staging} or @code{core-updates} branches, they will be forked and renamed with the suffix @code{-frozen}, at which time only bug fixes may be pushed to the frozen branches. The @code{core-updates} and @code{staging} branches will remain open to accept patches for the next cycle. Please ask on the mailing list or IRC if unsure where to place a patch."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:1138
- #, no-wrap
- msgid "determinism, of build processes"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:1139
- #, no-wrap
- msgid "reproducible builds, checking"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1143
- msgid "Check whether the package's build process is deterministic. This typically means checking whether an independent build of the package yields the exact same result that you obtained, bit for bit."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1146
- msgid "A simple way to do that is by building the same package several times in a row on your machine (@pxref{Invoking guix build}):"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:1149
- #, no-wrap
- msgid "guix build --rounds=2 my-package\n"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1153
- msgid "This is enough to catch a class of common non-determinism issues, such as timestamps or randomly-generated output in the build result."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1163
- msgid "Another option is to use @command{guix challenge} (@pxref{Invoking guix challenge}). You may run it once the package has been committed and built by @code{@value{SUBSTITUTE-SERVER-1}} to check whether it obtains the same result as you did. Better yet: Find another machine that can build it and run @command{guix publish}. Since the remote build machine is likely different from yours, this can catch non-determinism issues related to the hardware---e.g., use of different instruction set extensions---or to the operating system kernel---e.g., reliance on @code{uname} or @file{/proc} files."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1169
- msgid "When writing documentation, please use gender-neutral wording when referring to people, such as @uref{https://en.wikipedia.org/wiki/Singular_they, singular ``they''@comma{} ``their''@comma{} ``them''}, and so forth."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1173
- msgid "Verify that your patch contains only one set of related changes. Bundling unrelated changes together makes reviewing harder and slower."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1176
- msgid "Examples of unrelated changes include the addition of several packages, or a package update along with fixes to that package."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1181
- msgid "Please follow our code formatting rules, possibly running the @command{etc/indent-code.el} script to do that automatically for you (@pxref{Formatting Code})."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1189
- msgid "When possible, use mirrors in the source URL (@pxref{Invoking guix download}). Use reliable URLs, not generated ones. For instance, GitHub archives are not necessarily identical from one generation to the next, so in this case it's often better to clone the repository. Don't use the @command{name} field in the URL: it is not very useful and if the name changes, the URL will probably be wrong."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1193
- msgid "Check if Guix builds (@pxref{Building from Git}) and address the warnings, especially those about use of undefined symbols."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1196
- msgid "Make sure your changes do not break Guix and simulate a @code{guix pull} with:"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:1198
- #, no-wrap
- msgid "guix pull --url=/path/to/your/checkout --profile=/tmp/guix.master\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1211
- msgid "When posting a patch to the mailing list, use @samp{[PATCH] @dots{}} as a subject, if your patch is to be applied on a branch other than @code{master}, say @code{core-updates}, specify it in the subject like @samp{[PATCH core-updates] @dots{}}. You may use your email client or the @command{git send-email} command (@pxref{Sending a Patch Series}). We prefer to get patches in plain text messages, either inline or as MIME attachments. You are advised to pay attention if your email client changes anything like line breaks or indentation which could potentially break the patches."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1216
- msgid "Expect some delay when you submit your very first patch to @email{guix-patches@@gnu.org}. You have to wait until you get an acknowledgement with the assigned tracking number. Future acknowledgements should not be delayed."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1219
- msgid "When a bug is resolved, please close the thread by sending an email to @email{@var{NNN}-done@@debbugs.gnu.org}."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/contributing.texi:1220 guix-git/doc/contributing.texi:1221
- #, no-wrap
- msgid "Configuring Git"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:1222
- #, no-wrap
- msgid "git configuration"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/contributing.texi:1224 guix-git/doc/contributing.texi:1259
- #, no-wrap
- msgid "git send-email"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1232
- msgid "If you have not done so already, you may wish to set a name and email that will be associated with your commits (@pxref{telling git your name, , Telling Git your name, git, Git User Manual}). If you wish to use a different name or email just for commits in this repository, you can use @command{git config --local}, or edit @file{.git/config} in the repository instead of @file{~/.gitconfig}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1238
- msgid "We provide some default settings in @file{etc/git/gitconfig} which modify how patches are generated, making them easier to read and apply. These settings can be applied by manually copying them to @file{.git/config} in your checkout, or by telling Git to include the whole file:"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:1241
- #, no-wrap
- msgid "git config --local include.path ../etc/git/gitconfig\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1245
- msgid "From then on, any changes to @file{etc/git/gitconfig} would automatically take effect."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1250
- msgid "Since the first patch in a series must be sent separately (@pxref{Sending a Patch Series}), it can also be helpful to tell @command{git format-patch} to handle the e-mail threading instead of @command{git send-email}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:1254
- #, no-wrap
- msgid ""
- "git config --local format.thread shallow\n"
- "git config --local sendemail.thread no\n"
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/contributing.texi:1256 guix-git/doc/contributing.texi:1258
- #, no-wrap
- msgid "Sending a Patch Series"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:1258
- #, no-wrap
- msgid "patch series"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1269
- msgid "When sending a patch series (e.g., using @code{git send-email}), please first send one message to @email{guix-patches@@gnu.org}, and then send subsequent patches to @email{@var{NNN}@@debbugs.gnu.org} to make sure they are kept together. See @uref{https://debbugs.gnu.org/Advanced.html, the Debbugs documentation} for more information. You can install @command{git send-email} with @command{guix install git:send-email}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1275
- msgid "This section describes how the Guix project tracks its bug reports and patch submissions."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/contributing.texi:1280 guix-git/doc/contributing.texi:1282
- #: guix-git/doc/contributing.texi:1283
- #, no-wrap
- msgid "The Issue Tracker"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/contributing.texi:1280
- msgid "The official bug and patch tracker."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/contributing.texi:1280 guix-git/doc/contributing.texi:1296
- #: guix-git/doc/contributing.texi:1297
- #, no-wrap
- msgid "Debbugs User Interfaces"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/contributing.texi:1280
- msgid "Ways to interact with Debbugs."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/contributing.texi:1280 guix-git/doc/contributing.texi:1336
- #: guix-git/doc/contributing.texi:1337
- #, no-wrap
- msgid "Debbugs Usertags"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/contributing.texi:1280
- msgid "Tag reports with custom labels."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:1285
- #, no-wrap
- msgid "bug reports, tracking"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:1286
- #, no-wrap
- msgid "patch submissions, tracking"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:1287
- #, no-wrap
- msgid "issue tracking"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:1288
- #, no-wrap
- msgid "Debbugs, issue tracking system"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1295
- msgid "Bug reports and patch submissions are currently tracked using the Debbugs instance at @uref{https://bugs.gnu.org}. Bug reports are filed against the @code{guix} ``package'' (in Debbugs parlance), by sending email to @email{bug-guix@@gnu.org}, while patch submissions are filed against the @code{guix-patches} package by sending email to @email{guix-patches@@gnu.org} (@pxref{Submitting Patches})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1301
- msgid "A web interface (actually @emph{two} web interfaces!) are available to browse issues:"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/contributing.texi:1310
- msgid "@url{https://issues.guix.gnu.org} provides a pleasant interface@footnote{The web interface at @url{https://issues.guix.gnu.org} is powered by Mumi, a nice piece of software written in Guile, and you can help! See @url{https://git.elephly.net/gitweb.cgi?p=software/mumi.git}.} to browse bug reports and patches, and to participate in discussions;"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/contributing.texi:1312
- msgid "@url{https://bugs.gnu.org/guix} lists bug reports;"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/contributing.texi:1314
- msgid "@url{https://bugs.gnu.org/guix-patches} lists patch submissions."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1319
- msgid "To view discussions related to issue number @var{n}, go to @indicateurl{https://issues.guix.gnu.org/@var{n}} or @indicateurl{https://bugs.gnu.org/@var{n}}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1322
- msgid "If you use Emacs, you may find it more convenient to interact with issues using @file{debbugs.el}, which you can install with:"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:1325
- #, no-wrap
- msgid "guix install emacs-debbugs\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1328
- msgid "For example, to list all open issues on @code{guix-patches}, hit:"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:1331
- #, no-wrap
- msgid "@kbd{C-u} @kbd{M-x} debbugs-gnu @kbd{RET} @kbd{RET} guix-patches @kbd{RET} n y\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1335
- msgid "@xref{Top,,, debbugs-ug, Debbugs User Guide}, for more information on this nifty tool!"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:1339
- #, no-wrap
- msgid "usertags, for debbugs"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:1340
- #, no-wrap
- msgid "Debbugs usertags"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1346
- msgid "Debbugs provides a feature called @dfn{usertags} that allows any user to tag any bug with an arbitrary label. Bugs can be searched by usertag, so this is a handy way to organize bugs@footnote{The list of usertags is public information, and anyone can modify any user's list of usertags, so keep that in mind if you choose to use this feature.}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1352
- msgid "For example, to view all the bug reports (or patches, in the case of @code{guix-patches}) tagged with the usertag @code{powerpc64le-linux} for the user @code{guix}, open a URL like the following in a web browser: @url{https://debbugs.gnu.org/cgi-bin/pkgreport.cgi?tag=powerpc64le-linux;users=guix}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1356
- msgid "For more information on how to use usertags, please refer to the documentation for Debbugs or the documentation for whatever tool you use to interact with Debbugs."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1361
- msgid "In Guix, we are experimenting with usertags to keep track of architecture-specific issues. To facilitate collaboration, all our usertags are associated with the single user @code{guix}. The following usertags currently exist for that user:"
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1364 guix-git/doc/guix.texi:556
- #, no-wrap
- msgid "powerpc64le-linux"
- msgstr ""
- #. type: table
- #: guix-git/doc/contributing.texi:1372
- msgid "The purpose of this usertag is to make it easy to find the issues that matter most for the @code{powerpc64le-linux} system type. Please assign this usertag to bugs or patches that affect @code{powerpc64le-linux} but not other system types. In addition, you may use it to identify issues that for some reason are particularly important for the @code{powerpc64le-linux} system type, even if the issue affects other system types, too."
- msgstr ""
- #. #-#-#-#-# contributing.pot (guix manual checkout) #-#-#-#-#
- #. type: item
- #. #-#-#-#-# guix.pot (guix manual checkout) #-#-#-#-#
- #. type: cindex
- #: guix-git/doc/contributing.texi:1373 guix-git/doc/guix.texi:3070
- #: guix-git/doc/guix.texi:4771
- #, no-wrap
- msgid "reproducibility"
- msgstr ""
- #. type: table
- #: guix-git/doc/contributing.texi:1377
- msgid "For issues related to reproducibility. For example, it would be appropriate to assign this usertag to a bug report for a package that fails to build reproducibly."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1384
- msgid "If you're a committer and you want to add a usertag, just start using it with the @code{guix} user. If the usertag proves useful to you, consider updating this section of the manual so that others will know what your usertag means."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:1388
- #, no-wrap
- msgid "commit access, for developers"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1394
- msgid "Everyone can contribute to Guix without having commit access (@pxref{Submitting Patches}). However, for frequent contributors, having write access to the repository can be convenient. Commit access should not be thought of as a ``badge of honor'' but rather as a responsibility a contributor is willing to take to help the project."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1398
- msgid "The following sections explain how to get commit access, how to be ready to push commits, and the policies and community expectations for commits pushed upstream."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/contributing.texi:1399
- #, no-wrap
- msgid "Applying for Commit Access"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1403
- msgid "When you deem it necessary, consider applying for commit access by following these steps:"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1412
- msgid "Find three committers who would vouch for you. You can view the list of committers at @url{https://savannah.gnu.org/project/memberlist.php?group=guix}. Each of them should email a statement to @email{guix-maintainers@@gnu.org} (a private alias for the collective of maintainers), signed with their OpenPGP key."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1418
- msgid "Committers are expected to have had some interactions with you as a contributor and to be able to judge whether you are sufficiently familiar with the project's practices. It is @emph{not} a judgment on the value of your work, so a refusal should rather be interpreted as ``let's try again later''."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1425
- msgid "Send @email{guix-maintainers@@gnu.org} a message stating your intent, listing the three committers who support your application, signed with the OpenPGP key you will use to sign commits, and giving its fingerprint (see below). See @uref{https://emailselfdefense.fsf.org/en/}, for an introduction to public-key cryptography with GnuPG."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1431
- msgid "Set up GnuPG such that it never uses the SHA1 hash algorithm for digital signatures, which is known to be unsafe since 2019, for instance by adding the following line to @file{~/.gnupg/gpg.conf} (@pxref{GPG Esoteric Options,,, gnupg, The GNU Privacy Guard Manual}):"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:1434
- #, no-wrap
- msgid "digest-algo sha512\n"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1439
- msgid "Maintainers ultimately decide whether to grant you commit access, usually following your referrals' recommendation."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:1441
- #, no-wrap
- msgid "OpenPGP, signed commits"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1446
- msgid "If and once you've been given access, please send a message to @email{guix-devel@@gnu.org} to say so, again signed with the OpenPGP key you will use to sign commits (do that before pushing your first commit). That way, everyone can notice and ensure you control that OpenPGP key."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/contributing.texi:1447 guix-git/doc/guix.texi:17972
- #, no-wrap
- msgid "Important"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/contributing.texi:1449
- msgid "Before you can push for the first time, maintainers must:"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1453
- msgid "add your OpenPGP key to the @code{keyring} branch;"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1456
- msgid "add your OpenPGP fingerprint to the @file{.guix-authorizations} file of the branch(es) you will commit to."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/contributing.texi:1461
- msgid "Make sure to read the rest of this section and... profit!"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/contributing.texi:1467
- msgid "Maintainers are happy to give commit access to people who have been contributing for some time and have a track record---don't be shy and don't underestimate your work!"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/contributing.texi:1471
- msgid "However, note that the project is working towards a more automated patch review and merging system, which, as a consequence, may lead us to have fewer people with commit access to the main repository. Stay tuned!"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1478
- msgid "All commits that are pushed to the central repository on Savannah must be signed with an OpenPGP key, and the public key should be uploaded to your user account on Savannah and to public key servers, such as @code{keys.openpgp.org}. To configure Git to automatically sign commits, run:"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:1481
- #, no-wrap
- msgid ""
- "git config commit.gpgsign true\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:1484
- #, no-wrap
- msgid ""
- "# Substitute the fingerprint of your public PGP key.\n"
- "git config user.signingkey CABBA6EA1DC0FF33\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1489
- msgid "You can prevent yourself from accidentally pushing unsigned commits to Savannah by using the pre-push Git hook located at @file{etc/git/pre-push}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:1492
- #, no-wrap
- msgid "cp etc/git/pre-push .git/hooks/pre-push\n"
- msgstr ""
- #. type: subsection
- #: guix-git/doc/contributing.texi:1494
- #, no-wrap
- msgid "Commit Policy"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1499
- msgid "If you get commit access, please make sure to follow the policy below (discussions of the policy can take place on @email{guix-devel@@gnu.org})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1504
- msgid "Non-trivial patches should always be posted to @email{guix-patches@@gnu.org} (trivial patches include fixing typos, etc.). This mailing list fills the patch-tracking database (@pxref{Tracking Bugs and Patches})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1513
- msgid "For patches that just add a new package, and a simple one, it's OK to commit, if you're confident (which means you successfully built it in a chroot setup, and have done a reasonable copyright and license auditing). Likewise for package upgrades, except upgrades that trigger a lot of rebuilds (for example, upgrading GnuTLS or GLib). We have a mailing list for commit notifications (@email{guix-commits@@gnu.org}), so people can notice. Before pushing your changes, make sure to run @code{git pull --rebase}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1518
- msgid "When pushing a commit on behalf of somebody else, please add a @code{Signed-off-by} line at the end of the commit log message---e.g., with @command{git am --signoff}. This improves tracking of who did what."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1522
- msgid "When adding channel news entries (@pxref{Channels, Writing Channel News}), make sure they are well-formed by running the following command right before pushing:"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:1525
- #, no-wrap
- msgid "make check-channel-news\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1531
- msgid "For anything else, please post to @email{guix-patches@@gnu.org} and leave time for a review, without committing anything (@pxref{Submitting Patches}). If you didn’t receive any reply after two weeks, and if you're confident, it's OK to commit."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1534
- msgid "That last part is subject to being adjusted, allowing individuals to commit directly on non-controversial changes on parts they’re familiar with."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/contributing.texi:1535
- #, no-wrap
- msgid "Addressing Issues"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1546
- msgid "Peer review (@pxref{Submitting Patches}) and tools such as @command{guix lint} (@pxref{Invoking guix lint}) and the test suite (@pxref{Running the Test Suite}) should catch issues before they are pushed. Yet, commits that ``break'' functionality might occasionally go through. When that happens, there are two priorities: mitigating the impact, and understanding what happened to reduce the chance of similar incidents in the future. The responsibility for both these things primarily lies with those involved, but like everything this is a group effort."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1551
- msgid "Some issues can directly affect all users---for instance because they make @command{guix pull} fail or break core functionality, because they break major packages (at build time or run time), or because they introduce known security vulnerabilities."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:1552
- #, no-wrap
- msgid "reverting commits"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1558
- msgid "The people involved in authoring, reviewing, and pushing such commit(s) should be at the forefront to mitigate their impact in a timely fashion: by pushing a followup commit to fix it (if possible), or by reverting it to leave time to come up with a proper fix, and by communicating with other developers about the problem."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1564
- msgid "If these persons are unavailable to address the issue in time, other committers are entitled to revert the commit(s), explaining in the commit log and on the mailing list what the problem was, with the goal of leaving time to the original committer, reviewer(s), and author(s) to propose a way forward."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1573
- msgid "Once the problem has been dealt with, it is the responsibility of those involved to make sure the situation is understood. If you are working to understand what happened, focus on gathering information and avoid assigning any blame. Do ask those involved to describe what happened, do not ask them to explain the situation---this would implicitly blame them, which is unhelpful. Accountability comes from a consensus about the problem, learning from it and improving processes so that it's less likely to reoccur."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/contributing.texi:1574
- #, no-wrap
- msgid "Commit Revocation"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1581
- msgid "In order to reduce the possibility of mistakes, committers will have their Savannah account removed from the Guix Savannah project and their key removed from @file{.guix-authorizations} after 12 months of inactivity; they can ask to regain commit access by emailing the maintainers, without going through the vouching process."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1591
- msgid "Maintainers@footnote{See @uref{https://guix.gnu.org/en/about} for the current list of maintainers. You can email them privately at @email{guix-maintainers@@gnu.org}.} may also revoke an individual's commit rights, as a last resort, if cooperation with the rest of the community has caused too much friction---even within the bounds of the project's code of conduct (@pxref{Contributing}). They would only do so after public or private discussion with the individual and a clear notice. Examples of behavior that hinders cooperation and could lead to such a decision include:"
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1593
- #, no-wrap
- msgid "repeated violation of the commit policy stated above;"
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1594
- #, no-wrap
- msgid "repeated failure to take peer criticism into account;"
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1595
- #, no-wrap
- msgid "breaching trust through a series of grave incidents."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1602
- msgid "When maintainers resort to such a decision, they notify developers on @email{guix-devel@@gnu.org}; inquiries may be sent to @email{guix-maintainers@@gnu.org}. Depending on the situation, the individual may still be welcome to contribute."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/contributing.texi:1603
- #, no-wrap
- msgid "Helping Out"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1610
- msgid "One last thing: the project keeps moving forward because committers not only push their own awesome changes, but also offer some of their time @emph{reviewing} and pushing other people's changes. As a committer, you're welcome to use your expertise and commit rights to help other contributors, too!"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:1614
- #, no-wrap
- msgid "update-guix-package, updating the guix package"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1620
- msgid "It is sometimes desirable to update the @code{guix} package itself (the package defined in @code{(gnu packages package-management)}), for example to make new daemon features available for use by the @code{guix-service-type} service type. In order to simplify this task, the following command can be used:"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:1623
- #, no-wrap
- msgid "make update-guix-package\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1630
- msgid "The @code{update-guix-package} make target will use the last known @emph{commit} corresponding to @code{HEAD} in your Guix checkout, compute the hash of the Guix sources corresponding to that commit and update the @code{commit}, @code{revision} and hash of the @code{guix} package definition."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1634
- msgid "To validate that the updated @code{guix} package hashes are correct and that it can be built successfully, the following command can be run from the directory of your Guix checkout:"
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:1637
- #, no-wrap
- msgid "./pre-inst-env guix build guix\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1642
- msgid "To guard against accidentally updating the @code{guix} package to a commit that others can't refer to, a check is made that the commit used has already been pushed to the Savannah-hosted Guix git repository."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1647
- msgid "This check can be disabled, @emph{at your own peril}, by setting the @code{GUIX_ALLOW_ME_TO_USE_PRIVATE_COMMIT} environment variable. When this variable is set, the updated package source is also added to the store. This is used as part of the release process of Guix."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:1648
- #, no-wrap
- msgid "translation"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:1649
- #, no-wrap
- msgid "l10n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:1650
- #, no-wrap
- msgid "i18n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/contributing.texi:1651
- #, no-wrap
- msgid "native language support"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1661
- msgid "Writing code and packages is not the only way to provide a meaningful contribution to Guix. Translating to a language you speak is another example of a valuable contribution you can make. This section is designed to describe the translation process. It gives you advice on how you can get involved, what can be translated, what mistakes you should avoid and what we can do to help you!"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1667
- msgid "Guix is a big project that has multiple components that can be translated. We coordinate the translation effort on a @uref{https://translate.fedoraproject.org/projects/guix/,Weblate instance} hosted by our friends at Fedora. You will need an account to submit translations."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1674
- msgid "Some of the software packaged in Guix also contain translations. We do not host a translation platform for them. If you want to translate a package provided by Guix, you should contact their developers or find the information on their website. As an example, you can find the homepage of the @code{hello} package by typing @code{guix show hello}. On the ``homepage'' line, you will see @url{https://www.gnu.org/software/hello/} as the homepage."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1679
- msgid "Many GNU and non-GNU packages can be translated on the @uref{https://translationproject.org,Translation Project}. Some projects with multiple components have their own platform. For instance, GNOME has its own platform, @uref{https://l10n.gnome.org/,Damned Lies}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1681
- msgid "Guix has five components hosted on Weblate."
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1683
- #, no-wrap
- msgid "@code{guix} contains all the strings from the Guix software (the"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/contributing.texi:1685
- msgid "guided system installer, the package manager, etc), excluding packages."
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1685
- #, no-wrap
- msgid "@code{packages} contains the synopsis (single-sentence description"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/contributing.texi:1687
- msgid "of a package) and description (longer description) of packages in Guix."
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1687
- #, no-wrap
- msgid "@code{website} contains the official Guix website, except for"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/contributing.texi:1689
- msgid "blog posts and multimedia content."
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1689
- #, no-wrap
- msgid "@code{documentation-manual} corresponds to this manual."
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1690
- #, no-wrap
- msgid "@code{documentation-cookbook} is the component for the cookbook."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/contributing.texi:1693
- #, no-wrap
- msgid "General Directions"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1701
- msgid "Once you get an account, you should be able to select a component from @uref{https://translate.fedoraproject.org/projects/guix/,the guix project}, and select a language. If your language does not appear in the list, go to the bottom and click on the ``Start new translation'' button. Select the language you want to translate to from the list, to start your new translation."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1706
- msgid "Like lots of other free software packages, Guix uses @uref{https://www.gnu.org/software/gettext,GNU Gettext} for its translations, with which translatable strings are extracted from the source code to so-called PO files."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1717
- msgid "Even though PO files are text files, changes should not be made with a text editor but with PO editing software. Weblate integrates PO editing functionality. Alternatively, translators can use any of various free-software tools for filling in translations, of which @uref{https://poedit.net/,Poedit} is one example, and (after logging in) @uref{https://docs.weblate.org/en/latest/user/files.html,upload} the changed file. There is also a special @uref{https://www.emacswiki.org/emacs/PoMode,PO editing mode} for users of GNU Emacs. Over time translators find out what software they are happy with and what features they need."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1722
- msgid "On Weblate, you will find various links to the editor, that will show various subsets (or all) of the strings. Have a look around and at the @uref{https://docs.weblate.org/en/latest/,documentation} to familiarize yourself with the platform."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/contributing.texi:1723
- #, no-wrap
- msgid "Translation Components"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1728
- msgid "In this section, we provide more detailed guidance on the translation process, as well as details on what you should or should not do. When in doubt, please contact us, we will be happy to help!"
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1730 guix-git/doc/guix.texi:9420
- #, no-wrap
- msgid "guix"
- msgstr ""
- #. type: table
- #: guix-git/doc/contributing.texi:1735
- msgid "Guix is written in the Guile programming language, and some strings contain special formatting that is interpreted by Guile. These special formatting should be highlighted by Weblate. They start with @code{~} followed by one or more characters."
- msgstr ""
- #. type: table
- #: guix-git/doc/contributing.texi:1744
- msgid "When printing the string, Guile replaces the special formatting symbols with actual values. For instance, the string @samp{ambiguous package specification `~a'} would be substituted to contain said package specification instead of @code{~a}. To properly translate this string, you must keep the formatting code in your translation, although you can place it where it makes sense in your language. For instance, the French translation says @samp{spécification du paquet « ~a » ambiguë} because the adjective needs to be placed in the end of the sentence."
- msgstr ""
- #. type: table
- #: guix-git/doc/contributing.texi:1748
- msgid "If there are multiple formatting symbols, make sure to respect the order. Guile does not know in which order you intended the string to be read, so it will substitute the symbols in the same order as the English sentence."
- msgstr ""
- #. type: table
- #: guix-git/doc/contributing.texi:1756
- msgid "As an example, you cannot translate @samp{package '~a' has been superseded by '~a'} by @samp{'~a' superseeds package '~a'}, because the meaning would be reversed. If @var{foo} is superseded by @var{bar}, the translation would read @samp{'foo' superseeds package 'bar'}. To work around this problem, it is possible to use more advanced formatting to select a given piece of data, instead of following the default English order. @xref{Formatted Output,,, guile, GNU Guile Reference Manual}, for more information on formatting in Guile."
- msgstr ""
- #. #-#-#-#-# contributing.pot (guix manual checkout) #-#-#-#-#
- #. type: item
- #. #-#-#-#-# guix.pot (guix manual checkout) #-#-#-#-#
- #. type: cindex
- #: guix-git/doc/contributing.texi:1757 guix-git/doc/guix.texi:2988
- #, no-wrap
- msgid "packages"
- msgstr ""
- #. type: table
- #: guix-git/doc/contributing.texi:1762
- msgid "Package descriptions occasionally contain Texinfo markup (@pxref{Synopses and Descriptions}). Texinfo markup looks like @samp{@@code@{rm -rf@}}, @samp{@@emph@{important@}}, etc. When translating, please leave markup as is."
- msgstr ""
- #. type: table
- #: guix-git/doc/contributing.texi:1771
- msgid "The characters after ``@@'' form the name of the markup, and the text between ``@{'' and ``@}'' is its content. In general, you should not translate the content of markup like @code{@@code}, as it contains literal code that do not change with language. You can translate the content of formatting markup such as @code{@@emph}, @code{@@i}, @code{@@itemize}, @code{@@item}. However, do not translate the name of the markup, or it will not be recognized. Do not translate the word after @code{@@end}, it is the name of the markup that is closed at this position (e.g.@: @code{@@itemize ... @@end itemize})."
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1772
- #, no-wrap
- msgid "documentation-manual and documentation-cookbook"
- msgstr ""
- #. type: table
- #: guix-git/doc/contributing.texi:1776
- msgid "The first step to ensure a successful translation of the manual is to find and translate the following strings @emph{first}:"
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1778
- #, no-wrap
- msgid "@code{version.texi}: Translate this string as @code{version-xx.texi},"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/contributing.texi:1781
- msgid "where @code{xx} is your language code (the one shown in the URL on weblate)."
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1781
- #, no-wrap
- msgid "@code{contributing.texi}: Translate this string as"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/contributing.texi:1783
- msgid "@code{contributing.xx.texi}, where @code{xx} is the same language code."
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1783
- #, no-wrap
- msgid "@code{Top}: Do not translate this string, it is important for Texinfo."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/contributing.texi:1786
- msgid "If you translate it, the document will be empty (missing a Top node). Please look for it, and register @code{Top} as its translation."
- msgstr ""
- #. type: table
- #: guix-git/doc/contributing.texi:1791
- msgid "Translating these strings first ensure we can include your translation in the guix repository without breaking the make process or the @command{guix pull} machinery."
- msgstr ""
- #. type: table
- #: guix-git/doc/contributing.texi:1798
- msgid "The manual and the cookbook both use Texinfo. As for @code{packages}, please keep Texinfo markup as is. There are more possible markup types in the manual than in the package descriptions. In general, do not translate the content of @code{@@code}, @code{@@file}, @code{@@var}, @code{@@value}, etc. You should translate the content of formatting markup such as @code{@@emph}, @code{@@i}, etc."
- msgstr ""
- #. type: table
- #: guix-git/doc/contributing.texi:1806
- msgid "The manual contains sections that can be referred to by name by @code{@@ref}, @code{@@xref} and @code{@@pxref}. We have a mechanism in place so you do not have to translate their content. If you keep the English title, we will automatically replace it with your translation of that title. This ensures that Texinfo will always be able to find the node. If you decide to change the translation of the title, the references will automatically be updated and you will not have to update them all yourself."
- msgstr ""
- #. type: table
- #: guix-git/doc/contributing.texi:1816
- msgid "When translating references from the cookbook to the manual, you need to replace the name of the manual and the name of the section. For instance, to translate @code{@@pxref@{Defining Packages,,, guix, GNU Guix Reference Manual@}}, you would replace @code{Defining Packages} with the title of that section in the translated manual @emph{only} if that title is translated. If the title is not translated in your language yet, do not translate it here, or the link will be broken. Replace @code{guix} with @code{guix.xx} where @code{xx} is your language code. @code{GNU Guix Reference Manual} is the text of the link. You can translate it however you wish."
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1817
- #, no-wrap
- msgid "website"
- msgstr ""
- #. type: table
- #: guix-git/doc/contributing.texi:1824
- msgid "The website pages are written using SXML, an s-expression version of HTML, the basic language of the web. We have a process to extract translatable strings from the source, and replace complex s-expressions with a more familiar XML markup, where each markup is numbered. Translators can arbitrarily change the ordering, as in the following example."
- msgstr ""
- #. type: example
- #: guix-git/doc/contributing.texi:1831
- #, no-wrap
- msgid ""
- "#. TRANSLATORS: Defining Packages is a section name\n"
- "#. in the English (en) manual.\n"
- "#: apps/base/templates/about.scm:64\n"
- "msgid \"Packages are <1>defined<1.1>en</1.1><1.2>Defining-Packages.html</1.2></1> as native <2>Guile</2> modules.\"\n"
- "msgstr \"Pakete werden als reine <2>Guile</2>-Module <1>definiert<1.1>de</1.1><1.2>Pakete-definieren.html</1.2></1>.\"\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/contributing.texi:1834
- msgid "Note that you need to include the same markups. You cannot skip any."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1842
- msgid "In case you make a mistake, the component might fail to build properly with your language, or even make guix pull fail. To prevent that, we have a process in place to check the content of the files before pushing to our repository. We will not be able to update the translation for your language in Guix, so we will notify you (through weblate and/or by email) so you get a chance to fix the issue."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/contributing.texi:1843
- #, no-wrap
- msgid "Outside of Weblate"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1846
- msgid "Currently, some parts of Guix cannot be translated on Weblate, help wanted!"
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1848
- #, no-wrap
- msgid "@command{guix pull} news can be translated in @file{news.scm}, but is not"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/contributing.texi:1854
- msgid "available from Weblate. If you want to provide a translation, you can prepare a patch as described above, or simply send us your translation with the name of the news entry you translated and your language. @xref{Writing Channel News}, for more information about channel news."
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1854
- #, no-wrap
- msgid "Guix blog posts cannot currently be translated."
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1855
- #, no-wrap
- msgid "The installer script (for foreign distributions) is entirely in English."
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1856
- #, no-wrap
- msgid "Some of the libraries Guix uses cannot be translated or are translated"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/contributing.texi:1858
- msgid "outside of the Guix project. Guile itself is not internationalized."
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1858
- #, no-wrap
- msgid "Other manuals linked from this manual or the cookbook might not be"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/contributing.texi:1860
- msgid "translated."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/contributing.texi:1862
- #, no-wrap
- msgid "Translation Infrastructure"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1873
- msgid "Weblate is backed by a git repository from which it discovers new strings to translate and pushes new and updated translations. Normally, it would be enough to give it commit access to our repositories. However, we decided to use a separate repository for two reasons. First, we would have to give Weblate commit access and authorize its signing key, but we do not trust it in the same way we trust guix developers, especially since we do not manage the instance ourselves. Second, if translators mess something up, it can break the generation of the website and/or guix pull for all our users, independently of their language."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1877
- msgid "For these reasons, we use a dedicated repository to host translations, and we synchronize it with our guix and artworks repositories after checking no issue was introduced in the translation."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1883
- msgid "Developers can download the latest PO files from weblate in the Guix repository by running the @command{make download-po} command. It will automatically download the latest files from weblate, reformat them to a canonical form, and check they do not contain issues. The manual needs to be built again to check for additional issues that might crash Texinfo."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/contributing.texi:1887
- msgid "Before pushing new translation files, developers should add them to the make machinery so the translations are actually available. The process differs for the various components."
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1889
- #, no-wrap
- msgid "New po files for the @code{guix} and @code{packages} components must"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/contributing.texi:1892
- msgid "be registered by adding the new language to @file{po/guix/LINGUAS} or @file{po/packages/LINGUAS}."
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1892
- #, no-wrap
- msgid "New po files for the @code{documentation-manual} component must be"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/contributing.texi:1898
- msgid "registered by adding the file name to @code{DOC_PO_FILES} in @file{po/doc/local.mk}, the generated @file{%D%/guix.xx.texi} manual to @code{info_TEXINFOS} in @file{doc/local.mk} and the generated @file{%D%/guix.xx.texi} and @file{%D%/contributing.xx.texi} to @code{TRANSLATED_INFO} also in @file{doc/local.mk}."
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1898
- #, no-wrap
- msgid "New po files for the @code{documentation-cookbook} component must be"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/contributing.texi:1904
- msgid "registered by adding the file name to @code{DOC_COOKBOOK_PO_FILES} in @file{po/doc/local.mk}, the generated @file{%D%/guix-cookbook.xx.texi} manual to @code{info_TEXINFOS} in @file{doc/local.mk} and the generated @file{%D%/guix-cookbook.xx.texi} to @code{TRANSLATED_INFO} also in @file{doc/local.mk}."
- msgstr ""
- #. type: item
- #: guix-git/doc/contributing.texi:1904
- #, no-wrap
- msgid "New po files for the @code{website} component must be added to the"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/contributing.texi:1909
- msgid "@code{guix-artwork} repository, in @file{website/po/}. @file{website/po/LINGUAS} and @file{website/po/ietf-tags.scm} must be updated accordingly (see @file{website/i18n-howto.txt} for more information on the process)."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7
- msgid "@documentencoding UTF-8"
- msgstr ""
- #. type: title
- #: guix-git/doc/guix.texi:7 guix-git/doc/guix.texi:131
- #, no-wrap
- msgid "GNU Guix Reference Manual"
- msgstr ""
- #. type: include
- #: guix-git/doc/guix.texi:10
- #, no-wrap
- msgid "version.texi"
- msgstr "version-fa.texi"
- #. type: copying
- #: guix-git/doc/guix.texi:103
- msgid "Copyright @copyright{} 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021 Ludovic Courtès@* Copyright @copyright{} 2013, 2014, 2016 Andreas Enge@* Copyright @copyright{} 2013 Nikita Karetnikov@* Copyright @copyright{} 2014, 2015, 2016 Alex Kost@* Copyright @copyright{} 2015, 2016 Mathieu Lirzin@* Copyright @copyright{} 2014 Pierre-Antoine Rault@* Copyright @copyright{} 2015 Taylan Ulrich Bayırlı/Kammer@* Copyright @copyright{} 2015, 2016, 2017, 2019, 2020, 2021 Leo Famulari@* Copyright @copyright{} 2015, 2016, 2017, 2018, 2019, 2020, 2021 Ricardo Wurmus@* Copyright @copyright{} 2016 Ben Woodcroft@* Copyright @copyright{} 2016, 2017, 2018, 2021 Chris Marusich@* Copyright @copyright{} 2016, 2017, 2018, 2019, 2020, 2021 Efraim Flashner@* Copyright @copyright{} 2016 John Darrington@* Copyright @copyright{} 2016, 2017 Nikita Gillmann@* Copyright @copyright{} 2016, 2017, 2018, 2019, 2020 Jan Nieuwenhuizen@* Copyright @copyright{} 2016, 2017, 2018, 2019, 2020, 2021 Julien Lepiller@* Copyright @copyright{} 2016 Alex ter Weele@* Copyright @copyright{} 2016, 2017, 2018, 2019, 2020, 2021 Christopher Baines@* Copyright @copyright{} 2017, 2018, 2019 Clément Lassieur@* Copyright @copyright{} 2017, 2018, 2020, 2021 Mathieu Othacehe@* Copyright @copyright{} 2017 Federico Beffa@* Copyright @copyright{} 2017, 2018 Carlo Zancanaro@* Copyright @copyright{} 2017 Thomas Danckaert@* Copyright @copyright{} 2017 humanitiesNerd@* Copyright @copyright{} 2017, 2021 Christine Lemmer-Webber@* Copyright @copyright{} 2017, 2018, 2019, 2020, 2021 Marius Bakke@* Copyright @copyright{} 2017, 2019, 2020 Hartmut Goebel@* Copyright @copyright{} 2017, 2019, 2020, 2021 Maxim Cournoyer@* Copyright @copyright{} 2017–2022 Tobias Geerinckx-Rice@* Copyright @copyright{} 2017 George Clemmer@* Copyright @copyright{} 2017 Andy Wingo@* Copyright @copyright{} 2017, 2018, 2019, 2020 Arun Isaac@* Copyright @copyright{} 2017 nee@* Copyright @copyright{} 2018 Rutger Helling@* Copyright @copyright{} 2018, 2021 Oleg Pykhalov@* Copyright @copyright{} 2018 Mike Gerwitz@* Copyright @copyright{} 2018 Pierre-Antoine Rouby@* Copyright @copyright{} 2018, 2019 Gábor Boskovits@* Copyright @copyright{} 2018, 2019, 2020 Florian Pelz@* Copyright @copyright{} 2018 Laura Lazzati@* Copyright @copyright{} 2018 Alex Vong@* Copyright @copyright{} 2019 Josh Holland@* Copyright @copyright{} 2019, 2020 Diego Nicola Barbato@* Copyright @copyright{} 2019 Ivan Petkov@* Copyright @copyright{} 2019 Jakob L. Kreuze@* Copyright @copyright{} 2019 Kyle Andrews@* Copyright @copyright{} 2019 Alex Griffin@* Copyright @copyright{} 2019, 2020, 2021 Guillaume Le Vaillant@* Copyright @copyright{} 2020 Liliana Marie Prikler@* Copyright @copyright{} 2019, 2020, 2021 Simon Tournier@* Copyright @copyright{} 2020 Wiktor Żelazny@* Copyright @copyright{} 2020 Damien Cassou@* Copyright @copyright{} 2020 Jakub Kądziołka@* Copyright @copyright{} 2020 Jack Hill@* Copyright @copyright{} 2020 Naga Malleswari@* Copyright @copyright{} 2020, 2021 Brice Waegeneire@* Copyright @copyright{} 2020 R Veera Kumar@* Copyright @copyright{} 2020, 2021 Pierre Langlois@* Copyright @copyright{} 2020 pinoaffe@* Copyright @copyright{} 2020 André Batista@* Copyright @copyright{} 2020, 2021 Alexandru-Sergiu Marton@* Copyright @copyright{} 2020 raingloom@* Copyright @copyright{} 2020 Daniel Brooks@* Copyright @copyright{} 2020 John Soo@* Copyright @copyright{} 2020 Jonathan Brielmaier@* Copyright @copyright{} 2020 Edgar Vincent@* Copyright @copyright{} 2021 Maxime Devos@* Copyright @copyright{} 2021 B. Wilson@* Copyright @copyright{} 2021 Xinglu Chen@* Copyright @copyright{} 2021 Raghav Gururajan@* Copyright @copyright{} 2021 Domagoj Stolfa@* Copyright @copyright{} 2021 Hui Lu@* Copyright @copyright{} 2021 pukkamustard@* Copyright @copyright{} 2021 Alice Brenon@* Copyright @copyright{} 2021 Josselin Poiret@* Copyright @copyright{} 2021 Andrew Tropin@* Copyright @copyright{} 2021 Sarah Morgensen@* Copyright @copyright{} 2021 Josselin Poiret@*"
- msgstr ""
- #. type: copying
- #: guix-git/doc/guix.texi:110
- msgid "Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled ``GNU Free Documentation License''."
- msgstr ""
- #. type: dircategory
- #: guix-git/doc/guix.texi:112
- #, no-wrap
- msgid "System administration"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:120
- msgid "Guix: (guix)"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:120
- msgid "Manage installed software and system configuration."
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:120
- msgid "guix package: (guix)Invoking guix package"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:120
- msgid "Installing, removing, and upgrading packages."
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:120
- msgid "guix gc: (guix)Invoking guix gc"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:120
- msgid "Reclaiming unused disk space."
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:120
- msgid "guix pull: (guix)Invoking guix pull"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:120
- msgid "Update the list of available packages."
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:120
- msgid "guix system: (guix)Invoking guix system"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:120
- msgid "Manage the operating system configuration."
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:120
- msgid "guix deploy: (guix)Invoking guix deploy"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:120
- msgid "Manage operating system configurations for remote hosts."
- msgstr ""
- #. type: dircategory
- #: guix-git/doc/guix.texi:122
- #, no-wrap
- msgid "Software development"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:128
- msgid "guix shell: (guix)Invoking guix shell"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:128
- msgid "Creating software environments."
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:128
- msgid "guix environment: (guix)Invoking guix environment"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:128
- msgid "Building development environments with Guix."
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:128
- msgid "guix build: (guix)Invoking guix build"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:128
- msgid "Building packages."
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:128
- msgid "guix pack: (guix)Invoking guix pack"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:128
- msgid "Creating binary bundles."
- msgstr ""
- #. type: subtitle
- #: guix-git/doc/guix.texi:132
- #, no-wrap
- msgid "Using the GNU Guix Functional Package Manager"
- msgstr ""
- #. type: author
- #: guix-git/doc/guix.texi:133
- #, no-wrap
- msgid "The GNU Guix Developers"
- msgstr ""
- #. type: titlepage
- #: guix-git/doc/guix.texi:139
- msgid "Edition @value{EDITION} @* @value{UPDATED} @*"
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:146
- #, no-wrap
- msgid "Top"
- msgstr ""
- #. type: top
- #: guix-git/doc/guix.texi:147
- #, no-wrap
- msgid "GNU Guix"
- msgstr "گیکسِ گنو"
- #. type: Plain text
- #: guix-git/doc/guix.texi:151
- msgid "This document describes GNU Guix version @value{VERSION}, a functional package management tool written for the GNU system."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:163
- msgid "This manual is also available in Simplified Chinese (@pxref{Top,,, guix.zh_CN, GNU Guix参考手册}), French (@pxref{Top,,, guix.fr, Manuel de référence de GNU Guix}), German (@pxref{Top,,, guix.de, Referenzhandbuch zu GNU Guix}), Spanish (@pxref{Top,,, guix.es, Manual de referencia de GNU Guix}), and Russian (@pxref{Top,,, guix.ru, Руководство GNU Guix}). If you would like to translate it in your native language, consider joining @uref{https://translate.fedoraproject.org/projects/guix/documentation-manual, Weblate} (@pxref{Translating Guix})."
- msgstr ""
- #. type: chapter
- #: guix-git/doc/guix.texi:182 guix-git/doc/guix.texi:192
- #: guix-git/doc/guix.texi:402 guix-git/doc/guix.texi:403
- #, no-wrap
- msgid "Introduction"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:182
- msgid "What is Guix about?"
- msgstr ""
- #. type: chapter
- #: guix-git/doc/guix.texi:182 guix-git/doc/guix.texi:197
- #: guix-git/doc/guix.texi:589 guix-git/doc/guix.texi:590
- #, no-wrap
- msgid "Installation"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:182
- msgid "Installing Guix."
- msgstr ""
- #. type: chapter
- #: guix-git/doc/guix.texi:182 guix-git/doc/guix.texi:213
- #: guix-git/doc/guix.texi:2049 guix-git/doc/guix.texi:2050
- #, no-wrap
- msgid "System Installation"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:182
- msgid "Installing the whole operating system."
- msgstr ""
- #. type: chapter
- #: guix-git/doc/guix.texi:182 guix-git/doc/guix.texi:2777
- #: guix-git/doc/guix.texi:2778
- #, no-wrap
- msgid "Getting Started"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:182
- msgid "Your first steps."
- msgstr ""
- #. type: chapter
- #: guix-git/doc/guix.texi:182 guix-git/doc/guix.texi:230
- #: guix-git/doc/guix.texi:2985 guix-git/doc/guix.texi:2986
- #, no-wrap
- msgid "Package Management"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:182
- msgid "Package installation, upgrade, etc."
- msgstr ""
- #. type: chapter
- #: guix-git/doc/guix.texi:182 guix-git/doc/guix.texi:253
- #: guix-git/doc/guix.texi:5053 guix-git/doc/guix.texi:5054
- #, no-wrap
- msgid "Channels"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:182
- msgid "Customizing the package collection."
- msgstr ""
- #. type: chapter
- #: guix-git/doc/guix.texi:182 guix-git/doc/guix.texi:267
- #: guix-git/doc/guix.texi:5581 guix-git/doc/guix.texi:5582
- #, no-wrap
- msgid "Development"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:182
- msgid "Guix-aided software development."
- msgstr ""
- #. type: chapter
- #: guix-git/doc/guix.texi:182 guix-git/doc/guix.texi:275
- #: guix-git/doc/guix.texi:6799 guix-git/doc/guix.texi:6800
- #, no-wrap
- msgid "Programming Interface"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:182
- msgid "Using Guix in Scheme."
- msgstr ""
- #. type: chapter
- #: guix-git/doc/guix.texi:182 guix-git/doc/guix.texi:294
- #: guix-git/doc/guix.texi:10774 guix-git/doc/guix.texi:10775
- #, no-wrap
- msgid "Utilities"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:182
- msgid "Package management commands."
- msgstr ""
- #. type: chapter
- #: guix-git/doc/guix.texi:182 guix-git/doc/guix.texi:320
- #: guix-git/doc/guix.texi:14278 guix-git/doc/guix.texi:14279
- #, no-wrap
- msgid "System Configuration"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:182
- msgid "Configuring the operating system."
- msgstr ""
- #. type: chapter
- #: guix-git/doc/guix.texi:182 guix-git/doc/guix.texi:36881
- #: guix-git/doc/guix.texi:36882
- #, no-wrap
- msgid "Home Configuration"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:182
- msgid "Configuring the home environment."
- msgstr ""
- #. type: chapter
- #: guix-git/doc/guix.texi:182 guix-git/doc/guix.texi:37721
- #: guix-git/doc/guix.texi:37722
- #, no-wrap
- msgid "Documentation"
- msgstr "مستندات"
- #. type: menuentry
- #: guix-git/doc/guix.texi:182
- msgid "Browsing software user manuals."
- msgstr ""
- #. type: chapter
- #: guix-git/doc/guix.texi:182 guix-git/doc/guix.texi:389
- #: guix-git/doc/guix.texi:37787 guix-git/doc/guix.texi:37788
- #, no-wrap
- msgid "Installing Debugging Files"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:182
- msgid "Feeding the debugger."
- msgstr ""
- #. type: chapter
- #: guix-git/doc/guix.texi:182 guix-git/doc/guix.texi:37942
- #: guix-git/doc/guix.texi:37943
- #, no-wrap
- msgid "Security Updates"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:182
- msgid "Deploying security fixes quickly."
- msgstr ""
- #. type: chapter
- #: guix-git/doc/guix.texi:182 guix-git/doc/guix.texi:394
- #: guix-git/doc/guix.texi:38057 guix-git/doc/guix.texi:38058
- #, no-wrap
- msgid "Bootstrapping"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:182
- msgid "GNU/Linux built from scratch."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:182 guix-git/doc/guix.texi:38349
- #, no-wrap
- msgid "Porting"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:182
- msgid "Targeting another platform or kernel."
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:182
- msgid "Your help needed!"
- msgstr ""
- #. type: chapter
- #: guix-git/doc/guix.texi:187 guix-git/doc/guix.texi:38397
- #: guix-git/doc/guix.texi:38398
- #, no-wrap
- msgid "Acknowledgments"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:187
- msgid "Thanks!"
- msgstr "سپاس!"
- #. type: appendix
- #: guix-git/doc/guix.texi:187 guix-git/doc/guix.texi:38419
- #: guix-git/doc/guix.texi:38420
- #, no-wrap
- msgid "GNU Free Documentation License"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:187
- msgid "The license of this manual."
- msgstr ""
- #. type: unnumbered
- #: guix-git/doc/guix.texi:187 guix-git/doc/guix.texi:38425
- #: guix-git/doc/guix.texi:38426
- #, no-wrap
- msgid "Concept Index"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:187
- msgid "Concepts."
- msgstr ""
- #. type: unnumbered
- #: guix-git/doc/guix.texi:187 guix-git/doc/guix.texi:38429
- #: guix-git/doc/guix.texi:38430
- #, no-wrap
- msgid "Programming Index"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:187
- msgid "Data types, functions, and variables."
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:190
- msgid "--- The Detailed Node Listing ---"
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:195 guix-git/doc/guix.texi:429
- #: guix-git/doc/guix.texi:431 guix-git/doc/guix.texi:432
- #, no-wrap
- msgid "Managing Software the Guix Way"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:195 guix-git/doc/guix.texi:429
- msgid "What's special."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:195 guix-git/doc/guix.texi:429
- #: guix-git/doc/guix.texi:486 guix-git/doc/guix.texi:487
- #, no-wrap
- msgid "GNU Distribution"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:195 guix-git/doc/guix.texi:429
- msgid "The packages and tools."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:205 guix-git/doc/guix.texi:629
- #: guix-git/doc/guix.texi:631 guix-git/doc/guix.texi:632
- #, no-wrap
- msgid "Binary Installation"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:205 guix-git/doc/guix.texi:629
- msgid "Getting Guix running in no time!"
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:205 guix-git/doc/guix.texi:629
- #: guix-git/doc/guix.texi:871 guix-git/doc/guix.texi:872
- #, no-wrap
- msgid "Requirements"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:205 guix-git/doc/guix.texi:629
- msgid "Software needed to build and run Guix."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:205 guix-git/doc/guix.texi:629
- #: guix-git/doc/guix.texi:957 guix-git/doc/guix.texi:958
- #, no-wrap
- msgid "Running the Test Suite"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:205 guix-git/doc/guix.texi:629
- msgid "Testing Guix."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:205 guix-git/doc/guix.texi:207
- #: guix-git/doc/guix.texi:629 guix-git/doc/guix.texi:1054
- #: guix-git/doc/guix.texi:1055
- #, no-wrap
- msgid "Setting Up the Daemon"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:205 guix-git/doc/guix.texi:629
- msgid "Preparing the build daemon's environment."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:205 guix-git/doc/guix.texi:629
- #: guix-git/doc/guix.texi:1525
- #, no-wrap
- msgid "Invoking guix-daemon"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:205 guix-git/doc/guix.texi:629
- msgid "Running the build daemon."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:205 guix-git/doc/guix.texi:629
- #: guix-git/doc/guix.texi:1827 guix-git/doc/guix.texi:1828
- #, no-wrap
- msgid "Application Setup"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:205 guix-git/doc/guix.texi:629
- msgid "Application-specific setup."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:205 guix-git/doc/guix.texi:629
- #: guix-git/doc/guix.texi:2012 guix-git/doc/guix.texi:2013
- #, no-wrap
- msgid "Upgrading Guix"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:205 guix-git/doc/guix.texi:629
- msgid "Upgrading Guix and its build daemon."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:211 guix-git/doc/guix.texi:1074
- #: guix-git/doc/guix.texi:1076 guix-git/doc/guix.texi:1077
- #, no-wrap
- msgid "Build Environment Setup"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:211 guix-git/doc/guix.texi:1074
- msgid "Preparing the isolated build environment."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:211 guix-git/doc/guix.texi:1074
- #: guix-git/doc/guix.texi:1195
- #, no-wrap
- msgid "Daemon Offload Setup"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:211 guix-git/doc/guix.texi:1074
- msgid "Offloading builds to remote machines."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:211 guix-git/doc/guix.texi:1074
- #: guix-git/doc/guix.texi:1434 guix-git/doc/guix.texi:1435
- #, no-wrap
- msgid "SELinux Support"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:211 guix-git/doc/guix.texi:1074
- msgid "Using an SELinux policy for the daemon."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:223 guix-git/doc/guix.texi:1470
- #: guix-git/doc/guix.texi:2083 guix-git/doc/guix.texi:2085
- #: guix-git/doc/guix.texi:2086
- #, no-wrap
- msgid "Limitations"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:223 guix-git/doc/guix.texi:2083
- msgid "What you can expect."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:223 guix-git/doc/guix.texi:2083
- #: guix-git/doc/guix.texi:2111 guix-git/doc/guix.texi:2112
- #, no-wrap
- msgid "Hardware Considerations"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:223 guix-git/doc/guix.texi:2083
- msgid "Supported hardware."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:223 guix-git/doc/guix.texi:2083
- #: guix-git/doc/guix.texi:2146 guix-git/doc/guix.texi:2147
- #, no-wrap
- msgid "USB Stick and DVD Installation"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:223 guix-git/doc/guix.texi:2083
- msgid "Preparing the installation medium."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:223 guix-git/doc/guix.texi:2083
- #: guix-git/doc/guix.texi:2227 guix-git/doc/guix.texi:2228
- #, no-wrap
- msgid "Preparing for Installation"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:223 guix-git/doc/guix.texi:2083
- msgid "Networking, partitioning, etc."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:223 guix-git/doc/guix.texi:2083
- #: guix-git/doc/guix.texi:2250 guix-git/doc/guix.texi:2251
- #, no-wrap
- msgid "Guided Graphical Installation"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:223 guix-git/doc/guix.texi:2083
- msgid "Easy graphical installation."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:223 guix-git/doc/guix.texi:225
- #: guix-git/doc/guix.texi:2083 guix-git/doc/guix.texi:2281
- #: guix-git/doc/guix.texi:2282
- #, no-wrap
- msgid "Manual Installation"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:223 guix-git/doc/guix.texi:2083
- msgid "Manual installation for wizards."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:223 guix-git/doc/guix.texi:2083
- #: guix-git/doc/guix.texi:2660 guix-git/doc/guix.texi:2661
- #, no-wrap
- msgid "After System Installation"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:223 guix-git/doc/guix.texi:2083
- msgid "When installation succeeded."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:223 guix-git/doc/guix.texi:2083
- #: guix-git/doc/guix.texi:2694
- #, no-wrap
- msgid "Installing Guix in a VM"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:223 guix-git/doc/guix.texi:2083
- msgid "Guix System playground."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:223 guix-git/doc/guix.texi:2083
- #: guix-git/doc/guix.texi:2745 guix-git/doc/guix.texi:2746
- #, no-wrap
- msgid "Building the Installation Image"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:223 guix-git/doc/guix.texi:2083
- msgid "How this comes to be."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:228 guix-git/doc/guix.texi:2299
- #: guix-git/doc/guix.texi:2301
- #, no-wrap
- msgid "Keyboard Layout and Networking and Partitioning"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:228 guix-git/doc/guix.texi:2299
- msgid "Initial setup."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:228 guix-git/doc/guix.texi:2299
- #: guix-git/doc/guix.texi:2571 guix-git/doc/guix.texi:2572
- #, no-wrap
- msgid "Proceeding with the Installation"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:228 guix-git/doc/guix.texi:2299
- msgid "Installing."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:241 guix-git/doc/guix.texi:3017
- #: guix-git/doc/guix.texi:3019 guix-git/doc/guix.texi:3020
- #, no-wrap
- msgid "Features"
- msgstr "ویژگیها"
- #. type: menuentry
- #: guix-git/doc/guix.texi:241 guix-git/doc/guix.texi:3017
- msgid "How Guix will make your life brighter."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:241 guix-git/doc/guix.texi:3017
- #: guix-git/doc/guix.texi:3109
- #, no-wrap
- msgid "Invoking guix package"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:241 guix-git/doc/guix.texi:3017
- msgid "Package installation, removal, etc."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:241 guix-git/doc/guix.texi:243
- #: guix-git/doc/guix.texi:3017 guix-git/doc/guix.texi:3738
- #: guix-git/doc/guix.texi:3739
- #, no-wrap
- msgid "Substitutes"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:241 guix-git/doc/guix.texi:3017
- msgid "Downloading pre-built binaries."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:241 guix-git/doc/guix.texi:3017
- #: guix-git/doc/guix.texi:4074 guix-git/doc/guix.texi:4075
- #, no-wrap
- msgid "Packages with Multiple Outputs"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:241 guix-git/doc/guix.texi:3017
- msgid "Single source package, multiple outputs."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:241 guix-git/doc/guix.texi:3017
- #: guix-git/doc/guix.texi:4128
- #, no-wrap
- msgid "Invoking guix gc"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:241 guix-git/doc/guix.texi:3017
- msgid "Running the garbage collector."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:241 guix-git/doc/guix.texi:3017
- #: guix-git/doc/guix.texi:4338
- #, no-wrap
- msgid "Invoking guix pull"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:241 guix-git/doc/guix.texi:3017
- msgid "Fetching the latest Guix and distribution."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:241 guix-git/doc/guix.texi:3017
- #: guix-git/doc/guix.texi:4585
- #, no-wrap
- msgid "Invoking guix time-machine"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:241 guix-git/doc/guix.texi:3017
- msgid "Running an older revision of Guix."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:241 guix-git/doc/guix.texi:3017
- #: guix-git/doc/guix.texi:4640 guix-git/doc/guix.texi:4641
- #, no-wrap
- msgid "Inferiors"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:241 guix-git/doc/guix.texi:3017
- msgid "Interacting with another revision of Guix."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:241 guix-git/doc/guix.texi:3017
- #: guix-git/doc/guix.texi:4768
- #, no-wrap
- msgid "Invoking guix describe"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:241 guix-git/doc/guix.texi:3017
- msgid "Display information about your Guix revision."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:241 guix-git/doc/guix.texi:3017
- #: guix-git/doc/guix.texi:4863
- #, no-wrap
- msgid "Invoking guix archive"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:241 guix-git/doc/guix.texi:3017
- msgid "Exporting and importing store files."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:3762
- #: guix-git/doc/guix.texi:3764 guix-git/doc/guix.texi:3765
- #, no-wrap
- msgid "Official Substitute Servers"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:3762
- msgid "One particular source of substitutes."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:3762
- #: guix-git/doc/guix.texi:3794 guix-git/doc/guix.texi:3795
- #, no-wrap
- msgid "Substitute Server Authorization"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:3762
- msgid "How to enable or disable substitutes."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:3762
- #: guix-git/doc/guix.texi:3864 guix-git/doc/guix.texi:3865
- #, no-wrap
- msgid "Getting Substitutes from Other Servers"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:3762
- msgid "Substitute diversity."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:3762
- #: guix-git/doc/guix.texi:3969 guix-git/doc/guix.texi:3970
- #, no-wrap
- msgid "Substitute Authentication"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:3762
- msgid "How Guix verifies substitutes."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:3762
- #: guix-git/doc/guix.texi:4004 guix-git/doc/guix.texi:4005
- #, no-wrap
- msgid "Proxy Settings"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:3762
- msgid "How to get substitutes via proxy."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:3762
- #: guix-git/doc/guix.texi:4016 guix-git/doc/guix.texi:4017
- #, no-wrap
- msgid "Substitution Failure"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:3762
- msgid "What happens when substitution fails."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:3762
- #: guix-git/doc/guix.texi:4044 guix-git/doc/guix.texi:4045
- #, no-wrap
- msgid "On Trusting Binaries"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:3762
- msgid "How can you trust that binary blob?"
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:265 guix-git/doc/guix.texi:5084
- #: guix-git/doc/guix.texi:5086 guix-git/doc/guix.texi:5087
- #, no-wrap
- msgid "Specifying Additional Channels"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:265 guix-git/doc/guix.texi:5084
- msgid "Extending the package collection."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:265 guix-git/doc/guix.texi:5084
- #: guix-git/doc/guix.texi:5136 guix-git/doc/guix.texi:5137
- #, no-wrap
- msgid "Using a Custom Guix Channel"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:265 guix-git/doc/guix.texi:5084
- msgid "Using a customized Guix."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:265 guix-git/doc/guix.texi:5084
- #: guix-git/doc/guix.texi:5158 guix-git/doc/guix.texi:5159
- #, no-wrap
- msgid "Replicating Guix"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:265 guix-git/doc/guix.texi:5084
- msgid "Running the @emph{exact same} Guix."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:265 guix-git/doc/guix.texi:5084
- #: guix-git/doc/guix.texi:5199 guix-git/doc/guix.texi:5200
- #, no-wrap
- msgid "Channel Authentication"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:265 guix-git/doc/guix.texi:5084
- msgid "How Guix verifies what it fetches."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:265 guix-git/doc/guix.texi:5084
- #: guix-git/doc/guix.texi:5239 guix-git/doc/guix.texi:5240
- #, no-wrap
- msgid "Channels with Substitutes"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:265 guix-git/doc/guix.texi:5084
- msgid "Using channels with available substitutes."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:265 guix-git/doc/guix.texi:5084
- #: guix-git/doc/guix.texi:5264 guix-git/doc/guix.texi:5265
- #, no-wrap
- msgid "Creating a Channel"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:265 guix-git/doc/guix.texi:5084
- msgid "How to write your custom channel."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:265 guix-git/doc/guix.texi:5084
- #: guix-git/doc/guix.texi:5331 guix-git/doc/guix.texi:5332
- #, no-wrap
- msgid "Package Modules in a Sub-directory"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:265 guix-git/doc/guix.texi:5084
- msgid "Specifying the channel's package modules location."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:265 guix-git/doc/guix.texi:5084
- #: guix-git/doc/guix.texi:5345 guix-git/doc/guix.texi:5346
- #, no-wrap
- msgid "Declaring Channel Dependencies"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:265 guix-git/doc/guix.texi:5084
- msgid "How to depend on other channels."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:265 guix-git/doc/guix.texi:5084
- #: guix-git/doc/guix.texi:5387 guix-git/doc/guix.texi:5388
- #, no-wrap
- msgid "Specifying Channel Authorizations"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:265 guix-git/doc/guix.texi:5084
- msgid "Defining channel authors authorizations."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:265 guix-git/doc/guix.texi:5084
- #: guix-git/doc/guix.texi:5488 guix-git/doc/guix.texi:5489
- #, no-wrap
- msgid "Primary URL"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:265 guix-git/doc/guix.texi:5084
- msgid "Distinguishing mirror to original."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:265 guix-git/doc/guix.texi:5084
- #: guix-git/doc/guix.texi:5511 guix-git/doc/guix.texi:5512
- #, no-wrap
- msgid "Writing Channel News"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:265 guix-git/doc/guix.texi:5084
- msgid "Communicating information to channel's users."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:273 guix-git/doc/guix.texi:5601
- #: guix-git/doc/guix.texi:5603
- #, no-wrap
- msgid "Invoking guix shell"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:273 guix-git/doc/guix.texi:5601
- msgid "Spawning one-off software environments."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:273 guix-git/doc/guix.texi:5601
- #: guix-git/doc/guix.texi:5956
- #, no-wrap
- msgid "Invoking guix environment"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:273 guix-git/doc/guix.texi:5601
- msgid "Setting up development environments."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:273 guix-git/doc/guix.texi:5601
- #: guix-git/doc/guix.texi:6325
- #, no-wrap
- msgid "Invoking guix pack"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:273 guix-git/doc/guix.texi:5601
- msgid "Creating software bundles."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:273 guix-git/doc/guix.texi:5601
- #: guix-git/doc/guix.texi:6711 guix-git/doc/guix.texi:6712
- #, no-wrap
- msgid "The GCC toolchain"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:273 guix-git/doc/guix.texi:5601
- msgid "Working with languages supported by GCC."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:273 guix-git/doc/guix.texi:5601
- #: guix-git/doc/guix.texi:6737
- #, no-wrap
- msgid "Invoking guix git authenticate"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:273 guix-git/doc/guix.texi:5601
- msgid "Authenticating Git repositories."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:287 guix-git/doc/guix.texi:6839
- #: guix-git/doc/guix.texi:6841 guix-git/doc/guix.texi:6842
- #, no-wrap
- msgid "Package Modules"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:287 guix-git/doc/guix.texi:6839
- msgid "Packages from the programmer's viewpoint."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:287 guix-git/doc/guix.texi:289
- #: guix-git/doc/guix.texi:6839 guix-git/doc/guix.texi:6903
- #: guix-git/doc/guix.texi:6904
- #, no-wrap
- msgid "Defining Packages"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:287 guix-git/doc/guix.texi:6839
- msgid "Defining new packages."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:287 guix-git/doc/guix.texi:6839
- #: guix-git/doc/guix.texi:7554 guix-git/doc/guix.texi:7555
- #, no-wrap
- msgid "Defining Package Variants"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:287 guix-git/doc/guix.texi:6839
- msgid "Customizing packages."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:287 guix-git/doc/guix.texi:6839
- #: guix-git/doc/guix.texi:7821 guix-git/doc/guix.texi:7822
- #, no-wrap
- msgid "Build Systems"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:287 guix-git/doc/guix.texi:6839
- msgid "Specifying how packages are built."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:287 guix-git/doc/guix.texi:6839
- #: guix-git/doc/guix.texi:8861 guix-git/doc/guix.texi:8862
- #: guix-git/doc/guix.texi:9292
- #, no-wrap
- msgid "Build Phases"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:287 guix-git/doc/guix.texi:6839
- msgid "Phases of the build process of a package."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:287 guix-git/doc/guix.texi:6839
- #: guix-git/doc/guix.texi:9055 guix-git/doc/guix.texi:9056
- #, no-wrap
- msgid "Build Utilities"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:287 guix-git/doc/guix.texi:6839
- msgid "Helpers for your package definitions and more."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:287 guix-git/doc/guix.texi:6839
- #: guix-git/doc/guix.texi:9369 guix-git/doc/guix.texi:9370
- #, no-wrap
- msgid "The Store"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:287 guix-git/doc/guix.texi:6839
- msgid "Manipulating the package store."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:287 guix-git/doc/guix.texi:6839
- #: guix-git/doc/guix.texi:9522 guix-git/doc/guix.texi:9523
- #, no-wrap
- msgid "Derivations"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:287 guix-git/doc/guix.texi:6839
- msgid "Low-level interface to package derivations."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:287 guix-git/doc/guix.texi:6839
- #: guix-git/doc/guix.texi:9716 guix-git/doc/guix.texi:9717
- #, no-wrap
- msgid "The Store Monad"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:287 guix-git/doc/guix.texi:6839
- msgid "Purely functional interface to the store."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:287 guix-git/doc/guix.texi:6839
- #: guix-git/doc/guix.texi:10035 guix-git/doc/guix.texi:10036
- #, no-wrap
- msgid "G-Expressions"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:287 guix-git/doc/guix.texi:6839
- msgid "Manipulating build expressions."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:287 guix-git/doc/guix.texi:6839
- #: guix-git/doc/guix.texi:10674
- #, no-wrap
- msgid "Invoking guix repl"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:287
- msgid "Programming Guix in Guile."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:292 guix-git/doc/guix.texi:7100
- #: guix-git/doc/guix.texi:7103
- #, no-wrap
- msgid "package Reference"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:292 guix-git/doc/guix.texi:7100
- msgid "The package data type."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:292 guix-git/doc/guix.texi:7100
- #: guix-git/doc/guix.texi:7362
- #, no-wrap
- msgid "origin Reference"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:292 guix-git/doc/guix.texi:7100
- msgid "The origin data type."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- #: guix-git/doc/guix.texi:10801
- #, no-wrap
- msgid "Invoking guix build"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- msgid "Building packages from the command line."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- #: guix-git/doc/guix.texi:11699
- #, no-wrap
- msgid "Invoking guix edit"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- msgid "Editing package definitions."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- #: guix-git/doc/guix.texi:11729
- #, no-wrap
- msgid "Invoking guix download"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- msgid "Downloading a file and printing its hash."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- #: guix-git/doc/guix.texi:11787
- #, no-wrap
- msgid "Invoking guix hash"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- msgid "Computing the cryptographic hash of a file."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- #: guix-git/doc/guix.texi:11877
- #, no-wrap
- msgid "Invoking guix import"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- msgid "Importing package definitions."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- #: guix-git/doc/guix.texi:12412
- #, no-wrap
- msgid "Invoking guix refresh"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- msgid "Updating package definitions."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- #: guix-git/doc/guix.texi:12784
- #, no-wrap
- msgid "Invoking guix style"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- msgid "Styling package definitions."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- #: guix-git/doc/guix.texi:12880
- #, no-wrap
- msgid "Invoking guix lint"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- msgid "Finding errors in package definitions."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- #: guix-git/doc/guix.texi:13056
- #, no-wrap
- msgid "Invoking guix size"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- msgid "Profiling disk usage."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- #: guix-git/doc/guix.texi:13200
- #, no-wrap
- msgid "Invoking guix graph"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- msgid "Visualizing the graph of packages."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- #: guix-git/doc/guix.texi:13481
- #, no-wrap
- msgid "Invoking guix publish"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- msgid "Sharing substitutes."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- #: guix-git/doc/guix.texi:13750
- #, no-wrap
- msgid "Invoking guix challenge"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- msgid "Challenging substitute servers."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- #: guix-git/doc/guix.texi:13933
- #, no-wrap
- msgid "Invoking guix copy"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- msgid "Copying to and from a remote store."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- #: guix-git/doc/guix.texi:13996
- #, no-wrap
- msgid "Invoking guix container"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- msgid "Process isolation."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- #: guix-git/doc/guix.texi:14050
- #, no-wrap
- msgid "Invoking guix weather"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- msgid "Assessing substitute availability."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- #: guix-git/doc/guix.texi:14180
- #, no-wrap
- msgid "Invoking guix processes"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:311 guix-git/doc/guix.texi:10799
- msgid "Listing client processes."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:313 guix-git/doc/guix.texi:10802
- #, no-wrap
- msgid "Invoking @command{guix build}"
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:318 guix-git/doc/guix.texi:10853
- #: guix-git/doc/guix.texi:10855 guix-git/doc/guix.texi:10856
- #, no-wrap
- msgid "Common Build Options"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:318 guix-git/doc/guix.texi:10853
- msgid "Build options for most commands."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:318 guix-git/doc/guix.texi:10853
- #: guix-git/doc/guix.texi:11010 guix-git/doc/guix.texi:11011
- #, no-wrap
- msgid "Package Transformation Options"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:318 guix-git/doc/guix.texi:10853
- msgid "Creating variants of packages."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:318 guix-git/doc/guix.texi:10853
- #: guix-git/doc/guix.texi:11381 guix-git/doc/guix.texi:11382
- #, no-wrap
- msgid "Additional Build Options"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:318 guix-git/doc/guix.texi:10853
- msgid "Options specific to 'guix build'."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:318 guix-git/doc/guix.texi:10853
- #: guix-git/doc/guix.texi:11619 guix-git/doc/guix.texi:11620
- #, no-wrap
- msgid "Debugging Build Failures"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:318 guix-git/doc/guix.texi:10853
- msgid "Real life packaging experience."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- #: guix-git/doc/guix.texi:14324 guix-git/doc/guix.texi:14325
- #, no-wrap
- msgid "Using the Configuration System"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- msgid "Customizing your GNU system."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- #: guix-git/doc/guix.texi:14575
- #, no-wrap
- msgid "operating-system Reference"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- msgid "Detail of operating-system declarations."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- #: guix-git/doc/guix.texi:14798 guix-git/doc/guix.texi:14799
- #, no-wrap
- msgid "File Systems"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- msgid "Configuring file system mounts."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- #: guix-git/doc/guix.texi:15151 guix-git/doc/guix.texi:15152
- #, no-wrap
- msgid "Mapped Devices"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- msgid "Block device extra processing."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- #: guix-git/doc/guix.texi:15300 guix-git/doc/guix.texi:15301
- #, no-wrap
- msgid "Swap Space"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- msgid "Backing RAM with disk space."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- #: guix-git/doc/guix.texi:15400 guix-git/doc/guix.texi:15401
- #, no-wrap
- msgid "User Accounts"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- msgid "Specifying user accounts."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:2308
- #: guix-git/doc/guix.texi:14322 guix-git/doc/guix.texi:15581
- #: guix-git/doc/guix.texi:15582
- #, no-wrap
- msgid "Keyboard Layout"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- msgid "How the system interprets key strokes."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:1835
- #: guix-git/doc/guix.texi:14322 guix-git/doc/guix.texi:15727
- #: guix-git/doc/guix.texi:15728
- #, no-wrap
- msgid "Locales"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- msgid "Language and cultural convention settings."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:345
- #: guix-git/doc/guix.texi:14322 guix-git/doc/guix.texi:15867
- #: guix-git/doc/guix.texi:15868
- #, no-wrap
- msgid "Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- msgid "Specifying system services."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- #: guix-git/doc/guix.texi:34056 guix-git/doc/guix.texi:34057
- #, no-wrap
- msgid "Setuid Programs"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- msgid "Programs running with root privileges."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:1984
- #: guix-git/doc/guix.texi:14322 guix-git/doc/guix.texi:34140
- #: guix-git/doc/guix.texi:34141
- #, no-wrap
- msgid "X.509 Certificates"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- msgid "Authenticating HTTPS servers."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:1878
- #: guix-git/doc/guix.texi:14322 guix-git/doc/guix.texi:34203
- #: guix-git/doc/guix.texi:34204
- #, no-wrap
- msgid "Name Service Switch"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- msgid "Configuring libc's name service switch."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- #: guix-git/doc/guix.texi:34341 guix-git/doc/guix.texi:34342
- #, no-wrap
- msgid "Initial RAM Disk"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- msgid "Linux-Libre bootstrapping."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- #: guix-git/doc/guix.texi:34536 guix-git/doc/guix.texi:34537
- #, no-wrap
- msgid "Bootloader Configuration"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- msgid "Configuring the boot loader."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- #: guix-git/doc/guix.texi:34834
- #, no-wrap
- msgid "Invoking guix system"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- msgid "Instantiating a system configuration."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- #: guix-git/doc/guix.texi:35425
- #, no-wrap
- msgid "Invoking guix deploy"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- msgid "Deploying a system configuration to a remote host."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- #: guix-git/doc/guix.texi:35631
- #, no-wrap
- msgid "Running Guix in a VM"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- msgid "How to run Guix System in a virtual machine."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:381
- #: guix-git/doc/guix.texi:14322 guix-git/doc/guix.texi:35765
- #: guix-git/doc/guix.texi:35766
- #, no-wrap
- msgid "Defining Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:339 guix-git/doc/guix.texi:14322
- msgid "Adding new service definitions."
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:341
- msgid "Home Environment Configuration"
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:343 guix-git/doc/guix.texi:36944
- #: guix-git/doc/guix.texi:37478
- #, no-wrap
- msgid "Invoking guix home"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:343
- msgid "Instantiating a home environment configuration."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:15953 guix-git/doc/guix.texi:15954
- #, no-wrap
- msgid "Base Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "Essential system services."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:16880 guix-git/doc/guix.texi:16881
- #, no-wrap
- msgid "Scheduled Job Execution"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "The mcron service."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:17030 guix-git/doc/guix.texi:17031
- #, no-wrap
- msgid "Log Rotation"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "The rottlog service."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:17143 guix-git/doc/guix.texi:17144
- #, no-wrap
- msgid "Networking Setup"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "Setting up network interfaces."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:17561 guix-git/doc/guix.texi:17562
- #, no-wrap
- msgid "Networking Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "Firewall, SSH daemon, etc."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:19020 guix-git/doc/guix.texi:19021
- #, no-wrap
- msgid "Unattended Upgrades"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "Automated system upgrades."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:19158 guix-git/doc/guix.texi:19159
- #, no-wrap
- msgid "X Window"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "Graphical display."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:19556 guix-git/doc/guix.texi:19557
- #, no-wrap
- msgid "Printing Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "Local and remote printer support."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:20409 guix-git/doc/guix.texi:20410
- #, no-wrap
- msgid "Desktop Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "D-Bus and desktop services."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:20928 guix-git/doc/guix.texi:20929
- #, no-wrap
- msgid "Sound Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "ALSA and Pulseaudio services."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:21068 guix-git/doc/guix.texi:21069
- #, no-wrap
- msgid "Database Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "SQL databases, key-value stores, etc."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:21403 guix-git/doc/guix.texi:21404
- #, no-wrap
- msgid "Mail Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "IMAP, POP3, SMTP, and all that."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:23262 guix-git/doc/guix.texi:23263
- #, no-wrap
- msgid "Messaging Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "Messaging services."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:23765 guix-git/doc/guix.texi:23766
- #, no-wrap
- msgid "Telephony Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "Telephony services."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:24996 guix-git/doc/guix.texi:24997
- #, no-wrap
- msgid "Monitoring Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "Monitoring services."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:25507 guix-git/doc/guix.texi:25508
- #, no-wrap
- msgid "Kerberos Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "Kerberos services."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:25633 guix-git/doc/guix.texi:25634
- #, no-wrap
- msgid "LDAP Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "LDAP services."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:26112 guix-git/doc/guix.texi:26113
- #, no-wrap
- msgid "Web Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "Web servers."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:27320 guix-git/doc/guix.texi:27321
- #, no-wrap
- msgid "Certificate Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "TLS certificates via Let's Encrypt."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:27501 guix-git/doc/guix.texi:27502
- #, no-wrap
- msgid "DNS Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "DNS daemons."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:28246 guix-git/doc/guix.texi:28247
- #, no-wrap
- msgid "VPN Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "VPN daemons."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:28758 guix-git/doc/guix.texi:28759
- #, no-wrap
- msgid "Network File System"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "NFS related services."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:28954 guix-git/doc/guix.texi:28955
- #, no-wrap
- msgid "Continuous Integration"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "Cuirass and Laminar services."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:29240 guix-git/doc/guix.texi:29241
- #, no-wrap
- msgid "Power Management Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "Extending battery life."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:29774 guix-git/doc/guix.texi:29775
- #, no-wrap
- msgid "Audio Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "The MPD."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:29893 guix-git/doc/guix.texi:29894
- #, no-wrap
- msgid "Virtualization Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "Virtualization services."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:31561 guix-git/doc/guix.texi:31562
- #, no-wrap
- msgid "Version Control Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "Providing remote access to Git repositories."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:32897 guix-git/doc/guix.texi:32898
- #, no-wrap
- msgid "Game Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "Game servers."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:32929 guix-git/doc/guix.texi:32930
- #, no-wrap
- msgid "PAM Mount Service"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "Service to mount volumes when logging in."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:33012 guix-git/doc/guix.texi:33013
- #, no-wrap
- msgid "Guix Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "Services relating specifically to Guix."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:33290 guix-git/doc/guix.texi:33291
- #, no-wrap
- msgid "Linux Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "Services tied to the Linux kernel."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:33517 guix-git/doc/guix.texi:33518
- #, no-wrap
- msgid "Hurd Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "Services specific for a Hurd System."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- #: guix-git/doc/guix.texi:33559 guix-git/doc/guix.texi:33560
- #, no-wrap
- msgid "Miscellaneous Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:15951
- msgid "Other services."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:387 guix-git/doc/guix.texi:35778
- #: guix-git/doc/guix.texi:35780 guix-git/doc/guix.texi:35781
- #, no-wrap
- msgid "Service Composition"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:387 guix-git/doc/guix.texi:35778
- msgid "The model for composing services."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:387 guix-git/doc/guix.texi:35778
- #: guix-git/doc/guix.texi:35836 guix-git/doc/guix.texi:35837
- #, no-wrap
- msgid "Service Types and Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:387 guix-git/doc/guix.texi:35778
- msgid "Types and services."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:387 guix-git/doc/guix.texi:35778
- #: guix-git/doc/guix.texi:35973 guix-git/doc/guix.texi:35974
- #, no-wrap
- msgid "Service Reference"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:387 guix-git/doc/guix.texi:35778
- msgid "API reference."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:387 guix-git/doc/guix.texi:35778
- #: guix-git/doc/guix.texi:36292 guix-git/doc/guix.texi:36293
- #, no-wrap
- msgid "Shepherd Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:387 guix-git/doc/guix.texi:35778
- msgid "A particular type of service."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:387 guix-git/doc/guix.texi:35778
- #: guix-git/doc/guix.texi:36511 guix-git/doc/guix.texi:36512
- #, fuzzy, no-wrap
- #| msgid "Documentation"
- msgid "Complex Configurations"
- msgstr "مستندات"
- #. type: menuentry
- #: guix-git/doc/guix.texi:387 guix-git/doc/guix.texi:35778
- msgid "Defining bindings for complex configurations."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:392 guix-git/doc/guix.texi:37804
- #: guix-git/doc/guix.texi:37806 guix-git/doc/guix.texi:37807
- #, no-wrap
- msgid "Separate Debug Info"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:392 guix-git/doc/guix.texi:37804
- msgid "Installing 'debug' outputs."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:392 guix-git/doc/guix.texi:37804
- #: guix-git/doc/guix.texi:37879 guix-git/doc/guix.texi:37880
- #, no-wrap
- msgid "Rebuilding Debug Info"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:392 guix-git/doc/guix.texi:37804
- msgid "Building missing debug info."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:397 guix-git/doc/guix.texi:38096
- #: guix-git/doc/guix.texi:38098
- #, no-wrap
- msgid "Reduced Binary Seed Bootstrap"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:397 guix-git/doc/guix.texi:38096
- msgid "A Bootstrap worthy of GNU."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:397 guix-git/doc/guix.texi:38096
- #: guix-git/doc/guix.texi:38173 guix-git/doc/guix.texi:38174
- #, no-wrap
- msgid "Preparing to Use the Bootstrap Binaries"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:397 guix-git/doc/guix.texi:38096
- msgid "Building that what matters most."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:405
- #, no-wrap
- msgid "purpose"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:413
- msgid "GNU Guix@footnote{``Guix'' is pronounced like ``geeks'', or ``ɡiːks'' using the international phonetic alphabet (IPA).} is a package management tool for and distribution of the GNU system. Guix makes it easy for unprivileged users to install, upgrade, or remove software packages, to roll back to a previous package set, to build packages from source, and generally assists with the creation and maintenance of software environments."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:414 guix-git/doc/guix.texi:489
- #, no-wrap
- msgid "Guix System"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:415
- #, no-wrap
- msgid "GuixSD, now Guix System"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:416
- #, no-wrap
- msgid "Guix System Distribution, now Guix System"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:425
- msgid "You can install GNU@tie{}Guix on top of an existing GNU/Linux system where it complements the available tools without interference (@pxref{Installation}), or you can use it as a standalone operating system distribution, @dfn{Guix@tie{}System}@footnote{We used to refer to Guix System as ``Guix System Distribution'' or ``GuixSD''. We now consider it makes more sense to group everything under the ``Guix'' banner since, after all, Guix System is readily available through the @command{guix system} command, even if you're using a different distro underneath!}. @xref{GNU Distribution}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:434
- #, no-wrap
- msgid "user interfaces"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:440
- msgid "Guix provides a command-line package management interface (@pxref{Package Management}), tools to help with software development (@pxref{Development}), command-line utilities for more advanced usage (@pxref{Utilities}), as well as Scheme programming interfaces (@pxref{Programming Interface})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:440
- #, no-wrap
- msgid "build daemon"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:444
- msgid "Its @dfn{build daemon} is responsible for building packages on behalf of users (@pxref{Setting Up the Daemon}) and for downloading pre-built binaries from authorized sources (@pxref{Substitutes})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:445
- #, no-wrap
- msgid "extensibility of the distribution"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:446 guix-git/doc/guix.texi:6863
- #, no-wrap
- msgid "customization, of packages"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:455
- msgid "Guix includes package definitions for many GNU and non-GNU packages, all of which @uref{https://www.gnu.org/philosophy/free-sw.html, respect the user's computing freedom}. It is @emph{extensible}: users can write their own package definitions (@pxref{Defining Packages}) and make them available as independent package modules (@pxref{Package Modules}). It is also @emph{customizable}: users can @emph{derive} specialized package definitions from existing ones, including from the command line (@pxref{Package Transformation Options})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:456
- #, no-wrap
- msgid "functional package management"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:457
- #, no-wrap
- msgid "isolation"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:472
- msgid "Under the hood, Guix implements the @dfn{functional package management} discipline pioneered by Nix (@pxref{Acknowledgments}). In Guix, the package build and installation process is seen as a @emph{function}, in the mathematical sense. That function takes inputs, such as build scripts, a compiler, and libraries, and returns an installed package. As a pure function, its result depends solely on its inputs---for instance, it cannot refer to software or scripts that were not explicitly passed as inputs. A build function always produces the same result when passed a given set of inputs. It cannot alter the environment of the running system in any way; for instance, it cannot create, modify, or delete files outside of its build and installation directories. This is achieved by running build processes in isolated environments (or @dfn{containers}), where only their explicit inputs are visible."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:473 guix-git/doc/guix.texi:9372
- #, no-wrap
- msgid "store"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:480
- msgid "The result of package build functions is @dfn{cached} in the file system, in a special directory called @dfn{the store} (@pxref{The Store}). Each package is installed in a directory of its own in the store---by default under @file{/gnu/store}. The directory name contains a hash of all the inputs used to build that package; thus, changing an input yields a different directory name."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:484
- msgid "This approach is the foundation for the salient features of Guix: support for transactional package upgrade and rollback, per-user installation, and garbage collection of packages (@pxref{Features})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:499
- msgid "Guix comes with a distribution of the GNU system consisting entirely of free software@footnote{The term ``free'' here refers to the @url{https://www.gnu.org/philosophy/free-sw.html,freedom provided to users of that software}.}. The distribution can be installed on its own (@pxref{System Installation}), but it is also possible to install Guix as a package manager on top of an installed GNU/Linux system (@pxref{Installation}). When we need to distinguish between the two, we refer to the standalone distribution as Guix@tie{}System."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:505
- msgid "The distribution provides core GNU packages such as GNU libc, GCC, and Binutils, as well as many GNU and non-GNU applications. The complete list of available packages can be browsed @url{https://www.gnu.org/software/guix/packages,on-line} or by running @command{guix package} (@pxref{Invoking guix package}):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:508
- #, no-wrap
- msgid "guix package --list-available\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:514
- msgid "Our goal is to provide a practical 100% free software distribution of Linux-based and other variants of GNU, with a focus on the promotion and tight integration of GNU components, and an emphasis on programs and tools that help users exert that freedom."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:516
- msgid "Packages are currently available on the following platforms:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:519 guix-git/doc/guix.texi:2155
- #, no-wrap
- msgid "x86_64-linux"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:521
- msgid "Intel/AMD @code{x86_64} architecture, Linux-Libre kernel."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:522 guix-git/doc/guix.texi:2158
- #, no-wrap
- msgid "i686-linux"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:524
- msgid "Intel 32-bit architecture (IA32), Linux-Libre kernel."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:525
- #, no-wrap
- msgid "armhf-linux"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:529
- msgid "ARMv7-A architecture with hard float, Thumb-2 and NEON, using the EABI hard-float application binary interface (ABI), and Linux-Libre kernel."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:530
- #, no-wrap
- msgid "aarch64-linux"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:532
- msgid "little-endian 64-bit ARMv8-A processors, Linux-Libre kernel."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:533
- #, no-wrap
- msgid "i586-gnu"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:536
- msgid "@uref{https://hurd.gnu.org, GNU/Hurd} on the Intel 32-bit architecture (IA32)."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:542
- msgid "This configuration is experimental and under development. The easiest way for you to give it a try is by setting up an instance of @code{hurd-vm-service-type} on your GNU/Linux machine (@pxref{transparent-emulation-qemu, @code{hurd-vm-service-type}}). @xref{Contributing}, on how to help!"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:543
- #, no-wrap
- msgid "mips64el-linux (unsupported)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:549
- msgid "little-endian 64-bit MIPS processors, specifically the Loongson series, n32 ABI, and Linux-Libre kernel. This configuration is no longer fully supported; in particular, there is no ongoing work to ensure that this architecture still works. Should someone decide they wish to revive this architecture then the code is still available."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:550
- #, no-wrap
- msgid "powerpc-linux (unsupported)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:555
- msgid "big-endian 32-bit PowerPC processors, specifically the PowerPC G4 with AltiVec support, and Linux-Libre kernel. This configuration is not fully supported and there is no ongoing work to ensure this architecture works."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:566
- msgid "little-endian 64-bit Power ISA processors, Linux-Libre kernel. This includes POWER9 systems such as the @uref{https://www.fsf.org/news/talos-ii-mainboard-and-talos-ii-lite-mainboard-now-fsf-certified-to-respect-your-freedom, RYF Talos II mainboard}. This platform is available as a \"technology preview\": although it is supported, substitutes are not yet available from the build farm (@pxref{Substitutes}), and some packages may fail to build (@pxref{Tracking Bugs and Patches}). That said, the Guix community is actively working on improving this support, and now is a great time to try it and get involved!"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:576
- msgid "With Guix@tie{}System, you @emph{declare} all aspects of the operating system configuration and Guix takes care of instantiating the configuration in a transactional, reproducible, and stateless fashion (@pxref{System Configuration}). Guix System uses the Linux-libre kernel, the Shepherd initialization system (@pxref{Introduction,,, shepherd, The GNU Shepherd Manual}), the well-known GNU utilities and tool chain, as well as the graphical environment or system services of your choice."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:579
- msgid "Guix System is available on all the above platforms except @code{mips64el-linux} and @code{powerpc64le-linux}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:583
- msgid "For information on porting to other architectures or kernels, @pxref{Porting}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:586
- msgid "Building this distribution is a cooperative effort, and you are invited to join! @xref{Contributing}, for information about how you can help."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:592
- #, no-wrap
- msgid "installing Guix"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:604
- msgid "We recommend the use of this @uref{https://git.savannah.gnu.org/cgit/guix.git/plain/etc/guix-install.sh, shell installer script} to install Guix on top of a running GNU/Linux system, thereafter called a @dfn{foreign distro}.@footnote{This section is concerned with the installation of the package manager, which can be done on top of a running GNU/Linux system. If, instead, you want to install the complete GNU operating system, @pxref{System Installation}.} The script automates the download, installation, and initial configuration of Guix. It should be run as the root user."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:606 guix-git/doc/guix.texi:1830
- #, no-wrap
- msgid "foreign distro"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:607
- #, no-wrap
- msgid "directories related to foreign distro"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:612
- msgid "When installed on a foreign distro, GNU@tie{}Guix complements the available tools without interference. Its data lives exclusively in two directories, usually @file{/gnu/store} and @file{/var/guix}; other files on your system, such as @file{/etc}, are left untouched."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:615
- msgid "Once installed, Guix can be updated by running @command{guix pull} (@pxref{Invoking guix pull})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:620
- msgid "If you prefer to perform the installation steps manually or want to tweak them, you may find the following subsections useful. They describe the software requirements of Guix, as well as how to install it manually and get ready to use it."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:634
- #, no-wrap
- msgid "installing Guix from binaries"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:635
- #, no-wrap
- msgid "installer script"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:641
- msgid "This section describes how to install Guix on an arbitrary system from a self-contained tarball providing binaries for Guix and for all its dependencies. This is often quicker than installing from source, which is described in the next sections. The only requirement is to have GNU@tie{}tar and Xz."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:649
- msgid "We recommend the use of this @uref{https://git.savannah.gnu.org/cgit/guix.git/plain/etc/guix-install.sh, shell installer script}. The script automates the download, installation, and initial configuration steps described below. It should be run as the root user. As root, you can thus run this:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:655
- #, no-wrap
- msgid ""
- "cd /tmp\n"
- "wget https://git.savannah.gnu.org/cgit/guix.git/plain/etc/guix-install.sh\n"
- "chmod +x guix-install.sh\n"
- "./guix-install.sh\n"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:659
- msgid "When you're done, @pxref{Application Setup} for extra configuration you might need, and @ref{Getting Started} for your first steps!"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:662
- msgid "Installing goes along these lines:"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:665
- #, no-wrap
- msgid "downloading Guix binary"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:671
- msgid "Download the binary tarball from @indicateurl{@value{BASE-URL}/guix-binary-@value{VERSION}.x86_64-linux.tar.xz}, where @code{x86_64-linux} can be replaced with @code{i686-linux} for an @code{i686} (32-bits) machine already running the kernel Linux, and so on (@pxref{GNU Distribution})."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:675
- msgid "Make sure to download the associated @file{.sig} file and to verify the authenticity of the tarball against it, along these lines:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:679
- #, no-wrap
- msgid ""
- "$ wget @value{BASE-URL}/guix-binary-@value{VERSION}.x86_64-linux.tar.xz.sig\n"
- "$ gpg --verify guix-binary-@value{VERSION}.x86_64-linux.tar.xz.sig\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:683 guix-git/doc/guix.texi:2173
- msgid "If that command fails because you do not have the required public key, then run this command to import it:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:687
- #, no-wrap
- msgid ""
- "$ wget '@value{OPENPGP-SIGNING-KEY-URL}' \\\n"
- " -qO - | gpg --import -\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:691 guix-git/doc/guix.texi:2181
- msgid "and rerun the @code{gpg --verify} command."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:694 guix-git/doc/guix.texi:2184
- msgid "Take note that a warning like ``This key is not certified with a trusted signature!'' is normal."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:700
- msgid "Now, you need to become the @code{root} user. Depending on your distribution, you may have to run @code{su -} or @code{sudo -i}. As @code{root}, run:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:706
- #, no-wrap
- msgid ""
- "# cd /tmp\n"
- "# tar --warning=no-timestamp -xf \\\n"
- " /path/to/guix-binary-@value{VERSION}.x86_64-linux.tar.xz\n"
- "# mv var/guix /var/ && mv gnu /\n"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:711
- msgid "This creates @file{/gnu/store} (@pxref{The Store}) and @file{/var/guix}. The latter contains a ready-to-use profile for @code{root} (see next step)."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:714
- msgid "Do @emph{not} unpack the tarball on a working Guix system since that would overwrite its own essential files."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:724
- msgid "The @option{--warning=no-timestamp} option makes sure GNU@tie{}tar does not emit warnings about ``implausibly old time stamps'' (such warnings were triggered by GNU@tie{}tar 1.26 and older; recent versions are fine). They stem from the fact that all the files in the archive have their modification time set to 1 (which means January 1st, 1970). This is done on purpose to make sure the archive content is independent of its creation time, thus making it reproducible."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:728
- msgid "Make the profile available under @file{~root/.config/guix/current}, which is where @command{guix pull} will install updates (@pxref{Invoking guix pull}):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:733
- #, no-wrap
- msgid ""
- "# mkdir -p ~root/.config/guix\n"
- "# ln -sf /var/guix/profiles/per-user/root/current-guix \\\n"
- " ~root/.config/guix/current\n"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:737
- msgid "Source @file{etc/profile} to augment @env{PATH} and other relevant environment variables:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:741
- #, no-wrap
- msgid ""
- "# GUIX_PROFILE=\"`echo ~root`/.config/guix/current\" ; \\\n"
- " source $GUIX_PROFILE/etc/profile\n"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:746
- msgid "Create the group and user accounts for build users as explained below (@pxref{Build Environment Setup})."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:749
- msgid "Run the daemon, and set it to automatically start on boot."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:752
- msgid "If your host distro uses the systemd init system, this can be achieved with these commands:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:765
- #, no-wrap
- msgid ""
- "# cp ~root/.config/guix/current/lib/systemd/system/gnu-store.mount \\\n"
- " ~root/.config/guix/current/lib/systemd/system/guix-daemon.service \\\n"
- " /etc/systemd/system/\n"
- "# systemctl enable --now gnu-store.mount guix-daemon\n"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:768
- msgid "You may also want to arrange for @command{guix gc} to run periodically:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:774
- #, no-wrap
- msgid ""
- "# cp ~root/.config/guix/current/lib/systemd/system/guix-gc.service \\\n"
- " ~root/.config/guix/current/lib/systemd/system/guix-gc.timer \\\n"
- " /etc/systemd/system/\n"
- "# systemctl enable --now guix-gc.timer\n"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:778
- msgid "You may want to edit @file{guix-gc.service} to adjust the command line options to fit your needs (@pxref{Invoking guix gc})."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:780 guix-git/doc/guix.texi:13740
- msgid "If your host distro uses the Upstart init system:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:786
- #, no-wrap
- msgid ""
- "# initctl reload-configuration\n"
- "# cp ~root/.config/guix/current/lib/upstart/system/guix-daemon.conf \\\n"
- " /etc/init/\n"
- "# start guix-daemon\n"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:789
- msgid "Otherwise, you can still start the daemon manually with:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:793
- #, no-wrap
- msgid ""
- "# ~root/.config/guix/current/bin/guix-daemon \\\n"
- " --build-users-group=guixbuild\n"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:798
- msgid "Make the @command{guix} command available to other users on the machine, for instance with:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:803
- #, no-wrap
- msgid ""
- "# mkdir -p /usr/local/bin\n"
- "# cd /usr/local/bin\n"
- "# ln -s /var/guix/profiles/per-user/root/current-guix/bin/guix\n"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:807
- msgid "It is also a good idea to make the Info version of this manual available there:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:813
- #, no-wrap
- msgid ""
- "# mkdir -p /usr/local/share/info\n"
- "# cd /usr/local/share/info\n"
- "# for i in /var/guix/profiles/per-user/root/current-guix/share/info/* ;\n"
- " do ln -s $i ; done\n"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:819
- msgid "That way, assuming @file{/usr/local/share/info} is in the search path, running @command{info guix} will open this manual (@pxref{Other Info Directories,,, texinfo, GNU Texinfo}, for more details on changing the Info search path)."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:821 guix-git/doc/guix.texi:3798
- #: guix-git/doc/guix.texi:16494
- #, no-wrap
- msgid "substitutes, authorization thereof"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:825
- msgid "To use substitutes from @code{@value{SUBSTITUTE-SERVER-1}}, @code{@value{SUBSTITUTE-SERVER-2}} or a mirror (@pxref{Substitutes}), authorize them:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:831
- #, no-wrap
- msgid ""
- "# guix archive --authorize < \\\n"
- " ~root/.config/guix/current/share/guix/@value{SUBSTITUTE-SERVER-1}.pub\n"
- "# guix archive --authorize < \\\n"
- " ~root/.config/guix/current/share/guix/@value{SUBSTITUTE-SERVER-2}.pub\n"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:838
- msgid "If you do not enable substitutes, Guix will end up building @emph{everything} from source on your machine, making each installation and upgrade very expensive. @xref{On Trusting Binaries}, for a discussion of reasons why one might want do disable substitutes."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:843
- msgid "Each user may need to perform a few additional steps to make their Guix environment ready for use, @pxref{Application Setup}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:846
- msgid "Voilà, the installation is complete!"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:849
- msgid "You can confirm that Guix is working by installing a sample package into the root profile:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:852
- #, no-wrap
- msgid "# guix install hello\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:856
- msgid "The binary installation tarball can be (re)produced and verified simply by running the following command in the Guix source tree:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:859
- #, no-wrap
- msgid "make guix-binary.@var{system}.tar.xz\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:863
- msgid "...@: which, in turn, runs:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:867
- #, no-wrap
- msgid ""
- "guix pack -s @var{system} --localstatedir \\\n"
- " --profile-name=current-guix guix\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:870
- msgid "@xref{Invoking guix pack}, for more info on this handy tool."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:878
- msgid "This section lists requirements when building Guix from source. The build procedure for Guix is the same as for other GNU software, and is not covered here. Please see the files @file{README} and @file{INSTALL} in the Guix source tree for additional details."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:879
- #, no-wrap
- msgid "official website"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:882
- msgid "GNU Guix is available for download from its website at @url{https://www.gnu.org/software/guix/}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:884
- msgid "GNU Guix depends on the following packages:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:886
- #, no-wrap
- msgid "@url{https://gnu.org/software/guile/, GNU Guile}, version 3.0.x;"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:887
- #, no-wrap
- msgid "@url{https://notabug.org/cwebber/guile-gcrypt, Guile-Gcrypt}, version"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:889
- msgid "0.1.0 or later;"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:893
- msgid "@uref{https://gnutls.org/, GnuTLS}, specifically its Guile bindings (@pxref{Guile Preparations, how to install the GnuTLS bindings for Guile,, gnutls-guile, GnuTLS-Guile});"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:896
- msgid "@uref{https://notabug.org/guile-sqlite3/guile-sqlite3, Guile-SQLite3}, version 0.1.0 or later;"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:896
- #, no-wrap
- msgid "@uref{https://notabug.org/guile-zlib/guile-zlib, Guile-zlib},"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:898
- msgid "version 0.1.0 or later;"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:898
- #, no-wrap
- msgid "@uref{https://notabug.org/guile-lzlib/guile-lzlib, Guile-lzlib};"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:899
- #, no-wrap
- msgid "@uref{https://www.nongnu.org/guile-avahi/, Guile-Avahi};"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:903
- msgid "@uref{https://gitlab.com/guile-git/guile-git, Guile-Git}, version 0.5.0 or later;"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:903
- #, no-wrap
- msgid "@uref{https://savannah.nongnu.org/projects/guile-json/, Guile-JSON}"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:905
- msgid "4.3.0 or later;"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:905
- #, no-wrap
- msgid "@url{https://www.gnu.org/software/make/, GNU Make}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:909
- msgid "The following dependencies are optional:"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:917
- msgid "Support for build offloading (@pxref{Daemon Offload Setup}) and @command{guix copy} (@pxref{Invoking guix copy}) depends on @uref{https://github.com/artyom-poptsov/guile-ssh, Guile-SSH}, version 0.13.0 or later."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:922
- msgid "@uref{https://notabug.org/guile-zstd/guile-zstd, Guile-zstd}, for zstd compression and decompression in @command{guix publish} and for substitutes (@pxref{Invoking guix publish})."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:926
- msgid "@uref{https://ngyro.com/software/guile-semver.html, Guile-Semver} for the @code{crate} importer (@pxref{Invoking guix import})."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:931
- msgid "@uref{https://www.nongnu.org/guile-lib/doc/ref/htmlprag/, Guile-Lib} for the @code{go} importer (@pxref{Invoking guix import}) and for some of the ``updaters'' (@pxref{Invoking guix refresh})."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:935
- msgid "When @url{http://www.bzip.org, libbz2} is available, @command{guix-daemon} can use it to compress build logs."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:939
- msgid "Unless @option{--disable-daemon} was passed to @command{configure}, the following packages are also needed:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:941
- #, no-wrap
- msgid "@url{https://gnupg.org/, GNU libgcrypt};"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:942
- #, no-wrap
- msgid "@url{https://sqlite.org, SQLite 3};"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:943
- #, no-wrap
- msgid "@url{https://gcc.gnu.org, GCC's g++}, with support for the"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:945
- msgid "C++11 standard."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:947
- #, no-wrap
- msgid "state directory"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:956
- msgid "When configuring Guix on a system that already has a Guix installation, be sure to specify the same state directory as the existing installation using the @option{--localstatedir} option of the @command{configure} script (@pxref{Directory Variables, @code{localstatedir},, standards, GNU Coding Standards}). Usually, this @var{localstatedir} option is set to the value @file{/var}. The @command{configure} script protects against unintended misconfiguration of @var{localstatedir} so you do not inadvertently corrupt your store (@pxref{The Store})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:960
- #, no-wrap
- msgid "test suite"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:966
- msgid "After a successful @command{configure} and @code{make} run, it is a good idea to run the test suite. It can help catch issues with the setup or environment, or bugs in Guix itself---and really, reporting test failures is a good way to help improve the software. To run the test suite, type:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:969
- #, no-wrap
- msgid "make check\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:976
- msgid "Test cases can run in parallel: you can use the @code{-j} option of GNU@tie{}make to speed things up. The first run may take a few minutes on a recent machine; subsequent runs will be faster because the store that is created for test purposes will already have various things in cache."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:979
- msgid "It is also possible to run a subset of the tests by defining the @code{TESTS} makefile variable as in this example:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:982
- #, no-wrap
- msgid "make check TESTS=\"tests/store.scm tests/cpio.scm\"\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:987
- msgid "By default, tests results are displayed at a file level. In order to see the details of every individual test cases, it is possible to define the @code{SCM_LOG_DRIVER_FLAGS} makefile variable as in this example:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:990
- #, no-wrap
- msgid "make check TESTS=\"tests/base64.scm\" SCM_LOG_DRIVER_FLAGS=\"--brief=no\"\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:998
- msgid "The underlying SRFI 64 custom Automake test driver used for the 'check' test suite (located at @file{build-aux/test-driver.scm}) also allows selecting which test cases to run at a finer level, via its @option{--select} and @option{--exclude} options. Here's an example, to run all the test cases from the @file{tests/packages.scm} test file whose names start with ``transaction-upgrade-entry'':"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:1002
- #, no-wrap
- msgid ""
- "export SCM_LOG_DRIVER_FLAGS=\"--select=^transaction-upgrade-entry\"\n"
- "make check TESTS=\"tests/packages.scm\"\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1008
- msgid "Those wishing to inspect the results of failed tests directly from the command line can add the @option{--errors-only=yes} option to the @code{SCM_LOG_DRIVER_FLAGS} makefile variable and set the @code{VERBOSE} Automake makefile variable, as in:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:1011
- #, no-wrap
- msgid "make check SCM_LOG_DRIVER_FLAGS=\"--brief=no --errors-only=yes\" VERBOSE=1\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1016
- msgid "The @option{--show-duration=yes} option can be used to print the duration of the individual test cases, when used in combination with @option{--brief=no}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:1019
- #, no-wrap
- msgid "make check SCM_LOG_DRIVER_FLAGS=\"--brief=no --show-duration=yes\"\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1023
- msgid "@xref{Parallel Test Harness,,,automake,GNU Automake} for more information about the Automake Parallel Test Harness."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1028
- msgid "Upon failure, please email @email{bug-guix@@gnu.org} and attach the @file{test-suite.log} file. Please specify the Guix version being used as well as version numbers of the dependencies (@pxref{Requirements}) in your message."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1032
- msgid "Guix also comes with a whole-system test suite that tests complete Guix System instances. It can only run on systems where Guix is already installed, using:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:1035
- #, no-wrap
- msgid "make check-system\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1039
- msgid "or, again, by defining @code{TESTS} to select a subset of tests to run:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:1042
- #, no-wrap
- msgid "make check-system TESTS=\"basic mcron\"\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1050
- msgid "These system tests are defined in the @code{(gnu tests @dots{})} modules. They work by running the operating systems under test with lightweight instrumentation in a virtual machine (VM). They can be computationally intensive or rather cheap, depending on whether substitutes are available for their dependencies (@pxref{Substitutes}). Some of them require a lot of storage space to hold VM images."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1053
- msgid "Again in case of test failures, please send @email{bug-guix@@gnu.org} all the details."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1057
- #, no-wrap
- msgid "daemon"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1065
- msgid "Operations such as building a package or running the garbage collector are all performed by a specialized process, the @dfn{build daemon}, on behalf of clients. Only the daemon may access the store and its associated database. Thus, any operation that manipulates the store goes through the daemon. For instance, command-line tools such as @command{guix package} and @command{guix build} communicate with the daemon (@i{via} remote procedure calls) to instruct it what to do."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1069
- msgid "The following sections explain how to prepare the build daemon's environment. See also @ref{Substitutes}, for information on how to allow the daemon to download pre-built binaries."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1079 guix-git/doc/guix.texi:1542
- #, no-wrap
- msgid "build environment"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1087
- msgid "In a standard multi-user setup, Guix and its daemon---the @command{guix-daemon} program---are installed by the system administrator; @file{/gnu/store} is owned by @code{root} and @command{guix-daemon} runs as @code{root}. Unprivileged users may use Guix tools to build packages or otherwise access the store, and the daemon will do it on their behalf, ensuring that the store is kept in a consistent state, and allowing built packages to be shared among users."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1088
- #, no-wrap
- msgid "build users"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1099
- msgid "When @command{guix-daemon} runs as @code{root}, you may not want package build processes themselves to run as @code{root} too, for obvious security reasons. To avoid that, a special pool of @dfn{build users} should be created for use by build processes started by the daemon. These build users need not have a shell and a home directory: they will just be used when the daemon drops @code{root} privileges in build processes. Having several such users allows the daemon to launch distinct build processes under separate UIDs, which guarantees that they do not interfere with each other---an essential feature since builds are regarded as pure functions (@pxref{Introduction})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1102
- msgid "On a GNU/Linux system, a build user pool may be created like this (using Bash syntax and the @code{shadow} commands):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:1114
- #, no-wrap
- msgid ""
- "# groupadd --system guixbuild\n"
- "# for i in $(seq -w 1 10);\n"
- " do\n"
- " useradd -g guixbuild -G guixbuild \\\n"
- " -d /var/empty -s $(which nologin) \\\n"
- " -c \"Guix build user $i\" --system \\\n"
- " guixbuilder$i;\n"
- " done\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1124
- msgid "The number of build users determines how many build jobs may run in parallel, as specified by the @option{--max-jobs} option (@pxref{Invoking guix-daemon, @option{--max-jobs}}). To use @command{guix system vm} and related commands, you may need to add the build users to the @code{kvm} group so they can access @file{/dev/kvm}, using @code{-G guixbuild,kvm} instead of @code{-G guixbuild} (@pxref{Invoking guix system})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1133
- msgid "The @code{guix-daemon} program may then be run as @code{root} with the following command@footnote{If your machine uses the systemd init system, dropping the @file{@var{prefix}/lib/systemd/system/guix-daemon.service} file in @file{/etc/systemd/system} will ensure that @command{guix-daemon} is automatically started. Similarly, if your machine uses the Upstart init system, drop the @file{@var{prefix}/lib/upstart/system/guix-daemon.conf} file in @file{/etc/init}.}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:1136 guix-git/doc/guix.texi:1535
- #, no-wrap
- msgid "# guix-daemon --build-users-group=guixbuild\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1138 guix-git/doc/guix.texi:1540
- #, no-wrap
- msgid "chroot"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1143
- msgid "This way, the daemon starts build processes in a chroot, under one of the @code{guixbuilder} users. On GNU/Linux, by default, the chroot environment contains nothing but:"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:1151
- msgid "a minimal @code{/dev} directory, created mostly independently from the host @code{/dev}@footnote{``Mostly'', because while the set of files that appear in the chroot's @code{/dev} is fixed, most of these files can only be created if the host has them.};"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:1155
- msgid "the @code{/proc} directory; it only shows the processes of the container since a separate PID name space is used;"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:1159
- msgid "@file{/etc/passwd} with an entry for the current user and an entry for user @file{nobody};"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:1162
- msgid "@file{/etc/group} with an entry for the user's group;"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:1166
- msgid "@file{/etc/hosts} with an entry that maps @code{localhost} to @code{127.0.0.1};"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:1169
- msgid "a writable @file{/tmp} directory."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1178
- msgid "You can influence the directory where the daemon stores build trees @i{via} the @env{TMPDIR} environment variable. However, the build tree within the chroot is always called @file{/tmp/guix-build-@var{name}.drv-0}, where @var{name} is the derivation name---e.g., @code{coreutils-8.24}. This way, the value of @env{TMPDIR} does not leak inside build environments, which avoids discrepancies in cases where build processes capture the name of their build tree."
- msgstr ""
- #. type: vindex
- #: guix-git/doc/guix.texi:1179 guix-git/doc/guix.texi:4007
- #, no-wrap
- msgid "http_proxy"
- msgstr ""
- #. type: vindex
- #: guix-git/doc/guix.texi:1180 guix-git/doc/guix.texi:4008
- #, no-wrap
- msgid "https_proxy"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1185
- msgid "The daemon also honors the @env{http_proxy} and @env{https_proxy} environment variables for HTTP and HTTPS downloads it performs, be it for fixed-output derivations (@pxref{Derivations}) or for substitutes (@pxref{Substitutes})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1193
- msgid "If you are installing Guix as an unprivileged user, it is still possible to run @command{guix-daemon} provided you pass @option{--disable-chroot}. However, build processes will not be isolated from one another, and not from the rest of the system. Thus, build processes may interfere with each other, and may access programs, libraries, and other files available on the system---making it much harder to view them as @emph{pure} functions."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:1196
- #, no-wrap
- msgid "Using the Offload Facility"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1198 guix-git/doc/guix.texi:1601
- #, no-wrap
- msgid "offloading"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1199
- #, no-wrap
- msgid "build hook"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1218
- msgid "When desired, the build daemon can @dfn{offload} derivation builds to other machines running Guix, using the @code{offload} @dfn{build hook}@footnote{This feature is available only when @uref{https://github.com/artyom-poptsov/guile-ssh, Guile-SSH} is present.}. When that feature is enabled, a list of user-specified build machines is read from @file{/etc/guix/machines.scm}; every time a build is requested, for instance via @code{guix build}, the daemon attempts to offload it to one of the machines that satisfy the constraints of the derivation, in particular its system types---e.g., @code{x86_64-linux}. A single machine can have multiple system types, either because its architecture natively supports it, via emulation (@pxref{transparent-emulation-qemu, Transparent Emulation with QEMU}), or both. Missing prerequisites for the build are copied over SSH to the target machine, which then proceeds with the build; upon success the output(s) of the build are copied back to the initial machine. The offload facility comes with a basic scheduler that attempts to select the best machine. The best machine is chosen among the available machines based on criteria such as:"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:1224
- msgid "The availability of a build slot. A build machine can have as many build slots (connections) as the value of the @code{parallel-builds} field of its @code{build-machine} object."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:1228
- msgid "Its relative speed, as defined via the @code{speed} field of its @code{build-machine} object."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:1233
- msgid "Its load. The normalized machine load must be lower than a threshold value, configurable via the @code{overload-threshold} field of its @code{build-machine} object."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:1236
- msgid "Disk space availability. More than a 100 MiB must be available."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1239
- msgid "The @file{/etc/guix/machines.scm} file typically looks like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:1247
- #, no-wrap
- msgid ""
- "(list (build-machine\n"
- " (name \"eightysix.example.org\")\n"
- " (systems (list \"x86_64-linux\" \"i686-linux\"))\n"
- " (host-key \"ssh-ed25519 AAAAC3Nza@dots{}\")\n"
- " (user \"bob\")\n"
- " (speed 2.)) ;incredibly fast!\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:1253
- #, no-wrap
- msgid ""
- " (build-machine\n"
- " (name \"armeight.example.org\")\n"
- " (systems (list \"aarch64-linux\"))\n"
- " (host-key \"ssh-rsa AAAAB3Nza@dots{}\")\n"
- " (user \"alice\")\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:1257
- #, no-wrap
- msgid ""
- " ;; Remember 'guix offload' is spawned by\n"
- " ;; 'guix-daemon' as root.\n"
- " (private-key \"/root/.ssh/identity-for-guix\")))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1263
- msgid "In the example above we specify a list of two build machines, one for the @code{x86_64} and @code{i686} architectures and one for the @code{aarch64} architecture."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1272
- msgid "In fact, this file is---not surprisingly!---a Scheme file that is evaluated when the @code{offload} hook is started. Its return value must be a list of @code{build-machine} objects. While this example shows a fixed list of build machines, one could imagine, say, using DNS-SD to return a list of potential build machines discovered in the local network (@pxref{Introduction, Guile-Avahi,, guile-avahi, Using Avahi in Guile Scheme Programs}). The @code{build-machine} data type is detailed below."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:1273
- #, no-wrap
- msgid "{Data Type} build-machine"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:1276
- msgid "This data type represents build machines to which the daemon may offload builds. The important fields are:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1279 guix-git/doc/guix.texi:7113
- #: guix-git/doc/guix.texi:15446 guix-git/doc/guix.texi:15545
- #: guix-git/doc/guix.texi:15786 guix-git/doc/guix.texi:17314
- #: guix-git/doc/guix.texi:17935 guix-git/doc/guix.texi:18209
- #: guix-git/doc/guix.texi:21269 guix-git/doc/guix.texi:24179
- #: guix-git/doc/guix.texi:25568 guix-git/doc/guix.texi:26180
- #: guix-git/doc/guix.texi:26533 guix-git/doc/guix.texi:26574
- #: guix-git/doc/guix.texi:28735 guix-git/doc/guix.texi:31072
- #: guix-git/doc/guix.texi:31092 guix-git/doc/guix.texi:33766
- #: guix-git/doc/guix.texi:33783 guix-git/doc/guix.texi:34320
- #: guix-git/doc/guix.texi:36095 guix-git/doc/guix.texi:36422
- #, no-wrap
- msgid "name"
- msgstr "نام"
- #. type: table
- #: guix-git/doc/guix.texi:1281
- msgid "The host name of the remote machine."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1282
- #, no-wrap
- msgid "systems"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1285
- msgid "The system types the remote machine supports---e.g., @code{(list \"x86_64-linux\" \"i686-linux\")}."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:1286 guix-git/doc/guix.texi:17945
- #, no-wrap
- msgid "user"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1290
- msgid "The user account to use when connecting to the remote machine over SSH. Note that the SSH key pair must @emph{not} be passphrase-protected, to allow non-interactive logins."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1291
- #, no-wrap
- msgid "host-key"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1295
- msgid "This must be the machine's SSH @dfn{public host key} in OpenSSH format. This is used to authenticate the machine when we connect to it. It is a long string that looks like this:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:1298
- #, no-wrap
- msgid "ssh-ed25519 AAAAC3NzaC@dots{}mde+UhL hint@@example.org\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1303
- msgid "If the machine is running the OpenSSH daemon, @command{sshd}, the host key can be found in a file such as @file{/etc/ssh/ssh_host_ed25519_key.pub}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1308
- msgid "If the machine is running the SSH daemon of GNU@tie{}lsh, @command{lshd}, the host key is in @file{/etc/lsh/host-key.pub} or a similar file. It can be converted to the OpenSSH format using @command{lsh-export-key} (@pxref{Converting keys,,, lsh, LSH Manual}):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:1312
- #, no-wrap
- msgid ""
- "$ lsh-export-key --openssh < /etc/lsh/host-key.pub\n"
- "ssh-rsa AAAAB3NzaC1yc2EAAAAEOp8FoQAAAQEAs1eB46LV@dots{}\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:1317
- msgid "A number of optional fields may be specified:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1320 guix-git/doc/guix.texi:35581
- #, no-wrap
- msgid "@code{port} (default: @code{22})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1322
- msgid "Port number of SSH server on the machine."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1323
- #, no-wrap
- msgid "@code{private-key} (default: @file{~root/.ssh/id_rsa})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1326
- msgid "The SSH private key file to use when connecting to the machine, in OpenSSH format. This key must not be protected with a passphrase."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1329
- msgid "Note that the default value is the private key @emph{of the root account}. Make sure it exists if you use the default."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1330
- #, no-wrap
- msgid "@code{compression} (default: @code{\"zlib@@openssh.com,zlib\"})"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:1331
- #, no-wrap
- msgid "@code{compression-level} (default: @code{3})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1333
- msgid "The SSH-level compression methods and compression level requested."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1336
- msgid "Note that offloading relies on SSH compression to reduce bandwidth usage when transferring files to and from build machines."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1337
- #, no-wrap
- msgid "@code{daemon-socket} (default: @code{\"/var/guix/daemon-socket/socket\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1340
- msgid "File name of the Unix-domain socket @command{guix-daemon} is listening to on that machine."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1341
- #, no-wrap
- msgid "@code{overload-threshold} (default: @code{0.6})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1347
- msgid "The load threshold above which a potential offload machine is disregarded by the offload scheduler. The value roughly translates to the total processor usage of the build machine, ranging from 0.0 (0%) to 1.0 (100%). It can also be disabled by setting @code{overload-threshold} to @code{#f}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1348
- #, no-wrap
- msgid "@code{parallel-builds} (default: @code{1})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1350
- msgid "The number of builds that may run in parallel on the machine."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1351
- #, no-wrap
- msgid "@code{speed} (default: @code{1.0})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1354
- msgid "A ``relative speed factor''. The offload scheduler will tend to prefer machines with a higher speed factor."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1355
- #, no-wrap
- msgid "@code{features} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1360
- msgid "A list of strings denoting specific features supported by the machine. An example is @code{\"kvm\"} for machines that have the KVM Linux modules and corresponding hardware support. Derivations can request features by name, and they will be scheduled on matching build machines."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1366
- msgid "The @command{guix} command must be in the search path on the build machines. You can check whether this is the case by running:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:1369
- #, no-wrap
- msgid "ssh build-machine guix repl --version\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1376
- msgid "There is one last thing to do once @file{machines.scm} is in place. As explained above, when offloading, files are transferred back and forth between the machine stores. For this to work, you first need to generate a key pair on each machine to allow the daemon to export signed archives of files from the store (@pxref{Invoking guix archive}):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:1379 guix-git/doc/guix.texi:35509
- #, no-wrap
- msgid "# guix archive --generate-key\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1384
- msgid "Each build machine must authorize the key of the master machine so that it accepts store items it receives from the master:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:1387
- #, no-wrap
- msgid "# guix archive --authorize < master-public-key.txt\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1391
- msgid "Likewise, the master machine must authorize the key of each build machine."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1397
- msgid "All the fuss with keys is here to express pairwise mutual trust relations between the master and the build machines. Concretely, when the master receives files from a build machine (and @i{vice versa}), its build daemon can make sure they are genuine, have not been tampered with, and that they are signed by an authorized key."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1398
- #, no-wrap
- msgid "offload test"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1401
- msgid "To test whether your setup is operational, run this command on the master node:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:1404
- #, no-wrap
- msgid "# guix offload test\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1410
- msgid "This will attempt to connect to each of the build machines specified in @file{/etc/guix/machines.scm}, make sure Guix is available on each machine, attempt to export to the machine and import from it, and report any error in the process."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1413
- msgid "If you want to test a different machine file, just specify it on the command line:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:1416
- #, no-wrap
- msgid "# guix offload test machines-qualif.scm\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1420
- msgid "Last, you can test the subset of the machines whose name matches a regular expression like this:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:1423
- #, no-wrap
- msgid "# guix offload test machines.scm '\\.gnu\\.org$'\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1425
- #, no-wrap
- msgid "offload status"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1428
- msgid "To display the current load of all build hosts, run this command on the main node:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:1431
- #, no-wrap
- msgid "# guix offload status\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1437
- #, no-wrap
- msgid "SELinux, daemon policy"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1438
- #, no-wrap
- msgid "mandatory access control, SELinux"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1439
- #, no-wrap
- msgid "security, guix-daemon"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1445
- msgid "Guix includes an SELinux policy file at @file{etc/guix-daemon.cil} that can be installed on a system where SELinux is enabled, in order to label Guix files and to specify the expected behavior of the daemon. Since Guix System does not provide an SELinux base policy, the daemon policy cannot be used on Guix System."
- msgstr ""
- #. type: subsubsection
- #: guix-git/doc/guix.texi:1446
- #, no-wrap
- msgid "Installing the SELinux policy"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1447
- #, no-wrap
- msgid "SELinux, policy installation"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1449
- msgid "To install the policy run this command as root:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:1452
- #, no-wrap
- msgid "semodule -i etc/guix-daemon.cil\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1456
- msgid "Then relabel the file system with @code{restorecon} or by a different mechanism provided by your system."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1461
- msgid "Once the policy is installed, the file system has been relabeled, and the daemon has been restarted, it should be running in the @code{guix_daemon_t} context. You can confirm this with the following command:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:1464
- #, no-wrap
- msgid "ps -Zax | grep guix-daemon\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1469
- msgid "Monitor the SELinux log files as you run a command like @code{guix build hello} to convince yourself that SELinux permits all necessary operations."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1471
- #, no-wrap
- msgid "SELinux, limitations"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1476
- msgid "This policy is not perfect. Here is a list of limitations or quirks that should be considered when deploying the provided SELinux policy for the Guix daemon."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:1483
- msgid "@code{guix_daemon_socket_t} isn’t actually used. None of the socket operations involve contexts that have anything to do with @code{guix_daemon_socket_t}. It doesn’t hurt to have this unused label, but it would be preferable to define socket rules for only this label."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:1494
- msgid "@code{guix gc} cannot access arbitrary links to profiles. By design, the file label of the destination of a symlink is independent of the file label of the link itself. Although all profiles under $localstatedir are labelled, the links to these profiles inherit the label of the directory they are in. For links in the user’s home directory this will be @code{user_home_t}. But for links from the root user’s home directory, or @file{/tmp}, or the HTTP server’s working directory, etc, this won’t work. @code{guix gc} would be prevented from reading and following these links."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:1499
- msgid "The daemon’s feature to listen for TCP connections might no longer work. This might require extra rules, because SELinux treats network sockets differently from files."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:1510
- msgid "Currently all files with a name matching the regular expression @code{/gnu/store/.+-(guix-.+|profile)/bin/guix-daemon} are assigned the label @code{guix_daemon_exec_t}; this means that @emph{any} file with that name in any profile would be permitted to run in the @code{guix_daemon_t} domain. This is not ideal. An attacker could build a package that provides this executable and convince a user to install and run it, which lifts it into the @code{guix_daemon_t} domain. At that point SELinux could not prevent it from accessing files that are allowed for processes in that domain."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:1515
- msgid "You will need to relabel the store directory after all upgrades to @file{guix-daemon}, such as after running @code{guix pull}. Assuming the store is in @file{/gnu}, you can do this with @code{restorecon -vR /gnu}, or by other means provided by your operating system."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:1523
- msgid "We could generate a much more restrictive policy at installation time, so that only the @emph{exact} file name of the currently installed @code{guix-daemon} executable would be labelled with @code{guix_daemon_exec_t}, instead of using a broad regular expression. The downside is that root would have to install or upgrade the policy at installation time whenever the Guix package that provides the effectively running @code{guix-daemon} executable is upgraded."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:1526
- #, no-wrap
- msgid "Invoking @command{guix-daemon}"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1532
- msgid "The @command{guix-daemon} program implements all the functionality to access the store. This includes launching build processes, running the garbage collector, querying the availability of a build result, etc. It is normally run as @code{root} like this:"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1539
- msgid "For details on how to set it up, @pxref{Setting Up the Daemon}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1541
- #, no-wrap
- msgid "container, build environment"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1543 guix-git/doc/guix.texi:3071
- #: guix-git/doc/guix.texi:3988 guix-git/doc/guix.texi:13753
- #, no-wrap
- msgid "reproducible builds"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1555
- msgid "By default, @command{guix-daemon} launches build processes under different UIDs, taken from the build group specified with @option{--build-users-group}. In addition, each build process is run in a chroot environment that only contains the subset of the store that the build process depends on, as specified by its derivation (@pxref{Programming Interface, derivation}), plus a set of specific system directories. By default, the latter contains @file{/dev} and @file{/dev/pts}. Furthermore, on GNU/Linux, the build environment is a @dfn{container}: in addition to having its own file system tree, it has a separate mount name space, its own PID name space, network name space, etc. This helps achieve reproducible builds (@pxref{Features})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1561
- msgid "When the daemon performs a build on behalf of the user, it creates a build directory under @file{/tmp} or under the directory specified by its @env{TMPDIR} environment variable. This directory is shared with the container for the duration of the build, though within the container, the build tree is always called @file{/tmp/guix-build-@var{name}.drv-0}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1565
- msgid "The build directory is automatically deleted upon completion, unless the build failed and the client specified @option{--keep-failed} (@pxref{Common Build Options, @option{--keep-failed}})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1571
- msgid "The daemon listens for connections and spawns one sub-process for each session started by a client (one of the @command{guix} sub-commands). The @command{guix processes} command allows you to get an overview of the activity on your system by viewing each of the active sessions and clients. @xref{Invoking guix processes}, for more information."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1573
- msgid "The following command-line options are supported:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1575
- #, no-wrap
- msgid "--build-users-group=@var{group}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1578
- msgid "Take users from @var{group} to run build processes (@pxref{Setting Up the Daemon, build users})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1579 guix-git/doc/guix.texi:10915
- #, no-wrap
- msgid "--no-substitutes"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1580 guix-git/doc/guix.texi:3083
- #: guix-git/doc/guix.texi:3741
- #, no-wrap
- msgid "substitutes"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1584 guix-git/doc/guix.texi:10919
- msgid "Do not use substitutes for build products. That is, always build things locally instead of allowing downloads of pre-built binaries (@pxref{Substitutes})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1588
- msgid "When the daemon runs with @option{--no-substitutes}, clients can still explicitly enable substitution @i{via} the @code{set-build-options} remote procedure call (@pxref{The Store})."
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:1590
- msgid "daemon-substitute-urls"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1590 guix-git/doc/guix.texi:10902
- #: guix-git/doc/guix.texi:13160 guix-git/doc/guix.texi:13899
- #: guix-git/doc/guix.texi:14124
- #, no-wrap
- msgid "--substitute-urls=@var{urls}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1594
- msgid "Consider @var{urls} the default whitespace-separated list of substitute source URLs. When this option is omitted, @indicateurl{@value{SUBSTITUTE-URLS}} is used."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1597
- msgid "This means that substitutes may be downloaded from @var{urls}, as long as they are signed by a trusted signature (@pxref{Substitutes})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1600
- msgid "@xref{Getting Substitutes from Other Servers}, for more information on how to configure the daemon to get substitutes from other servers."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1602 guix-git/doc/guix.texi:10938
- #, no-wrap
- msgid "--no-offload"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1606 guix-git/doc/guix.texi:10942
- msgid "Do not use offload builds to other machines (@pxref{Daemon Offload Setup}). That is, always build things locally instead of offloading builds to remote machines."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1607
- #, no-wrap
- msgid "--cache-failures"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1609
- msgid "Cache build failures. By default, only successful builds are cached."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1614
- msgid "When this option is used, @command{guix gc --list-failures} can be used to query the set of store items marked as failed; @command{guix gc --clear-failures} removes store items from the set of cached failures. @xref{Invoking guix gc}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1615 guix-git/doc/guix.texi:10968
- #, no-wrap
- msgid "--cores=@var{n}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:1616 guix-git/doc/guix.texi:10969
- #, no-wrap
- msgid "-c @var{n}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1619
- msgid "Use @var{n} CPU cores to build each derivation; @code{0} means as many as available."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1623
- msgid "The default value is @code{0}, but it may be overridden by clients, such as the @option{--cores} option of @command{guix build} (@pxref{Invoking guix build})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1627
- msgid "The effect is to define the @env{NIX_BUILD_CORES} environment variable in the build process, which can then use it to exploit internal parallelism---for instance, by running @code{make -j$NIX_BUILD_CORES}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1628 guix-git/doc/guix.texi:10973
- #, no-wrap
- msgid "--max-jobs=@var{n}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:1629 guix-git/doc/guix.texi:10974
- #, no-wrap
- msgid "-M @var{n}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1634
- msgid "Allow at most @var{n} build jobs in parallel. The default value is @code{1}. Setting it to @code{0} means that no builds will be performed locally; instead, the daemon will offload builds (@pxref{Daemon Offload Setup}), or simply fail."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1635 guix-git/doc/guix.texi:10943
- #, no-wrap
- msgid "--max-silent-time=@var{seconds}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1638 guix-git/doc/guix.texi:10946
- msgid "When the build or substitution process remains silent for more than @var{seconds}, terminate it and report a build failure."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1640 guix-git/doc/guix.texi:1649
- msgid "The default value is @code{0}, which disables the timeout."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1643
- msgid "The value specified here can be overridden by clients (@pxref{Common Build Options, @option{--max-silent-time}})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1644 guix-git/doc/guix.texi:10950
- #, no-wrap
- msgid "--timeout=@var{seconds}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1647 guix-git/doc/guix.texi:10953
- msgid "Likewise, when the build or substitution process lasts for more than @var{seconds}, terminate it and report a build failure."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1652
- msgid "The value specified here can be overridden by clients (@pxref{Common Build Options, @option{--timeout}})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1653
- #, no-wrap
- msgid "--rounds=@var{N}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1658
- msgid "Build each derivation @var{n} times in a row, and raise an error if consecutive build results are not bit-for-bit identical. Note that this setting can be overridden by clients such as @command{guix build} (@pxref{Invoking guix build})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1662 guix-git/doc/guix.texi:10937
- #: guix-git/doc/guix.texi:11561
- msgid "When used in conjunction with @option{--keep-failed}, the differing output is kept in the store, under @file{/gnu/store/@dots{}-check}. This makes it easy to look for differences between the two results."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1663
- #, no-wrap
- msgid "--debug"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1665
- msgid "Produce debugging output."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1669
- msgid "This is useful to debug daemon start-up issues, but then it may be overridden by clients, for example the @option{--verbosity} option of @command{guix build} (@pxref{Invoking guix build})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1670
- #, no-wrap
- msgid "--chroot-directory=@var{dir}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1672
- msgid "Add @var{dir} to the build chroot."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1678
- msgid "Doing this may change the result of build processes---for instance if they use optional dependencies found in @var{dir} when it is available, and not otherwise. For that reason, it is not recommended to do so. Instead, make sure that each derivation declares all the inputs that it needs."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1679
- #, no-wrap
- msgid "--disable-chroot"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1681
- msgid "Disable chroot builds."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1686
- msgid "Using this option is not recommended since, again, it would allow build processes to gain access to undeclared dependencies. It is necessary, though, when @command{guix-daemon} is running under an unprivileged user account."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1687
- #, no-wrap
- msgid "--log-compression=@var{type}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1690
- msgid "Compress build logs according to @var{type}, one of @code{gzip}, @code{bzip2}, or @code{none}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1694
- msgid "Unless @option{--lose-logs} is used, all the build logs are kept in the @var{localstatedir}. To save space, the daemon automatically compresses them with Bzip2 by default."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1695
- #, no-wrap
- msgid "--discover[=yes|no]"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1698 guix-git/doc/guix.texi:16563
- msgid "Whether to discover substitute servers on the local network using mDNS and DNS-SD."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1701
- msgid "This feature is still experimental. However, here are a few considerations."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:1705
- msgid "It might be faster/less expensive than fetching from remote servers;"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:1708
- msgid "There are no security risks, only genuine substitutes will be used (@pxref{Substitute Authentication});"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:1712
- msgid "An attacker advertising @command{guix publish} on your LAN cannot serve you malicious binaries, but they can learn what software you’re installing;"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:1715
- msgid "Servers may serve substitute over HTTP, unencrypted, so anyone on the LAN can see what software you’re installing."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1719
- msgid "It is also possible to enable or disable substitute server discovery at run-time by running:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:1723
- #, no-wrap
- msgid ""
- "herd discover guix-daemon on\n"
- "herd discover guix-daemon off\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1725
- #, no-wrap
- msgid "--disable-deduplication"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1726 guix-git/doc/guix.texi:4326
- #, no-wrap
- msgid "deduplication"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1728
- msgid "Disable automatic file ``deduplication'' in the store."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1735
- msgid "By default, files added to the store are automatically ``deduplicated'': if a newly added file is identical to another one found in the store, the daemon makes the new file a hard link to the other file. This can noticeably reduce disk usage, at the expense of slightly increased input/output load at the end of a build process. This option disables this optimization."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1736
- #, no-wrap
- msgid "--gc-keep-outputs[=yes|no]"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1739
- msgid "Tell whether the garbage collector (GC) must keep outputs of live derivations."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1740 guix-git/doc/guix.texi:4139
- #, no-wrap
- msgid "GC roots"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1741 guix-git/doc/guix.texi:4140
- #, no-wrap
- msgid "garbage collector roots"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1747
- msgid "When set to @code{yes}, the GC will keep the outputs of any live derivation available in the store---the @file{.drv} files. The default is @code{no}, meaning that derivation outputs are kept only if they are reachable from a GC root. @xref{Invoking guix gc}, for more on GC roots."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1748
- #, no-wrap
- msgid "--gc-keep-derivations[=yes|no]"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1751
- msgid "Tell whether the garbage collector (GC) must keep derivations corresponding to live outputs."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1757
- msgid "When set to @code{yes}, as is the case by default, the GC keeps derivations---i.e., @file{.drv} files---as long as at least one of their outputs is live. This allows users to keep track of the origins of items in their store. Setting it to @code{no} saves a bit of disk space."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1766
- msgid "In this way, setting @option{--gc-keep-derivations} to @code{yes} causes liveness to flow from outputs to derivations, and setting @option{--gc-keep-outputs} to @code{yes} causes liveness to flow from derivations to outputs. When both are set to @code{yes}, the effect is to keep all the build prerequisites (the sources, compiler, libraries, and other build-time tools) of live objects in the store, regardless of whether these prerequisites are reachable from a GC root. This is convenient for developers since it saves rebuilds or downloads."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1767
- #, no-wrap
- msgid "--impersonate-linux-2.6"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1770
- msgid "On Linux-based systems, impersonate Linux 2.6. This means that the kernel's @command{uname} system call will report 2.6 as the release number."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1773
- msgid "This might be helpful to build programs that (usually wrongfully) depend on the kernel version number."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1774
- #, no-wrap
- msgid "--lose-logs"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1777
- msgid "Do not keep build logs. By default they are kept under @file{@var{localstatedir}/guix/log}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1778 guix-git/doc/guix.texi:4567
- #: guix-git/doc/guix.texi:5846 guix-git/doc/guix.texi:6229
- #: guix-git/doc/guix.texi:6629 guix-git/doc/guix.texi:11505
- #: guix-git/doc/guix.texi:13187 guix-git/doc/guix.texi:13452
- #: guix-git/doc/guix.texi:14129 guix-git/doc/guix.texi:34442
- #: guix-git/doc/guix.texi:35251
- #, no-wrap
- msgid "--system=@var{system}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1782
- msgid "Assume @var{system} as the current system type. By default it is the architecture/kernel pair found at configure time, such as @code{x86_64-linux}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1783 guix-git/doc/guix.texi:10747
- #, no-wrap
- msgid "--listen=@var{endpoint}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1788
- msgid "Listen for connections on @var{endpoint}. @var{endpoint} is interpreted as the file name of a Unix-domain socket if it starts with @code{/} (slash sign). Otherwise, @var{endpoint} is interpreted as a host name or host name and port to listen to. Here are a few examples:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1790
- #, no-wrap
- msgid "--listen=/gnu/var/daemon"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1793
- msgid "Listen for connections on the @file{/gnu/var/daemon} Unix-domain socket, creating it if needed."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1794
- #, no-wrap
- msgid "--listen=localhost"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1795 guix-git/doc/guix.texi:9421
- #, no-wrap
- msgid "daemon, remote access"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1796 guix-git/doc/guix.texi:9422
- #, no-wrap
- msgid "remote access to the daemon"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1797 guix-git/doc/guix.texi:9423
- #, no-wrap
- msgid "daemon, cluster setup"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1798 guix-git/doc/guix.texi:9424
- #, no-wrap
- msgid "clusters, daemon setup"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1801
- msgid "Listen for TCP connections on the network interface corresponding to @code{localhost}, on port 44146."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:1802
- #, no-wrap
- msgid "--listen=128.0.0.42:1234"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1805
- msgid "Listen for TCP connections on the network interface corresponding to @code{128.0.0.42}, on port 1234."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1812
- msgid "This option can be repeated multiple times, in which case @command{guix-daemon} accepts connections on all the specified endpoints. Users can tell client commands what endpoint to connect to by setting the @env{GUIX_DAEMON_SOCKET} environment variable (@pxref{The Store, @env{GUIX_DAEMON_SOCKET}})."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:1819
- msgid "The daemon protocol is @emph{unauthenticated and unencrypted}. Using @option{--listen=@var{host}} is suitable on local networks, such as clusters, where only trusted nodes may connect to the build daemon. In other cases where remote access to the daemon is needed, we recommend using Unix-domain sockets along with SSH."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:1824
- msgid "When @option{--listen} is omitted, @command{guix-daemon} listens for connections on the Unix-domain socket located at @file{@var{localstatedir}/guix/daemon-socket/socket}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1834
- msgid "When using Guix on top of GNU/Linux distribution other than Guix System---a so-called @dfn{foreign distro}---a few additional steps are needed to get everything in place. Here are some of them."
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:1838
- msgid "locales-and-locpath"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1838
- #, no-wrap
- msgid "locales, when not on Guix System"
- msgstr ""
- #. type: vindex
- #: guix-git/doc/guix.texi:1839 guix-git/doc/guix.texi:15770
- #, no-wrap
- msgid "LOCPATH"
- msgstr ""
- #. type: vindex
- #: guix-git/doc/guix.texi:1840
- #, no-wrap
- msgid "GUIX_LOCPATH"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1845
- msgid "Packages installed @i{via} Guix will not use the locale data of the host system. Instead, you must first install one of the locale packages available with Guix and then define the @env{GUIX_LOCPATH} environment variable:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:1849
- #, no-wrap
- msgid ""
- "$ guix install glibc-locales\n"
- "$ export GUIX_LOCPATH=$HOME/.guix-profile/lib/locale\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1855
- msgid "Note that the @code{glibc-locales} package contains data for all the locales supported by the GNU@tie{}libc and weighs in at around 917@tie{}MiB@. Alternatively, the @code{glibc-utf8-locales} is smaller but limited to a few UTF-8 locales."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1859
- msgid "The @env{GUIX_LOCPATH} variable plays a role similar to @env{LOCPATH} (@pxref{Locale Names, @env{LOCPATH},, libc, The GNU C Library Reference Manual}). There are two important differences though:"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:1866
- msgid "@env{GUIX_LOCPATH} is honored only by the libc in Guix, and not by the libc provided by foreign distros. Thus, using @env{GUIX_LOCPATH} allows you to make sure the programs of the foreign distro will not end up loading incompatible locale data."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:1873
- msgid "libc suffixes each entry of @env{GUIX_LOCPATH} with @code{/X.Y}, where @code{X.Y} is the libc version---e.g., @code{2.22}. This means that, should your Guix profile contain a mixture of programs linked against different libc version, each libc version will only try to load locale data in the right format."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1877
- msgid "This is important because the locale data format used by different libc versions may be incompatible."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1880
- #, no-wrap
- msgid "name service switch, glibc"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1881
- #, no-wrap
- msgid "NSS (name service switch), glibc"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1882
- #, no-wrap
- msgid "nscd (name service caching daemon)"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1883
- #, no-wrap
- msgid "name service caching daemon (nscd)"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1890
- msgid "When using Guix on a foreign distro, we @emph{strongly recommend} that the system run the GNU C library's @dfn{name service cache daemon}, @command{nscd}, which should be listening on the @file{/var/run/nscd/socket} socket. Failing to do that, applications installed with Guix may fail to look up host names or user accounts, or may even crash. The next paragraphs explain why."
- msgstr ""
- #. type: file{#1}
- #: guix-git/doc/guix.texi:1891
- #, no-wrap
- msgid "nsswitch.conf"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1896
- msgid "The GNU C library implements a @dfn{name service switch} (NSS), which is an extensible mechanism for ``name lookups'' in general: host name resolution, user accounts, and more (@pxref{Name Service Switch,,, libc, The GNU C Library Reference Manual})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1897
- #, no-wrap
- msgid "Network information service (NIS)"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1898
- #, no-wrap
- msgid "NIS (Network information service)"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1907
- msgid "Being extensible, the NSS supports @dfn{plugins}, which provide new name lookup implementations: for example, the @code{nss-mdns} plugin allow resolution of @code{.local} host names, the @code{nis} plugin allows user account lookup using the Network information service (NIS), and so on. These extra ``lookup services'' are configured system-wide in @file{/etc/nsswitch.conf}, and all the programs running on the system honor those settings (@pxref{NSS Configuration File,,, libc, The GNU C Reference Manual})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1917
- msgid "When they perform a name lookup---for instance by calling the @code{getaddrinfo} function in C---applications first try to connect to the nscd; on success, nscd performs name lookups on their behalf. If the nscd is not running, then they perform the name lookup by themselves, by loading the name lookup services into their own address space and running it. These name lookup services---the @file{libnss_*.so} files---are @code{dlopen}'d, but they may come from the host system's C library, rather than from the C library the application is linked against (the C library coming from Guix)."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1922
- msgid "And this is where the problem is: if your application is linked against Guix's C library (say, glibc 2.24) and tries to load NSS plugins from another C library (say, @code{libnss_mdns.so} for glibc 2.22), it will likely crash or have its name lookups fail unexpectedly."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1927
- msgid "Running @command{nscd} on the system, among other advantages, eliminates this binary incompatibility problem because those @code{libnss_*.so} files are loaded in the @command{nscd} process, not in applications themselves."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:1928
- #, no-wrap
- msgid "X11 Fonts"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1938
- msgid "The majority of graphical applications use Fontconfig to locate and load fonts and perform X11-client-side rendering. The @code{fontconfig} package in Guix looks for fonts in @file{$HOME/.guix-profile} by default. Thus, to allow graphical applications installed with Guix to display fonts, you have to install fonts with Guix as well. Essential font packages include @code{font-ghostscript}, @code{font-dejavu}, and @code{font-gnu-freefont}."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:1939
- #, no-wrap
- msgid "fc-cache"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:1940
- #, no-wrap
- msgid "font cache"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1944
- msgid "Once you have installed or removed fonts, or when you notice an application that does not find fonts, you may need to install Fontconfig and to force an update of its font cache by running:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:1948
- #, no-wrap
- msgid ""
- "guix install fontconfig\n"
- "fc-cache -rv\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1956
- msgid "To display text written in Chinese languages, Japanese, or Korean in graphical applications, consider installing @code{font-adobe-source-han-sans} or @code{font-wqy-zenhei}. The former has multiple outputs, one per language family (@pxref{Packages with Multiple Outputs}). For instance, the following command installs fonts for Chinese languages:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:1959
- #, no-wrap
- msgid "guix install font-adobe-source-han-sans:cn\n"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:1961
- #, no-wrap
- msgid "xterm"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1965
- msgid "Older programs such as @command{xterm} do not use Fontconfig and instead rely on server-side font rendering. Such programs require to specify a full name of a font using XLFD (X Logical Font Description), like this:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:1968
- #, no-wrap
- msgid "-*-dejavu sans-medium-r-normal-*-*-100-*-*-*-*-*-1\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1972
- msgid "To be able to use such full names for the TrueType fonts installed in your Guix profile, you need to extend the font path of the X server:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:1977
- #, no-wrap
- msgid "xset +fp $(dirname $(readlink -f ~/.guix-profile/share/fonts/truetype/fonts.dir))\n"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:1979
- #, no-wrap
- msgid "xlsfonts"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1982
- msgid "After that, you can run @code{xlsfonts} (from @code{xlsfonts} package) to make sure your TrueType fonts are listed there."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:1986 guix-git/doc/guix.texi:34161
- #, no-wrap
- msgid "nss-certs"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1989
- msgid "The @code{nss-certs} package provides X.509 certificates, which allow programs to authenticate Web servers accessed over HTTPS."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:1994
- msgid "When using Guix on a foreign distro, you can install this package and define the relevant environment variables so that packages know where to look for certificates. @xref{X.509 Certificates}, for detailed information."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:1997
- #, no-wrap
- msgid "emacs"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2003
- msgid "When you install Emacs packages with Guix, the Elisp files are placed under the @file{share/emacs/site-lisp/} directory of the profile in which they are installed. The Elisp libraries are made available to Emacs through the @env{EMACSLOADPATH} environment variable, which is set when installing Emacs itself."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2010
- msgid "Additionally, autoload definitions are automatically evaluated at the initialization of Emacs, by the Guix-specific @code{guix-emacs-autoload-packages} procedure. If, for some reason, you want to avoid auto-loading the Emacs packages installed with Guix, you can do so by running Emacs with the @option{--no-site-file} option (@pxref{Init File,,, emacs, The GNU Emacs Manual})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:2015
- #, no-wrap
- msgid "Upgrading Guix, on a foreign distro"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2018
- msgid "To upgrade Guix, run:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2021 guix-git/doc/guix.texi:2879
- #, no-wrap
- msgid "guix pull\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2024
- msgid "@xref{Invoking guix pull}, for more information."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:2025
- #, no-wrap
- msgid "upgrading Guix for the root user, on a foreign distro"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:2026
- #, no-wrap
- msgid "upgrading the Guix daemon, on a foreign distro"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:2027
- #, no-wrap
- msgid "@command{guix pull} for the root user, on a foreign distro"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2030
- msgid "On a foreign distro, you can upgrade the build daemon by running:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2033
- #, no-wrap
- msgid "sudo -i guix pull\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2038
- msgid "followed by (assuming your distro uses the systemd service management tool):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2041
- #, no-wrap
- msgid "systemctl restart guix-daemon.service\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2045
- msgid "On Guix System, upgrading the daemon is achieved by reconfiguring the system (@pxref{Invoking guix system, @code{guix system reconfigure}})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:2052
- #, no-wrap
- msgid "installing Guix System"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:2053
- #, no-wrap
- msgid "Guix System, installation"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2058
- msgid "This section explains how to install Guix System on a machine. Guix, as a package manager, can also be installed on top of a running GNU/Linux system, @pxref{Installation}."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:2067
- msgid "You are reading this documentation with an Info reader. For details on how to use it, hit the @key{RET} key (``return'' or ``enter'') on the link that follows: @pxref{Top, Info reader,, info-stnd, Stand-alone GNU Info}. Hit @kbd{l} afterwards to come back here."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:2070
- msgid "Alternatively, run @command{info info} in another tty to keep the manual available."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2091
- msgid "We consider Guix System to be ready for a wide range of ``desktop'' and server use cases. The reliability guarantees it provides---transactional upgrades and rollbacks, reproducibility---make it a solid foundation."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2094
- msgid "Nevertheless, before you proceed with the installation, be aware of the following noteworthy limitations applicable to version @value{VERSION}:"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:2099
- msgid "More and more system services are provided (@pxref{Services}), but some may be missing."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:2104
- msgid "GNOME, Xfce, LXDE, and Enlightenment are available (@pxref{Desktop Services}), as well as a number of X11 window managers. However, KDE is currently missing."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2109
- msgid "More than a disclaimer, this is an invitation to report issues (and success stories!), and to join us in improving it. @xref{Contributing}, for more info."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:2114
- #, no-wrap
- msgid "hardware support on Guix System"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2123
- msgid "GNU@tie{}Guix focuses on respecting the user's computing freedom. It builds around the kernel Linux-libre, which means that only hardware for which free software drivers and firmware exist is supported. Nowadays, a wide range of off-the-shelf hardware is supported on GNU/Linux-libre---from keyboards to graphics cards to scanners and Ethernet controllers. Unfortunately, there are still areas where hardware vendors deny users control over their own computing, and such hardware is not supported on Guix System."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:2124
- #, no-wrap
- msgid "WiFi, hardware support"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2133
- msgid "One of the main areas where free drivers or firmware are lacking is WiFi devices. WiFi devices known to work include those using Atheros chips (AR9271 and AR7010), which corresponds to the @code{ath9k} Linux-libre driver, and those using Broadcom/AirForce chips (BCM43xx with Wireless-Core Revision 5), which corresponds to the @code{b43-open} Linux-libre driver. Free firmware exists for both and is available out-of-the-box on Guix System, as part of @code{%base-firmware} (@pxref{operating-system Reference, @code{firmware}})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:2134
- #, no-wrap
- msgid "RYF, Respects Your Freedom"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2140
- msgid "The @uref{https://www.fsf.org/, Free Software Foundation} runs @uref{https://www.fsf.org/ryf, @dfn{Respects Your Freedom}} (RYF), a certification program for hardware products that respect your freedom and your privacy and ensure that you have control over your device. We encourage you to check the list of RYF-certified devices."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2144
- msgid "Another useful resource is the @uref{https://www.h-node.org/, H-Node} web site. It contains a catalog of hardware devices with information about their support in GNU/Linux."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2153
- msgid "An ISO-9660 installation image that can be written to a USB stick or burnt to a DVD can be downloaded from @indicateurl{@value{BASE-URL}/guix-system-install-@value{VERSION}.x86_64-linux.iso}, where you can replace @code{x86_64-linux} with one of:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:2157
- msgid "for a GNU/Linux system on Intel/AMD-compatible 64-bit CPUs;"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:2160
- msgid "for a 32-bit GNU/Linux system on Intel-compatible CPUs."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2165
- msgid "Make sure to download the associated @file{.sig} file and to verify the authenticity of the image against it, along these lines:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2169
- #, no-wrap
- msgid ""
- "$ wget @value{BASE-URL}/guix-system-install-@value{VERSION}.x86_64-linux.iso.sig\n"
- "$ gpg --verify guix-system-install-@value{VERSION}.x86_64-linux.iso.sig\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2177
- #, no-wrap
- msgid ""
- "$ wget @value{OPENPGP-SIGNING-KEY-URL} \\\n"
- " -qO - | gpg --import -\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2189
- msgid "This image contains the tools necessary for an installation. It is meant to be copied @emph{as is} to a large-enough USB stick or DVD."
- msgstr ""
- #. type: unnumberedsubsec
- #: guix-git/doc/guix.texi:2190
- #, no-wrap
- msgid "Copying to a USB Stick"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2195
- msgid "Insert a USB stick of 1@tie{}GiB or more into your machine, and determine its device name. Assuming that the USB stick is known as @file{/dev/sdX}, copy the image with:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2199
- #, no-wrap
- msgid ""
- "dd if=guix-system-install-@value{VERSION}.x86_64-linux.iso of=/dev/sdX status=progress\n"
- "sync\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2202
- msgid "Access to @file{/dev/sdX} usually requires root privileges."
- msgstr ""
- #. type: unnumberedsubsec
- #: guix-git/doc/guix.texi:2203
- #, no-wrap
- msgid "Burning on a DVD"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2208
- msgid "Insert a blank DVD into your machine, and determine its device name. Assuming that the DVD drive is known as @file{/dev/srX}, copy the image with:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2211
- #, no-wrap
- msgid "growisofs -dvd-compat -Z /dev/srX=guix-system-install-@value{VERSION}.x86_64-linux.iso\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2214
- msgid "Access to @file{/dev/srX} usually requires root privileges."
- msgstr ""
- #. type: unnumberedsubsec
- #: guix-git/doc/guix.texi:2215
- #, no-wrap
- msgid "Booting"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2222
- msgid "Once this is done, you should be able to reboot the system and boot from the USB stick or DVD@. The latter usually requires you to get in the BIOS or UEFI boot menu, where you can choose to boot from the USB stick. In order to boot from Libreboot, switch to the command mode by pressing the @kbd{c} key and type @command{search_grub usb}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2225
- msgid "@xref{Installing Guix in a VM}, if, instead, you would like to install Guix System in a virtual machine (VM)."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2235
- msgid "Once you have booted, you can use the guided graphical installer, which makes it easy to get started (@pxref{Guided Graphical Installation}). Alternatively, if you are already familiar with GNU/Linux and if you want more control than what the graphical installer provides, you can choose the ``manual'' installation process (@pxref{Manual Installation})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2243
- msgid "The graphical installer is available on TTY1. You can obtain root shells on TTYs 3 to 6 by hitting @kbd{ctrl-alt-f3}, @kbd{ctrl-alt-f4}, etc. TTY2 shows this documentation and you can reach it with @kbd{ctrl-alt-f2}. Documentation is browsable using the Info reader commands (@pxref{Top,,, info-stnd, Stand-alone GNU Info}). The installation system runs the GPM mouse daemon, which allows you to select text with the left mouse button and to paste it with the middle button."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:2248
- msgid "Installation requires access to the Internet so that any missing dependencies of your system configuration can be downloaded. See the ``Networking'' section below."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2255
- msgid "The graphical installer is a text-based user interface. It will guide you, with dialog boxes, through the steps needed to install GNU@tie{}Guix System."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2260
- msgid "The first dialog boxes allow you to set up the system as you use it during the installation: you can choose the language, keyboard layout, and set up networking, which will be used during the installation. The image below shows the networking dialog."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2262
- msgid "@image{images/installer-network,5in,, networking setup with the graphical installer}"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2267
- msgid "Later steps allow you to partition your hard disk, as shown in the image below, to choose whether or not to use encrypted file systems, to enter the host name and root password, and to create an additional account, among other things."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2269
- msgid "@image{images/installer-partitions,5in,, partitioning with the graphical installer}"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2272
- msgid "Note that, at any time, the installer allows you to exit the current installation step and resume at a previous step, as show in the image below."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2274
- msgid "@image{images/installer-resume,5in,, resuming the installation process}"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2279
- msgid "Once you're done, the installer produces an operating system configuration and displays it (@pxref{Using the Configuration System}). At that point you can hit ``OK'' and installation will proceed. On success, you can reboot into the new system and enjoy. @xref{After System Installation}, for what's next!"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2289
- msgid "This section describes how you would ``manually'' install GNU@tie{}Guix System on your machine. This option requires familiarity with GNU/Linux, with the shell, and with common administration tools. If you think this is not for you, consider using the guided graphical installer (@pxref{Guided Graphical Installation})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2295
- msgid "The installation system provides root shells on TTYs 3 to 6; press @kbd{ctrl-alt-f3}, @kbd{ctrl-alt-f4}, and so on to reach them. It includes many common tools needed to install the system. But it is also a full-blown Guix System, which means that you can install additional packages, should you need it, using @command{guix package} (@pxref{Invoking guix package})."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:2302
- #, no-wrap
- msgid "Keyboard Layout, Networking, and Partitioning"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2307
- msgid "Before you can install the system, you may want to adjust the keyboard layout, set up networking, and partition your target hard disk. This section will guide you through this."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:2310 guix-git/doc/guix.texi:15584
- #, no-wrap
- msgid "keyboard layout"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2314
- msgid "The installation image uses the US qwerty keyboard layout. If you want to change it, you can use the @command{loadkeys} command. For example, the following command selects the Dvorak keyboard layout:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2317
- #, no-wrap
- msgid "loadkeys dvorak\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2322
- msgid "See the files under @file{/run/current-system/profile/share/keymaps} for a list of available keyboard layouts. Run @command{man loadkeys} for more information."
- msgstr ""
- #. type: subsubsection
- #: guix-git/doc/guix.texi:2323
- #, no-wrap
- msgid "Networking"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2326
- msgid "Run the following command to see what your network interfaces are called:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2329
- #, no-wrap
- msgid "ifconfig -a\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:2333 guix-git/doc/guix.texi:2355
- msgid "@dots{} or, using the GNU/Linux-specific @command{ip} command:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2336
- #, no-wrap
- msgid "ip address\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2343
- msgid "Wired interfaces have a name starting with @samp{e}; for example, the interface corresponding to the first on-board Ethernet controller is called @samp{eno1}. Wireless interfaces have a name starting with @samp{w}, like @samp{w1p2s0}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:2345
- #, no-wrap
- msgid "Wired connection"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:2348
- msgid "To configure a wired network run the following command, substituting @var{interface} with the name of the wired interface you want to use."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2351
- #, no-wrap
- msgid "ifconfig @var{interface} up\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2358
- #, no-wrap
- msgid "ip link set @var{interface} up\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:2360
- #, no-wrap
- msgid "Wireless connection"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:2361 guix-git/doc/guix.texi:17484
- #, no-wrap
- msgid "wireless"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:2362 guix-git/doc/guix.texi:17485
- #, no-wrap
- msgid "WiFi"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:2367
- msgid "To configure wireless networking, you can create a configuration file for the @command{wpa_supplicant} configuration tool (its location is not important) using one of the available text editors such as @command{nano}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2370
- #, no-wrap
- msgid "nano wpa_supplicant.conf\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:2375
- msgid "As an example, the following stanza can go to this file and will work for many wireless networks, provided you give the actual SSID and passphrase for the network you are connecting to:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2382
- #, no-wrap
- msgid ""
- "network=@{\n"
- " ssid=\"@var{my-ssid}\"\n"
- " key_mgmt=WPA-PSK\n"
- " psk=\"the network's secret passphrase\"\n"
- "@}\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:2387
- msgid "Start the wireless service and run it in the background with the following command (substitute @var{interface} with the name of the network interface you want to use):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2390
- #, no-wrap
- msgid "wpa_supplicant -c wpa_supplicant.conf -i @var{interface} -B\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:2393
- msgid "Run @command{man wpa_supplicant} for more information."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:2395
- #, no-wrap
- msgid "DHCP"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2398
- msgid "At this point, you need to acquire an IP address. On a network where IP addresses are automatically assigned @i{via} DHCP, you can run:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2401
- #, no-wrap
- msgid "dhclient -v @var{interface}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2404
- msgid "Try to ping a server to see if networking is up and running:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2407
- #, no-wrap
- msgid "ping -c 3 gnu.org\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2411
- msgid "Setting up network access is almost always a requirement because the image does not contain all the software and tools that may be needed."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:2412
- #, no-wrap
- msgid "proxy, during system installation"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2415
- msgid "If you need HTTP and HTTPS access to go through a proxy, run the following command:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2418
- #, no-wrap
- msgid "herd set-http-proxy guix-daemon @var{URL}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2423
- msgid "where @var{URL} is the proxy URL, for example @code{http://example.org:8118}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:2424
- #, no-wrap
- msgid "installing over SSH"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2427
- msgid "If you want to, you can continue the installation remotely by starting an SSH server:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2430
- #, no-wrap
- msgid "herd start ssh-daemon\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2434
- msgid "Make sure to either set a password with @command{passwd}, or configure OpenSSH public key authentication before logging in."
- msgstr ""
- #. type: subsubsection
- #: guix-git/doc/guix.texi:2435
- #, no-wrap
- msgid "Disk Partitioning"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2439
- msgid "Unless this has already been done, the next step is to partition, and then format the target partition(s)."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2444
- msgid "The installation image includes several partitioning tools, including Parted (@pxref{Overview,,, parted, GNU Parted User Manual}), @command{fdisk}, and @command{cfdisk}. Run it and set up your disk with the partition layout you want:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2447
- #, no-wrap
- msgid "cfdisk\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2453
- msgid "If your disk uses the GUID Partition Table (GPT) format and you plan to install BIOS-based GRUB (which is the default), make sure a BIOS Boot Partition is available (@pxref{BIOS installation,,, grub, GNU GRUB manual})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:2454
- #, no-wrap
- msgid "EFI, installation"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:2455
- #, no-wrap
- msgid "UEFI, installation"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:2456
- #, no-wrap
- msgid "ESP, EFI system partition"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2460
- msgid "If you instead wish to use EFI-based GRUB, a FAT32 @dfn{EFI System Partition} (ESP) is required. This partition can be mounted at @file{/boot/efi} for instance and must have the @code{esp} flag set. E.g., for @command{parted}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2463
- #, no-wrap
- msgid "parted /dev/sda set 1 esp on\n"
- msgstr ""
- #. type: vindex
- #: guix-git/doc/guix.texi:2466 guix-git/doc/guix.texi:34580
- #, no-wrap
- msgid "grub-bootloader"
- msgstr ""
- #. type: vindex
- #: guix-git/doc/guix.texi:2467 guix-git/doc/guix.texi:34574
- #, no-wrap
- msgid "grub-efi-bootloader"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:2474
- msgid "Unsure whether to use EFI- or BIOS-based GRUB? If the directory @file{/sys/firmware/efi} exists in the installation image, then you should probably perform an EFI installation, using @code{grub-efi-bootloader}. Otherwise you should use the BIOS-based GRUB, known as @code{grub-bootloader}. @xref{Bootloader Configuration}, for more info on bootloaders."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2482
- msgid "Once you are done partitioning the target hard disk drive, you have to create a file system on the relevant partition(s)@footnote{Currently Guix System only supports ext4, btrfs, JFS, F2FS, and XFS file systems. In particular, code that reads file system UUIDs and labels only works for these file system types.}. For the ESP, if you have one and assuming it is @file{/dev/sda1}, run:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2485
- #, no-wrap
- msgid "mkfs.fat -F32 /dev/sda1\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2492
- msgid "For the root file system, ext4 is the most widely used format. Other file systems, such as Btrfs, support compression, which is reported to nicely complement file deduplication that the daemon performs independently of the file system (@pxref{Invoking guix-daemon, deduplication})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2499
- msgid "Preferably, assign file systems a label so that you can easily and reliably refer to them in @code{file-system} declarations (@pxref{File Systems}). This is typically done using the @code{-L} option of @command{mkfs.ext4} and related commands. So, assuming the target root partition lives at @file{/dev/sda2}, a file system with the label @code{my-root} can be created with:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2502
- #, no-wrap
- msgid "mkfs.ext4 -L my-root /dev/sda2\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:2504 guix-git/doc/guix.texi:14475
- #, no-wrap
- msgid "encrypted disk"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2509
- msgid "If you are instead planning to encrypt the root partition, you can use the Cryptsetup/LUKS utilities to do that (see @inlinefmtifelse{html, @uref{https://linux.die.net/man/8/cryptsetup, @code{man cryptsetup}}, @code{man cryptsetup}} for more information)."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:2510 guix-git/doc/guix.texi:5280
- #: guix-git/doc/guix.texi:6489 guix-git/doc/guix.texi:14601
- #: guix-git/doc/guix.texi:21013 guix-git/doc/guix.texi:21020
- #, no-wrap
- msgid "Warning"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:2517
- msgid "Note that GRUB can unlock LUKS2 devices since version 2.06, but only supports the PBKDF2 key derivation function, which is not the default for @command{cryptsetup luksFormat}. You can check which key derivation function is being used by a device by running @command{cryptsetup luksDump @var{device}}, and looking for the PBKDF field of your keyslots."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2522
- msgid "Assuming you want to store the root partition on @file{/dev/sda2}, the command sequence to format it as a LUKS2 partition would be along these lines:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2527
- #, no-wrap
- msgid ""
- "cryptsetup luksFormat --type luks2 --pbkdf pbkdf2 /dev/sda2\n"
- "cryptsetup open /dev/sda2 my-partition\n"
- "mkfs.ext4 -L my-root /dev/mapper/my-partition\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2532
- msgid "Once that is done, mount the target file system under @file{/mnt} with a command like (again, assuming @code{my-root} is the label of the root file system):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2535
- #, no-wrap
- msgid "mount LABEL=my-root /mnt\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2541
- msgid "Also mount any other file systems you would like to use on the target system relative to this path. If you have opted for @file{/boot/efi} as an EFI mount point for example, mount it at @file{/mnt/boot/efi} now so it is found by @code{guix system init} afterwards."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2545
- msgid "Finally, if you plan to use one or more swap partitions (@pxref{Swap Space}), make sure to initialize them with @command{mkswap}. Assuming you have one swap partition on @file{/dev/sda3}, you would run:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2549
- #, no-wrap
- msgid ""
- "mkswap /dev/sda3\n"
- "swapon /dev/sda3\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2557
- msgid "Alternatively, you may use a swap file. For example, assuming that in the new system you want to use the file @file{/swapfile} as a swap file, you would run@footnote{This example will work for many types of file systems (e.g., ext4). However, for copy-on-write file systems (e.g., btrfs), the required steps may be different. For details, see the manual pages for @command{mkswap} and @command{swapon}.}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2565
- #, no-wrap
- msgid ""
- "# This is 10 GiB of swap space. Adjust \"count\" to change the size.\n"
- "dd if=/dev/zero of=/mnt/swapfile bs=1MiB count=10240\n"
- "# For security, make the file readable and writable only by root.\n"
- "chmod 600 /mnt/swapfile\n"
- "mkswap /mnt/swapfile\n"
- "swapon /mnt/swapfile\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2570
- msgid "Note that if you have encrypted the root partition and created a swap file in its file system as described above, then the encryption also protects the swap file, just like any other file in that file system."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2576
- msgid "With the target partitions ready and the target root mounted on @file{/mnt}, we're ready to go. First, run:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2579
- #, no-wrap
- msgid "herd start cow-store /mnt\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2586
- msgid "This makes @file{/gnu/store} copy-on-write, such that packages added to it during the installation phase are written to the target disk on @file{/mnt} rather than kept in memory. This is necessary because the first phase of the @command{guix system init} command (see below) entails downloads or builds to @file{/gnu/store} which, initially, is an in-memory file system."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2597
- msgid "Next, you have to edit a file and provide the declaration of the operating system to be installed. To that end, the installation system comes with three text editors. We recommend GNU nano (@pxref{Top,,, nano, GNU nano Manual}), which supports syntax highlighting and parentheses matching; other editors include mg (an Emacs clone), and nvi (a clone of the original BSD @command{vi} editor). We strongly recommend storing that file on the target root file system, say, as @file{/mnt/etc/config.scm}. Failing to do that, you will have lost your configuration file once you have rebooted into the newly-installed system."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2604
- msgid "@xref{Using the Configuration System}, for an overview of the configuration file. The example configurations discussed in that section are available under @file{/etc/configuration} in the installation image. Thus, to get started with a system configuration providing a graphical display server (a ``desktop'' system), you can run something along these lines:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2609
- #, no-wrap
- msgid ""
- "# mkdir /mnt/etc\n"
- "# cp /etc/configuration/desktop.scm /mnt/etc/config.scm\n"
- "# nano /mnt/etc/config.scm\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2613
- msgid "You should pay attention to what your configuration file contains, and in particular:"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:2625
- msgid "Make sure the @code{bootloader-configuration} form refers to the targets you want to install GRUB on. It should mention @code{grub-bootloader} if you are installing GRUB in the legacy way, or @code{grub-efi-bootloader} for newer UEFI systems. For legacy systems, the @code{targets} field contain the names of the devices, like @code{(list \"/dev/sda\")}; for UEFI systems it names the paths to mounted EFI partitions, like @code{(list \"/boot/efi\")}; do make sure the paths are currently mounted and a @code{file-system} entry is specified in your configuration."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:2631
- msgid "Be sure that your file system labels match the value of their respective @code{device} fields in your @code{file-system} configuration, assuming your @code{file-system} configuration uses the @code{file-system-label} procedure in its @code{device} field."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:2635
- msgid "If there are encrypted or RAID partitions, make sure to add a @code{mapped-devices} field to describe them (@pxref{Mapped Devices})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2640
- msgid "Once you are done preparing the configuration file, the new system must be initialized (remember that the target root file system is mounted under @file{/mnt}):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2643
- #, no-wrap
- msgid "guix system init /mnt/etc/config.scm /mnt\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2650
- msgid "This copies all the necessary files and installs GRUB on @file{/dev/sdX}, unless you pass the @option{--no-bootloader} option. For more information, @pxref{Invoking guix system}. This command may trigger downloads or builds of missing packages, which can take some time."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2658
- msgid "Once that command has completed---and hopefully succeeded!---you can run @command{reboot} and boot into the new system. The @code{root} password in the new system is initially empty; other users' passwords need to be initialized by running the @command{passwd} command as @code{root}, unless your configuration specifies otherwise (@pxref{user-account-password, user account passwords}). @xref{After System Installation}, for what's next!"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2665
- msgid "Success, you've now booted into Guix System! From then on, you can update the system whenever you want by running, say:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2669
- #, no-wrap
- msgid ""
- "guix pull\n"
- "sudo guix system reconfigure /etc/config.scm\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2675
- msgid "This builds a new system generation with the latest packages and services (@pxref{Invoking guix system}). We recommend doing that regularly so that your system includes the latest security updates (@pxref{Security Updates})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:2678
- #, no-wrap
- msgid "sudo vs. @command{guix pull}"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:2682
- msgid "Note that @command{sudo guix} runs your user's @command{guix} command and @emph{not} root's, because @command{sudo} leaves @env{PATH} unchanged. To explicitly run root's @command{guix}, type @command{sudo -i guix @dots{}}."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:2687
- msgid "The difference matters here, because @command{guix pull} updates the @command{guix} command and package definitions only for the user it is run as. This means that if you choose to use @command{guix system reconfigure} in root's login shell, you'll need to @command{guix pull} separately."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2692
- msgid "Now, @pxref{Getting Started}, and join us on @code{#guix} on the Libera Chat IRC network or on @email{guix-devel@@gnu.org} to share your experience!"
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:2695
- #, no-wrap
- msgid "Installing Guix in a Virtual Machine"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:2697
- #, no-wrap
- msgid "virtual machine, Guix System installation"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:2698
- #, no-wrap
- msgid "virtual private server (VPS)"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:2699
- #, no-wrap
- msgid "VPS (virtual private server)"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2703
- msgid "If you'd like to install Guix System in a virtual machine (VM) or on a virtual private server (VPS) rather than on your beloved machine, this section is for you."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2706
- msgid "To boot a @uref{https://qemu.org/,QEMU} VM for installing Guix System in a disk image, follow these steps:"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:2711
- msgid "First, retrieve and decompress the Guix system installation image as described previously (@pxref{USB Stick and DVD Installation})."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:2715
- msgid "Create a disk image that will hold the installed system. To make a qcow2-formatted disk image, use the @command{qemu-img} command:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2718
- #, no-wrap
- msgid "qemu-img create -f qcow2 guix-system.img 50G\n"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:2722
- msgid "The resulting file will be much smaller than 50 GB (typically less than 1 MB), but it will grow as the virtualized storage device is filled up."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:2725
- msgid "Boot the USB installation image in an VM:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2731
- #, no-wrap
- msgid ""
- "qemu-system-x86_64 -m 1024 -smp 1 -enable-kvm \\\n"
- " -nic user,model=virtio-net-pci -boot menu=on,order=d \\\n"
- " -drive file=guix-system.img \\\n"
- " -drive media=cdrom,file=guix-system-install-@value{VERSION}.@var{system}.iso\n"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:2735
- msgid "@code{-enable-kvm} is optional, but significantly improves performance, @pxref{Running Guix in a VM}."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:2739
- msgid "You're now root in the VM, proceed with the installation process. @xref{Preparing for Installation}, and follow the instructions."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2744
- msgid "Once installation is complete, you can boot the system that's on your @file{guix-system.img} image. @xref{Running Guix in a VM}, for how to do that."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:2748
- #, no-wrap
- msgid "installation image"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2751
- msgid "The installation image described above was built using the @command{guix system} command, specifically:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2754
- #, no-wrap
- msgid "guix system image -t iso9660 gnu/system/install.scm\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2759
- msgid "Have a look at @file{gnu/system/install.scm} in the source tree, and see also @ref{Invoking guix system} for more information about the installation image."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:2760
- #, no-wrap
- msgid "Building the Installation Image for ARM Boards"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2764
- msgid "Many ARM boards require a specific variant of the @uref{https://www.denx.de/wiki/U-Boot/, U-Boot} bootloader."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2768
- msgid "If you build a disk image and the bootloader is not available otherwise (on another boot drive etc), it's advisable to build an image that includes the bootloader, specifically:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2771
- #, no-wrap
- msgid "guix system image --system=armhf-linux -e '((@@ (gnu system install) os-with-u-boot) (@@ (gnu system install) installation-os) \"A20-OLinuXino-Lime2\")'\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2775
- msgid "@code{A20-OLinuXino-Lime2} is the name of the board. If you specify an invalid board, a list of possible boards will be printed."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2785
- msgid "Presumably, you've reached this section because either you have installed Guix on top of another distribution (@pxref{Installation}), or you've installed the standalone Guix System (@pxref{System Installation}). It's time for you to get started using Guix and this section aims to help you do that and give you a feel of what it's like."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2789
- msgid "Guix is about installing software, so probably the first thing you'll want to do is to actually look for software. Let's say you're looking for a text editor, you can run:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2792
- #, no-wrap
- msgid "guix search text editor\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2799
- msgid "This command shows you a number of matching @dfn{packages}, each time showing the package's name, version, a description, and additional info. Once you've found out the one you want to use, let's say Emacs (ah ha!), you can go ahead and install it (run this command as a regular user, @emph{no need for root privileges}!):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2802
- #, no-wrap
- msgid "guix install emacs\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:2804 guix-git/doc/guix.texi:3116
- #: guix-git/doc/guix.texi:3168
- #, no-wrap
- msgid "profile"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2812
- msgid "You've installed your first package, congrats! The package is now visible in your default @dfn{profile}, @file{$HOME/.guix-profile}---a profile is a directory containing installed packages. In the process, you've probably noticed that Guix downloaded pre-built binaries; or, if you explicitly chose to @emph{not} use pre-built binaries, then probably Guix is still building software (@pxref{Substitutes}, for more info)."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2815
- msgid "Unless you're using Guix System, the @command{guix install} command must have printed this hint:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2818
- #, no-wrap
- msgid ""
- "hint: Consider setting the necessary environment variables by running:\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2821
- #, no-wrap
- msgid ""
- " GUIX_PROFILE=\"$HOME/.guix-profile\"\n"
- " . \"$GUIX_PROFILE/etc/profile\"\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2823
- #, no-wrap
- msgid "Alternately, see `guix package --search-paths -p \"$HOME/.guix-profile\"'.\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2837
- msgid "Indeed, you must now tell your shell where @command{emacs} and other programs installed with Guix are to be found. Pasting the two lines above will do just that: it will add @code{$HOME/.guix-profile/bin}---which is where the installed package is---to the @code{PATH} environment variable. You can paste these two lines in your shell so they take effect right away, but more importantly you should add them to @file{~/.bash_profile} (or equivalent file if you do not use Bash) so that environment variables are set next time you spawn a shell. You only need to do this once and other search paths environment variables will be taken care of similarly---e.g., if you eventually install @code{python} and Python libraries, @env{GUIX_PYTHONPATH} will be defined."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2840
- msgid "You can go on installing packages at your will. To list installed packages, run:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2843
- #, no-wrap
- msgid "guix package --list-installed\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2848
- msgid "To remove a package, you would unsurprisingly run @command{guix remove}. A distinguishing feature is the ability to @dfn{roll back} any operation you made---installation, removal, upgrade---by simply typing:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2851
- #, no-wrap
- msgid "guix package --roll-back\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2856
- msgid "This is because each operation is in fact a @dfn{transaction} that creates a new @dfn{generation}. These generations and the difference between them can be displayed by running:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2859
- #, no-wrap
- msgid "guix package --list-generations\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2862
- msgid "Now you know the basics of package management!"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:2863 guix-git/doc/guix.texi:2922
- #, no-wrap
- msgid "Going further"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:2871
- msgid "@xref{Package Management}, for more about package management. You may like @dfn{declarative} package management with @command{guix package --manifest}, managing separate @dfn{profiles} with @option{--profile}, deleting old generations, collecting garbage, and other nifty features that will come in handy as you become more familiar with Guix. If you are a developer, @pxref{Development} for additional tools. And if you're curious, @pxref{Features}, to peek under the hood."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2876
- msgid "Once you've installed a set of packages, you will want to periodically @emph{upgrade} them to the latest and greatest version. To do that, you will first pull the latest revision of Guix and its package collection:"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2886
- msgid "The end result is a new @command{guix} command, under @file{~/.config/guix/current/bin}. Unless you're on Guix System, the first time you run @command{guix pull}, be sure to follow the hint that the command prints and, similar to what we saw above, paste these two lines in your terminal and @file{.bash_profile}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2890
- #, no-wrap
- msgid ""
- "GUIX_PROFILE=\"$HOME/.config/guix/current\"\n"
- ". \"$GUIX_PROFILE/etc/profile\"\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2894
- msgid "You must also instruct your shell to point to this new @command{guix}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2897
- #, no-wrap
- msgid "hash guix\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2901
- msgid "At this point, you're running a brand new Guix. You can thus go ahead and actually upgrade all the packages you previously installed:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2904
- #, no-wrap
- msgid "guix upgrade\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2910
- msgid "As you run this command, you will see that binaries are downloaded (or perhaps some packages are built), and eventually you end up with the upgraded packages. Should one of these upgraded packages not be to your liking, remember you can always roll back!"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2913
- msgid "You can display the exact revision of Guix you're currently using by running:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2916
- #, no-wrap
- msgid "guix describe\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2921
- msgid "The information it displays is @emph{all it takes to reproduce the exact same Guix}, be it at a different point in time or on a different machine."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:2927
- msgid "@xref{Invoking guix pull}, for more information. @xref{Channels}, on how to specify additional @dfn{channels} to pull packages from, how to replicate Guix, and more. You may also find @command{time-machine} handy (@pxref{Invoking guix time-machine})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2932
- msgid "If you installed Guix System, one of the first things you'll want to do is to upgrade your system. Once you've run @command{guix pull} to get the latest Guix, you can upgrade the system like this:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2935
- #, no-wrap
- msgid "sudo guix system reconfigure /etc/config.scm\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2944
- msgid "Upon completion, the system runs the latest versions of its software packages. When you eventually reboot, you'll notice a sub-menu in the bootloader that reads ``Old system generations'': it's what allows you to boot @emph{an older generation of your system}, should the latest generation be ``broken'' or otherwise unsatisfying. Just like for packages, you can always @emph{roll back} to a previous generation @emph{of the whole system}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:2947
- #, no-wrap
- msgid "sudo guix system roll-back\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2954
- msgid "There are many things you'll probably want to tweak on your system: adding new user accounts, adding new system services, fiddling with the configuration of those services, etc. The system configuration is @emph{entirely} described in the @file{/etc/config.scm} file. @xref{Using the Configuration System}, to learn how to change it."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2956
- msgid "Now you know enough to get started!"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:2957
- #, no-wrap
- msgid "Resources"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:2960
- msgid "The rest of this manual provides a reference for all things Guix. Here are some additional resources you may find useful:"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:2965
- msgid "@xref{Top,,, guix-cookbook, The GNU Guix Cookbook}, for a list of ``how-to'' style of recipes for a variety of applications."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:2970
- msgid "The @uref{https://guix.gnu.org/guix-refcard.pdf, GNU Guix Reference Card} lists in two pages most of the commands and options you'll ever need."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:2975
- msgid "The web site contains @uref{https://guix.gnu.org/en/videos/, instructional videos} covering topics such as everyday use of Guix, how to get help, and how to become a contributor."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:2979
- msgid "@xref{Documentation}, to learn how to access documentation on your computer."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:2982
- msgid "We hope you will enjoy Guix as much as the community enjoys building it!"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:2993
- msgid "The purpose of GNU Guix is to allow users to easily install, upgrade, and remove software packages, without having to know about their build procedures or dependencies. Guix also goes beyond this obvious set of features."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3001
- msgid "This chapter describes the main features of Guix, as well as the package management tools it provides. Along with the command-line interface described below (@pxref{Invoking guix package, @code{guix package}}), you may also use the Emacs-Guix interface (@pxref{Top,,, emacs-guix, The Emacs-Guix Reference Manual}), after installing @code{emacs-guix} package (run @kbd{M-x guix-help} command to start with it):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3004
- #, no-wrap
- msgid "guix install emacs-guix\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3025
- msgid "Here we assume you've already made your first steps with Guix (@pxref{Getting Started}) and would like to get an overview about what's going on under the hood."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3029
- msgid "When using Guix, each package ends up in the @dfn{package store}, in its own directory---something that resembles @file{/gnu/store/xxx-package-1.2}, where @code{xxx} is a base32 string."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3034
- msgid "Instead of referring to these directories, users have their own @dfn{profile}, which points to the packages that they actually want to use. These profiles are stored within each user's home directory, at @code{$HOME/.guix-profile}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3042
- msgid "For example, @code{alice} installs GCC 4.7.2. As a result, @file{/home/alice/.guix-profile/bin/gcc} points to @file{/gnu/store/@dots{}-gcc-4.7.2/bin/gcc}. Now, on the same machine, @code{bob} had already installed GCC 4.8.0. The profile of @code{bob} simply continues to point to @file{/gnu/store/@dots{}-gcc-4.8.0/bin/gcc}---i.e., both versions of GCC coexist on the same system without any interference."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3046
- msgid "The @command{guix package} command is the central tool to manage packages (@pxref{Invoking guix package}). It operates on the per-user profiles, and can be used @emph{with normal user privileges}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3047 guix-git/doc/guix.texi:3130
- #, no-wrap
- msgid "transactions"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3054
- msgid "The command provides the obvious install, remove, and upgrade operations. Each invocation is actually a @emph{transaction}: either the specified operation succeeds, or nothing happens. Thus, if the @command{guix package} process is terminated during the transaction, or if a power outage occurs during the transaction, then the user's profile remains in its previous state, and remains usable."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3062
- msgid "In addition, any package transaction may be @emph{rolled back}. So, if, for example, an upgrade installs a new version of a package that turns out to have a serious bug, users may roll back to the previous instance of their profile, which was known to work well. Similarly, the global system configuration on Guix is subject to transactional upgrades and roll-back (@pxref{Using the Configuration System})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3069
- msgid "All packages in the package store may be @emph{garbage-collected}. Guix can determine which packages are still referenced by user profiles, and remove those that are provably no longer referenced (@pxref{Invoking guix gc}). Users may also explicitly remove old generations of their profile so that the packages they refer to can be collected."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3082
- msgid "Guix takes a @dfn{purely functional} approach to package management, as described in the introduction (@pxref{Introduction}). Each @file{/gnu/store} package directory name contains a hash of all the inputs that were used to build that package---compiler, libraries, build scripts, etc. This direct correspondence allows users to make sure a given package installation matches the current state of their distribution. It also helps maximize @dfn{build reproducibility}: thanks to the isolated build environments that are used, a given build is likely to yield bit-identical files when performed on different machines (@pxref{Invoking guix-daemon, container})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3093
- msgid "This foundation allows Guix to support @dfn{transparent binary/source deployment}. When a pre-built binary for a @file{/gnu/store} item is available from an external source---a @dfn{substitute}, Guix just downloads it and unpacks it; otherwise, it builds the package from source, locally (@pxref{Substitutes}). Because build results are usually bit-for-bit reproducible, users do not have to trust servers that provide substitutes: they can force a local build and @emph{challenge} providers (@pxref{Invoking guix challenge})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3099
- msgid "Control over the build environment is a feature that is also useful for developers. The @command{guix shell} command allows developers of a package to quickly set up the right development environment for their package, without having to manually install the dependencies of the package into their profile (@pxref{Invoking guix shell})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3100
- #, no-wrap
- msgid "replication, of software environments"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3101
- #, no-wrap
- msgid "provenance tracking, of software artifacts"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3108
- msgid "All of Guix and its package definitions is version-controlled, and @command{guix pull} allows you to ``travel in time'' on the history of Guix itself (@pxref{Invoking guix pull}). This makes it possible to replicate a Guix instance on a different machine or at a later point in time, which in turn allows you to @emph{replicate complete software environments}, while retaining precise @dfn{provenance tracking} of the software."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:3110
- #, no-wrap
- msgid "Invoking @command{guix package}"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3112
- #, no-wrap
- msgid "installing packages"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3113
- #, no-wrap
- msgid "removing packages"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3114
- #, no-wrap
- msgid "package installation"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3115
- #, no-wrap
- msgid "package removal"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3125
- msgid "The @command{guix package} command is the tool that allows users to install, upgrade, and remove packages, as well as rolling back to previous configurations. These operations work on a user @dfn{profile}---a directory of installed packages. Each user has a default profile in @file{$HOME/.guix-profile}. The command operates only on the user's own profile, and works with normal user privileges (@pxref{Features}). Its syntax is:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3128
- #, no-wrap
- msgid "guix package @var{options}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3135
- msgid "Primarily, @var{options} specifies the operations to be performed during the transaction. Upon completion, a new profile is created, but previous @dfn{generations} of the profile remain available, should the user want to roll back."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3138
- msgid "For example, to remove @code{lua} and install @code{guile} and @code{guile-cairo} in a single transaction:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3141
- #, no-wrap
- msgid "guix package -r lua -i guile guile-cairo\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3143
- #, no-wrap
- msgid "aliases, for @command{guix package}"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3145
- msgid "For your convenience, we also provide the following aliases:"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:3149
- msgid "@command{guix search} is an alias for @command{guix package -s},"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:3151
- msgid "@command{guix install} is an alias for @command{guix package -i},"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:3153
- msgid "@command{guix remove} is an alias for @command{guix package -r},"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:3155
- msgid "@command{guix upgrade} is an alias for @command{guix package -u},"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:3157
- msgid "and @command{guix show} is an alias for @command{guix package --show=}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3162
- msgid "These aliases are less expressive than @command{guix package} and provide fewer options, so in some cases you'll probably want to use @command{guix package} directly."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3167
- msgid "@command{guix package} also supports a @dfn{declarative approach} whereby the user specifies the exact set of packages to be available and passes it @i{via} the @option{--manifest} option (@pxref{profile-manifest, @option{--manifest}})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3174
- msgid "For each user, a symlink to the user's default profile is automatically created in @file{$HOME/.guix-profile}. This symlink always points to the current generation of the user's default profile. Thus, users can add @file{$HOME/.guix-profile/bin} to their @env{PATH} environment variable, and so on."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3174 guix-git/doc/guix.texi:3418
- #, no-wrap
- msgid "search paths"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3179
- msgid "If you are not using Guix System, consider adding the following lines to your @file{~/.bash_profile} (@pxref{Bash Startup Files,,, bash, The GNU Bash Reference Manual}) so that newly-spawned shells get all the right environment variable definitions:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3183
- #, no-wrap
- msgid ""
- "GUIX_PROFILE=\"$HOME/.guix-profile\" ; \\\n"
- "source \"$GUIX_PROFILE/etc/profile\"\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3194
- msgid "In a multi-user setup, user profiles are stored in a place registered as a @dfn{garbage-collector root}, which @file{$HOME/.guix-profile} points to (@pxref{Invoking guix gc}). That directory is normally @code{@var{localstatedir}/guix/profiles/per-user/@var{user}}, where @var{localstatedir} is the value passed to @code{configure} as @option{--localstatedir}, and @var{user} is the user name. The @file{per-user} directory is created when @command{guix-daemon} is started, and the @var{user} sub-directory is created by @command{guix package}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3196
- msgid "The @var{options} can be among the following:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:3199
- #, no-wrap
- msgid "--install=@var{package} @dots{}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:3200
- #, no-wrap
- msgid "-i @var{package} @dots{}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3202
- msgid "Install the specified @var{package}s."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3207
- msgid "Each @var{package} may specify either a simple package name, such as @code{guile}, or a package name followed by an at-sign and version number, such as @code{guile@@1.8.8} or simply @code{guile@@1.8} (in the latter case, the newest version prefixed by @code{1.8} is selected)."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3215
- msgid "If no version number is specified, the newest available version will be selected. In addition, @var{package} may contain a colon, followed by the name of one of the outputs of the package, as in @code{gcc:doc} or @code{binutils@@2.22:lib} (@pxref{Packages with Multiple Outputs}). Packages with a corresponding name (and optionally version) are searched for among the GNU distribution modules (@pxref{Package Modules})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3216
- #, no-wrap
- msgid "propagated inputs"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3222
- msgid "Sometimes packages have @dfn{propagated inputs}: these are dependencies that automatically get installed along with the required package (@pxref{package-propagated-inputs, @code{propagated-inputs} in @code{package} objects}, for information about propagated inputs in package definitions)."
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:3229
- msgid "package-cmd-propagated-inputs"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3229
- msgid "An example is the GNU MPC library: its C header files refer to those of the GNU MPFR library, which in turn refer to those of the GMP library. Thus, when installing MPC, the MPFR and GMP libraries also get installed in the profile; removing MPC also removes MPFR and GMP---unless they had also been explicitly installed by the user."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3234
- msgid "Besides, packages sometimes rely on the definition of environment variables for their search paths (see explanation of @option{--search-paths} below). Any missing or possibly incorrect environment variable definitions are reported here."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:3235
- #, no-wrap
- msgid "--install-from-expression=@var{exp}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:3236
- #, no-wrap
- msgid "-e @var{exp}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3238
- msgid "Install the package @var{exp} evaluates to."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3243
- msgid "@var{exp} must be a Scheme expression that evaluates to a @code{<package>} object. This option is notably useful to disambiguate between same-named variants of a package, with expressions such as @code{(@@ (gnu packages base) guile-final)}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3247
- msgid "Note that this option installs the first output of the specified package, which may be insufficient when needing a specific output of a multiple-output package."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:3248
- #, no-wrap
- msgid "--install-from-file=@var{file}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:3249 guix-git/doc/guix.texi:5781
- #: guix-git/doc/guix.texi:11396
- #, no-wrap
- msgid "-f @var{file}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3251
- msgid "Install the package that the code within @var{file} evaluates to."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3254 guix-git/doc/guix.texi:5787
- #: guix-git/doc/guix.texi:6162
- msgid "As an example, @var{file} might contain a definition like this (@pxref{Defining Packages}):"
- msgstr ""
- #. type: include
- #: guix-git/doc/guix.texi:3256 guix-git/doc/guix.texi:11404
- #, no-wrap
- msgid "package-hello.scm"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3263
- msgid "Developers may find it useful to include such a @file{guix.scm} file in the root of their project source tree that can be used to test development snapshots and create reproducible development environments (@pxref{Invoking guix shell})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3268
- msgid "The @var{file} may also contain a JSON representation of one or more package definitions. Running @code{guix package -f} on @file{hello.json} with the following contents would result in installing the package @code{greeter} after building @code{myhello}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3271 guix-git/doc/guix.texi:11414
- #, no-wrap
- msgid "@verbatiminclude package-hello.json\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:3273
- #, no-wrap
- msgid "--remove=@var{package} @dots{}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:3274
- #, no-wrap
- msgid "-r @var{package} @dots{}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3276
- msgid "Remove the specified @var{package}s."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3281
- msgid "As for @option{--install}, each @var{package} may specify a version number and/or output name in addition to the package name. For instance, @samp{-r glibc:debug} would remove the @code{debug} output of @code{glibc}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:3282
- #, no-wrap
- msgid "--upgrade[=@var{regexp} @dots{}]"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:3283
- #, no-wrap
- msgid "-u [@var{regexp} @dots{}]"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3284
- #, no-wrap
- msgid "upgrading packages"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3288
- msgid "Upgrade all the installed packages. If one or more @var{regexp}s are specified, upgrade only installed packages whose name matches a @var{regexp}. Also see the @option{--do-not-upgrade} option below."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3293
- msgid "Note that this upgrades package to the latest version of packages found in the distribution currently installed. To update your distribution, you should regularly run @command{guix pull} (@pxref{Invoking guix pull})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3294
- #, no-wrap
- msgid "package transformations, upgrades"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3299
- msgid "When upgrading, package transformations that were originally applied when creating the profile are automatically re-applied (@pxref{Package Transformation Options}). For example, assume you first installed Emacs from the tip of its development branch with:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3302
- #, no-wrap
- msgid "guix install emacs-next --with-branch=emacs-next=master\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3307
- msgid "Next time you run @command{guix upgrade}, Guix will again pull the tip of the Emacs development branch and build @code{emacs-next} from that checkout."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3312
- msgid "Note that transformation options such as @option{--with-branch} and @option{--with-source} depend on external state; it is up to you to ensure that they work as expected. You can also discard a transformations that apply to a package by running:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3315
- #, no-wrap
- msgid "guix install @var{package}\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:3317
- #, no-wrap
- msgid "--do-not-upgrade[=@var{regexp} @dots{}]"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3322
- msgid "When used together with the @option{--upgrade} option, do @emph{not} upgrade any packages whose name matches a @var{regexp}. For example, to upgrade all packages in the current profile except those containing the substring ``emacs'':"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3325
- #, no-wrap
- msgid "$ guix package --upgrade . --do-not-upgrade emacs\n"
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:3327
- #, no-wrap
- msgid "profile-manifest"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:3327 guix-git/doc/guix.texi:5799
- #: guix-git/doc/guix.texi:6167 guix-git/doc/guix.texi:6615
- #: guix-git/doc/guix.texi:12535 guix-git/doc/guix.texi:14135
- #, no-wrap
- msgid "--manifest=@var{file}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:3328 guix-git/doc/guix.texi:5800
- #: guix-git/doc/guix.texi:6168 guix-git/doc/guix.texi:6616
- #: guix-git/doc/guix.texi:12536
- #, no-wrap
- msgid "-m @var{file}"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3329
- #, no-wrap
- msgid "profile declaration"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3330
- #, no-wrap
- msgid "profile manifest"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3334
- msgid "Create a new generation of the profile from the manifest object returned by the Scheme code in @var{file}. This option can be repeated several times, in which case the manifests are concatenated."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3340
- msgid "This allows you to @emph{declare} the profile's contents rather than constructing it through a sequence of @option{--install} and similar commands. The advantage is that @var{file} can be put under version control, copied to different machines to reproduce the same profile, and so on."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3344
- msgid "@var{file} must return a @dfn{manifest} object, which is roughly a list of packages:"
- msgstr ""
- #. type: findex
- #: guix-git/doc/guix.texi:3345
- #, no-wrap
- msgid "packages->manifest"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:3348
- #, no-wrap
- msgid ""
- "(use-package-modules guile emacs)\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:3354
- #, no-wrap
- msgid ""
- "(packages->manifest\n"
- " (list emacs\n"
- " guile-2.0\n"
- " ;; Use a specific package output.\n"
- " (list guile-2.0 \"debug\")))\n"
- msgstr ""
- #. type: findex
- #: guix-git/doc/guix.texi:3356
- #, no-wrap
- msgid "specifications->manifest"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3363
- msgid "In this example we have to know which modules define the @code{emacs} and @code{guile-2.0} variables to provide the right @code{use-package-modules} line, which can be cumbersome. We can instead provide regular package specifications and let @code{specifications->manifest} look up the corresponding package objects, like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:3367
- #, no-wrap
- msgid ""
- "(specifications->manifest\n"
- " '(\"emacs\" \"guile@@2.2\" \"guile@@2.2:debug\"))\n"
- msgstr ""
- #. type: findex
- #: guix-git/doc/guix.texi:3369
- #, no-wrap
- msgid "package->development-manifest"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3372
- msgid "You might also want to create a manifest for all the dependencies of a package, rather than the package itself:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:3375
- #, no-wrap
- msgid "(package->development-manifest (specification->package \"emacs\"))\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3379
- msgid "The example above gives you all the software required to develop Emacs, similar to what @command{guix environment emacs} provides."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3382
- msgid "@xref{export-manifest, @option{--export-manifest}}, to learn how to obtain a manifest file from an existing profile."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:3383 guix-git/doc/guix.texi:4492
- #, no-wrap
- msgid "--roll-back"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3384 guix-git/doc/guix.texi:4493
- #: guix-git/doc/guix.texi:35006 guix-git/doc/guix.texi:37641
- #, no-wrap
- msgid "rolling back"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3385 guix-git/doc/guix.texi:4494
- #, no-wrap
- msgid "undoing transactions"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3386 guix-git/doc/guix.texi:4495
- #, no-wrap
- msgid "transactions, undoing"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3389
- msgid "Roll back to the previous @dfn{generation} of the profile---i.e., undo the last transaction."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3392
- msgid "When combined with options such as @option{--install}, roll back occurs before any other actions."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3396
- msgid "When rolling back from the first generation that actually contains installed packages, the profile is made to point to the @dfn{zeroth generation}, which contains no files apart from its own metadata."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3400
- msgid "After having rolled back, installing, removing, or upgrading packages overwrites previous future generations. Thus, the history of the generations in a profile is always linear."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:3401 guix-git/doc/guix.texi:4499
- #, no-wrap
- msgid "--switch-generation=@var{pattern}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:3402 guix-git/doc/guix.texi:4500
- #, no-wrap
- msgid "-S @var{pattern}"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3403 guix-git/doc/guix.texi:3635
- #: guix-git/doc/guix.texi:4501 guix-git/doc/guix.texi:34964
- #, no-wrap
- msgid "generations"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3405 guix-git/doc/guix.texi:4503
- msgid "Switch to a particular generation defined by @var{pattern}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3411 guix-git/doc/guix.texi:4509
- msgid "@var{pattern} may be either a generation number or a number prefixed with ``+'' or ``-''. The latter means: move forward/backward by a specified number of generations. For example, if you want to return to the latest generation after @option{--roll-back}, use @option{--switch-generation=+1}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3416
- msgid "The difference between @option{--roll-back} and @option{--switch-generation=-1} is that @option{--switch-generation} will not make a zeroth generation, so if a specified generation does not exist, the current generation will not be changed."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:3417
- #, no-wrap
- msgid "--search-paths[=@var{kind}]"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3423
- msgid "Report environment variable definitions, in Bash syntax, that may be needed in order to use the set of installed packages. These environment variables are used to specify @dfn{search paths} for files used by some of the installed packages."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3431
- msgid "For example, GCC needs the @env{CPATH} and @env{LIBRARY_PATH} environment variables to be defined so it can look for headers and libraries in the user's profile (@pxref{Environment Variables,,, gcc, Using the GNU Compiler Collection (GCC)}). If GCC and, say, the C library are installed in the profile, then @option{--search-paths} will suggest setting these variables to @file{@var{profile}/include} and @file{@var{profile}/lib}, respectively."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3434
- msgid "The typical use case is to define these environment variables in the shell:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3437
- #, no-wrap
- msgid "$ eval `guix package --search-paths`\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3443
- msgid "@var{kind} may be one of @code{exact}, @code{prefix}, or @code{suffix}, meaning that the returned environment variable definitions will either be exact settings, or prefixes or suffixes of the current value of these variables. When omitted, @var{kind} defaults to @code{exact}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3446
- msgid "This option can also be used to compute the @emph{combined} search paths of several profiles. Consider this example:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3451
- #, no-wrap
- msgid ""
- "$ guix package -p foo -i guile\n"
- "$ guix package -p bar -i guile-json\n"
- "$ guix package -p foo -p bar --search-paths\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3456
- msgid "The last command above reports about the @env{GUILE_LOAD_PATH} variable, even though, taken individually, neither @file{foo} nor @file{bar} would lead to that recommendation."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3458
- #, no-wrap
- msgid "profile, choosing"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:3459 guix-git/doc/guix.texi:4529
- #: guix-git/doc/guix.texi:4858
- #, no-wrap
- msgid "--profile=@var{profile}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:3460 guix-git/doc/guix.texi:4530
- #: guix-git/doc/guix.texi:4859
- #, no-wrap
- msgid "-p @var{profile}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3462
- msgid "Use @var{profile} instead of the user's default profile."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3467
- msgid "@var{profile} must be the name of a file that will be created upon completion. Concretely, @var{profile} will be a mere symbolic link (``symlink'') pointing to the actual profile where packages are installed:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3473
- #, no-wrap
- msgid ""
- "$ guix install hello -p ~/code/my-profile\n"
- "@dots{}\n"
- "$ ~/code/my-profile/bin/hello\n"
- "Hello, world!\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3477
- msgid "All it takes to get rid of the profile is to remove this symlink and its siblings that point to specific generations:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3480
- #, no-wrap
- msgid "$ rm ~/code/my-profile ~/code/my-profile-*-link\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:3482
- #, no-wrap
- msgid "--list-profiles"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3484
- msgid "List all the user's profiles:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3491
- #, no-wrap
- msgid ""
- "$ guix package --list-profiles\n"
- "/home/charlie/.guix-profile\n"
- "/home/charlie/code/my-profile\n"
- "/home/charlie/code/devel-profile\n"
- "/home/charlie/tmp/test\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3494
- msgid "When running as root, list all the profiles of all the users."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3495
- #, no-wrap
- msgid "collisions, in a profile"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3496
- #, no-wrap
- msgid "colliding packages in profiles"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3497
- #, no-wrap
- msgid "profile collisions"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:3498
- #, no-wrap
- msgid "--allow-collisions"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3500
- msgid "Allow colliding packages in the new profile. Use at your own risk!"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3504
- msgid "By default, @command{guix package} reports as an error @dfn{collisions} in the profile. Collisions happen when two or more different versions or variants of a given package end up in the profile."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:3505 guix-git/doc/guix.texi:4572
- #: guix-git/doc/guix.texi:6701
- #, no-wrap
- msgid "--bootstrap"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3508
- msgid "Use the bootstrap Guile to build the profile. This option is only useful to distribution developers."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3514
- msgid "In addition to these actions, @command{guix package} supports the following options to query the current state of a profile, or the availability of packages:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:3517
- #, no-wrap
- msgid "--search=@var{regexp}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:3518
- #, no-wrap
- msgid "-s @var{regexp}"
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:3520
- msgid "guix-search"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3520
- #, no-wrap
- msgid "searching for packages"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3526
- msgid "List the available packages whose name, synopsis, or description matches @var{regexp} (in a case-insensitive fashion), sorted by relevance. Print all the metadata of matching packages in @code{recutils} format (@pxref{Top, GNU recutils databases,, recutils, GNU recutils manual})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3529
- msgid "This allows specific fields to be extracted using the @command{recsel} command, for instance:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3535
- #, no-wrap
- msgid ""
- "$ guix package -s malloc | recsel -p name,version,relevance\n"
- "name: jemalloc\n"
- "version: 4.5.0\n"
- "relevance: 6\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3539
- #, no-wrap
- msgid ""
- "name: glibc\n"
- "version: 2.25\n"
- "relevance: 1\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3543
- #, no-wrap
- msgid ""
- "name: libgc\n"
- "version: 7.6.0\n"
- "relevance: 1\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3547
- msgid "Similarly, to show the name of all the packages available under the terms of the GNU@tie{}LGPL version 3:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3551
- #, no-wrap
- msgid ""
- "$ guix package -s \"\" | recsel -p name -e 'license ~ \"LGPL 3\"'\n"
- "name: elfutils\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3554
- #, no-wrap
- msgid ""
- "name: gmp\n"
- "@dots{}\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3560
- msgid "It is also possible to refine search results using several @code{-s} flags to @command{guix package}, or several arguments to @command{guix search}. For example, the following command returns a list of board games (this time using the @command{guix search} alias):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3565
- #, no-wrap
- msgid ""
- "$ guix search '\\<board\\>' game | recsel -p name\n"
- "name: gnubg\n"
- "@dots{}\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3571
- msgid "If we were to omit @code{-s game}, we would also get software packages that deal with printed circuit boards; removing the angle brackets around @code{board} would further add packages that have to do with keyboards."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3575
- msgid "And now for a more elaborate example. The following command searches for cryptographic libraries, filters out Haskell, Perl, Python, and Ruby libraries, and prints the name and synopsis of the matching packages:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3579
- #, no-wrap
- msgid ""
- "$ guix search crypto library | \\\n"
- " recsel -e '! (name ~ \"^(ghc|perl|python|ruby)\")' -p name,synopsis\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3584
- msgid "@xref{Selection Expressions,,, recutils, GNU recutils manual}, for more information on @dfn{selection expressions} for @code{recsel -e}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:3585
- #, no-wrap
- msgid "--show=@var{package}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3589
- msgid "Show details about @var{package}, taken from the list of available packages, in @code{recutils} format (@pxref{Top, GNU recutils databases,, recutils, GNU recutils manual})."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3594
- #, no-wrap
- msgid ""
- "$ guix package --show=guile | recsel -p name,version\n"
- "name: guile\n"
- "version: 3.0.5\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3597
- #, no-wrap
- msgid ""
- "name: guile\n"
- "version: 3.0.2\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3601
- #, no-wrap
- msgid ""
- "name: guile\n"
- "version: 2.2.7\n"
- "@dots{}\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3605
- msgid "You may also specify the full name of a package to only get details about a specific version of it (this time using the @command{guix show} alias):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3609
- #, no-wrap
- msgid ""
- "$ guix show guile@@3.0.5 | recsel -p name,version\n"
- "name: guile\n"
- "version: 3.0.5\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:3611
- #, no-wrap
- msgid "--list-installed[=@var{regexp}]"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:3612
- #, no-wrap
- msgid "-I [@var{regexp}]"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3616
- msgid "List the currently installed packages in the specified profile, with the most recently installed packages shown last. When @var{regexp} is specified, list only installed packages whose name matches @var{regexp}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3622
- msgid "For each installed package, print the following items, separated by tabs: the package name, its version string, the part of the package that is installed (for instance, @code{out} for the default output, @code{include} for its headers, etc.), and the path of this package in the store."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:3623
- #, no-wrap
- msgid "--list-available[=@var{regexp}]"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:3624
- #, no-wrap
- msgid "-A [@var{regexp}]"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3628
- msgid "List packages currently available in the distribution for this system (@pxref{GNU Distribution}). When @var{regexp} is specified, list only available packages whose name matches @var{regexp}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3632
- msgid "For each package, print the following items separated by tabs: its name, its version string, the parts of the package (@pxref{Packages with Multiple Outputs}), and the source location of its definition."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:3633 guix-git/doc/guix.texi:4485
- #, no-wrap
- msgid "--list-generations[=@var{pattern}]"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:3634 guix-git/doc/guix.texi:4486
- #, no-wrap
- msgid "-l [@var{pattern}]"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3640
- msgid "Return a list of generations along with their creation dates; for each generation, show the installed packages, with the most recently installed packages shown last. Note that the zeroth generation is never shown."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3645
- msgid "For each installed package, print the following items, separated by tabs: the name of a package, its version string, the part of the package that is installed (@pxref{Packages with Multiple Outputs}), and the location of this package in the store."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3648
- msgid "When @var{pattern} is used, the command returns only matching generations. Valid patterns include:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:3650
- #, no-wrap
- msgid "@emph{Integers and comma-separated integers}. Both patterns denote"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:3653
- msgid "generation numbers. For instance, @option{--list-generations=1} returns the first one."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:3656
- msgid "And @option{--list-generations=1,8,2} outputs three generations in the specified order. Neither spaces nor trailing commas are allowed."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:3657
- #, no-wrap
- msgid "@emph{Ranges}. @option{--list-generations=2..9} prints the"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:3660
- msgid "specified generations and everything in between. Note that the start of a range must be smaller than its end."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:3664
- msgid "It is also possible to omit the endpoint. For example, @option{--list-generations=2..}, returns all generations starting from the second one."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:3665
- #, no-wrap
- msgid "@emph{Durations}. You can also get the last @emph{N}@tie{}days, weeks,"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:3669
- msgid "or months by passing an integer along with the first letter of the duration. For example, @option{--list-generations=20d} lists generations that are up to 20 days old."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:3671 guix-git/doc/guix.texi:4510
- #, no-wrap
- msgid "--delete-generations[=@var{pattern}]"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:3672 guix-git/doc/guix.texi:4511
- #, no-wrap
- msgid "-d [@var{pattern}]"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3675 guix-git/doc/guix.texi:4514
- msgid "When @var{pattern} is omitted, delete all generations except the current one."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3681 guix-git/doc/guix.texi:4520
- msgid "This command accepts the same patterns as @option{--list-generations}. When @var{pattern} is specified, delete the matching generations. When @var{pattern} specifies a duration, generations @emph{older} than the specified duration match. For instance, @option{--delete-generations=1m} deletes generations that are more than one month old."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3684
- msgid "If the current generation matches, it is @emph{not} deleted. Also, the zeroth generation is never deleted."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3687 guix-git/doc/guix.texi:4525
- msgid "Note that deleting generations prevents rolling back to them. Consequently, this command must be used with care."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3688
- #, no-wrap
- msgid "manifest, exporting"
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:3690
- msgid "export-manifest"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:3690
- #, no-wrap
- msgid "--export-manifest"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3693
- msgid "Write to standard output a manifest suitable for @option{--manifest} corresponding to the chosen profile(s)."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3697
- msgid "This option is meant to help you migrate from the ``imperative'' operating mode---running @command{guix install}, @command{guix upgrade}, etc.---to the declarative mode that @option{--manifest} offers."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3702
- msgid "Be aware that the resulting manifest @emph{approximates} what your profile actually contains; for instance, depending on how your profile was created, it can refer to packages or package versions that are not exactly what you specified."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3707
- msgid "Keep in mind that a manifest is purely symbolic: it only contains package names and possibly versions, and their meaning varies over time. If you wish to ``pin'' channels to the revisions that were used to build the profile(s), see @option{--export-channels} below."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3708
- #, no-wrap
- msgid "pinning, channel revisions of a profile"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:3709
- #, no-wrap
- msgid "--export-channels"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3713
- msgid "Write to standard output the list of channels used by the chosen profile(s), in a format suitable for @command{guix pull --channels} or @command{guix time-machine --channels} (@pxref{Channels})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3717
- msgid "Together with @option{--export-manifest}, this option provides information allowing you to replicate the current profile (@pxref{Replicating Guix})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3725
- msgid "However, note that the output of this command @emph{approximates} what was actually used to build this profile. In particular, a single profile might have been built from several different revisions of the same channel. In that case, @option{--export-manifest} chooses the last one and writes the list of other revisions in a comment. If you really need to pick packages from different channel revisions, you can use inferiors in your manifest to do so (@pxref{Inferiors})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:3730
- msgid "Together with @option{--export-manifest}, this is a good starting point if you are willing to migrate from the ``imperative'' model to the fully declarative model consisting of a manifest file along with a channels file pinning the exact channel revision(s) you want."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3737
- msgid "Finally, since @command{guix package} may actually start build processes, it supports all the common build options (@pxref{Common Build Options}). It also supports package transformation options, such as @option{--with-source}, and preserves them across upgrades (@pxref{Package Transformation Options})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3742
- #, no-wrap
- msgid "pre-built binaries"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3748
- msgid "Guix supports transparent source/binary deployment, which means that it can either build things locally, or download pre-built items from a server, or both. We call these pre-built items @dfn{substitutes}---they are substitutes for local build results. In many cases, downloading a substitute is much faster than building things locally."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3753
- msgid "Substitutes can be anything resulting from a derivation build (@pxref{Derivations}). Of course, in the common case, they are pre-built package binaries, but source tarballs, for instance, which also result from derivation builds, can be available as substitutes."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3767
- #, no-wrap
- msgid "build farm"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3778
- msgid "@code{@value{SUBSTITUTE-SERVER-1}} and @code{@value{SUBSTITUTE-SERVER-2}} are both front-ends to official build farms that build packages from Guix continuously for some architectures, and make them available as substitutes. These are the default source of substitutes; which can be overridden by passing the @option{--substitute-urls} option either to @command{guix-daemon} (@pxref{daemon-substitute-urls,, @code{guix-daemon --substitute-urls}}) or to client tools such as @command{guix package} (@pxref{client-substitute-urls,, client @option{--substitute-urls} option})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3784
- msgid "Substitute URLs can be either HTTP or HTTPS. HTTPS is recommended because communications are encrypted; conversely, using HTTP makes all communications visible to an eavesdropper, who could use the information gathered to determine, for instance, whether your system has unpatched security vulnerabilities."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3793
- msgid "Substitutes from the official build farms are enabled by default when using Guix System (@pxref{GNU Distribution}). However, they are disabled by default when using Guix on a foreign distribution, unless you have explicitly enabled them via one of the recommended installation steps (@pxref{Installation}). The following paragraphs describe how to enable or disable substitutes for the official build farm; the same procedure can also be used to enable substitutes for any other substitute server."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3797
- #, no-wrap
- msgid "security"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3799
- #, no-wrap
- msgid "access control list (ACL), for substitutes"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3800
- #, no-wrap
- msgid "ACL (access control list), for substitutes"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3806
- msgid "To allow Guix to download substitutes from @code{@value{SUBSTITUTE-SERVER-1}}, @code{@value{SUBSTITUTE-SERVER-2}} or a mirror, you must add the relevant public key to the access control list (ACL) of archive imports, using the @command{guix archive} command (@pxref{Invoking guix archive}). Doing so implies that you trust the substitute server to not be compromised and to serve genuine substitutes."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:3811
- msgid "If you are using Guix System, you can skip this section: Guix System authorizes substitutes from @code{@value{SUBSTITUTE-SERVER-1}} and @code{@value{SUBSTITUTE-SERVER-2}} by default."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3819
- msgid "The public keys for each of the project maintained substitute servers are installed along with Guix, in @code{@var{prefix}/share/guix/}, where @var{prefix} is the installation prefix of Guix. If you installed Guix from source, make sure you checked the GPG signature of @file{guix-@value{VERSION}.tar.gz}, which contains this public key file. Then, you can run something like this:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3823
- #, no-wrap
- msgid ""
- "# guix archive --authorize < @var{prefix}/share/guix/@value{SUBSTITUTE-SERVER-1}.pub\n"
- "# guix archive --authorize < @var{prefix}/share/guix/@value{SUBSTITUTE-SERVER-2}.pub\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3827
- msgid "Once this is in place, the output of a command like @code{guix build} should change from something like:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3836
- #, no-wrap
- msgid ""
- "$ guix build emacs --dry-run\n"
- "The following derivations would be built:\n"
- " /gnu/store/yr7bnx8xwcayd6j95r2clmkdl1qh688w-emacs-24.3.drv\n"
- " /gnu/store/x8qsh1hlhgjx6cwsjyvybnfv2i37z23w-dbus-1.6.4.tar.gz.drv\n"
- " /gnu/store/1ixwp12fl950d15h2cj11c73733jay0z-alsa-lib-1.0.27.1.tar.bz2.drv\n"
- " /gnu/store/nlma1pw0p603fpfiqy7kn4zm105r5dmw-util-linux-2.21.drv\n"
- "@dots{}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3840
- msgid "to something like:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3849
- #, no-wrap
- msgid ""
- "$ guix build emacs --dry-run\n"
- "112.3 MB would be downloaded:\n"
- " /gnu/store/pk3n22lbq6ydamyymqkkz7i69wiwjiwi-emacs-24.3\n"
- " /gnu/store/2ygn4ncnhrpr61rssa6z0d9x22si0va3-libjpeg-8d\n"
- " /gnu/store/71yz6lgx4dazma9dwn2mcjxaah9w77jq-cairo-1.12.16\n"
- " /gnu/store/7zdhgp0n1518lvfn8mb96sxqfmvqrl7v-libxrender-0.9.7\n"
- "@dots{}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3856
- msgid "The text changed from ``The following derivations would be built'' to ``112.3 MB would be downloaded''. This indicates that substitutes from the configured substitute servers are usable and will be downloaded, when possible, for future builds."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3857
- #, no-wrap
- msgid "substitutes, how to disable"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3863
- msgid "The substitute mechanism can be disabled globally by running @code{guix-daemon} with @option{--no-substitutes} (@pxref{Invoking guix-daemon}). It can also be disabled temporarily by passing the @option{--no-substitutes} option to @command{guix package}, @command{guix build}, and other command-line tools."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3867
- #, no-wrap
- msgid "substitute servers, adding more"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3874
- msgid "Guix can look up and fetch substitutes from several servers. This is useful when you are using packages from additional channels for which the official server does not have substitutes but another server provides them. Another situation where this is useful is when you would prefer to download from your organization's substitute server, resorting to the official server only as a fallback or dismissing it altogether."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3879
- msgid "You can give Guix a list of substitute server URLs and it will check them in the specified order. You also need to explicitly authorize the public keys of substitute servers to instruct Guix to accept the substitutes they sign."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3886
- msgid "On Guix System, this is achieved by modifying the configuration of the @code{guix} service. Since the @code{guix} service is part of the default lists of services, @code{%base-services} and @code{%desktop-services}, you can use @code{modify-services} to change its configuration and add the URLs and substitute keys that you want (@pxref{Service Reference, @code{modify-services}})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3892
- msgid "As an example, suppose you want to fetch substitutes from @code{guix.example.org} and to authorize the signing key of that server, in addition to the default @code{@value{SUBSTITUTE-SERVER-1}} and @code{@value{SUBSTITUTE-SERVER-2}}. The resulting operating system configuration will look something like:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:3909
- #, no-wrap
- msgid ""
- "(operating-system\n"
- " ;; @dots{}\n"
- " (services\n"
- " ;; Assume we're starting from '%desktop-services'. Replace it\n"
- " ;; with the list of services you're actually using.\n"
- " (modify-services %desktop-services\n"
- " (guix-service-type config =>\n"
- " (guix-configuration\n"
- " (inherit config)\n"
- " (substitute-urls\n"
- " (append (list \"https://guix.example.org\")\n"
- " %default-substitute-urls))\n"
- " (authorized-keys\n"
- " (append (list (local-file \"./key.pub\"))\n"
- " %default-authorized-guix-keys)))))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3916
- msgid "This assumes that the file @file{key.pub} contains the signing key of @code{guix.example.org}. With this change in place in your operating system configuration file (say @file{/etc/config.scm}), you can reconfigure and restart the @code{guix-daemon} service or reboot so the changes take effect:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3920
- #, no-wrap
- msgid ""
- "$ sudo guix system reconfigure /etc/config.scm\n"
- "$ sudo herd restart guix-daemon\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3924
- msgid "If you're running Guix on a ``foreign distro'', you would instead take the following steps to get substitutes from additional servers:"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:3933
- msgid "Edit the service configuration file for @code{guix-daemon}; when using systemd, this is normally @file{/etc/systemd/system/guix-daemon.service}. Add the @option{--substitute-urls} option on the @command{guix-daemon} command line and list the URLs of interest (@pxref{daemon-substitute-urls, @code{guix-daemon --substitute-urls}}):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3936
- #, no-wrap
- msgid "@dots{} --substitute-urls='https://guix.example.org @value{SUBSTITUTE-URLS}'\n"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:3940
- msgid "Restart the daemon. For systemd, it goes like this:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3944
- #, no-wrap
- msgid ""
- "systemctl daemon-reload\n"
- "systemctl restart guix-daemon.service\n"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:3948
- msgid "Authorize the key of the new server (@pxref{Invoking guix archive}):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3951
- #, no-wrap
- msgid "guix archive --authorize < key.pub\n"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:3955
- msgid "Again this assumes @file{key.pub} contains the public key that @code{guix.example.org} uses to sign substitutes."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3964
- msgid "Now you're all set! Substitutes will be preferably taken from @code{https://guix.example.org}, using @code{@value{SUBSTITUTE-SERVER-1}} then @code{@value{SUBSTITUTE-SERVER-2}} as fallback options. Of course you can list as many substitute servers as you like, with the caveat that substitute lookup can be slowed down if too many servers need to be contacted."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3968
- msgid "Note that there are also situations where one may want to add the URL of a substitute server @emph{without} authorizing its key. @xref{Substitute Authentication}, to understand this fine point."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:3972
- #, no-wrap
- msgid "digital signatures"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3976
- msgid "Guix detects and raises an error when attempting to use a substitute that has been tampered with. Likewise, it ignores substitutes that are not signed, or that are not signed by one of the keys listed in the ACL."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3982
- msgid "There is one exception though: if an unauthorized server provides substitutes that are @emph{bit-for-bit identical} to those provided by an authorized server, then the unauthorized server becomes eligible for downloads. For example, assume we have chosen two substitute servers with this option:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:3985
- #, no-wrap
- msgid "--substitute-urls=\"https://a.example.org https://b.example.org\"\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:3996
- msgid "If the ACL contains only the key for @samp{b.example.org}, and if @samp{a.example.org} happens to serve the @emph{exact same} substitutes, then Guix will download substitutes from @samp{a.example.org} because it comes first in the list and can be considered a mirror of @samp{b.example.org}. In practice, independent build machines usually produce the same binaries, thanks to bit-reproducible builds (see below)."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4003
- msgid "When using HTTPS, the server's X.509 certificate is @emph{not} validated (in other words, the server is not authenticated), contrary to what HTTPS clients such as Web browsers usually do. This is because Guix authenticates substitute information itself, as explained above, which is what we care about (whereas X.509 certificates are about authenticating bindings between domain names and public keys)."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4015
- msgid "Substitutes are downloaded over HTTP or HTTPS@. The @env{http_proxy} and @env{https_proxy} environment variables can be set in the environment of @command{guix-daemon} and are honored for downloads of substitutes. Note that the value of those environment variables in the environment where @command{guix build}, @command{guix package}, and other client commands are run has @emph{absolutely no effect}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4024
- msgid "Even when a substitute for a derivation is available, sometimes the substitution attempt will fail. This can happen for a variety of reasons: the substitute server might be offline, the substitute may recently have been deleted, the connection might have been interrupted, etc."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4038
- msgid "When substitutes are enabled and a substitute for a derivation is available, but the substitution attempt fails, Guix will attempt to build the derivation locally depending on whether or not @option{--fallback} was given (@pxref{fallback-option,, common build option @option{--fallback}}). Specifically, if @option{--fallback} was omitted, then no local build will be performed, and the derivation is considered to have failed. However, if @option{--fallback} was given, then Guix will attempt to build the derivation locally, and the success or failure of the derivation depends on the success or failure of the local build. Note that when substitutes are disabled or no substitute is available for the derivation in question, a local build will @emph{always} be performed, regardless of whether or not @option{--fallback} was given."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4043
- msgid "To get an idea of how many substitutes are available right now, you can try running the @command{guix weather} command (@pxref{Invoking guix weather}). This command provides statistics on the substitutes provided by a server."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4047
- #, no-wrap
- msgid "trust, of pre-built binaries"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4057
- msgid "Today, each individual's control over their own computing is at the mercy of institutions, corporations, and groups with enough power and determination to subvert the computing infrastructure and exploit its weaknesses. While using substitutes can be convenient, we encourage users to also build on their own, or even run their own build farm, such that the project run substitute servers are less of an interesting target. One way to help is by publishing the software you build using @command{guix publish} so that others have one more choice of server to download substitutes from (@pxref{Invoking guix publish})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4069
- msgid "Guix has the foundations to maximize build reproducibility (@pxref{Features}). In most cases, independent builds of a given package or derivation should yield bit-identical results. Thus, through a diverse set of independent package builds, we can strengthen the integrity of our systems. The @command{guix challenge} command aims to help users assess substitute servers, and to assist developers in finding out about non-deterministic package builds (@pxref{Invoking guix challenge}). Similarly, the @option{--check} option of @command{guix build} allows users to check whether previously-installed substitutes are genuine by rebuilding them locally (@pxref{build-check, @command{guix build --check}})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4073
- msgid "In the future, we want Guix to have support to publish and retrieve binaries to/from other users, in a peer-to-peer fashion. If you would like to discuss this project, join us on @email{guix-devel@@gnu.org}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4077
- #, no-wrap
- msgid "multiple-output packages"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4078
- #, no-wrap
- msgid "package outputs"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4079
- #, no-wrap
- msgid "outputs"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4089
- msgid "Often, packages defined in Guix have a single @dfn{output}---i.e., the source package leads to exactly one directory in the store. When running @command{guix install glibc}, one installs the default output of the GNU libc package; the default output is called @code{out}, but its name can be omitted as shown in this command. In this particular case, the default output of @code{glibc} contains all the C header files, shared libraries, static libraries, Info documentation, and other supporting files."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4097
- msgid "Sometimes it is more appropriate to separate the various types of files produced from a single source package into separate outputs. For instance, the GLib C library (used by GTK+ and related packages) installs more than 20 MiB of reference documentation as HTML pages. To save space for users who do not need it, the documentation goes to a separate output, called @code{doc}. To install the main GLib output, which contains everything but the documentation, one would run:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:4100
- #, no-wrap
- msgid "guix install glib\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4102 guix-git/doc/guix.texi:36368
- #: guix-git/doc/guix.texi:36425
- #, no-wrap
- msgid "documentation"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4104
- msgid "The command to install its documentation is:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:4107
- #, no-wrap
- msgid "guix install glib:doc\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4118
- msgid "Some packages install programs with different ``dependency footprints''. For instance, the WordNet package installs both command-line tools and graphical user interfaces (GUIs). The former depend solely on the C library, whereas the latter depend on Tcl/Tk and the underlying X libraries. In this case, we leave the command-line tools in the default output, whereas the GUIs are in a separate output. This allows users who do not need the GUIs to save space. The @command{guix size} command can help find out about such situations (@pxref{Invoking guix size}). @command{guix graph} can also be helpful (@pxref{Invoking guix graph})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4126
- msgid "There are several such multiple-output packages in the GNU distribution. Other conventional output names include @code{lib} for libraries and possibly header files, @code{bin} for stand-alone programs, and @code{debug} for debugging information (@pxref{Installing Debugging Files}). The outputs of a packages are listed in the third column of the output of @command{guix package --list-available} (@pxref{Invoking guix package})."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:4129
- #, no-wrap
- msgid "Invoking @command{guix gc}"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4131
- #, no-wrap
- msgid "garbage collector"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4132
- #, no-wrap
- msgid "disk space"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4138
- msgid "Packages that are installed, but not used, may be @dfn{garbage-collected}. The @command{guix gc} command allows users to explicitly run the garbage collector to reclaim space from the @file{/gnu/store} directory. It is the @emph{only} way to remove files from @file{/gnu/store}---removing files or directories manually may break it beyond repair!"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4149
- msgid "The garbage collector has a set of known @dfn{roots}: any file under @file{/gnu/store} reachable from a root is considered @dfn{live} and cannot be deleted; any other file is considered @dfn{dead} and may be deleted. The set of garbage collector roots (``GC roots'' for short) includes default user profiles; by default, the symlinks under @file{/var/guix/gcroots} represent these GC roots. New GC roots can be added with @command{guix build --root}, for example (@pxref{Invoking guix build}). The @command{guix gc --list-roots} command lists them."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4155
- msgid "Prior to running @code{guix gc --collect-garbage} to make space, it is often useful to remove old generations from user profiles; that way, old package builds referenced by those generations can be reclaimed. This is achieved by running @code{guix package --delete-generations} (@pxref{Invoking guix package})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4159
- msgid "Our recommendation is to run a garbage collection periodically, or when you are short on disk space. For instance, to guarantee that at least 5@tie{}GB are available on your disk, simply run:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:4162
- #, no-wrap
- msgid "guix gc -F 5G\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4171
- msgid "It is perfectly safe to run as a non-interactive periodic job (@pxref{Scheduled Job Execution}, for how to set up such a job). Running @command{guix gc} with no arguments will collect as much garbage as it can, but that is often inconvenient: you may find yourself having to rebuild or re-download software that is ``dead'' from the GC viewpoint but that is necessary to build other pieces of software---e.g., the compiler tool chain."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4177
- msgid "The @command{guix gc} command has three modes of operation: it can be used to garbage-collect any dead files (the default), to delete specific files (the @option{--delete} option), to print garbage-collector information, or for more advanced queries. The garbage collection options are as follows:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4179
- #, no-wrap
- msgid "--collect-garbage[=@var{min}]"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:4180
- #, no-wrap
- msgid "-C [@var{min}]"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4184
- msgid "Collect garbage---i.e., unreachable @file{/gnu/store} files and sub-directories. This is the default operation when no option is specified."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4189
- msgid "When @var{min} is given, stop once @var{min} bytes have been collected. @var{min} may be a number of bytes, or it may include a unit as a suffix, such as @code{MiB} for mebibytes and @code{GB} for gigabytes (@pxref{Block size, size specifications,, coreutils, GNU Coreutils})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4191
- msgid "When @var{min} is omitted, collect all the garbage."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4192
- #, no-wrap
- msgid "--free-space=@var{free}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:4193
- #, no-wrap
- msgid "-F @var{free}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4197
- msgid "Collect garbage until @var{free} space is available under @file{/gnu/store}, if possible; @var{free} denotes storage space, such as @code{500MiB}, as described above."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4200
- msgid "When @var{free} or more is already available in @file{/gnu/store}, do nothing and exit immediately."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4201
- #, no-wrap
- msgid "--delete-generations[=@var{duration}]"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:4202
- #, no-wrap
- msgid "-d [@var{duration}]"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4206
- msgid "Before starting the garbage collection process, delete all the generations older than @var{duration}, for all the user profiles; when run as root, this applies to all the profiles @emph{of all the users}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4210
- msgid "For example, this command deletes all the generations of all your profiles that are older than 2 months (except generations that are current), and then proceeds to free space until at least 10 GiB are available:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:4213
- #, no-wrap
- msgid "guix gc -d 2m -F 10G\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4215
- #, no-wrap
- msgid "--delete"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:4216 guix-git/doc/guix.texi:5740
- #, no-wrap
- msgid "-D"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4220
- msgid "Attempt to delete all the store files and directories specified as arguments. This fails if some of the files are not in the store, or if they are still live."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4221
- #, no-wrap
- msgid "--list-failures"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4223
- msgid "List store items corresponding to cached build failures."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4227
- msgid "This prints nothing unless the daemon was started with @option{--cache-failures} (@pxref{Invoking guix-daemon, @option{--cache-failures}})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4228
- #, no-wrap
- msgid "--list-roots"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4231
- msgid "List the GC roots owned by the user; when run as root, list @emph{all} the GC roots."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4232
- #, no-wrap
- msgid "--list-busy"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4235
- msgid "List store items in use by currently running processes. These store items are effectively considered GC roots: they cannot be deleted."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4236
- #, no-wrap
- msgid "--clear-failures"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4238
- msgid "Remove the specified store items from the failed-build cache."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4241
- msgid "Again, this option only makes sense when the daemon is started with @option{--cache-failures}. Otherwise, it does nothing."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4242
- #, no-wrap
- msgid "--list-dead"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4245
- msgid "Show the list of dead files and directories still present in the store---i.e., files and directories no longer reachable from any root."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4246
- #, no-wrap
- msgid "--list-live"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4248
- msgid "Show the list of live store files and directories."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4252
- msgid "In addition, the references among existing store files can be queried:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4255
- #, no-wrap
- msgid "--references"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:4256
- #, no-wrap
- msgid "--referrers"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4257 guix-git/doc/guix.texi:13205
- #, no-wrap
- msgid "package dependencies"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4260
- msgid "List the references (respectively, the referrers) of store files given as arguments."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4261
- #, no-wrap
- msgid "--requisites"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:4262 guix-git/doc/guix.texi:6501
- #, no-wrap
- msgid "-R"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4263 guix-git/doc/guix.texi:13061
- #: guix-git/doc/guix.texi:13089 guix-git/doc/guix.texi:13170
- #, no-wrap
- msgid "closure"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4268
- msgid "List the requisites of the store files passed as arguments. Requisites include the store files themselves, their references, and the references of these, recursively. In other words, the returned list is the @dfn{transitive closure} of the store files."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4272
- msgid "@xref{Invoking guix size}, for a tool to profile the size of the closure of an element. @xref{Invoking guix graph}, for a tool to visualize the graph of references."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4273
- #, no-wrap
- msgid "--derivers"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4274 guix-git/doc/guix.texi:6815
- #: guix-git/doc/guix.texi:12917 guix-git/doc/guix.texi:13314
- #, no-wrap
- msgid "derivation"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4277
- msgid "Return the derivation(s) leading to the given store items (@pxref{Derivations})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4279
- msgid "For example, this command:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:4282
- #, no-wrap
- msgid "guix gc --derivers $(guix package -I ^emacs$ | cut -f4)\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4287
- msgid "returns the @file{.drv} file(s) leading to the @code{emacs} package installed in your profile."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4291
- msgid "Note that there may be zero matching @file{.drv} files, for instance because these files have been garbage-collected. There can also be more than one matching @file{.drv} due to fixed-output derivations."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4295
- msgid "Lastly, the following options allow you to check the integrity of the store and to control disk usage."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4298
- #, no-wrap
- msgid "--verify[=@var{options}]"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4299
- #, no-wrap
- msgid "integrity, of the store"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4300
- #, no-wrap
- msgid "integrity checking"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4302
- msgid "Verify the integrity of the store."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4305
- msgid "By default, make sure that all the store items marked as valid in the database of the daemon actually exist in @file{/gnu/store}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4308
- msgid "When provided, @var{options} must be a comma-separated list containing one or more of @code{contents} and @code{repair}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4314
- msgid "When passing @option{--verify=contents}, the daemon computes the content hash of each store item and compares it against its hash in the database. Hash mismatches are reported as data corruptions. Because it traverses @emph{all the files in the store}, this command can take a long time, especially on systems with a slow disk drive."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4315
- #, no-wrap
- msgid "repairing the store"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4316 guix-git/doc/guix.texi:11564
- #, no-wrap
- msgid "corruption, recovering from"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4324
- msgid "Using @option{--verify=repair} or @option{--verify=contents,repair} causes the daemon to try to repair corrupt store items by fetching substitutes for them (@pxref{Substitutes}). Because repairing is not atomic, and thus potentially dangerous, it is available only to the system administrator. A lightweight alternative, when you know exactly which items in the store are corrupt, is @command{guix build --repair} (@pxref{Invoking guix build})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4325
- #, no-wrap
- msgid "--optimize"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4329
- msgid "Optimize the store by hard-linking identical files---this is @dfn{deduplication}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4335
- msgid "The daemon performs deduplication after each successful build or archive import, unless it was started with @option{--disable-deduplication} (@pxref{Invoking guix-daemon, @option{--disable-deduplication}}). Thus, this option is primarily useful when the daemon was running with @option{--disable-deduplication}."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:4339
- #, no-wrap
- msgid "Invoking @command{guix pull}"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4341
- #, no-wrap
- msgid "upgrading Guix"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4342
- #, no-wrap
- msgid "updating Guix"
- msgstr ""
- #. type: command{#1}
- #: guix-git/doc/guix.texi:4343
- #, no-wrap
- msgid "guix pull"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4344
- #, no-wrap
- msgid "pull"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4345
- #, no-wrap
- msgid "security, @command{guix pull}"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4346
- #, no-wrap
- msgid "authenticity, of code obtained with @command{guix pull}"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4356
- msgid "Packages are installed or upgraded to the latest version available in the distribution currently available on your local machine. To update that distribution, along with the Guix tools, you must run @command{guix pull}: the command downloads the latest Guix source code and package descriptions, and deploys it. Source code is downloaded from a @uref{https://git-scm.com, Git} repository, by default the official GNU@tie{}Guix repository, though this can be customized. @command{guix pull} ensures that the code it downloads is @emph{authentic} by verifying that commits are signed by Guix developers."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4359
- msgid "Specifically, @command{guix pull} downloads code from the @dfn{channels} (@pxref{Channels}) specified by one of the followings, in this order:"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:4363
- msgid "the @option{--channels} option;"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:4365
- msgid "the user's @file{~/.config/guix/channels.scm} file;"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:4367
- msgid "the system-wide @file{/etc/guix/channels.scm} file;"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:4370
- msgid "the built-in default channels specified in the @code{%default-channels} variable."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4377
- msgid "On completion, @command{guix package} will use packages and package versions from this just-retrieved copy of Guix. Not only that, but all the Guix commands and Scheme modules will also be taken from that latest version. New @command{guix} sub-commands added by the update also become available."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4383
- msgid "Any user can update their Guix copy using @command{guix pull}, and the effect is limited to the user who ran @command{guix pull}. For instance, when user @code{root} runs @command{guix pull}, this has no effect on the version of Guix that user @code{alice} sees, and vice versa."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4389
- msgid "The result of running @command{guix pull} is a @dfn{profile} available under @file{~/.config/guix/current} containing the latest Guix. Thus, make sure to add it to the beginning of your search path so that you use the latest version, and similarly for the Info manual (@pxref{Documentation}):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:4393
- #, no-wrap
- msgid ""
- "export PATH=\"$HOME/.config/guix/current/bin:$PATH\"\n"
- "export INFOPATH=\"$HOME/.config/guix/current/share/info:$INFOPATH\"\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4397
- msgid "The @option{--list-generations} or @option{-l} option lists past generations produced by @command{guix pull}, along with details about their provenance:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:4405
- #, no-wrap
- msgid ""
- "$ guix pull -l\n"
- "Generation 1\tJun 10 2018 00:18:18\n"
- " guix 65956ad\n"
- " repository URL: https://git.savannah.gnu.org/git/guix.git\n"
- " branch: origin/master\n"
- " commit: 65956ad3526ba09e1f7a40722c96c6ef7c0936fe\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:4415
- #, no-wrap
- msgid ""
- "Generation 2\tJun 11 2018 11:02:49\n"
- " guix e0cc7f6\n"
- " repository URL: https://git.savannah.gnu.org/git/guix.git\n"
- " branch: origin/master\n"
- " commit: e0cc7f669bec22c37481dd03a7941c7d11a64f1d\n"
- " 2 new packages: keepalived, libnfnetlink\n"
- " 6 packages upgraded: emacs-nix-mode@@2.0.4,\n"
- " guile2.0-guix@@0.14.0-12.77a1aac, guix@@0.14.0-12.77a1aac,\n"
- " heimdal@@7.5.0, milkytracker@@1.02.00, nix@@2.0.4\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:4423
- #, no-wrap
- msgid ""
- "Generation 3\tJun 13 2018 23:31:07\t(current)\n"
- " guix 844cc1c\n"
- " repository URL: https://git.savannah.gnu.org/git/guix.git\n"
- " branch: origin/master\n"
- " commit: 844cc1c8f394f03b404c5bb3aee086922373490c\n"
- " 28 new packages: emacs-helm-ls-git, emacs-helm-mu, @dots{}\n"
- " 69 packages upgraded: borg@@1.1.6, cheese@@3.28.0, @dots{}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4427
- msgid "@xref{Invoking guix describe, @command{guix describe}}, for other ways to describe the current status of Guix."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4432
- msgid "This @code{~/.config/guix/current} profile works exactly like the profiles created by @command{guix package} (@pxref{Invoking guix package}). That is, you can list generations, roll back to the previous generation---i.e., the previous Guix---and so on:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:4438
- #, no-wrap
- msgid ""
- "$ guix pull --roll-back\n"
- "switched from generation 3 to 2\n"
- "$ guix pull --delete-generations=1\n"
- "deleting /var/guix/profiles/per-user/charlie/current-guix-1-link\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4442
- msgid "You can also use @command{guix package} (@pxref{Invoking guix package}) to manage the profile by naming it explicitly:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:4447
- #, no-wrap
- msgid ""
- "$ guix package -p ~/.config/guix/current --roll-back\n"
- "switched from generation 3 to 2\n"
- "$ guix package -p ~/.config/guix/current --delete-generations=1\n"
- "deleting /var/guix/profiles/per-user/charlie/current-guix-1-link\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4451
- msgid "The @command{guix pull} command is usually invoked with no arguments, but it supports the following options:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4453 guix-git/doc/guix.texi:4611
- #, no-wrap
- msgid "--url=@var{url}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:4454 guix-git/doc/guix.texi:4612
- #, no-wrap
- msgid "--commit=@var{commit}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:4455 guix-git/doc/guix.texi:4613
- #, no-wrap
- msgid "--branch=@var{branch}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4459
- msgid "Download code for the @code{guix} channel from the specified @var{url}, at the given @var{commit} (a valid Git commit ID represented as a hexadecimal string), or @var{branch}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4460 guix-git/doc/guix.texi:5057
- #, no-wrap
- msgid "@file{channels.scm}, configuration file"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4461 guix-git/doc/guix.texi:5058
- #, no-wrap
- msgid "configuration file for channels"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4465
- msgid "These options are provided for convenience, but you can also specify your configuration in the @file{~/.config/guix/channels.scm} file or using the @option{--channels} option (see below)."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4466 guix-git/doc/guix.texi:4618
- #, no-wrap
- msgid "--channels=@var{file}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:4467 guix-git/doc/guix.texi:4619
- #, no-wrap
- msgid "-C @var{file}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4473
- msgid "Read the list of channels from @var{file} instead of @file{~/.config/guix/channels.scm} or @file{/etc/guix/channels.scm}. @var{file} must contain Scheme code that evaluates to a list of channel objects. @xref{Channels}, for more information."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4474
- #, no-wrap
- msgid "channel news"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4475
- #, no-wrap
- msgid "--news"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:4476 guix-git/doc/guix.texi:5864
- #: guix-git/doc/guix.texi:6247 guix-git/doc/guix.texi:35304
- #, no-wrap
- msgid "-N"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4480
- msgid "Display the list of packages added or upgraded since the previous generation, as well as, occasionally, news written by channel authors for their users (@pxref{Channels, Writing Channel News})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4484
- msgid "The package information is the same as displayed upon @command{guix pull} completion, but without ellipses; it is also similar to the output of @command{guix pull -l} for the last generation (see below)."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4491
- msgid "List all the generations of @file{~/.config/guix/current} or, if @var{pattern} is provided, the subset of generations that match @var{pattern}. The syntax of @var{pattern} is the same as with @code{guix package --list-generations} (@pxref{Invoking guix package})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4498
- msgid "Roll back to the previous @dfn{generation} of @file{~/.config/guix/current}---i.e., undo the last transaction."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4522
- msgid "If the current generation matches, it is @emph{not} deleted."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4528
- msgid "@xref{Invoking guix describe}, for a way to display information about the current generation only."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4532
- msgid "Use @var{profile} instead of @file{~/.config/guix/current}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4533 guix-git/doc/guix.texi:10893
- #: guix-git/doc/guix.texi:12836
- #, no-wrap
- msgid "--dry-run"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:4534 guix-git/doc/guix.texi:10894
- #: guix-git/doc/guix.texi:12837 guix-git/doc/guix.texi:13043
- #, no-wrap
- msgid "-n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4537
- msgid "Show which channel commit(s) would be used and what would be built or substituted but do not actually do it."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4538 guix-git/doc/guix.texi:35323
- #, no-wrap
- msgid "--allow-downgrades"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4541
- msgid "Allow pulling older or unrelated revisions of channels than those currently in use."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4542
- #, no-wrap
- msgid "downgrade attacks, protection against"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4547
- msgid "By default, @command{guix pull} protects against so-called ``downgrade attacks'' whereby the Git repository of a channel would be reset to an earlier or unrelated revision of itself, potentially leading you to install older, known-vulnerable versions of software packages."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:4551 guix-git/doc/guix.texi:35337
- msgid "Make sure you understand its security implications before using @option{--allow-downgrades}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4553
- #, no-wrap
- msgid "--disable-authentication"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4555
- msgid "Allow pulling channel code without authenticating it."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4556 guix-git/doc/guix.texi:5203
- #, no-wrap
- msgid "authentication, of channel code"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4561
- msgid "By default, @command{guix pull} authenticates code downloaded from channels by verifying that its commits are signed by authorized developers, and raises an error if this is not the case. This option instructs it to not perform any such verification."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:4565
- msgid "Make sure you understand its security implications before using @option{--disable-authentication}."
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:4568 guix-git/doc/guix.texi:5847
- #: guix-git/doc/guix.texi:6230 guix-git/doc/guix.texi:6630
- #: guix-git/doc/guix.texi:11506 guix-git/doc/guix.texi:13188
- #: guix-git/doc/guix.texi:13453 guix-git/doc/guix.texi:14130
- #: guix-git/doc/guix.texi:35252
- #, no-wrap
- msgid "-s @var{system}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4571 guix-git/doc/guix.texi:6633
- msgid "Attempt to build for @var{system}---e.g., @code{i686-linux}---instead of the system type of the build host."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4575
- msgid "Use the bootstrap Guile to build the latest Guix. This option is only useful to Guix developers."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4581
- msgid "The @dfn{channel} mechanism allows you to instruct @command{guix pull} which repository and branch to pull from, as well as @emph{additional} repositories containing package modules that should be deployed. @xref{Channels}, for more information."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4584
- msgid "In addition, @command{guix pull} supports all the common build options (@pxref{Common Build Options})."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:4586
- #, no-wrap
- msgid "Invoking @command{guix time-machine}"
- msgstr ""
- #. type: command{#1}
- #: guix-git/doc/guix.texi:4588
- #, no-wrap
- msgid "guix time-machine"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4589 guix-git/doc/guix.texi:5161
- #, no-wrap
- msgid "pinning, channels"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4590 guix-git/doc/guix.texi:4772
- #: guix-git/doc/guix.texi:5162
- #, no-wrap
- msgid "replicating Guix"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4591 guix-git/doc/guix.texi:5163
- #, no-wrap
- msgid "reproducibility, of Guix"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4599
- msgid "The @command{guix time-machine} command provides access to other revisions of Guix, for example to install older versions of packages, or to reproduce a computation in an identical environment. The revision of Guix to be used is defined by a commit or by a channel description file created by @command{guix describe} (@pxref{Invoking guix describe})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4601 guix-git/doc/guix.texi:5623
- #: guix-git/doc/guix.texi:5974 guix-git/doc/guix.texi:6753
- #: guix-git/doc/guix.texi:10689 guix-git/doc/guix.texi:10813
- #: guix-git/doc/guix.texi:11797 guix-git/doc/guix.texi:11892
- #: guix-git/doc/guix.texi:12825 guix-git/doc/guix.texi:13018
- #: guix-git/doc/guix.texi:13511 guix-git/doc/guix.texi:13884
- #: guix-git/doc/guix.texi:13973 guix-git/doc/guix.texi:14012
- #: guix-git/doc/guix.texi:14109
- msgid "The general syntax is:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:4604
- #, no-wrap
- msgid "guix time-machine @var{options}@dots{} -- @var{command} @var {arg}@dots{}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4609
- msgid "where @var{command} and @var{arg}@dots{} are passed unmodified to the @command{guix} command of the specified revision. The @var{options} that define this revision are the same as for @command{guix pull} (@pxref{Invoking guix pull}):"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4617
- msgid "Use the @code{guix} channel from the specified @var{url}, at the given @var{commit} (a valid Git commit ID represented as a hexadecimal string), or @var{branch}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4623
- msgid "Read the list of channels from @var{file}. @var{file} must contain Scheme code that evaluates to a list of channel objects. @xref{Channels} for more information."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4627
- msgid "As for @command{guix pull}, the absence of any options means that the latest commit on the master branch will be used. The command"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:4630
- #, no-wrap
- msgid "guix time-machine -- build hello\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4635
- msgid "will thus build the package @code{hello} as defined in the master branch, which is in general a newer revision of Guix than you have installed. Time travel works in both directions!"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4639
- msgid "Note that @command{guix time-machine} can trigger builds of channels and their dependencies, and these are controlled by the standard build options (@pxref{Common Build Options})."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:4647
- msgid "The functionality described here is a ``technology preview'' as of version @value{VERSION}. As such, the interface is subject to change."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4649 guix-git/doc/guix.texi:10726
- #, no-wrap
- msgid "inferiors"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4650
- #, no-wrap
- msgid "composition of Guix revisions"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4655
- msgid "Sometimes you might need to mix packages from the revision of Guix you're currently running with packages available in a different revision of Guix. Guix @dfn{inferiors} allow you to achieve that by composing different Guix revisions in arbitrary ways."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4656 guix-git/doc/guix.texi:4721
- #, no-wrap
- msgid "inferior packages"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4662
- msgid "Technically, an ``inferior'' is essentially a separate Guix process connected to your main Guix process through a REPL (@pxref{Invoking guix repl}). The @code{(guix inferior)} module allows you to create inferiors and to communicate with them. It also provides a high-level interface to browse and manipulate the packages that an inferior provides---@dfn{inferior packages}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4672
- msgid "When combined with channels (@pxref{Channels}), inferiors provide a simple way to interact with a separate revision of Guix. For example, let's assume you want to install in your profile the current @code{guile} package, along with the @code{guile-json} as it existed in an older revision of Guix---perhaps because the newer @code{guile-json} has an incompatible API and you want to run your code against the old API@. To do that, you could write a manifest for use by @code{guix package --manifest} (@pxref{Invoking guix package}); in that manifest, you would create an inferior for that old Guix revision you care about, and you would look up the @code{guile-json} package in the inferior:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:4676
- #, no-wrap
- msgid ""
- "(use-modules (guix inferior) (guix channels)\n"
- " (srfi srfi-1)) ;for 'first'\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:4685
- #, no-wrap
- msgid ""
- "(define channels\n"
- " ;; This is the old revision from which we want to\n"
- " ;; extract guile-json.\n"
- " (list (channel\n"
- " (name 'guix)\n"
- " (url \"https://git.savannah.gnu.org/git/guix.git\")\n"
- " (commit\n"
- " \"65956ad3526ba09e1f7a40722c96c6ef7c0936fe\"))))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:4689
- #, no-wrap
- msgid ""
- "(define inferior\n"
- " ;; An inferior representing the above revision.\n"
- " (inferior-for-channels channels))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:4695
- #, no-wrap
- msgid ""
- ";; Now create a manifest with the current \"guile\" package\n"
- ";; and the old \"guile-json\" package.\n"
- "(packages->manifest\n"
- " (list (first (lookup-inferior-packages inferior \"guile-json\"))\n"
- " (specification->package \"guile\")))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4700
- msgid "On its first run, @command{guix package --manifest} might have to build the channel you specified before it can create the inferior; subsequent runs will be much faster because the Guix revision will be cached."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4703
- msgid "The @code{(guix inferior)} module provides the following procedures to open an inferior:"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:4704
- #, no-wrap
- msgid "{Scheme Procedure} inferior-for-channels @var{channels} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:4709
- msgid "[#:cache-directory] [#:ttl] Return an inferior for @var{channels}, a list of channels. Use the cache at @var{cache-directory}, where entries can be reclaimed after @var{ttl} seconds. This procedure opens a new connection to the build daemon."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:4712
- msgid "As a side effect, this procedure may build or substitute binaries for @var{channels}, which can take time."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:4714
- #, no-wrap
- msgid "{Scheme Procedure} open-inferior @var{directory} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:4719
- msgid "[#:command \"bin/guix\"] Open the inferior Guix in @var{directory}, running @code{@var{directory}/@var{command} repl} or equivalent. Return @code{#f} if the inferior could not be launched."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4724
- msgid "The procedures listed below allow you to obtain and manipulate inferior packages."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:4725
- #, no-wrap
- msgid "{Scheme Procedure} inferior-packages @var{inferior}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:4727
- msgid "Return the list of packages known to @var{inferior}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:4729
- #, no-wrap
- msgid "{Scheme Procedure} lookup-inferior-packages @var{inferior} @var{name} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:4734
- msgid "[@var{version}] Return the sorted list of inferior packages matching @var{name} in @var{inferior}, with highest version numbers first. If @var{version} is true, return only packages with a version number prefixed by @var{version}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:4736
- #, no-wrap
- msgid "{Scheme Procedure} inferior-package? @var{obj}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:4738
- msgid "Return true if @var{obj} is an inferior package."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:4740
- #, no-wrap
- msgid "{Scheme Procedure} inferior-package-name @var{package}"
- msgstr ""
- #. type: deffnx
- #: guix-git/doc/guix.texi:4741
- #, no-wrap
- msgid "{Scheme Procedure} inferior-package-version @var{package}"
- msgstr ""
- #. type: deffnx
- #: guix-git/doc/guix.texi:4742
- #, no-wrap
- msgid "{Scheme Procedure} inferior-package-synopsis @var{package}"
- msgstr ""
- #. type: deffnx
- #: guix-git/doc/guix.texi:4743
- #, no-wrap
- msgid "{Scheme Procedure} inferior-package-description @var{package}"
- msgstr ""
- #. type: deffnx
- #: guix-git/doc/guix.texi:4744
- #, no-wrap
- msgid "{Scheme Procedure} inferior-package-home-page @var{package}"
- msgstr ""
- #. type: deffnx
- #: guix-git/doc/guix.texi:4745
- #, no-wrap
- msgid "{Scheme Procedure} inferior-package-location @var{package}"
- msgstr ""
- #. type: deffnx
- #: guix-git/doc/guix.texi:4746
- #, no-wrap
- msgid "{Scheme Procedure} inferior-package-inputs @var{package}"
- msgstr ""
- #. type: deffnx
- #: guix-git/doc/guix.texi:4747
- #, no-wrap
- msgid "{Scheme Procedure} inferior-package-native-inputs @var{package}"
- msgstr ""
- #. type: deffnx
- #: guix-git/doc/guix.texi:4748
- #, no-wrap
- msgid "{Scheme Procedure} inferior-package-propagated-inputs @var{package}"
- msgstr ""
- #. type: deffnx
- #: guix-git/doc/guix.texi:4749
- #, no-wrap
- msgid "{Scheme Procedure} inferior-package-transitive-propagated-inputs @var{package}"
- msgstr ""
- #. type: deffnx
- #: guix-git/doc/guix.texi:4750
- #, no-wrap
- msgid "{Scheme Procedure} inferior-package-native-search-paths @var{package}"
- msgstr ""
- #. type: deffnx
- #: guix-git/doc/guix.texi:4751
- #, no-wrap
- msgid "{Scheme Procedure} inferior-package-transitive-native-search-paths @var{package}"
- msgstr ""
- #. type: deffnx
- #: guix-git/doc/guix.texi:4752
- #, no-wrap
- msgid "{Scheme Procedure} inferior-package-search-paths @var{package}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:4757
- msgid "These procedures are the counterpart of package record accessors (@pxref{package Reference}). Most of them work by querying the inferior @var{package} comes from, so the inferior must still be live when you call these procedures."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4767
- msgid "Inferior packages can be used transparently like any other package or file-like object in G-expressions (@pxref{G-Expressions}). They are also transparently handled by the @code{packages->manifest} procedure, which is commonly used in manifests (@pxref{Invoking guix package, the @option{--manifest} option of @command{guix package}}). Thus you can insert an inferior package pretty much anywhere you would insert a regular package: in manifests, in the @code{packages} field of your @code{operating-system} declaration, and so on."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:4769
- #, no-wrap
- msgid "Invoking @command{guix describe}"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4780
- msgid "Often you may want to answer questions like: ``Which revision of Guix am I using?'' or ``Which channels am I using?'' This is useful information in many situations: if you want to @emph{replicate} an environment on a different machine or user account, if you want to report a bug or to determine what change in the channels you are using caused it, or if you want to record your system state for reproducibility purposes. The @command{guix describe} command answers these questions."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4784
- msgid "When run from a @command{guix pull}ed @command{guix}, @command{guix describe} displays the channel(s) that it was built from, including their repository URL and commit IDs (@pxref{Channels}):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:4792
- #, no-wrap
- msgid ""
- "$ guix describe\n"
- "Generation 10\tSep 03 2018 17:32:44\t(current)\n"
- " guix e0fa68c\n"
- " repository URL: https://git.savannah.gnu.org/git/guix.git\n"
- " branch: master\n"
- " commit: e0fa68c7718fffd33d81af415279d6ddb518f727\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4801
- msgid "If you're familiar with the Git version control system, this is similar in spirit to @command{git describe}; the output is also similar to that of @command{guix pull --list-generations}, but limited to the current generation (@pxref{Invoking guix pull, the @option{--list-generations} option}). Because the Git commit ID shown above unambiguously refers to a snapshot of Guix, this information is all it takes to describe the revision of Guix you're using, and also to replicate it."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4804
- msgid "To make it easier to replicate Guix, @command{guix describe} can also be asked to return a list of channels instead of the human-readable description above:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:4817
- #, no-wrap
- msgid ""
- "$ guix describe -f channels\n"
- "(list (channel\n"
- " (name 'guix)\n"
- " (url \"https://git.savannah.gnu.org/git/guix.git\")\n"
- " (commit\n"
- " \"e0fa68c7718fffd33d81af415279d6ddb518f727\")\n"
- " (introduction\n"
- " (make-channel-introduction\n"
- " \"9edb3f66fd807b096b48283debdcddccfea34bad\"\n"
- " (openpgp-fingerprint\n"
- " \"BBB0 2DDF 2CEA F6A8 0D1D E643 A2A0 6DF2 A33A 54FA\")))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4826
- msgid "You can save this to a file and feed it to @command{guix pull -C} on some other machine or at a later point in time, which will instantiate @emph{this exact Guix revision} (@pxref{Invoking guix pull, the @option{-C} option}). From there on, since you're able to deploy the same revision of Guix, you can just as well @emph{replicate a complete software environment}. We humbly think that this is @emph{awesome}, and we hope you'll like it too!"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4829
- msgid "The details of the options supported by @command{guix describe} are as follows:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4831 guix-git/doc/guix.texi:6431
- #: guix-git/doc/guix.texi:14242
- #, no-wrap
- msgid "--format=@var{format}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:4832 guix-git/doc/guix.texi:6432
- #: guix-git/doc/guix.texi:14243
- #, no-wrap
- msgid "-f @var{format}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4834 guix-git/doc/guix.texi:14245
- msgid "Produce output in the specified @var{format}, one of:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4836
- #, no-wrap
- msgid "human"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4838
- msgid "produce human-readable output;"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4838 guix-git/doc/guix.texi:5056
- #, no-wrap
- msgid "channels"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4842
- msgid "produce a list of channel specifications that can be passed to @command{guix pull -C} or installed as @file{~/.config/guix/channels.scm} (@pxref{Invoking guix pull});"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4842
- #, no-wrap
- msgid "channels-sans-intro"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4848
- msgid "like @code{channels}, but omit the @code{introduction} field; use it to produce a channel specification suitable for Guix version 1.1.0 or earlier---the @code{introduction} field has to do with channel authentication (@pxref{Channels, Channel Authentication}) and is not supported by these older versions;"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4848 guix-git/doc/guix.texi:12109
- #, no-wrap
- msgid "json"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4849
- #, no-wrap
- msgid "JSON"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4851
- msgid "produce a list of channel specifications in JSON format;"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4851 guix-git/doc/guix.texi:14247
- #, no-wrap
- msgid "recutils"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4853
- msgid "produce a list of channel specifications in Recutils format."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4855
- #, no-wrap
- msgid "--list-formats"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4857
- msgid "Display available formats for @option{--format} option."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4861
- msgid "Display information about @var{profile}."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:4864
- #, no-wrap
- msgid "Invoking @command{guix archive}"
- msgstr ""
- #. type: command{#1}
- #: guix-git/doc/guix.texi:4866
- #, no-wrap
- msgid "guix archive"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4867
- #, no-wrap
- msgid "archive"
- msgstr "بایگانی"
- #. type: Plain text
- #: guix-git/doc/guix.texi:4873
- msgid "The @command{guix archive} command allows users to @dfn{export} files from the store into a single archive, and to later @dfn{import} them on a machine that runs Guix. In particular, it allows store files to be transferred from one machine to the store on another machine."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:4877
- msgid "If you're looking for a way to produce archives in a format suitable for tools other than Guix, @pxref{Invoking guix pack}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4879
- #, no-wrap
- msgid "exporting store items"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4881
- msgid "To export store files as an archive to standard output, run:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:4884
- #, no-wrap
- msgid "guix archive --export @var{options} @var{specifications}...\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4891
- msgid "@var{specifications} may be either store file names or package specifications, as for @command{guix package} (@pxref{Invoking guix package}). For instance, the following command creates an archive containing the @code{gui} output of the @code{git} package and the main output of @code{emacs}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:4894
- #, no-wrap
- msgid "guix archive --export git:gui /gnu/store/...-emacs-24.3 > great.nar\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4899
- msgid "If the specified packages are not built yet, @command{guix archive} automatically builds them. The build process may be controlled with the common build options (@pxref{Common Build Options})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4902
- msgid "To transfer the @code{emacs} package to a machine connected over SSH, one would run:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:4905
- #, no-wrap
- msgid "guix archive --export -r emacs | ssh the-machine guix archive --import\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4910
- msgid "Similarly, a complete user profile may be transferred from one machine to another like this:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:4914
- #, no-wrap
- msgid ""
- "guix archive --export -r $(readlink -f ~/.guix-profile) | \\\n"
- " ssh the-machine guix archive --import\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4924
- msgid "However, note that, in both examples, all of @code{emacs} and the profile as well as all of their dependencies are transferred (due to @option{-r}), regardless of what is already available in the store on the target machine. The @option{--missing} option can help figure out which items are missing from the target store. The @command{guix copy} command simplifies and optimizes this whole process, so this is probably what you should use in this case (@pxref{Invoking guix copy})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4925
- #, no-wrap
- msgid "nar, archive format"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4926
- #, no-wrap
- msgid "normalized archive (nar)"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4927
- #, no-wrap
- msgid "nar bundle, archive format"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4932
- msgid "Each store item is written in the @dfn{normalized archive} or @dfn{nar} format (described below), and the output of @command{guix archive --export} (and input of @command{guix archive --import}) is a @dfn{nar bundle}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4942
- msgid "The nar format is comparable in spirit to `tar', but with differences that make it more appropriate for our purposes. First, rather than recording all Unix metadata for each file, the nar format only mentions the file type (regular, directory, or symbolic link); Unix permissions and owner/group are dismissed. Second, the order in which directory entries are stored always follows the order of file names according to the C locale collation order. This makes archive production fully deterministic."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4946
- msgid "That nar bundle format is essentially the concatenation of zero or more nars along with metadata for each store item it contains: its file name, references, corresponding derivation, and a digital signature."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4952
- msgid "When exporting, the daemon digitally signs the contents of the archive, and that digital signature is appended. When importing, the daemon verifies the signature and rejects the import in case of an invalid signature or if the signing key is not authorized."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:4954
- msgid "The main options are:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4956
- #, no-wrap
- msgid "--export"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4959
- msgid "Export the specified store files or packages (see below). Write the resulting archive to the standard output."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4962
- msgid "Dependencies are @emph{not} included in the output, unless @option{--recursive} is passed."
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:4963 guix-git/doc/guix.texi:11830
- #: guix-git/doc/guix.texi:11956 guix-git/doc/guix.texi:11981
- #: guix-git/doc/guix.texi:12013 guix-git/doc/guix.texi:12184
- #: guix-git/doc/guix.texi:12225 guix-git/doc/guix.texi:12276
- #: guix-git/doc/guix.texi:12301 guix-git/doc/guix.texi:12317
- #: guix-git/doc/guix.texi:12365 guix-git/doc/guix.texi:12401
- #, no-wrap
- msgid "-r"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4964 guix-git/doc/guix.texi:11829
- #: guix-git/doc/guix.texi:11955 guix-git/doc/guix.texi:11980
- #: guix-git/doc/guix.texi:12012 guix-git/doc/guix.texi:12183
- #: guix-git/doc/guix.texi:12224 guix-git/doc/guix.texi:12275
- #: guix-git/doc/guix.texi:12300 guix-git/doc/guix.texi:12316
- #: guix-git/doc/guix.texi:12364 guix-git/doc/guix.texi:12400
- #: guix-git/doc/guix.texi:12449
- #, no-wrap
- msgid "--recursive"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4969
- msgid "When combined with @option{--export}, this instructs @command{guix archive} to include dependencies of the given items in the archive. Thus, the resulting archive is self-contained: it contains the closure of the exported store items."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4970
- #, no-wrap
- msgid "--import"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4975
- msgid "Read an archive from the standard input, and import the files listed therein into the store. Abort if the archive has an invalid digital signature, or if it is signed by a public key not among the authorized keys (see @option{--authorize} below)."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4976
- #, no-wrap
- msgid "--missing"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4980
- msgid "Read a list of store file names from the standard input, one per line, and write on the standard output the subset of these files missing from the store."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:4981
- #, no-wrap
- msgid "--generate-key[=@var{parameters}]"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:4982
- #, no-wrap
- msgid "signing, archives"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4989
- msgid "Generate a new key pair for the daemon. This is a prerequisite before archives can be exported with @option{--export}. This operation is usually instantaneous but it can take time if the system's entropy pool needs to be refilled. On Guix System, @code{guix-service-type} takes care of generating this key pair the first boot."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:4999
- msgid "The generated key pair is typically stored under @file{/etc/guix}, in @file{signing-key.pub} (public key) and @file{signing-key.sec} (private key, which must be kept secret). When @var{parameters} is omitted, an ECDSA key using the Ed25519 curve is generated, or, for Libgcrypt versions before 1.6.0, it is a 4096-bit RSA key. Alternatively, @var{parameters} can specify @code{genkey} parameters suitable for Libgcrypt (@pxref{General public-key related Functions, @code{gcry_pk_genkey},, gcrypt, The Libgcrypt Reference Manual})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:5000
- #, no-wrap
- msgid "--authorize"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:5001
- #, no-wrap
- msgid "authorizing, archives"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5005
- msgid "Authorize imports signed by the public key passed on standard input. The public key must be in ``s-expression advanced format''---i.e., the same format as the @file{signing-key.pub} file."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5012
- msgid "The list of authorized keys is kept in the human-editable file @file{/etc/guix/acl}. The file contains @url{https://people.csail.mit.edu/rivest/Sexp.txt, ``advanced-format s-expressions''} and is structured as an access-control list in the @url{https://theworld.com/~cme/spki.txt, Simple Public-Key Infrastructure (SPKI)}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:5013
- #, no-wrap
- msgid "--extract=@var{directory}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:5014
- #, no-wrap
- msgid "-x @var{directory}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5018
- msgid "Read a single-item archive as served by substitute servers (@pxref{Substitutes}) and extract it to @var{directory}. This is a low-level operation needed in only very narrow use cases; see below."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5021
- msgid "For example, the following command extracts the substitute for Emacs served by @code{@value{SUBSTITUTE-SERVER-1}} to @file{/tmp/emacs}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:5026
- #, no-wrap
- msgid ""
- "$ wget -O - \\\n"
- " https://@value{SUBSTITUTE-SERVER-1}/nar/gzip/@dots{}-emacs-24.5 \\\n"
- " | gunzip | guix archive -x /tmp/emacs\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5033
- msgid "Single-item archives are different from multiple-item archives produced by @command{guix archive --export}; they contain a single store item, and they do @emph{not} embed a signature. Thus this operation does @emph{no} signature verification and its output should be considered unsafe."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5037
- msgid "The primary purpose of this operation is to facilitate inspection of archive contents coming from possibly untrusted substitute servers (@pxref{Invoking guix challenge})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:5038
- #, no-wrap
- msgid "--list"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:5039 guix-git/doc/guix.texi:12171
- #: guix-git/doc/guix.texi:12218
- #, no-wrap
- msgid "-t"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5043
- msgid "Read a single-item archive as served by substitute servers (@pxref{Substitutes}) and print the list of files it contains, as in this example:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:5048
- #, no-wrap
- msgid ""
- "$ wget -O - \\\n"
- " https://@value{SUBSTITUTE-SERVER-1}/nar/lzip/@dots{}-emacs-26.3 \\\n"
- " | lzip -d | guix archive -t\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:5059
- #, no-wrap
- msgid "@command{guix pull}, configuration file"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:5060
- #, no-wrap
- msgid "configuration of @command{guix pull}"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5071
- msgid "Guix and its package collection are updated by running @command{guix pull} (@pxref{Invoking guix pull}). By default @command{guix pull} downloads and deploys Guix itself from the official GNU@tie{}Guix repository. This can be customized by defining @dfn{channels} in the @file{~/.config/guix/channels.scm} file. A channel specifies a URL and branch of a Git repository to be deployed, and @command{guix pull} can be instructed to pull from one or more channels. In other words, channels can be used to @emph{customize} and to @emph{extend} Guix, as we will see below. Guix is able to take into account security concerns and deal with authenticated updates."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:5089
- #, no-wrap
- msgid "extending the package collection (channels)"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:5090
- #, no-wrap
- msgid "variant packages (channels)"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5094
- msgid "You can specify @emph{additional channels} to pull from. To use a channel, write @code{~/.config/guix/channels.scm} to instruct @command{guix pull} to pull from it @emph{in addition} to the default Guix channel(s):"
- msgstr ""
- #. type: vindex
- #: guix-git/doc/guix.texi:5095
- #, no-wrap
- msgid "%default-channels"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:5102
- #, no-wrap
- msgid ""
- ";; Add variant packages to those Guix provides.\n"
- "(cons (channel\n"
- " (name 'variant-packages)\n"
- " (url \"https://example.org/variant-packages.git\"))\n"
- " %default-channels)\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5112
- msgid "Note that the snippet above is (as always!)@: Scheme code; we use @code{cons} to add a channel the list of channels that the variable @code{%default-channels} is bound to (@pxref{Pairs, @code{cons} and lists,, guile, GNU Guile Reference Manual}). With this file in place, @command{guix pull} builds not only Guix but also the package modules from your own repository. The result in @file{~/.config/guix/current} is the union of Guix with your own package modules:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:5127
- #, no-wrap
- msgid ""
- "$ guix pull --list-generations\n"
- "@dots{}\n"
- "Generation 19\tAug 27 2018 16:20:48\n"
- " guix d894ab8\n"
- " repository URL: https://git.savannah.gnu.org/git/guix.git\n"
- " branch: master\n"
- " commit: d894ab8e9bfabcefa6c49d9ba2e834dd5a73a300\n"
- " variant-packages dd3df5e\n"
- " repository URL: https://example.org/variant-packages.git\n"
- " branch: master\n"
- " commit: dd3df5e2c8818760a8fc0bd699e55d3b69fef2bb\n"
- " 11 new packages: variant-gimp, variant-emacs-with-cool-features, @dots{}\n"
- " 4 packages upgraded: emacs-racket-mode@@0.0.2-2.1b78827, @dots{}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5135
- msgid "The output of @command{guix pull} above shows that Generation@tie{}19 includes both Guix and packages from the @code{variant-personal-packages} channel. Among the new and upgraded packages that are listed, some like @code{variant-gimp} and @code{variant-emacs-with-cool-features} might come from @code{variant-packages}, while others come from the Guix default channel."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5144
- msgid "The channel called @code{guix} specifies where Guix itself---its command-line tools as well as its package collection---should be downloaded. For instance, suppose you want to update from another copy of the Guix repository at @code{example.org}, and specifically the @code{super-hacks} branch, you can write in @code{~/.config/guix/channels.scm} this specification:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:5151
- #, no-wrap
- msgid ""
- ";; Tell 'guix pull' to use another repo.\n"
- "(list (channel\n"
- " (name 'guix)\n"
- " (url \"https://example.org/another-guix.git\")\n"
- " (branch \"super-hacks\")))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5157
- msgid "From there on, @command{guix pull} will fetch code from the @code{super-hacks} branch of the repository at @code{example.org}. The authentication concern is addressed below ((@pxref{Channel Authentication})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5168
- msgid "The @command{guix pull --list-generations} output above shows precisely which commits were used to build this instance of Guix. We can thus replicate it, say, on another machine, by providing a channel specification in @file{~/.config/guix/channels.scm} that is ``pinned'' to these commits:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:5179
- #, no-wrap
- msgid ""
- ";; Deploy specific commits of my channels of interest.\n"
- "(list (channel\n"
- " (name 'guix)\n"
- " (url \"https://git.savannah.gnu.org/git/guix.git\")\n"
- " (commit \"6298c3ffd9654d3231a6f25390b056483e8f407c\"))\n"
- " (channel\n"
- " (name 'variant-packages)\n"
- " (url \"https://example.org/variant-packages.git\")\n"
- " (commit \"dd3df5e2c8818760a8fc0bd699e55d3b69fef2bb\")))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5186
- msgid "The @command{guix describe --format=channels} command can even generate this list of channels directly (@pxref{Invoking guix describe}). The resulting file can be used with the -C options of @command{guix pull} (@pxref{Invoking guix pull}) or @command{guix time-machine} (@pxref{Invoking guix time-machine})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5193
- msgid "At this point the two machines run the @emph{exact same Guix}, with access to the @emph{exact same packages}. The output of @command{guix build gimp} on one machine will be exactly the same, bit for bit, as the output of the same command on the other machine. It also means both machines have access to all the source code of Guix and, transitively, to all the source code of every package it defines."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5198
- msgid "This gives you super powers, allowing you to track the provenance of binary artifacts with very fine grain, and to reproduce software environments at will---some sort of ``meta reproducibility'' capabilities, if you will. @xref{Inferiors}, for another way to take advantage of these super powers."
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:5203
- msgid "channel-authentication"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5209
- msgid "The @command{guix pull} and @command{guix time-machine} commands @dfn{authenticate} the code retrieved from channels: they make sure each commit that is fetched is signed by an authorized developer. The goal is to protect from unauthorized modifications to the channel that would lead users to run malicious code."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5214
- msgid "As a user, you must provide a @dfn{channel introduction} in your channels file so that Guix knows how to authenticate its first commit. A channel specification, including its introduction, looks something along these lines:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:5224
- #, no-wrap
- msgid ""
- "(channel\n"
- " (name 'some-channel)\n"
- " (url \"https://example.org/some-channel.git\")\n"
- " (introduction\n"
- " (make-channel-introduction\n"
- " \"6f0d8cc0d88abb59c324b2990bfee2876016bb86\"\n"
- " (openpgp-fingerprint\n"
- " \"CABB A931 C0FF EEC6 900D 0CFB 090B 1199 3D9A EBB5\"))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5230
- msgid "The specification above shows the name and URL of the channel. The call to @code{make-channel-introduction} above specifies that authentication of this channel starts at commit @code{6f0d8cc@dots{}}, which is signed by the OpenPGP key with fingerprint @code{CABB A931@dots{}}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5236
- msgid "For the main channel, called @code{guix}, you automatically get that information from your Guix installation. For other channels, include the channel introduction provided by the channel authors in your @file{channels.scm} file. Make sure you retrieve the channel introduction from a trusted source since that is the root of your trust."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5238
- msgid "If you're curious about the authentication mechanics, read on!"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5249
- msgid "When running @command{guix pull}, Guix will first compile the definitions of every available package. This is an expensive operation for which substitutes (@pxref{Substitutes}) may be available. The following snippet in @file{channels.scm} will ensure that @command{guix pull} uses the latest commit with available substitutes for the package definitions: this is done by querying the continuous integration server at @url{https://ci.guix.gnu.org}."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:5252
- #, no-wrap
- msgid ""
- "(use-modules (guix ci))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:5256
- #, no-wrap
- msgid ""
- "(list (channel-with-substitutes-available\n"
- " %default-guix-channel\n"
- " \"https://ci.guix.gnu.org\"))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5263
- msgid "Note that this does not mean that all the packages that you will install after running @command{guix pull} will have available substitutes. It only ensures that @command{guix pull} will not try to compile package definitions. This is particularly useful when using machines with limited resources."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:5267
- #, no-wrap
- msgid "personal packages (channels)"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:5268
- #, no-wrap
- msgid "channels, for personal packages"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5276
- msgid "Let's say you have a bunch of custom package variants or personal packages that you think would make little sense to contribute to the Guix project, but would like to have these packages transparently available to you at the command line. You would first write modules containing those package definitions (@pxref{Package Modules}), maintain them in a Git repository, and then you and anyone else can use it as an additional channel to get packages from. Neat, no?"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:5284
- msgid "Before you, dear user, shout---``woow this is @emph{soooo coool}!''---and publish your personal channel to the world, we would like to share a few words of caution:"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:5292
- msgid "Before publishing a channel, please consider contributing your package definitions to Guix proper (@pxref{Contributing}). Guix as a project is open to free software of all sorts, and packages in Guix proper are readily available to all Guix users and benefit from the project's quality assurance process."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:5301
- msgid "When you maintain package definitions outside Guix, we, Guix developers, consider that @emph{the compatibility burden is on you}. Remember that package modules and package definitions are just Scheme code that uses various programming interfaces (APIs). We want to remain free to change these APIs to keep improving Guix, possibly in ways that break your channel. We never change APIs gratuitously, but we will @emph{not} commit to freezing APIs either."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:5305
- msgid "Corollary: if you're using an external channel and that channel breaks, please @emph{report the issue to the channel authors}, not to the Guix project."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:5312
- msgid "You've been warned! Having said this, we believe external channels are a practical way to exert your freedom to augment Guix' package collection and to share your improvements, which are basic tenets of @uref{https://www.gnu.org/philosophy/free-sw.html, free software}. Please email us at @email{guix-devel@@gnu.org} if you'd like to discuss this."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5324
- msgid "To create a channel, create a Git repository containing your own package modules and make it available. The repository can contain anything, but a useful channel will contain Guile modules that export packages. Once you start using a channel, Guix will behave as if the root directory of that channel's Git repository has been added to the Guile load path (@pxref{Load Paths,,, guile, GNU Guile Reference Manual}). For example, if your channel contains a file at @file{my-packages/my-tools.scm} that defines a Guile module, then the module will be available under the name @code{(my-packages my-tools)}, and you will be able to use it like any other module (@pxref{Modules,,, guile, GNU Guile Reference Manual})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5329
- msgid "As a channel author, consider bundling authentication material with your channel so that users can authenticate it. @xref{Channel Authentication}, and @ref{Specifying Channel Authorizations}, for info on how to do it."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:5334
- #, no-wrap
- msgid "subdirectory, channels"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5338
- msgid "As a channel author, you may want to keep your channel modules in a sub-directory. If your modules are in the sub-directory @file{guix}, you must add a meta-data file @file{.guix-channel} that contains:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:5343
- #, no-wrap
- msgid ""
- "(channel\n"
- " (version 0)\n"
- " (directory \"guix\"))\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:5348
- #, no-wrap
- msgid "dependencies, channels"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:5349
- #, no-wrap
- msgid "meta-data, channels"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5354
- msgid "Channel authors may decide to augment a package collection provided by other channels. They can declare their channel to be dependent on other channels in a meta-data file @file{.guix-channel}, which is to be placed in the root of the channel repository."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5356
- msgid "The meta-data file should contain a simple S-expression like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:5364
- #, no-wrap
- msgid ""
- "(channel\n"
- " (version 0)\n"
- " (dependencies\n"
- " (channel\n"
- " (name some-collection)\n"
- " (url \"https://example.org/first-collection.git\")\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:5376
- #, no-wrap
- msgid ""
- " ;; The 'introduction' bit below is optional: you would\n"
- " ;; provide it for dependencies that can be authenticated.\n"
- " (introduction\n"
- " (channel-introduction\n"
- " (version 0)\n"
- " (commit \"a8883b58dc82e167c96506cf05095f37c2c2c6cd\")\n"
- " (signer \"CABB A931 C0FF EEC6 900D 0CFB 090B 1199 3D9A EBB5\"))))\n"
- " (channel\n"
- " (name some-other-collection)\n"
- " (url \"https://example.org/second-collection.git\")\n"
- " (branch \"testing\"))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5382
- msgid "In the above example this channel is declared to depend on two other channels, which will both be fetched automatically. The modules provided by the channel will be compiled in an environment where the modules of all these declared channels are available."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5386
- msgid "For the sake of reliability and maintainability, you should avoid dependencies on channels that you don't control, and you should aim to keep the number of dependencies to a minimum."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:5390
- #, no-wrap
- msgid "channel authorizations"
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:5404
- msgid "channel-authorizations"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5404
- msgid "As we saw above, Guix ensures the source code it pulls from channels comes from authorized developers. As a channel author, you need to specify the list of authorized developers in the @file{.guix-authorizations} file in the channel's Git repository. The authentication rule is simple: each commit must be signed by a key listed in the @file{.guix-authorizations} file of its parent commit(s)@footnote{Git commits form a @dfn{directed acyclic graph} (DAG). Each commit can have zero or more parents; ``regular'' commits have one parent and merge commits have two parent commits. Read @uref{https://eagain.net/articles/git-for-computer-scientists/, @i{Git for Computer Scientists}} for a great overview.} The @file{.guix-authorizations} file looks like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:5407
- #, no-wrap
- msgid ""
- ";; Example '.guix-authorizations' file.\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:5410
- #, no-wrap
- msgid ""
- "(authorizations\n"
- " (version 0) ;current file format version\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:5417
- #, no-wrap
- msgid ""
- " ((\"AD17 A21E F8AE D8F1 CC02 DBD9 F8AE D8F1 765C 61E3\"\n"
- " (name \"alice\"))\n"
- " (\"2A39 3FFF 68F4 EF7A 3D29 12AF 68F4 EF7A 22FB B2D5\"\n"
- " (name \"bob\"))\n"
- " (\"CABB A931 C0FF EEC6 900D 0CFB 090B 1199 3D9A EBB5\"\n"
- " (name \"charlie\"))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5421
- msgid "Each fingerprint is followed by optional key/value pairs, as in the example above. Currently these key/value pairs are ignored."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5426
- msgid "This authentication rule creates a chicken-and-egg issue: how do we authenticate the first commit? Related to that: how do we deal with channels whose repository history contains unsigned commits and lack @file{.guix-authorizations}? And how do we fork existing channels?"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:5427
- #, no-wrap
- msgid "channel introduction"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5434
- msgid "Channel introductions answer these questions by describing the first commit of a channel that should be authenticated. The first time a channel is fetched with @command{guix pull} or @command{guix time-machine}, the command looks up the introductory commit and verifies that it is signed by the specified OpenPGP key. From then on, it authenticates commits according to the rule above."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5441
- msgid "Additionally, your channel must provide all the OpenPGP keys that were ever mentioned in @file{.guix-authorizations}, stored as @file{.key} files, which can be either binary or ``ASCII-armored''. By default, those @file{.key} files are searched for in the branch named @code{keyring} but you can specify a different branch name in @code{.guix-channel} like so:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:5446
- #, no-wrap
- msgid ""
- "(channel\n"
- " (version 0)\n"
- " (keyring-reference \"my-keyring-branch\"))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5450
- msgid "To summarize, as the author of a channel, there are three things you have to do to allow users to authenticate your code:"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:5456
- msgid "Export the OpenPGP keys of past and present committers with @command{gpg --export} and store them in @file{.key} files, by default in a branch named @code{keyring} (we recommend making it an @dfn{orphan branch})."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:5461
- msgid "Introduce an initial @file{.guix-authorizations} in the channel's repository. Do that in a signed commit (@pxref{Commit Access}, for information on how to sign Git commits.)"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:5467
- msgid "Advertise the channel introduction, for instance on your channel's web page. The channel introduction, as we saw above, is the commit/key pair---i.e., the commit that introduced @file{.guix-authorizations}, and the fingerprint of the OpenPGP used to sign it."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5472
- msgid "Before pushing to your public Git repository, you can run @command{guix git-authenticate} to verify that you did sign all the commits you are about to push with an authorized key:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:5475
- #, no-wrap
- msgid "guix git authenticate @var{commit} @var{signer}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5480
- msgid "where @var{commit} and @var{signer} are your channel introduction. @xref{Invoking guix git authenticate}, for details."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5487
- msgid "Publishing a signed channel requires discipline: any mistake, such as an unsigned commit or a commit signed by an unauthorized key, will prevent users from pulling from your channel---well, that's the whole point of authentication! Pay attention to merges in particular: merge commits are considered authentic if and only if they are signed by a key present in the @file{.guix-authorizations} file of @emph{both} branches."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:5491
- #, no-wrap
- msgid "primary URL, channels"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5494
- msgid "Channel authors can indicate the primary URL of their channel's Git repository in the @file{.guix-channel} file, like so:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:5499
- #, no-wrap
- msgid ""
- "(channel\n"
- " (version 0)\n"
- " (url \"https://example.org/guix.git\"))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5506
- msgid "This allows @command{guix pull} to determine whether it is pulling code from a mirror of the channel; when that is the case, it warns the user that the mirror might be stale and displays the primary URL@. That way, users cannot be tricked into fetching code from a stale mirror that does not receive security updates."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5510
- msgid "This feature only makes sense for authenticated repositories, such as the official @code{guix} channel, for which @command{guix pull} ensures the code it fetches is authentic."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:5514
- #, no-wrap
- msgid "news, for channels"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5518
- msgid "Channel authors may occasionally want to communicate to their users information about important changes in the channel. You'd send them all an email, but that's not convenient."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5523
- msgid "Instead, channels can provide a @dfn{news file}; when the channel users run @command{guix pull}, that news file is automatically read and @command{guix pull --news} can display the announcements that correspond to the new commits that have been pulled, if any."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5526
- msgid "To do that, channel authors must first declare the name of the news file in their @file{.guix-channel} file:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:5531
- #, no-wrap
- msgid ""
- "(channel\n"
- " (version 0)\n"
- " (news-file \"etc/news.txt\"))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5535
- msgid "The news file itself, @file{etc/news.txt} in this example, must look something like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:5548
- #, no-wrap
- msgid ""
- "(channel-news\n"
- " (version 0)\n"
- " (entry (tag \"the-bug-fix\")\n"
- " (title (en \"Fixed terrible bug\")\n"
- " (fr \"Oh la la\"))\n"
- " (body (en \"@@emph@{Good news@}! It's fixed!\")\n"
- " (eo \"Certe ĝi pli bone funkcias nun!\")))\n"
- " (entry (commit \"bdcabe815cd28144a2d2b4bc3c5057b051fa9906\")\n"
- " (title (en \"Added a great package\")\n"
- " (ca \"Què vol dir guix?\"))\n"
- " (body (en \"Don't miss the @@code@{hello@} package!\"))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5555
- msgid "While the news file is using the Scheme syntax, avoid naming it with a @file{.scm} extension or else it will get picked up when building the channel and yield an error since it is not a valid module. Alternatively, you can move the channel module to a subdirectory and store the news file in another directory."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5560
- msgid "The file consists of a list of @dfn{news entries}. Each entry is associated with a commit or tag: it describes changes made in this commit, possibly in preceding commits as well. Users see entries only the first time they obtain the commit the entry refers to."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5566
- msgid "The @code{title} field should be a one-line summary while @code{body} can be arbitrarily long, and both can contain Texinfo markup (@pxref{Overview,,, texinfo, GNU Texinfo}). Both the title and body are a list of language tag/message tuples, which allows @command{guix pull} to display news in the language that corresponds to the user's locale."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5572
- msgid "If you want to translate news using a gettext-based workflow, you can extract translatable strings with @command{xgettext} (@pxref{xgettext Invocation,,, gettext, GNU Gettext Utilities}). For example, assuming you write news entries in English first, the command below creates a PO file containing the strings to translate:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:5575
- #, no-wrap
- msgid "xgettext -o news.po -l scheme -ken etc/news.txt\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5579
- msgid "To sum up, yes, you could use your channel as a blog. But beware, this is @emph{not quite} what your users might expect."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:5584
- #, no-wrap
- msgid "software development"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5588
- msgid "If you are a software developer, Guix provides tools that you should find helpful---independently of the language you're developing in. This is what this chapter is about."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5594
- msgid "The @command{guix shell} command provides a convenient way to set up one-off software environments, be it for development purposes or to run a command without installing it in your profile. The @command{guix pack} command allows you to create @dfn{application bundles} that can be easily distributed to users who do not run Guix."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:5604
- #, no-wrap
- msgid "Invoking @command{guix shell}"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:5606
- #, no-wrap
- msgid "reproducible build environments"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:5607
- #, no-wrap
- msgid "development environments"
- msgstr ""
- #. type: command{#1}
- #: guix-git/doc/guix.texi:5608
- #, no-wrap
- msgid "guix environment"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:5609
- #, no-wrap
- msgid "environment, package build environment"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5614
- msgid "The purpose of @command{guix shell} is to make it easy to create one-off software environments, without changing one's profile. It is typically used to create development environments; it is also a convenient way to run applications without ``polluting'' your profile."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:5620
- msgid "The @command{guix shell} command was recently introduced to supersede @command{guix environment} (@pxref{Invoking guix environment}). If you are familiar with @command{guix environment}, you will notice that it is similar but also---we hope!---more convenient."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:5626
- #, no-wrap
- msgid "guix shell [@var{options}] [@var{package}@dots{}]\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5631
- msgid "The following example creates an environment containing Python and NumPy, building or downloading any missing package, and runs the @command{python3} command in that environment:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:5634
- #, no-wrap
- msgid "guix shell python python-numpy -- python3\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5639
- msgid "Development environments can be created as in the example below, which spawns an interactive shell containing all the dependencies and environment variables needed to work on Inkscape:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:5642
- #, no-wrap
- msgid "guix shell --development inkscape\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5648
- msgid "Exiting the shell places the user back in the original environment before @command{guix shell} was invoked. The next garbage collection (@pxref{Invoking guix gc}) may clean up packages that were installed in the environment and that are no longer used outside of it."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5655
- msgid "As an added convenience, when running from a directory that contains a @file{manifest.scm} or a @file{guix.scm} file (in this order), possibly in a parent directory, @command{guix shell} automatically loads the file---provided the directory is listed in @file{~/.config/guix/shell-authorized-directories}, and only for interactive use:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:5658
- #, no-wrap
- msgid "guix shell\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5662
- msgid "This provides an easy way to define, share, and enter development environments."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5673
- msgid "By default, the shell session or command runs in an @emph{augmented} environment, where the new packages are added to search path environment variables such as @code{PATH}. You can, instead, choose to create an @emph{isolated} environment containing nothing but the packages you asked for. Passing the @option{--pure} option clears environment variable definitions found in the parent environment@footnote{Be sure to use the @option{--check} option the first time you use @command{guix shell} interactively to make sure the shell does not undo the effect of @option{--pure}.}; passing @option{--container} goes one step further by spawning a @dfn{container} isolated from the rest of the system:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:5676
- #, no-wrap
- msgid "guix shell --container emacs gcc-toolchain\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5684
- msgid "The command above spawns an interactive shell in a container where nothing but @code{emacs}, @code{gcc-toolchain}, and their dependencies is available. The container lacks network access and shares no files other than the current working directory with the surrounding environment. This is useful to prevent access to system-wide resources such as @file{/usr/bin} on foreign distros."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5691
- msgid "This @option{--container} option can also prove useful if you wish to run a security-sensitive application, such as a web browser, in an isolated environment. For example, the command below launches Ungoogled-Chromium in an isolated environment, this time sharing network access with the host and preserving its @code{DISPLAY} environment variable, but without even sharing the current directory:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:5695
- #, no-wrap
- msgid ""
- "guix shell --container --network --no-cwd ungoogled-chromium \\\n"
- " --preserve='^DISPLAY$' -- chromium\n"
- msgstr ""
- #. type: vindex
- #: guix-git/doc/guix.texi:5697 guix-git/doc/guix.texi:6008
- #, no-wrap
- msgid "GUIX_ENVIRONMENT"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5703
- msgid "@command{guix shell} defines the @env{GUIX_ENVIRONMENT} variable in the shell it spawns; its value is the file name of the profile of this environment. This allows users to, say, define a specific prompt for development environments in their @file{.bashrc} (@pxref{Bash Startup Files,,, bash, The GNU Bash Reference Manual}):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:5709 guix-git/doc/guix.texi:6020
- #, no-wrap
- msgid ""
- "if [ -n \"$GUIX_ENVIRONMENT\" ]\n"
- "then\n"
- " export PS1=\"\\u@@\\h \\w [dev]\\$ \"\n"
- "fi\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5713 guix-git/doc/guix.texi:6024
- msgid "...@: or to browse the profile:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:5716 guix-git/doc/guix.texi:6027
- #, no-wrap
- msgid "$ ls \"$GUIX_ENVIRONMENT/bin\"\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5719 guix-git/doc/guix.texi:6103
- msgid "The available options are summarized below."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:5721 guix-git/doc/guix.texi:6105
- #: guix-git/doc/guix.texi:11546
- #, no-wrap
- msgid "--check"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5726
- msgid "Set up the environment and check whether the shell would clobber environment variables. It's a good idea to use this option the first time you run @command{guix shell} for an interactive session to make sure your setup is correct."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5730
- msgid "For example, if the shell modifies the @env{PATH} environment variable, report it since you would get a different environment than what you asked for."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5738
- msgid "Such problems usually indicate that the shell startup files are unexpectedly modifying those environment variables. For example, if you are using Bash, make sure that environment variables are set or modified in @file{~/.bash_profile} and @emph{not} in @file{~/.bashrc}---the former is sourced only by log-in shells. @xref{Bash Startup Files,,, bash, The GNU Bash Reference Manual}, for details on Bash start-up files."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:5739
- #, no-wrap
- msgid "--development"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5746
- msgid "Cause @command{guix shell} to include in the environment the dependencies of the following package rather than the package itself. This can be combined with other packages. For instance, the command below starts an interactive shell containing the build-time dependencies of GNU@tie{}Guile, plus Autoconf, Automake, and Libtool:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:5749
- #, no-wrap
- msgid "guix shell -D guile autoconf automake libtool\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:5751 guix-git/doc/guix.texi:6126
- #: guix-git/doc/guix.texi:6607 guix-git/doc/guix.texi:11421
- #: guix-git/doc/guix.texi:12494 guix-git/doc/guix.texi:12845
- #: guix-git/doc/guix.texi:13442 guix-git/doc/guix.texi:35243
- #: guix-git/doc/guix.texi:37713
- #, no-wrap
- msgid "--expression=@var{expr}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:5752 guix-git/doc/guix.texi:6127
- #: guix-git/doc/guix.texi:6608 guix-git/doc/guix.texi:11422
- #: guix-git/doc/guix.texi:12495 guix-git/doc/guix.texi:12846
- #: guix-git/doc/guix.texi:13443 guix-git/doc/guix.texi:35244
- #: guix-git/doc/guix.texi:37714
- #, no-wrap
- msgid "-e @var{expr}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5755 guix-git/doc/guix.texi:6130
- msgid "Create an environment for the package or list of packages that @var{expr} evaluates to."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5757 guix-git/doc/guix.texi:6132
- #: guix-git/doc/guix.texi:12850
- msgid "For example, running:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:5760
- #, no-wrap
- msgid "guix shell -D -e '(@@ (gnu packages maths) petsc-openmpi)'\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5764 guix-git/doc/guix.texi:6139
- msgid "starts a shell with the environment for this specific variant of the PETSc package."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5766 guix-git/doc/guix.texi:6141
- msgid "Running:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:5769
- #, no-wrap
- msgid "guix shell -e '(@@ (gnu) %base-packages)'\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5772 guix-git/doc/guix.texi:6147
- msgid "starts a shell with all the base system packages available."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5775 guix-git/doc/guix.texi:6150
- msgid "The above commands only use the default output of the given packages. To select other outputs, two element tuples can be specified:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:5778
- #, no-wrap
- msgid "guix shell -e '(list (@@ (gnu packages bash) bash) \"include\")'\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:5780 guix-git/doc/guix.texi:11395
- #, no-wrap
- msgid "--file=@var{file}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5784
- msgid "Create an environment containing the package or list of packages that the code within @var{file} evaluates to."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:5790 guix-git/doc/guix.texi:6165
- #, no-wrap
- msgid "@verbatiminclude environment-gdb.scm\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5794
- msgid "With the file above, you can enter a development environment for GDB by running:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:5797
- #, no-wrap
- msgid "guix shell -D -f gdb-devel.scm\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5804 guix-git/doc/guix.texi:6172
- msgid "Create an environment for the packages contained in the manifest object returned by the Scheme code in @var{file}. This option can be repeated several times, in which case the manifests are concatenated."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5808 guix-git/doc/guix.texi:6176
- msgid "This is similar to the same-named option in @command{guix package} (@pxref{profile-manifest, @option{--manifest}}) and uses the same manifest files."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:5809
- #, no-wrap
- msgid "--rebuild-cache"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5814
- msgid "When using @option{--manifest}, @option{--file}, or when invoked without arguments, @command{guix shell} caches the environment so that subsequent uses are instantaneous. The cache is invalidated anytime the file is modified."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5819
- msgid "The @option{--rebuild-cache} forces the cached environment to be refreshed even if the file has not changed. This is useful if the @command{guix.scm} or @command{manifest.scm} has external dependencies, or if its behavior depends, say, on environment variables."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:5820 guix-git/doc/guix.texi:6203
- #, no-wrap
- msgid "--pure"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5824 guix-git/doc/guix.texi:6207
- msgid "Unset existing environment variables when building the new environment, except those specified with @option{--preserve} (see below). This has the effect of creating an environment in which search paths only contain package inputs."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:5825 guix-git/doc/guix.texi:6208
- #, no-wrap
- msgid "--preserve=@var{regexp}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:5826 guix-git/doc/guix.texi:6209
- #, no-wrap
- msgid "-E @var{regexp}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5831 guix-git/doc/guix.texi:6214
- msgid "When used alongside @option{--pure}, preserve the environment variables matching @var{regexp}---in other words, put them on a ``white list'' of environment variables that must be preserved. This option can be repeated several times."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:5835
- #, no-wrap
- msgid ""
- "guix shell --pure --preserve=^SLURM openmpi @dots{} \\\n"
- " -- mpirun @dots{}\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5841 guix-git/doc/guix.texi:6224
- msgid "This example runs @command{mpirun} in a context where the only environment variables defined are @env{PATH}, environment variables whose name starts with @samp{SLURM}, as well as the usual ``precious'' variables (@env{HOME}, @env{USER}, etc.)."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:5842 guix-git/doc/guix.texi:6225
- #, no-wrap
- msgid "--search-paths"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5845 guix-git/doc/guix.texi:6228
- msgid "Display the environment variable definitions that make up the environment."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5849 guix-git/doc/guix.texi:6232
- msgid "Attempt to build for @var{system}---e.g., @code{i686-linux}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:5850 guix-git/doc/guix.texi:6233
- #, no-wrap
- msgid "--container"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:5851 guix-git/doc/guix.texi:6234
- #, no-wrap
- msgid "-C"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:5852 guix-git/doc/guix.texi:6069
- #: guix-git/doc/guix.texi:6235 guix-git/doc/guix.texi:13998
- #: guix-git/doc/guix.texi:35211
- #, no-wrap
- msgid "container"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5858 guix-git/doc/guix.texi:6241
- msgid "Run @var{command} within an isolated container. The current working directory outside the container is mapped inside the container. Additionally, unless overridden with @option{--user}, a dummy home directory is created that matches the current user's home directory, and @file{/etc/passwd} is configured accordingly."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5862 guix-git/doc/guix.texi:6245
- msgid "The spawned process runs as the current user outside the container. Inside the container, it has the same UID and GID as the current user, unless @option{--user} is passed (see below)."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:5863 guix-git/doc/guix.texi:6246
- #: guix-git/doc/guix.texi:35303
- #, no-wrap
- msgid "--network"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5868 guix-git/doc/guix.texi:6251
- msgid "For containers, share the network namespace with the host system. Containers created without this flag only have access to the loopback device."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:5869 guix-git/doc/guix.texi:6252
- #, no-wrap
- msgid "--link-profile"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:5870 guix-git/doc/guix.texi:6253
- #, no-wrap
- msgid "-P"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5878
- msgid "For containers, link the environment profile to @file{~/.guix-profile} within the container and set @code{GUIX_ENVIRONMENT} to that. This is equivalent to making @file{~/.guix-profile} a symlink to the actual profile within the container. Linking will fail and abort the environment if the directory already exists, which will certainly be the case if @command{guix shell} was invoked in the user's home directory."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5884 guix-git/doc/guix.texi:6267
- msgid "Certain packages are configured to look in @file{~/.guix-profile} for configuration files and data;@footnote{For example, the @code{fontconfig} package inspects @file{~/.guix-profile/share/fonts} for additional fonts.} @option{--link-profile} allows these programs to behave as expected within the environment."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:5885 guix-git/doc/guix.texi:6268
- #: guix-git/doc/guix.texi:13575
- #, no-wrap
- msgid "--user=@var{user}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:5886 guix-git/doc/guix.texi:6269
- #: guix-git/doc/guix.texi:13576
- #, no-wrap
- msgid "-u @var{user}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5893 guix-git/doc/guix.texi:6276
- msgid "For containers, use the username @var{user} in place of the current user. The generated @file{/etc/passwd} entry within the container will contain the name @var{user}, the home directory will be @file{/home/@var{user}}, and no user GECOS data will be copied. Furthermore, the UID and GID inside the container are 1000. @var{user} need not exist on the system."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5898 guix-git/doc/guix.texi:6281
- msgid "Additionally, any shared or exposed path (see @option{--share} and @option{--expose} respectively) whose target is within the current user's home directory will be remapped relative to @file{/home/USER}; this includes the automatic mapping of the current working directory."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:5905
- #, no-wrap
- msgid ""
- "# will expose paths as /home/foo/wd, /home/foo/test, and /home/foo/target\n"
- "cd $HOME/wd\n"
- "guix shell --container --user=foo \\\n"
- " --expose=$HOME/test \\\n"
- " --expose=/tmp/target=$HOME/target\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5910 guix-git/doc/guix.texi:6293
- msgid "While this will limit the leaking of user identity through home paths and each of the user fields, this is only one useful component of a broader privacy/anonymity solution---not one in and of itself."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:5911 guix-git/doc/guix.texi:6294
- #, no-wrap
- msgid "--no-cwd"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5918 guix-git/doc/guix.texi:6301
- msgid "For containers, the default behavior is to share the current working directory with the isolated container and immediately change to that directory within the container. If this is undesirable, @option{--no-cwd} will cause the current working directory to @emph{not} be automatically shared and will change to the user's home directory within the container instead. See also @option{--user}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:5919 guix-git/doc/guix.texi:6302
- #, no-wrap
- msgid "--expose=@var{source}[=@var{target}]"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:5920 guix-git/doc/guix.texi:6303
- #, no-wrap
- msgid "--share=@var{source}[=@var{target}]"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5926 guix-git/doc/guix.texi:6309
- msgid "For containers, @option{--expose} (resp. @option{--share}) exposes the file system @var{source} from the host system as the read-only (resp. writable) file system @var{target} within the container. If @var{target} is not specified, @var{source} is used as the target mount point in the container."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5930 guix-git/doc/guix.texi:6313
- msgid "The example below spawns a Guile REPL in a container in which the user's home directory is accessible read-only via the @file{/exchange} directory:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:5933
- #, no-wrap
- msgid "guix shell --container --expose=$HOME=/exchange guile -- guile\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:5935 guix-git/doc/guix.texi:6110
- #: guix-git/doc/guix.texi:6675 guix-git/doc/guix.texi:11575
- #: guix-git/doc/guix.texi:35308
- #, no-wrap
- msgid "--root=@var{file}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:5936 guix-git/doc/guix.texi:6111
- #: guix-git/doc/guix.texi:6676 guix-git/doc/guix.texi:11576
- #: guix-git/doc/guix.texi:35309
- #, no-wrap
- msgid "-r @var{file}"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:5937 guix-git/doc/guix.texi:6112
- #, no-wrap
- msgid "persistent environment"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:5938 guix-git/doc/guix.texi:6113
- #, no-wrap
- msgid "garbage collector root, for environments"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5941 guix-git/doc/guix.texi:6116
- msgid "Make @var{file} a symlink to the profile for this environment, and register it as a garbage collector root."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5944 guix-git/doc/guix.texi:6119
- msgid "This is useful if you want to protect your environment from garbage collection, to make it ``persistent''."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:5950
- msgid "When this option is omitted, the environment is protected from garbage collection only for the duration of the @command{guix shell} session. This means that next time you recreate the same environment, you could have to rebuild or re-download packages. @xref{Invoking guix gc}, for more on GC roots."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5955
- msgid "@command{guix shell} also supports all of the common build options that @command{guix build} supports (@pxref{Common Build Options}) as well as package transformation options (@pxref{Package Transformation Options})."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:5957
- #, no-wrap
- msgid "Invoking @command{guix environment}"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5961
- msgid "The purpose of @command{guix environment} is to assist in creating development environments."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:5962
- #, no-wrap
- msgid "Deprecation warning"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:5966
- msgid "The @command{guix environment} command is deprecated in favor of @command{guix shell}, which performs similar functions but is more convenient to use. @xref{Invoking guix shell}."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:5971
- msgid "Being deprecated, @command{guix environment} is slated for eventual removal, but the Guix project is committed to keeping it until May 1st, 2023. Please get in touch with us at @email{guix-devel@@gnu.org} if you would like to discuss it."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:5977
- #, no-wrap
- msgid "guix environment @var{options} @var{package}@dots{}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:5981
- msgid "The following example spawns a new shell set up for the development of GNU@tie{}Guile:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:5984
- #, no-wrap
- msgid "guix environment guile\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6001
- msgid "If the needed dependencies are not built yet, @command{guix environment} automatically builds them. The environment of the new shell is an augmented version of the environment that @command{guix environment} was run in. It contains the necessary search paths for building the given package added to the existing environment variables. To create a ``pure'' environment, in which the original environment variables have been unset, use the @option{--pure} option@footnote{Users sometimes wrongfully augment environment variables such as @env{PATH} in their @file{~/.bashrc} file. As a consequence, when @command{guix environment} launches it, Bash may read @file{~/.bashrc}, thereby introducing ``impurities'' in these environment variables. It is an error to define such environment variables in @file{.bashrc}; instead, they should be defined in @file{.bash_profile}, which is sourced only by log-in shells. @xref{Bash Startup Files,,, bash, The GNU Bash Reference Manual}, for details on Bash start-up files.}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6007
- msgid "Exiting from a Guix environment is the same as exiting from the shell, and will place the user back in the old environment before @command{guix environment} was invoked. The next garbage collection (@pxref{Invoking guix gc}) will clean up packages that were installed from within the environment and are no longer used outside of it."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6014
- msgid "@command{guix environment} defines the @env{GUIX_ENVIRONMENT} variable in the shell it spawns; its value is the file name of the profile of this environment. This allows users to, say, define a specific prompt for development environments in their @file{.bashrc} (@pxref{Bash Startup Files,,, bash, The GNU Bash Reference Manual}):"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6033
- msgid "Additionally, more than one package may be specified, in which case the union of the inputs for the given packages are used. For example, the command below spawns a shell where all of the dependencies of both Guile and Emacs are available:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:6036
- #, no-wrap
- msgid "guix environment guile emacs\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6041
- msgid "Sometimes an interactive shell session is not desired. An arbitrary command may be invoked by placing the @code{--} token to separate the command from the rest of the arguments:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:6044
- #, no-wrap
- msgid "guix environment guile -- make -j4\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6050
- msgid "In other situations, it is more convenient to specify the list of packages needed in the environment. For example, the following command runs @command{python} from an environment containing Python@tie{}3 and NumPy:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:6053
- #, no-wrap
- msgid "guix environment --ad-hoc python-numpy python -- python3\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6064
- msgid "Furthermore, one might want the dependencies of a package and also some additional packages that are not build-time or runtime dependencies, but are useful when developing nonetheless. Because of this, the @option{--ad-hoc} flag is positional. Packages appearing before @option{--ad-hoc} are interpreted as packages whose dependencies will be added to the environment. Packages appearing after are interpreted as packages that will be added to the environment directly. For example, the following command creates a Guix development environment that additionally includes Git and strace:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:6067
- #, no-wrap
- msgid "guix environment --pure guix --ad-hoc git strace\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6077
- msgid "Sometimes it is desirable to isolate the environment as much as possible, for maximal purity and reproducibility. In particular, when using Guix on a host distro that is not Guix System, it is desirable to prevent access to @file{/usr/bin} and other system-wide resources from the development environment. For example, the following command spawns a Guile REPL in a ``container'' where only the store and the current working directory are mounted:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:6080
- #, no-wrap
- msgid "guix environment --ad-hoc --container guile -- guile\n"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:6084
- msgid "The @option{--container} option requires Linux-libre 3.19 or newer."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:6086
- #, no-wrap
- msgid "certificates"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6093
- msgid "Another typical use case for containers is to run security-sensitive applications such as a web browser. To run Eolie, we must expose and share some files and directories; we include @code{nss-certs} and expose @file{/etc/ssl/certs/} for HTTPS authentication; finally we preserve the @env{DISPLAY} environment variable since containerized graphical applications won't display without it."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:6100
- #, no-wrap
- msgid ""
- "guix environment --preserve='^DISPLAY$' --container --network \\\n"
- " --expose=/etc/machine-id \\\n"
- " --expose=/etc/ssl/certs/ \\\n"
- " --share=$HOME/.local/share/eolie/=$HOME/.local/share/eolie/ \\\n"
- " --ad-hoc eolie nss-certs dbus -- eolie\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6109
- msgid "Set up the environment and check whether the shell would clobber environment variables. @xref{Invoking guix shell, @option{--check}}, for more info."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6125
- msgid "When this option is omitted, the environment is protected from garbage collection only for the duration of the @command{guix environment} session. This means that next time you recreate the same environment, you could have to rebuild or re-download packages. @xref{Invoking guix gc}, for more on GC roots."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:6135
- #, no-wrap
- msgid "guix environment -e '(@@ (gnu packages maths) petsc-openmpi)'\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:6144
- #, no-wrap
- msgid "guix environment --ad-hoc -e '(@@ (gnu) %base-packages)'\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:6153
- #, no-wrap
- msgid "guix environment --ad-hoc -e '(list (@@ (gnu packages bash) bash) \"include\")'\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:6155
- #, no-wrap
- msgid "--load=@var{file}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:6156
- #, no-wrap
- msgid "-l @var{file}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6159
- msgid "Create an environment for the package or list of packages that the code within @var{file} evaluates to."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:6177
- #, no-wrap
- msgid "--ad-hoc"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6182
- msgid "Include all specified packages in the resulting environment, as if an @i{ad hoc} package were defined with them as inputs. This option is useful for quickly creating an environment without having to write a package expression to contain the desired inputs."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6184
- msgid "For instance, the command:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:6187
- #, no-wrap
- msgid "guix environment --ad-hoc guile guile-sdl -- guile\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6191
- msgid "runs @command{guile} in an environment where Guile and Guile-SDL are available."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6196
- msgid "Note that this example implicitly asks for the default output of @code{guile} and @code{guile-sdl}, but it is possible to ask for a specific output---e.g., @code{glib:bin} asks for the @code{bin} output of @code{glib} (@pxref{Packages with Multiple Outputs})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6202
- msgid "This option may be composed with the default behavior of @command{guix environment}. Packages appearing before @option{--ad-hoc} are interpreted as packages whose dependencies will be added to the environment, the default behavior. Packages appearing after are interpreted as packages that will be added to the environment directly."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:6218
- #, no-wrap
- msgid ""
- "guix environment --pure --preserve=^SLURM --ad-hoc openmpi @dots{} \\\n"
- " -- mpirun @dots{}\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6261
- msgid "For containers, link the environment profile to @file{~/.guix-profile} within the container and set @code{GUIX_ENVIRONMENT} to that. This is equivalent to making @file{~/.guix-profile} a symlink to the actual profile within the container. Linking will fail and abort the environment if the directory already exists, which will certainly be the case if @command{guix environment} was invoked in the user's home directory."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:6288
- #, no-wrap
- msgid ""
- "# will expose paths as /home/foo/wd, /home/foo/test, and /home/foo/target\n"
- "cd $HOME/wd\n"
- "guix environment --container --user=foo \\\n"
- " --expose=$HOME/test \\\n"
- " --expose=/tmp/target=$HOME/target\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:6316
- #, no-wrap
- msgid "guix environment --container --expose=$HOME=/exchange --ad-hoc guile -- guile\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6324
- msgid "@command{guix environment} also supports all of the common build options that @command{guix build} supports (@pxref{Common Build Options}) as well as package transformation options (@pxref{Package Transformation Options})."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:6326
- #, no-wrap
- msgid "Invoking @command{guix pack}"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6332
- msgid "Occasionally you want to pass software to people who are not (yet!) lucky enough to be using Guix. You'd tell them to run @command{guix package -i @var{something}}, but that's not possible in this case. This is where @command{guix pack} comes in."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:6337
- msgid "If you are looking for ways to exchange binaries among machines that already run Guix, @pxref{Invoking guix copy}, @ref{Invoking guix publish}, and @ref{Invoking guix archive}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:6339
- #, no-wrap
- msgid "pack"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:6340
- #, no-wrap
- msgid "bundle"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:6341
- #, no-wrap
- msgid "application bundle"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:6342
- #, no-wrap
- msgid "software bundle"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6351
- msgid "The @command{guix pack} command creates a shrink-wrapped @dfn{pack} or @dfn{software bundle}: it creates a tarball or some other archive containing the binaries of the software you're interested in, and all its dependencies. The resulting archive can be used on any machine that does not have Guix, and people can run the exact same binaries as those you have with Guix. The pack itself is created in a bit-reproducible fashion, so anyone can verify that it really contains the build results that you pretend to be shipping."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6354
- msgid "For example, to create a bundle containing Guile, Emacs, Geiser, and all their dependencies, you can run:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:6359
- #, no-wrap
- msgid ""
- "$ guix pack guile emacs emacs-geiser\n"
- "@dots{}\n"
- "/gnu/store/@dots{}-pack.tar.gz\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6367
- msgid "The result here is a tarball containing a @file{/gnu/store} directory with all the relevant packages. The resulting tarball contains a @dfn{profile} with the three packages of interest; the profile is the same as would be created by @command{guix package -i}. It is this mechanism that is used to create Guix's own standalone binary tarball (@pxref{Binary Installation})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6372
- msgid "Users of this pack would have to run @file{/gnu/store/@dots{}-profile/bin/guile} to run Guile, which you may find inconvenient. To work around it, you can create, say, a @file{/opt/gnu/bin} symlink to the profile:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:6375
- #, no-wrap
- msgid "guix pack -S /opt/gnu/bin=bin guile emacs emacs-geiser\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6379
- msgid "That way, users can happily type @file{/opt/gnu/bin/guile} and enjoy."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:6380
- #, no-wrap
- msgid "relocatable binaries, with @command{guix pack}"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6388
- msgid "What if the recipient of your pack does not have root privileges on their machine, and thus cannot unpack it in the root file system? In that case, you will want to use the @option{--relocatable} option (see below). This option produces @dfn{relocatable binaries}, meaning they they can be placed anywhere in the file system hierarchy: in the example above, users can unpack your tarball in their home directory and directly run @file{./opt/gnu/bin/guile}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:6389
- #, no-wrap
- msgid "Docker, build an image with guix pack"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6392
- msgid "Alternatively, you can produce a pack in the Docker image format using the following command:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:6395
- #, no-wrap
- msgid "guix pack -f docker -S /bin=bin guile guile-readline\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6400
- msgid "The result is a tarball that can be passed to the @command{docker load} command, followed by @code{docker run}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:6404
- #, no-wrap
- msgid ""
- "docker load < @var{file}\n"
- "docker run -ti guile-guile-readline /bin/guile\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6411
- msgid "where @var{file} is the image returned by @var{guix pack}, and @code{guile-guile-readline} is its ``image tag''. See the @uref{https://docs.docker.com/engine/reference/commandline/load/, Docker documentation} for more information."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:6412
- #, no-wrap
- msgid "Singularity, build an image with guix pack"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:6413
- #, no-wrap
- msgid "SquashFS, build an image with guix pack"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6416
- msgid "Yet another option is to produce a SquashFS image with the following command:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:6419
- #, no-wrap
- msgid "guix pack -f squashfs bash guile emacs emacs-geiser\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6427
- msgid "The result is a SquashFS file system image that can either be mounted or directly be used as a file system container image with the @uref{https://www.sylabs.io/docs/, Singularity container execution environment}, using commands like @command{singularity shell} or @command{singularity exec}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6429
- msgid "Several command-line options allow you to customize your pack:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6434
- msgid "Produce a pack in the given @var{format}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6436
- msgid "The available formats are:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:6438
- #, no-wrap
- msgid "tarball"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6441
- msgid "This is the default format. It produces a tarball containing all the specified binaries and symlinks."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:6442
- #, no-wrap
- msgid "docker"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6448
- msgid "This produces a tarball that follows the @uref{https://github.com/docker/docker/blob/master/image/spec/v1.2.md, Docker Image Specification}. The ``repository name'' as it appears in the output of the @command{docker images} command is computed from package names passed on the command line or in the manifest file."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:6449
- #, no-wrap
- msgid "squashfs"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6453
- msgid "This produces a SquashFS image containing all the specified binaries and symlinks, as well as empty mount points for virtual file systems like procfs."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:6459
- msgid "Singularity @emph{requires} you to provide @file{/bin/sh} in the image. For that reason, @command{guix pack -f squashfs} always implies @code{-S /bin=bin}. Thus, your @command{guix pack} invocation must always start with something like:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:6462
- #, no-wrap
- msgid "guix pack -f squashfs bash @dots{}\n"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:6467
- msgid "If you forget the @code{bash} (or similar) package, @command{singularity run} and @command{singularity exec} will fail with an unhelpful ``no such file or directory'' message."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:6469
- #, no-wrap
- msgid "deb"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6477
- msgid "This produces a Debian archive (a package with the @samp{.deb} file extension) containing all the specified binaries and symbolic links, that can be installed on top of any dpkg-based GNU(/Linux) distribution. Advanced options can be revealed via the @option{--help-deb-format} option. They allow embedding control files for more fine-grained control, such as activating specific triggers or providing a maintainer configure script to run arbitrary setup code upon installation."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:6480
- #, no-wrap
- msgid "guix pack -f deb -C xz -S /usr/bin/hello=bin/hello hello\n"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:6487
- msgid "Because archives produced with @command{guix pack} contain a collection of store items and because each @command{dpkg} package must not have conflicting files, in practice that means you likely won't be able to install more than one such archive on a given system."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:6495
- msgid "@command{dpkg} will assume ownership of any files contained in the pack that it does @emph{not} know about. It is unwise to install Guix-produced @samp{.deb} files on a system where @file{/gnu/store} is shared by other software, such as a Guix installation or other, non-deb packs."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:6499
- #, no-wrap
- msgid "relocatable binaries"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:6500
- #, no-wrap
- msgid "--relocatable"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6504
- msgid "Produce @dfn{relocatable binaries}---i.e., binaries that can be placed anywhere in the file system hierarchy and run from there."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6512
- msgid "When this option is passed once, the resulting binaries require support for @dfn{user namespaces} in the kernel Linux; when passed @emph{twice}@footnote{Here's a trick to memorize it: @code{-RR}, which adds PRoot support, can be thought of as the abbreviation of ``Really Relocatable''. Neat, isn't it?}, relocatable binaries fall to back to other techniques if user namespaces are unavailable, and essentially work anywhere---see below for the implications."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6514
- msgid "For example, if you create a pack containing Bash with:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:6517
- #, no-wrap
- msgid "guix pack -RR -S /mybin=bin bash\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6522
- msgid "...@: you can copy that pack to a machine that lacks Guix, and from your home directory as a normal user, run:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:6526
- #, no-wrap
- msgid ""
- "tar xf pack.tar.gz\n"
- "./mybin/sh\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6534
- msgid "In that shell, if you type @code{ls /gnu/store}, you'll notice that @file{/gnu/store} shows up and contains all the dependencies of @code{bash}, even though the machine actually lacks @file{/gnu/store} altogether! That is probably the simplest way to deploy Guix-built software on a non-Guix machine."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:6540
- msgid "By default, relocatable binaries rely on the @dfn{user namespace} feature of the kernel Linux, which allows unprivileged users to mount or change root. Old versions of Linux did not support it, and some GNU/Linux distributions turn it off."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:6546
- msgid "To produce relocatable binaries that work even in the absence of user namespaces, pass @option{--relocatable} or @option{-R} @emph{twice}. In that case, binaries will try user namespace support and fall back to another @dfn{execution engine} if user namespaces are not supported. The following execution engines are supported:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:6548 guix-git/doc/guix.texi:17371
- #, no-wrap
- msgid "default"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6551
- msgid "Try user namespaces and fall back to PRoot if user namespaces are not supported (see below)."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:6552
- #, no-wrap
- msgid "performance"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6555
- msgid "Try user namespaces and fall back to Fakechroot if user namespaces are not supported (see below)."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:6556
- #, no-wrap
- msgid "userns"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6559
- msgid "Run the program through user namespaces and abort if they are not supported."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:6560
- #, no-wrap
- msgid "proot"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6567
- msgid "Run through PRoot. The @uref{https://proot-me.github.io/, PRoot} program provides the necessary support for file system virtualization. It achieves that by using the @code{ptrace} system call on the running program. This approach has the advantage to work without requiring special kernel support, but it incurs run-time overhead every time a system call is made."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:6568
- #, no-wrap
- msgid "fakechroot"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6576
- msgid "Run through Fakechroot. @uref{https://github.com/dex4er/fakechroot/, Fakechroot} virtualizes file system accesses by intercepting calls to C library functions such as @code{open}, @code{stat}, @code{exec}, and so on. Unlike PRoot, it incurs very little overhead. However, it does not always work: for example, some file system accesses made from within the C library are not intercepted, and file system accesses made @i{via} direct syscalls are not intercepted either, leading to erratic behavior."
- msgstr ""
- #. type: vindex
- #: guix-git/doc/guix.texi:6578
- #, no-wrap
- msgid "GUIX_EXECUTION_ENGINE"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:6582
- msgid "When running a wrapped program, you can explicitly request one of the execution engines listed above by setting the @env{GUIX_EXECUTION_ENGINE} environment variable accordingly."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:6584
- #, no-wrap
- msgid "entry point, for Docker images"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:6585
- #, no-wrap
- msgid "--entry-point=@var{command}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6590
- msgid "Use @var{command} as the @dfn{entry point} of the resulting pack, if the pack format supports it---currently @code{docker} and @code{squashfs} (Singularity) support it. @var{command} must be relative to the profile contained in the pack."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6594
- msgid "The entry point specifies the command that tools like @code{docker run} or @code{singularity run} automatically start by default. For example, you can do:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:6597
- #, no-wrap
- msgid "guix pack -f docker --entry-point=bin/guile guile\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6601
- msgid "The resulting pack can easily be loaded and @code{docker run} with no extra arguments will spawn @code{bin/guile}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:6605
- #, no-wrap
- msgid ""
- "docker load -i pack.tar.gz\n"
- "docker run @var{image-id}\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6610 guix-git/doc/guix.texi:12497
- #: guix-git/doc/guix.texi:13445
- msgid "Consider the package @var{expr} evaluates to."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6614
- msgid "This has the same purpose as the same-named option in @command{guix build} (@pxref{Additional Build Options, @option{--expression} in @command{guix build}})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6620
- msgid "Use the packages contained in the manifest object returned by the Scheme code in @var{file}. This option can be repeated several times, in which case the manifests are concatenated."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6628
- msgid "This has a similar purpose as the same-named option in @command{guix package} (@pxref{profile-manifest, @option{--manifest}}) and uses the same manifest files. It allows you to define a collection of packages once and use it both for creating profiles and for creating archives for use on machines that do not have Guix installed. Note that you can specify @emph{either} a manifest file @emph{or} a list of packages, but not both."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:6634 guix-git/doc/guix.texi:11539
- #, no-wrap
- msgid "--target=@var{triplet}"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:6635 guix-git/doc/guix.texi:7080
- #: guix-git/doc/guix.texi:11540
- #, no-wrap
- msgid "cross-compilation"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6639
- msgid "Cross-build for @var{triplet}, which must be a valid GNU triplet, such as @code{\"aarch64-linux-gnu\"} (@pxref{Specifying target triplets, GNU configuration triplets,, autoconf, Autoconf})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:6640
- #, no-wrap
- msgid "--compression=@var{tool}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:6641
- #, no-wrap
- msgid "-C @var{tool}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6645
- msgid "Compress the resulting tarball using @var{tool}---one of @code{gzip}, @code{zstd}, @code{bzip2}, @code{xz}, @code{lzip}, or @code{none} for no compression."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:6646
- #, no-wrap
- msgid "--symlink=@var{spec}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:6647
- #, no-wrap
- msgid "-S @var{spec}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6650
- msgid "Add the symlinks specified by @var{spec} to the pack. This option can appear several times."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6654
- msgid "@var{spec} has the form @code{@var{source}=@var{target}}, where @var{source} is the symlink that will be created and @var{target} is the symlink target."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6657
- msgid "For instance, @code{-S /opt/gnu/bin=bin} creates a @file{/opt/gnu/bin} symlink pointing to the @file{bin} sub-directory of the profile."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:6658 guix-git/doc/guix.texi:35262
- #, no-wrap
- msgid "--save-provenance"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6662
- msgid "Save provenance information for the packages passed on the command line. Provenance information includes the URL and commit of the channels in use (@pxref{Channels})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6668
- msgid "Provenance information is saved in the @file{/gnu/store/@dots{}-profile/manifest} file in the pack, along with the usual package metadata---the name and version of each package, their propagated inputs, and so on. It is useful information to the recipient of the pack, who then knows how the pack was (supposedly) obtained."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6674
- msgid "This option is not enabled by default because, like timestamps, provenance information contributes nothing to the build process. In other words, there is an infinity of channel URLs and commit IDs that can lead to the same pack. Recording such ``silent'' metadata in the output thus potentially breaks the source-to-binary bitwise reproducibility property."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:6677
- #, no-wrap
- msgid "garbage collector root, for packs"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6680
- msgid "Make @var{file} a symlink to the resulting pack, and register it as a garbage collector root."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:6681
- #, no-wrap
- msgid "--localstatedir"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:6682
- #, no-wrap
- msgid "--profile-name=@var{name}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6687
- msgid "Include the ``local state directory'', @file{/var/guix}, in the resulting pack, and notably the @file{/var/guix/profiles/per-user/root/@var{name}} profile---by default @var{name} is @code{guix-profile}, which corresponds to @file{~root/.guix-profile}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6693
- msgid "@file{/var/guix} contains the store database (@pxref{The Store}) as well as garbage-collector roots (@pxref{Invoking guix gc}). Providing it in the pack means that the store is ``complete'' and manageable by Guix; not providing it pack means that the store is ``dead'': items cannot be added to it or removed from it after extraction of the pack."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6696
- msgid "One use case for this is the Guix self-contained binary tarball (@pxref{Binary Installation})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:6697 guix-git/doc/guix.texi:35256
- #, no-wrap
- msgid "--derivation"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:6698 guix-git/doc/guix.texi:11571
- #: guix-git/doc/guix.texi:35257
- #, no-wrap
- msgid "-d"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6700
- msgid "Print the name of the derivation that builds the pack."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6704
- msgid "Use the bootstrap binaries to build the pack. This option is only useful to Guix developers."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6709
- msgid "In addition, @command{guix pack} supports all the common build options (@pxref{Common Build Options}) and all the package transformation options (@pxref{Package Transformation Options})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:6714
- #, no-wrap
- msgid "GCC"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:6715
- #, no-wrap
- msgid "ld-wrapper"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:6716
- #, no-wrap
- msgid "linker wrapper"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:6717
- #, no-wrap
- msgid "toolchain, for C development"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:6718
- #, no-wrap
- msgid "toolchain, for Fortran development"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6725
- msgid "If you need a complete toolchain for compiling and linking C or C++ source code, use the @code{gcc-toolchain} package. This package provides a complete GCC toolchain for C/C++ development, including GCC itself, the GNU C Library (headers and binaries, plus debugging symbols in the @code{debug} output), Binutils, and a linker wrapper."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6731
- msgid "The wrapper's purpose is to inspect the @code{-L} and @code{-l} switches passed to the linker, add corresponding @code{-rpath} arguments, and invoke the actual linker with this new set of arguments. You can instruct the wrapper to refuse to link against libraries not in the store by setting the @env{GUIX_LD_WRAPPER_ALLOW_IMPURITIES} environment variable to @code{no}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6735
- msgid "The package @code{gfortran-toolchain} provides a complete GCC toolchain for Fortran development. For other languages, please use @samp{guix search gcc toolchain} (@pxref{guix-search,, Invoking guix package})."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:6738
- #, no-wrap
- msgid "Invoking @command{guix git authenticate}"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6746
- msgid "The @command{guix git authenticate} command authenticates a Git checkout following the same rule as for channels (@pxref{channel-authentication, channel authentication}). That is, starting from a given commit, it ensures that all subsequent commits are signed by an OpenPGP key whose fingerprint appears in the @file{.guix-authorizations} file of its parent commit(s)."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6751
- msgid "You will find this command useful if you maintain a channel. But in fact, this authentication mechanism is useful in a broader context, so you might want to use it for Git repositories that have nothing to do with Guix."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:6756
- #, no-wrap
- msgid "guix git authenticate @var{commit} @var{signer} [@var{options}@dots{}]\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6765
- msgid "By default, this command authenticates the Git checkout in the current directory; it outputs nothing and exits with exit code zero on success and non-zero on failure. @var{commit} above denotes the first commit where authentication takes place, and @var{signer} is the OpenPGP fingerprint of public key used to sign @var{commit}. Together, they form a ``channel introduction'' (@pxref{channel-authentication, channel introduction}). The options below allow you to fine-tune the process."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:6767
- #, no-wrap
- msgid "--repository=@var{directory}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:6768
- #, no-wrap
- msgid "-r @var{directory}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6771
- msgid "Open the Git repository in @var{directory} instead of the current directory."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:6772
- #, no-wrap
- msgid "--keyring=@var{reference}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:6773
- #, no-wrap
- msgid "-k @var{reference}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6779
- msgid "Load OpenPGP keyring from @var{reference}, the reference of a branch such as @code{origin/keyring} or @code{my-keyring}. The branch must contain OpenPGP public keys in @file{.key} files, either in binary form or ``ASCII-armored''. By default the keyring is loaded from the branch named @code{keyring}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:6780
- #, no-wrap
- msgid "--stats"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6782
- msgid "Display commit signing statistics upon completion."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:6783
- #, no-wrap
- msgid "--cache-key=@var{key}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6787
- msgid "Previously-authenticated commits are cached in a file under @file{~/.cache/guix/authentication}. This option forces the cache to be stored in file @var{key} in that directory."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:6788
- #, no-wrap
- msgid "--historical-authorizations=@var{file}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:6795
- msgid "By default, any commit whose parent commit(s) lack the @file{.guix-authorizations} file is considered inauthentic. In contrast, this option considers the authorizations in @var{file} for any commit that lacks @file{.guix-authorizations}. The format of @var{file} is the same as that of @file{.guix-authorizations} (@pxref{channel-authorizations, @file{.guix-authorizations} format})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6808
- msgid "GNU Guix provides several Scheme programming interfaces (APIs) to define, build, and query packages. The first interface allows users to write high-level package definitions. These definitions refer to familiar packaging concepts, such as the name and version of a package, its build system, and its dependencies. These definitions can then be turned into concrete build actions."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6814
- msgid "Build actions are performed by the Guix daemon, on behalf of users. In a standard setup, the daemon has write access to the store---the @file{/gnu/store} directory---whereas users do not. The recommended setup also has the daemon perform builds in chroots, under specific build users, to minimize interference with the rest of the system."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6823
- msgid "Lower-level APIs are available to interact with the daemon and the store. To instruct the daemon to perform a build action, users actually provide it with a @dfn{derivation}. A derivation is a low-level representation of the build actions to be taken, and the environment in which they should occur---derivations are to package definitions what assembly is to C programs. The term ``derivation'' comes from the fact that build results @emph{derive} from them."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6826
- msgid "This chapter describes all these APIs in turn, starting from high-level package definitions."
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:6839
- msgid "Programming Guix in Guile"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6855
- msgid "From a programming viewpoint, the package definitions of the GNU distribution are provided by Guile modules in the @code{(gnu packages @dots{})} name space@footnote{Note that packages under the @code{(gnu packages @dots{})} module name space are not necessarily ``GNU packages''. This module naming scheme follows the usual Guile module naming convention: @code{gnu} means that these modules are distributed as part of the GNU system, and @code{packages} identifies modules that define packages.} (@pxref{Modules, Guile modules,, guile, GNU Guile Reference Manual}). For instance, the @code{(gnu packages emacs)} module exports a variable named @code{emacs}, which is bound to a @code{<package>} object (@pxref{Defining Packages})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6862
- msgid "The @code{(gnu packages @dots{})} module name space is automatically scanned for packages by the command-line tools. For instance, when running @code{guix install emacs}, all the @code{(gnu packages @dots{})} modules are scanned until one that exports a package object whose name is @code{emacs} is found. This package search facility is implemented in the @code{(gnu packages)} module."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:6864
- #, no-wrap
- msgid "package module search path"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6873
- msgid "Users can store package definitions in modules with different names---e.g., @code{(my-packages emacs)}@footnote{Note that the file name and module name must match. For instance, the @code{(my-packages emacs)} module must be stored in a @file{my-packages/emacs.scm} file relative to the load path specified with @option{--load-path} or @env{GUIX_PACKAGE_PATH}. @xref{Modules and the File System,,, guile, GNU Guile Reference Manual}, for details.}. There are two ways to make these package definitions visible to the user interfaces:"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:6880
- msgid "By adding the directory containing your package modules to the search path with the @code{-L} flag of @command{guix package} and other commands (@pxref{Common Build Options}), or by setting the @env{GUIX_PACKAGE_PATH} environment variable described below."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:6886
- msgid "By defining a @dfn{channel} and configuring @command{guix pull} so that it pulls from it. A channel is essentially a Git repository containing package modules. @xref{Channels}, for more information on how to define and use channels."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6889
- msgid "@env{GUIX_PACKAGE_PATH} works similarly to other search path variables:"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:6890
- #, no-wrap
- msgid "{Environment Variable} GUIX_PACKAGE_PATH"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:6894
- msgid "This is a colon-separated list of directories to search for additional package modules. Directories listed in this variable take precedence over the own modules of the distribution."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6902
- msgid "The distribution is fully @dfn{bootstrapped} and @dfn{self-contained}: each package is built based solely on other packages in the distribution. The root of this dependency graph is a small set of @dfn{bootstrap binaries}, provided by the @code{(gnu packages bootstrap)} module. For more information on bootstrapping, @pxref{Bootstrapping}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6910
- msgid "The high-level interface to package definitions is implemented in the @code{(guix packages)} and @code{(guix build-system)} modules. As an example, the package definition, or @dfn{recipe}, for the GNU Hello package looks like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:6918
- #, no-wrap
- msgid ""
- "(define-module (gnu packages hello)\n"
- " #:use-module (guix packages)\n"
- " #:use-module (guix download)\n"
- " #:use-module (guix build-system gnu)\n"
- " #:use-module (guix licenses)\n"
- " #:use-module (gnu packages gawk))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:6937
- #, no-wrap
- msgid ""
- "(define-public hello\n"
- " (package\n"
- " (name \"hello\")\n"
- " (version \"2.10\")\n"
- " (source (origin\n"
- " (method url-fetch)\n"
- " (uri (string-append \"mirror://gnu/hello/hello-\" version\n"
- " \".tar.gz\"))\n"
- " (sha256\n"
- " (base32\n"
- " \"0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i\"))))\n"
- " (build-system gnu-build-system)\n"
- " (arguments '(#:configure-flags '(\"--enable-silent-rules\")))\n"
- " (inputs (list gawk))\n"
- " (synopsis \"Hello, GNU world: An example GNU package\")\n"
- " (description \"Guess what GNU Hello prints!\")\n"
- " (home-page \"https://www.gnu.org/software/hello/\")\n"
- " (license gpl3+)))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6947
- msgid "Without being a Scheme expert, the reader may have guessed the meaning of the various fields here. This expression binds the variable @code{hello} to a @code{<package>} object, which is essentially a record (@pxref{SRFI-9, Scheme records,, guile, GNU Guile Reference Manual}). This package object can be inspected using procedures found in the @code{(guix packages)} module; for instance, @code{(package-name hello)} returns---surprise!---@code{\"hello\"}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6951
- msgid "With luck, you may be able to import part or all of the definition of the package you are interested in from another repository, using the @code{guix import} command (@pxref{Invoking guix import})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6957
- msgid "In the example above, @code{hello} is defined in a module of its own, @code{(gnu packages hello)}. Technically, this is not strictly necessary, but it is convenient to do so: all the packages defined in modules under @code{(gnu packages @dots{})} are automatically known to the command-line tools (@pxref{Package Modules})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:6959
- msgid "There are a few points worth noting in the above package definition:"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:6966
- msgid "The @code{source} field of the package is an @code{<origin>} object (@pxref{origin Reference}, for the complete reference). Here, the @code{url-fetch} method from @code{(guix download)} is used, meaning that the source is a file to be downloaded over FTP or HTTP."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:6969
- msgid "The @code{mirror://gnu} prefix instructs @code{url-fetch} to use one of the GNU mirrors defined in @code{(guix download)}."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:6976
- msgid "The @code{sha256} field specifies the expected SHA256 hash of the file being downloaded. It is mandatory, and allows Guix to check the integrity of the file. The @code{(base32 @dots{})} form introduces the base32 representation of the hash. You can obtain this information with @code{guix download} (@pxref{Invoking guix download}) and @code{guix hash} (@pxref{Invoking guix hash})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:6977
- #, no-wrap
- msgid "patches"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:6981
- msgid "When needed, the @code{origin} form can also have a @code{patches} field listing patches to be applied, and a @code{snippet} field giving a Scheme expression to modify the source code."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:6983
- #, no-wrap
- msgid "GNU Build System"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:6989
- msgid "The @code{build-system} field specifies the procedure to build the package (@pxref{Build Systems}). Here, @code{gnu-build-system} represents the familiar GNU Build System, where packages may be configured, built, and installed with the usual @code{./configure && make && make check && make install} command sequence."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:6993
- msgid "When you start packaging non-trivial software, you may need tools to manipulate those build phases, manipulate files, and so on. @xref{Build Utilities}, for more on this."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:6999
- msgid "The @code{arguments} field specifies options for the build system (@pxref{Build Systems}). Here it is interpreted by @code{gnu-build-system} as a request run @file{configure} with the @option{--enable-silent-rules} flag."
- msgstr ""
- #. type: findex
- #: guix-git/doc/guix.texi:7000 guix-git/doc/guix.texi:7003
- #, no-wrap
- msgid "quote"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:7001
- #, no-wrap
- msgid "quoting"
- msgstr ""
- #. type: findex
- #: guix-git/doc/guix.texi:7002
- #, no-wrap
- msgid "'"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:7004
- #, no-wrap
- msgid "backquote (quasiquote)"
- msgstr ""
- #. type: findex
- #: guix-git/doc/guix.texi:7005
- #, no-wrap
- msgid "`"
- msgstr ""
- #. type: findex
- #: guix-git/doc/guix.texi:7006
- #, no-wrap
- msgid "quasiquote"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:7007
- #, no-wrap
- msgid "comma (unquote)"
- msgstr ""
- #. type: findex
- #: guix-git/doc/guix.texi:7008
- #, no-wrap
- msgid ","
- msgstr ""
- #. type: findex
- #: guix-git/doc/guix.texi:7009
- #, no-wrap
- msgid "unquote"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:7019
- msgid "What about these quote (@code{'}) characters? They are Scheme syntax to introduce a literal list; @code{'} is synonymous with @code{quote}. Sometimes you'll also see @code{`} (a backquote, synonymous with @code{quasiquote}) and @code{,} (a comma, synonymous with @code{unquote}). @xref{Expression Syntax, quoting,, guile, GNU Guile Reference Manual}, for details. Here the value of the @code{arguments} field is a list of arguments passed to the build system down the road, as with @code{apply} (@pxref{Fly Evaluation, @code{apply},, guile, GNU Guile Reference Manual})."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:7025
- msgid "The hash-colon (@code{#:}) sequence defines a Scheme @dfn{keyword} (@pxref{Keywords,,, guile, GNU Guile Reference Manual}), and @code{#:configure-flags} is a keyword used to pass a keyword argument to the build system (@pxref{Coding With Keywords,,, guile, GNU Guile Reference Manual})."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:7031
- msgid "The @code{inputs} field specifies inputs to the build process---i.e., build-time or run-time dependencies of the package. Here, we add an input, a reference to the @code{gawk} variable; @code{gawk} is itself bound to a @code{<package>} object."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:7035
- msgid "Note that GCC, Coreutils, Bash, and other essential tools do not need to be specified as inputs here. Instead, @code{gnu-build-system} takes care of ensuring that they are present (@pxref{Build Systems})."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:7039
- msgid "However, any other dependencies need to be specified in the @code{inputs} field. Any dependency not specified here will simply be unavailable to the build process, possibly leading to a build failure."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7042
- msgid "@xref{package Reference}, for a full description of possible fields."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7053
- msgid "Once a package definition is in place, the package may actually be built using the @code{guix build} command-line tool (@pxref{Invoking guix build}), troubleshooting any build failures you encounter (@pxref{Debugging Build Failures}). You can easily jump back to the package definition using the @command{guix edit} command (@pxref{Invoking guix edit}). @xref{Packaging Guidelines}, for more information on how to test package definitions, and @ref{Invoking guix lint}, for information on how to check a definition for style conformance."
- msgstr ""
- #. type: vindex
- #: guix-git/doc/guix.texi:7053
- #, no-wrap
- msgid "GUIX_PACKAGE_PATH"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7057
- msgid "Lastly, @pxref{Channels}, for information on how to extend the distribution by adding your own package definitions in a ``channel''."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7061
- msgid "Finally, updating the package definition to a new upstream version can be partly automated by the @command{guix refresh} command (@pxref{Invoking guix refresh})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7067
- msgid "Behind the scenes, a derivation corresponding to the @code{<package>} object is first computed by the @code{package-derivation} procedure. That derivation is stored in a @file{.drv} file under @file{/gnu/store}. The build actions it prescribes may then be realized by using the @code{build-derivations} procedure (@pxref{The Store})."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7068
- #, no-wrap
- msgid "{Scheme Procedure} package-derivation @var{store} @var{package} [@var{system}]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7071
- msgid "Return the @code{<derivation>} object of @var{package} for @var{system} (@pxref{Derivations})."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7077
- msgid "@var{package} must be a valid @code{<package>} object, and @var{system} must be a string denoting the target system type---e.g., @code{\"x86_64-linux\"} for an x86_64 Linux-based GNU system. @var{store} must be a connection to the daemon, which operates on the store (@pxref{The Store})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7083
- msgid "Similarly, it is possible to compute a derivation that cross-builds a package for some other system:"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7084
- #, no-wrap
- msgid "{Scheme Procedure} package-cross-derivation @var{store} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7088
- msgid "@var{package} @var{target} [@var{system}] Return the @code{<derivation>} object of @var{package} cross-built from @var{system} to @var{target}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7092
- msgid "@var{target} must be a valid GNU triplet denoting the target hardware and operating system, such as @code{\"aarch64-linux-gnu\"} (@pxref{Specifying Target Triplets,,, autoconf, Autoconf})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7096
- msgid "Once you have package definitions, you can easily define @emph{variants} of those packages. @xref{Defining Package Variants}, for more on that."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:7104
- #, no-wrap
- msgid "@code{package} Reference"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7108
- msgid "This section summarizes all the options available in @code{package} declarations (@pxref{Defining Packages})."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:7109
- #, no-wrap
- msgid "{Data Type} package"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:7111
- msgid "This is the data type representing a package recipe."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7115
- msgid "The name of the package, as a string."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:7116
- #, no-wrap
- msgid "version"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7119
- msgid "The version of the package, as a string. @xref{Version Numbers}, for guidelines."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:7120 guix-git/doc/guix.texi:12900
- #: guix-git/doc/guix.texi:15181 guix-git/doc/guix.texi:15790
- #, no-wrap
- msgid "source"
- msgstr "منبع"
- #. type: table
- #: guix-git/doc/guix.texi:7127
- msgid "An object telling how the source code for the package should be acquired. Most of the time, this is an @code{origin} object, which denotes a file fetched from the Internet (@pxref{origin Reference}). It can also be any other ``file-like'' object such as a @code{local-file}, which denotes a file from the local file system (@pxref{G-Expressions, @code{local-file}})."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:7128
- #, no-wrap
- msgid "build-system"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7131
- msgid "The build system that should be used to build the package (@pxref{Build Systems})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7132 guix-git/doc/guix.texi:17953
- #, no-wrap
- msgid "@code{arguments} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7135
- msgid "The arguments that should be passed to the build system. This is a list, typically containing sequential keyword-value pairs."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7136
- #, no-wrap
- msgid "@code{inputs} (default: @code{'()})"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:7137
- #, no-wrap
- msgid "@code{native-inputs} (default: @code{'()})"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:7138
- #, no-wrap
- msgid "@code{propagated-inputs} (default: @code{'()})"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:7139
- #, no-wrap
- msgid "inputs, of packages"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7146
- msgid "These fields list dependencies of the package. Each element of these lists is either a package, origin, or other ``file-like object'' (@pxref{G-Expressions}); to specify the output of that file-like object that should be used, pass a two-element list where the second element is the output (@pxref{Packages with Multiple Outputs}, for more on package outputs). For example, the list below specifies three inputs:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7150
- #, no-wrap
- msgid ""
- "(list libffi libunistring\n"
- " `(,glib \"bin\")) ;the \"bin\" output of GLib\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7154
- msgid "In the example above, the @code{\"out\"} output of @code{libffi} and @code{libunistring} is used."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:7155
- #, no-wrap
- msgid "Compatibility Note"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:7162
- msgid "Until version 1.3.0, input lists were a list of tuples, where each tuple has a label for the input (a string) as its first element, a package, origin, or derivation as its second element, and optionally the name of the output thereof that should be used, which defaults to @code{\"out\"}. For example, the list below is equivalent to the one above, but using the @dfn{old input style}:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7168
- #, no-wrap
- msgid ""
- ";; Old input style (deprecated).\n"
- "`((\"libffi\" ,libffi)\n"
- " (\"libunistring\" ,libunistring)\n"
- " (\"glib:bin\" ,glib \"bin\")) ;the \"bin\" output of GLib\n"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:7174
- msgid "This style is now deprecated; it is still supported but support will be removed in a future version. It should not be used for new package definitions. @xref{Invoking guix style}, on how to migrate to the new style."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:7176
- #, no-wrap
- msgid "cross compilation, package dependencies"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7182
- msgid "The distinction between @code{native-inputs} and @code{inputs} is necessary when considering cross-compilation. When cross-compiling, dependencies listed in @code{inputs} are built for the @emph{target} architecture; conversely, dependencies listed in @code{native-inputs} are built for the architecture of the @emph{build} machine."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7187
- msgid "@code{native-inputs} is typically used to list tools needed at build time, but not at run time, such as Autoconf, Automake, pkg-config, Gettext, or Bison. @command{guix lint} can report likely mistakes in this area (@pxref{Invoking guix lint})."
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:7195
- msgid "package-propagated-inputs"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7195
- msgid "Lastly, @code{propagated-inputs} is similar to @code{inputs}, but the specified packages will be automatically installed to profiles (@pxref{Features, the role of profiles in Guix}) alongside the package they belong to (@pxref{package-cmd-propagated-inputs, @command{guix package}}, for information on how @command{guix package} deals with propagated inputs)."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7199
- msgid "For example this is necessary when packaging a C/C++ library that needs headers of another library to compile, or when a pkg-config file refers to another one @i{via} its @code{Requires} field."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7206
- msgid "Another example where @code{propagated-inputs} is useful is for languages that lack a facility to record the run-time search path akin to the @code{RUNPATH} of ELF files; this includes Guile, Python, Perl, and more. When packaging libraries written in those languages, ensure they can find library code they depend on at run time by listing run-time dependencies in @code{propagated-inputs} rather than @code{inputs}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7207
- #, no-wrap
- msgid "@code{outputs} (default: @code{'(\"out\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7210
- msgid "The list of output names of the package. @xref{Packages with Multiple Outputs}, for typical uses of additional outputs."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7211
- #, no-wrap
- msgid "@code{native-search-paths} (default: @code{'()})"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:7212
- #, no-wrap
- msgid "@code{search-paths} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7215
- msgid "A list of @code{search-path-specification} objects describing search-path environment variables honored by the package."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7216
- #, no-wrap
- msgid "@code{replacement} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7220
- msgid "This must be either @code{#f} or a package object that will be used as a @dfn{replacement} for this package. @xref{Security Updates, grafts}, for details."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7221 guix-git/doc/guix.texi:12892
- #, no-wrap
- msgid "synopsis"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7223
- msgid "A one-line description of the package."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:7224 guix-git/doc/guix.texi:12893
- #: guix-git/doc/guix.texi:35959 guix-git/doc/guix.texi:36119
- #, no-wrap
- msgid "description"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7226
- msgid "A more elaborate description of the package."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:7227
- #, no-wrap
- msgid "license"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:7228
- #, no-wrap
- msgid "license, of packages"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7231
- msgid "The license of the package; a value from @code{(guix licenses)}, or a list of such values."
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:7232 guix-git/doc/guix.texi:12901
- #, no-wrap
- msgid "home-page"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7234
- msgid "The URL to the home-page of the package, as a string."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7235
- #, no-wrap
- msgid "@code{supported-systems} (default: @code{%supported-systems})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7238
- msgid "The list of systems supported by the package, as strings of the form @code{architecture-kernel}, for example @code{\"x86_64-linux\"}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7239
- #, no-wrap
- msgid "@code{location} (default: source location of the @code{package} form)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7243
- msgid "The source location of the package. It is useful to override this when inheriting from another package, in which case this field is not automatically corrected."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7246
- #, no-wrap
- msgid "{Scheme Syntax} this-package"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7249
- msgid "When used in the @emph{lexical scope} of a package field definition, this identifier resolves to the package being defined."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7252
- msgid "The example below shows how to add a package as a native input of itself when cross-compiling:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7257
- #, no-wrap
- msgid ""
- "(package\n"
- " (name \"guile\")\n"
- " ;; ...\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7263
- #, no-wrap
- msgid ""
- " ;; When cross-compiled, Guile, for example, depends on\n"
- " ;; a native version of itself. Add it here.\n"
- " (native-inputs (if (%current-target-system)\n"
- " (list this-package)\n"
- " '())))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7266
- msgid "It is an error to refer to @code{this-package} outside a package definition."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7270
- msgid "The following helper procedures are provided to help deal with package inputs."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7271
- #, no-wrap
- msgid "{Scheme Procedure} lookup-package-input @var{package} @var{name}"
- msgstr ""
- #. type: deffnx
- #: guix-git/doc/guix.texi:7272
- #, no-wrap
- msgid "{Scheme Procedure} lookup-package-native-input @var{package} @var{name}"
- msgstr ""
- #. type: deffnx
- #: guix-git/doc/guix.texi:7273
- #, no-wrap
- msgid "{Scheme Procedure} lookup-package-propagated-input @var{package} @var{name}"
- msgstr ""
- #. type: deffnx
- #: guix-git/doc/guix.texi:7274
- #, no-wrap
- msgid "{Scheme Procedure} lookup-package-direct-input @var{package} @var{name}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7277
- msgid "Look up @var{name} among @var{package}'s inputs (or native, propagated, or direct inputs). Return it if found, @code{#f} otherwise."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7280
- msgid "@var{name} is the name of a package depended on. Here's how you might use it:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7283
- #, no-wrap
- msgid ""
- "(use-modules (guix packages) (gnu packages base))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7286
- #, no-wrap
- msgid ""
- "(lookup-package-direct-input coreutils \"gmp\")\n"
- "@result{} #<package gmp@@6.2.1 @dots{}>\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7290
- msgid "In this example we obtain the @code{gmp} package that is among the direct inputs of @code{coreutils}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:7292
- #, no-wrap
- msgid "development inputs, of a package"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:7293
- #, no-wrap
- msgid "implicit inputs, of a package"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7298
- msgid "Sometimes you will want to obtain the list of inputs needed to @emph{develop} a package---all the inputs that are visible when the package is compiled. This is what the @code{package-development-inputs} procedure returns."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7299
- #, no-wrap
- msgid "{Scheme Procedure} package-development-inputs @var{package} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7306
- msgid "[@var{system}] [#:target #f] Return the list of inputs required by @var{package} for development purposes on @var{system}. When @var{target} is true, return the inputs needed to cross-compile @var{package} from @var{system} to @var{triplet}, where @var{triplet} is a triplet such as @code{\"aarch64-linux-gnu\"}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7310
- msgid "Note that the result includes both explicit inputs and implicit inputs---inputs automatically added by the build system (@pxref{Build Systems}). Let us take the @code{hello} package to illustrate that:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7313
- #, no-wrap
- msgid ""
- "(use-modules (gnu packages base) (guix packages))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7316
- #, no-wrap
- msgid ""
- "hello\n"
- "@result{} #<package hello@@2.10 gnu/packages/base.scm:79 7f585d4f6790>\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7319
- #, no-wrap
- msgid ""
- "(package-direct-inputs hello)\n"
- "@result{} ()\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7322
- #, no-wrap
- msgid ""
- "(package-development-inputs hello)\n"
- "@result{} ((\"source\" @dots{}) (\"tar\" #<package tar@@1.32 @dots{}>) @dots{})\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7331
- msgid "In this example, @code{package-direct-inputs} returns the empty list, because @code{hello} has zero explicit dependencies. Conversely, @code{package-development-inputs} includes inputs implicitly added by @code{gnu-build-system} that are required to build @code{hello}: tar, gzip, GCC, libc, Bash, and more. To visualize it, @command{guix graph hello} would show you explicit inputs, whereas @command{guix graph -t bag hello} would include implicit inputs (@pxref{Invoking guix graph})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7337
- msgid "Because packages are regular Scheme objects that capture a complete dependency graph and associated build procedures, it is often useful to write procedures that take a package and return a modified version thereof according to some parameters. Below are a few examples."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:7338
- #, no-wrap
- msgid "tool chain, choosing a package's tool chain"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7339
- #, no-wrap
- msgid "{Scheme Procedure} package-with-c-toolchain @var{package} @var{toolchain}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7344
- msgid "Return a variant of @var{package} that uses @var{toolchain} instead of the default GNU C/C++ toolchain. @var{toolchain} must be a list of inputs (label/package tuples) providing equivalent functionality, such as the @code{gcc-toolchain} package."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7348
- msgid "The example below returns a variant of the @code{hello} package built with GCC@tie{}10.x and the rest of the GNU tool chain (Binutils and the GNU C Library) instead of the default tool chain:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7352
- #, no-wrap
- msgid ""
- "(let ((toolchain (specification->package \"gcc-toolchain@@10\")))\n"
- " (package-with-c-toolchain hello `((\"toolchain\" ,toolchain))))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7360
- msgid "The build tool chain is part of the @dfn{implicit inputs} of packages---it's usually not listed as part of the various ``inputs'' fields and is instead pulled in by the build system. Consequently, this procedure works by changing the build system of @var{package} so that it pulls in @var{toolchain} instead of the defaults. @ref{Build Systems}, for more on build systems."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:7363
- #, no-wrap
- msgid "@code{origin} Reference"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7371
- msgid "This section documents @dfn{origins}. An @code{origin} declaration specifies data that must be ``produced''---downloaded, usually---and whose content hash is known in advance. Origins are primarily used to represent the source code of packages (@pxref{Defining Packages}). For that reason, the @code{origin} form allows you to declare patches to apply to the original source code as well as code snippets to modify it."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:7372
- #, no-wrap
- msgid "{Data Type} origin"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:7374
- msgid "This is the data type representing a source code origin."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:7376 guix-git/doc/guix.texi:26552
- #, no-wrap
- msgid "uri"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7381
- msgid "An object containing the URI of the source. The object type depends on the @code{method} (see below). For example, when using the @var{url-fetch} method of @code{(guix download)}, the valid @code{uri} values are: a URL represented as a string, or a list thereof."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:7382
- #, no-wrap
- msgid "fixed-output derivations, for download"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:7383
- #, no-wrap
- msgid "method"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7390
- msgid "A monadic procedure that handles the given URI@. The procedure must accept at least three arguments: the value of the @code{uri} field and the hash algorithm and hash value specified by the @code{hash} field. It must return a store item or a derivation in the store monad (@pxref{The Store Monad}); most methods return a fixed-output derivation (@pxref{Derivations})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7394
- msgid "Commonly used methods include @code{url-fetch}, which fetches data from a URL, and @code{git-fetch}, which fetches data from a Git repository (see below)."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:7395
- #, no-wrap
- msgid "sha256"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7399
- msgid "A bytevector containing the SHA-256 hash of the source. This is equivalent to providing a @code{content-hash} SHA256 object in the @code{hash} field described below."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:7400
- #, no-wrap
- msgid "hash"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7403
- msgid "The @code{content-hash} object of the source---see below for how to use @code{content-hash}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7407
- msgid "You can obtain this information using @code{guix download} (@pxref{Invoking guix download}) or @code{guix hash} (@pxref{Invoking guix hash})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7408
- #, no-wrap
- msgid "@code{file-name} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7414
- msgid "The file name under which the source code should be saved. When this is @code{#f}, a sensible default value will be used in most cases. In case the source is fetched from a URL, the file name from the URL will be used. For version control checkouts, it is recommended to provide the file name explicitly because the default is not very descriptive."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7415
- #, no-wrap
- msgid "@code{patches} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7418
- msgid "A list of file names, origins, or file-like objects (@pxref{G-Expressions, file-like objects}) pointing to patches to be applied to the source."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7422
- msgid "This list of patches must be unconditional. In particular, it cannot depend on the value of @code{%current-system} or @code{%current-target-system}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7423
- #, no-wrap
- msgid "@code{snippet} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7427
- msgid "A G-expression (@pxref{G-Expressions}) or S-expression that will be run in the source directory. This is a convenient way to modify the source, sometimes more convenient than a patch."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7428
- #, no-wrap
- msgid "@code{patch-flags} (default: @code{'(\"-p1\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7431
- msgid "A list of command-line flags that should be passed to the @code{patch} command."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7432
- #, no-wrap
- msgid "@code{patch-inputs} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7436
- msgid "Input packages or derivations to the patching process. When this is @code{#f}, the usual set of inputs necessary for patching are provided, such as GNU@tie{}Patch."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7437 guix-git/doc/guix.texi:26425
- #, no-wrap
- msgid "@code{modules} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7440
- msgid "A list of Guile modules that should be loaded during the patching process and while running the code in the @code{snippet} field."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7441
- #, no-wrap
- msgid "@code{patch-guile} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7444
- msgid "The Guile package that should be used in the patching process. When this is @code{#f}, a sensible default is used."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:7447
- #, no-wrap
- msgid "{Data Type} content-hash @var{value} [@var{algorithm}]"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:7451
- msgid "Construct a content hash object for the given @var{algorithm}, and with @var{value} as its hash value. When @var{algorithm} is omitted, assume it is @code{sha256}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:7454
- msgid "@var{value} can be a literal string, in which case it is base32-decoded, or it can be a bytevector."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:7456
- msgid "The following forms are all equivalent:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7465
- #, no-wrap
- msgid ""
- "(content-hash \"05zxkyz9bv3j9h0xyid1rhvh3klhsmrpkf3bcs6frvlgyr2gwilj\")\n"
- "(content-hash \"05zxkyz9bv3j9h0xyid1rhvh3klhsmrpkf3bcs6frvlgyr2gwilj\"\n"
- " sha256)\n"
- "(content-hash (base32\n"
- " \"05zxkyz9bv3j9h0xyid1rhvh3klhsmrpkf3bcs6frvlgyr2gwilj\"))\n"
- "(content-hash (base64 \"kkb+RPaP7uyMZmu4eXPVkM4BN8yhRd8BTHLslb6f/Rc=\")\n"
- " sha256)\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:7470
- msgid "Technically, @code{content-hash} is currently implemented as a macro. It performs sanity checks at macro-expansion time, when possible, such as ensuring that @var{value} has the right size for @var{algorithm}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7476
- msgid "As we have seen above, how exactly the data an origin refers to is retrieved is determined by its @code{method} field. The @code{(guix download)} module provides the most common method, @code{url-fetch}, described below."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7477
- #, no-wrap
- msgid "{Scheme Procedure} url-fetch @var{url} @var{hash-algo} @var{hash} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7485
- msgid "[name] [#:executable? #f] Return a fixed-output derivation that fetches data from @var{url} (a string, or a list of strings denoting alternate URLs), which is expected to have hash @var{hash} of type @var{hash-algo} (a symbol). By default, the file name is the base name of URL; optionally, @var{name} can specify a different file name. When @var{executable?} is true, make the downloaded file executable."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7488
- msgid "When one of the URL starts with @code{mirror://}, then its host part is interpreted as the name of a mirror scheme, taken from @file{%mirror-file}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7491
- msgid "Alternatively, when URL starts with @code{file://}, return the corresponding file name in the store."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7497
- msgid "Likewise, the @code{(guix git-download)} module defines the @code{git-fetch} origin method, which fetches data from a Git version control repository, and the @code{git-reference} data type to describe the repository and revision to fetch."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7498
- #, no-wrap
- msgid "{Scheme Procedure} git-fetch @var{ref} @var{hash-algo} @var{hash}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7503
- msgid "Return a fixed-output derivation that fetches @var{ref}, a @code{<git-reference>} object. The output is expected to have recursive hash @var{hash} of type @var{hash-algo} (a symbol). Use @var{name} as the file name, or a generic name if @code{#f}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:7505
- #, no-wrap
- msgid "{Data Type} git-reference"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:7508
- msgid "This data type represents a Git reference for @code{git-fetch} to retrieve."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:7510 guix-git/doc/guix.texi:24186
- #, no-wrap
- msgid "url"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7512
- msgid "The URL of the Git repository to clone."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:7513
- #, no-wrap
- msgid "commit"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7518
- msgid "This string denotes either the commit to fetch (a hexadecimal string), or the tag to fetch. You can also use a ``short'' commit ID or a @command{git describe} style identifier such as @code{v1.0.1-10-g58d7909c97}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7519
- #, no-wrap
- msgid "@code{recursive?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7521
- msgid "This Boolean indicates whether to recursively fetch Git sub-modules."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:7525
- msgid "The example below denotes the @code{v2.10} tag of the GNU@tie{}Hello repository:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7530
- #, no-wrap
- msgid ""
- "(git-reference\n"
- " (url \"https://git.savannah.gnu.org/git/hello.git\")\n"
- " (commit \"v2.10\"))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:7534
- msgid "This is equivalent to the reference below, which explicitly names the commit:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7539
- #, no-wrap
- msgid ""
- "(git-reference\n"
- " (url \"https://git.savannah.gnu.org/git/hello.git\")\n"
- " (commit \"dc7dc56a00e48fe6f231a58f6537139fe2908fb9\"))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7545
- msgid "For Mercurial repositories, the module @code{(guix hg-download)} defines the @code{hg-fetch} origin method and @code{hg-reference} data type for support of the Mercurial version control system."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7546
- #, no-wrap
- msgid "{Scheme Procedure} hg-fetch @var{ref} @var{hash-algo} @var{hash} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7552
- msgid "[name] Return a fixed-output derivation that fetches @var{ref}, a @code{<hg-reference>} object. The output is expected to have recursive hash @var{hash} of type @var{hash-algo} (a symbol). Use @var{name} as the file name, or a generic name if @code{#false}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:7557
- #, no-wrap
- msgid "customizing packages"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:7558
- #, no-wrap
- msgid "variants, of packages"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7568
- msgid "One of the nice things with Guix is that, given a package definition, you can easily @emph{derive} variants of that package---for a different upstream version, with different dependencies, different compilation options, and so on. Some of these custom packages can be defined straight from the command line (@pxref{Package Transformation Options}). This section describes how to define package variants in code. This can be useful in ``manifests'' (@pxref{profile-manifest, @option{--manifest}}) and in your own package collection (@pxref{Creating a Channel}), among others!"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:7569
- #, no-wrap
- msgid "inherit, for package definitions"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7576
- msgid "As discussed earlier, packages are first-class objects in the Scheme language. The @code{(guix packages)} module provides the @code{package} construct to define new package objects (@pxref{package Reference}). The easiest way to define a package variant is using the @code{inherit} keyword together with @code{package}. This allows you to inherit from a package definition while overriding the fields you want."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7581
- msgid "For example, given the @code{hello} variable, which contains a definition for the current version of GNU@tie{}Hello, here's how you would define a variant for version 2.2 (released in 2006, it's vintage!):"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7584
- #, no-wrap
- msgid ""
- "(use-modules (gnu packages base)) ;for 'hello'\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7596
- #, no-wrap
- msgid ""
- "(define hello-2.2\n"
- " (package\n"
- " (inherit hello)\n"
- " (version \"2.2\")\n"
- " (source (origin\n"
- " (method url-fetch)\n"
- " (uri (string-append \"mirror://gnu/hello/hello-\" version\n"
- " \".tar.gz\"))\n"
- " (sha256\n"
- " (base32\n"
- " \"0lappv4slgb5spyqbh6yl5r013zv72yqg2pcl30mginf3wdqd8k9\"))))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7605
- msgid "The example above corresponds to what the @option{--with-source} package transformation option does. Essentially @code{hello-2.2} preserves all the fields of @code{hello}, except @code{version} and @code{source}, which it overrides. Note that the original @code{hello} variable is still there, in the @code{(gnu packages base)} module, unchanged. When you define a custom package like this, you are really @emph{adding} a new package definition; the original one remains available."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7611
- msgid "You can just as well define variants with a different set of dependencies than the original package. For example, the default @code{gdb} package depends on @code{guile}, but since that is an optional dependency, you can define a variant that removes that dependency like so:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7614
- #, no-wrap
- msgid ""
- "(use-modules (gnu packages gdb)) ;for 'gdb'\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7620
- #, no-wrap
- msgid ""
- "(define gdb-sans-guile\n"
- " (package\n"
- " (inherit gdb)\n"
- " (inputs (modify-inputs (package-inputs gdb)\n"
- " (delete \"guile\")))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7626
- msgid "The @code{modify-inputs} form above removes the @code{\"guile\"} package from the @code{inputs} field of @code{gdb}. The @code{modify-inputs} macro is a helper that can prove useful anytime you want to remove, add, or replace package inputs."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7627
- #, no-wrap
- msgid "{Scheme Syntax} modify-inputs @var{inputs} @var{clauses}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7631
- msgid "Modify the given package inputs, as returned by @code{package-inputs} & co., according to the given clauses. Each clause must have one of the following forms:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7633
- #, no-wrap
- msgid "(delete @var{name}@dots{})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7635
- msgid "Delete from the inputs packages with the given @var{name}s (strings)."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7636
- #, no-wrap
- msgid "(append @var{package}@dots{})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7638
- msgid "Add @var{package}s to the end of the input list."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7639
- #, no-wrap
- msgid "(prepend @var{package}@dots{})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7641
- msgid "Add @var{package}s to the front of the input list."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7645
- msgid "The example below removes the GMP and ACL inputs of Coreutils and adds libcap to the back of the input list:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7650
- #, no-wrap
- msgid ""
- "(modify-inputs (package-inputs coreutils)\n"
- " (delete \"gmp\" \"acl\")\n"
- " (append libcap))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7654
- msgid "The example below replaces the @code{guile} package from the inputs of @code{guile-redis} with @code{guile-2.2}:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7658
- #, no-wrap
- msgid ""
- "(modify-inputs (package-inputs guile-redis)\n"
- " (replace \"guile\" guile-2.2))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7662
- msgid "The last type of clause is @code{prepend}, to add inputs to the front of the list."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7671
- msgid "In some cases, you may find it useful to write functions (``procedures'', in Scheme parlance) that return a package based on some parameters. For example, consider the @code{luasocket} library for the Lua programming language. We want to create @code{luasocket} packages for major versions of Lua. One way to do that is to define a procedure that takes a Lua package and returns a @code{luasocket} package that depends on it:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7681
- #, no-wrap
- msgid ""
- "(define (make-lua-socket name lua)\n"
- " ;; Return a luasocket package built with LUA.\n"
- " (package\n"
- " (name name)\n"
- " (version \"3.0\")\n"
- " ;; several fields omitted\n"
- " (inputs (list lua))\n"
- " (synopsis \"Socket library for Lua\")))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7684
- #, no-wrap
- msgid ""
- "(define-public lua5.1-socket\n"
- " (make-lua-socket \"lua5.1-socket\" lua-5.1))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7687
- #, no-wrap
- msgid ""
- "(define-public lua5.2-socket\n"
- " (make-lua-socket \"lua5.2-socket\" lua-5.2))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7695
- msgid "Here we have defined packages @code{lua5.1-socket} and @code{lua5.2-socket} by calling @code{make-lua-socket} with different arguments. @xref{Procedures,,, guile, GNU Guile Reference Manual}, for more info on procedures. Having top-level public definitions for these two packages means that they can be referred to from the command line (@pxref{Package Modules})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:7696
- #, no-wrap
- msgid "package transformations"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7701
- msgid "These are pretty simple package variants. As a convenience, the @code{(guix transformations)} module provides a high-level interface that directly maps to the more sophisticated package transformation options (@pxref{Package Transformation Options}):"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7702
- #, no-wrap
- msgid "{Scheme Procedure} options->transformation @var{opts}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7706
- msgid "Return a procedure that, when passed an object to build (package, derivation, etc.), applies the transformations specified by @var{opts} and returns the resulting objects. @var{opts} must be a list of symbol/string pairs such as:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7710
- #, no-wrap
- msgid ""
- "((with-branch . \"guile-gcrypt=master\")\n"
- " (without-tests . \"libgcrypt\"))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7714
- msgid "Each symbol names a transformation and the corresponding string is an argument to that transformation."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7717
- msgid "For instance, a manifest equivalent to this command:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:7722
- #, no-wrap
- msgid ""
- "guix build guix \\\n"
- " --with-branch=guile-gcrypt=master \\\n"
- " --with-debug-info=zlib\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7726
- msgid "... would look like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7729
- #, no-wrap
- msgid ""
- "(use-modules (guix transformations))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7735
- #, no-wrap
- msgid ""
- "(define transform\n"
- " ;; The package transformation procedure.\n"
- " (options->transformation\n"
- " '((with-branch . \"guile-gcrypt=master\")\n"
- " (with-debug-info . \"zlib\"))))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7738
- #, no-wrap
- msgid ""
- "(packages->manifest\n"
- " (list (transform (specification->package \"guix\"))))\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:7740
- #, no-wrap
- msgid "input rewriting"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:7741
- #, no-wrap
- msgid "dependency graph rewriting"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7748
- msgid "The @code{options->transformation} procedure is convenient, but it's perhaps also not as flexible as you may like. How is it implemented? The astute reader probably noticed that most package transformation options go beyond the superficial changes shown in the first examples of this section: they involve @dfn{input rewriting}, whereby the dependency graph of a package is rewritten by replacing specific inputs by others."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7752
- msgid "Dependency graph rewriting, for the purposes of swapping packages in the graph, is what the @code{package-input-rewriting} procedure in @code{(guix packages)} implements."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7753
- #, no-wrap
- msgid "{Scheme Procedure} package-input-rewriting @var{replacements} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7760
- msgid "[@var{rewrite-name}] [#:deep? #t] Return a procedure that, when passed a package, replaces its direct and indirect dependencies, including implicit inputs when @var{deep?} is true, according to @var{replacements}. @var{replacements} is a list of package pairs; the first element of each pair is the package to replace, and the second one is the replacement."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7763
- msgid "Optionally, @var{rewrite-name} is a one-argument procedure that takes the name of a package and returns its new name after rewrite."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7767 guix-git/doc/guix.texi:11216
- msgid "Consider this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7773
- #, no-wrap
- msgid ""
- "(define libressl-instead-of-openssl\n"
- " ;; This is a procedure to replace OPENSSL by LIBRESSL,\n"
- " ;; recursively.\n"
- " (package-input-rewriting `((,openssl . ,libressl))))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7776
- #, no-wrap
- msgid ""
- "(define git-with-libressl\n"
- " (libressl-instead-of-openssl git))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7784
- msgid "Here we first define a rewriting procedure that replaces @var{openssl} with @var{libressl}. Then we use it to define a @dfn{variant} of the @var{git} package that uses @var{libressl} instead of @var{openssl}. This is exactly what the @option{--with-input} command-line option does (@pxref{Package Transformation Options, @option{--with-input}})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7787
- msgid "The following variant of @code{package-input-rewriting} can match packages to be replaced by name rather than by identity."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7788
- #, no-wrap
- msgid "{Scheme Procedure} package-input-rewriting/spec @var{replacements} [#:deep? #t]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7795
- msgid "Return a procedure that, given a package, applies the given @var{replacements} to all the package graph, including implicit inputs unless @var{deep?} is false. @var{replacements} is a list of spec/procedures pair; each spec is a package specification such as @code{\"gcc\"} or @code{\"guile@@2\"}, and each procedure takes a matching package and returns a replacement for that package."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7798
- msgid "The example above could be rewritten this way:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:7803
- #, no-wrap
- msgid ""
- "(define libressl-instead-of-openssl\n"
- " ;; Replace all the packages called \"openssl\" with LibreSSL.\n"
- " (package-input-rewriting/spec `((\"openssl\" . ,(const libressl)))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7808
- msgid "The key difference here is that, this time, packages are matched by spec and not by identity. In other words, any package in the graph that is called @code{openssl} will be replaced."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7812
- msgid "A more generic procedure to rewrite a package dependency graph is @code{package-mapping}: it supports arbitrary changes to nodes in the graph."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7813
- #, no-wrap
- msgid "{Scheme Procedure} package-mapping @var{proc} [@var{cut?}] [#:deep? #f]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:7818
- msgid "Return a procedure that, given a package, applies @var{proc} to all the packages depended on and returns the resulting package. The procedure stops recursion when @var{cut?} returns true for a given package. When @var{deep?} is true, @var{proc} is applied to implicit inputs as well."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:7824
- #, no-wrap
- msgid "build system"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7829
- msgid "Each package definition specifies a @dfn{build system} and arguments for that build system (@pxref{Defining Packages}). This @code{build-system} field represents the build procedure of the package, as well as implicit dependencies of that build procedure."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7833
- msgid "Build systems are @code{<build-system>} objects. The interface to create and manipulate them is provided by the @code{(guix build-system)} module, and actual build systems are exported by specific modules."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:7834
- #, no-wrap
- msgid "bag (low-level package representation)"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7844
- msgid "Under the hood, build systems first compile package objects to @dfn{bags}. A @dfn{bag} is like a package, but with less ornamentation---in other words, a bag is a lower-level representation of a package, which includes all the inputs of that package, including some that were implicitly added by the build system. This intermediate representation is then compiled to a derivation (@pxref{Derivations}). The @code{package-with-c-toolchain} is an example of a way to change the implicit inputs that a package's build system pulls in (@pxref{package Reference, @code{package-with-c-toolchain}})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7852
- msgid "Build systems accept an optional list of @dfn{arguments}. In package definitions, these are passed @i{via} the @code{arguments} field (@pxref{Defining Packages}). They are typically keyword arguments (@pxref{Optional Arguments, keyword arguments in Guile,, guile, GNU Guile Reference Manual}). The value of these arguments is usually evaluated in the @dfn{build stratum}---i.e., by a Guile process launched by the daemon (@pxref{Derivations})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7856
- msgid "The main build system is @code{gnu-build-system}, which implements the standard build procedure for GNU and many other packages. It is provided by the @code{(guix build-system gnu)} module."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:7857
- #, no-wrap
- msgid "{Scheme Variable} gnu-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:7861
- msgid "@code{gnu-build-system} represents the GNU Build System, and variants thereof (@pxref{Configuration, configuration and makefile conventions,, standards, GNU Coding Standards})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:7862 guix-git/doc/guix.texi:8812
- #: guix-git/doc/guix.texi:9294
- #, no-wrap
- msgid "build phases"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:7869
- msgid "In a nutshell, packages using it are configured, built, and installed with the usual @code{./configure && make && make check && make install} command sequence. In practice, a few additional steps are often needed. All these steps are split up in separate @dfn{phases}. @xref{Build Phases}, for more info on build phases and ways to customize them."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:7876
- msgid "In addition, this build system ensures that the ``standard'' environment for GNU packages is available. This includes tools such as GCC, libc, Coreutils, Bash, Make, Diffutils, grep, and sed (see the @code{(guix build-system gnu)} module for a complete list). We call these the @dfn{implicit inputs} of a package, because package definitions do not have to mention them."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:7880
- msgid "This build system supports a number of keyword arguments, which can be passed @i{via} the @code{arguments} field of a package. Here are some of the main parameters:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7882
- #, no-wrap
- msgid "#:phases"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7885
- msgid "This argument specifies build-side code that evaluates to an alist of build phases. @xref{Build Phases}, for more information."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7886
- #, no-wrap
- msgid "#:configure-flags"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7889
- msgid "This is a list of flags (strings) passed to the @command{configure} script. @xref{Defining Packages}, for an example."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7890
- #, no-wrap
- msgid "#:make-flags"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7894
- msgid "This list of strings contains flags passed as arguments to @command{make} invocations in the @code{build}, @code{check}, and @code{install} phases."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7895
- #, no-wrap
- msgid "#:out-of-source?"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7898
- msgid "This Boolean, @code{#f} by default, indicates whether to run builds in a build directory separate from the source tree."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7903
- msgid "When it is true, the @code{configure} phase creates a separate build directory, changes to that directory, and runs the @code{configure} script from there. This is useful for packages that require it, such as @code{glibc}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7904
- #, no-wrap
- msgid "#:tests?"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7907
- msgid "This Boolean, @code{#t} by default, indicates whether the @code{check} phase should run the package's test suite."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7908
- #, no-wrap
- msgid "#:test-target"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7911
- msgid "This string, @code{\"check\"} by default, gives the name of the makefile target used by the @code{check} phase."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7912
- #, no-wrap
- msgid "#:parallel-build?"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:7913
- #, no-wrap
- msgid "#:parallel-tests?"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7920
- msgid "These Boolean values specify whether to build, respectively run the test suite, in parallel, with the @code{-j} flag of @command{make}. When they are true, @code{make} is passed @code{-j@var{n}}, where @var{n} is the number specified as the @option{--cores} option of @command{guix-daemon} or that of the @command{guix} client command (@pxref{Common Build Options, @option{--cores}})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:7921
- #, no-wrap
- msgid "RUNPATH, validation"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7922
- #, no-wrap
- msgid "#:validate-runpath?"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7926
- msgid "This Boolean, @code{#t} by default, determines whether to ``validate'' the @code{RUNPATH} of ELF binaries (@code{.so} shared libraries as well as executables) previously installed by the @code{install} phase."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7934
- msgid "This validation step consists in making sure that all the shared libraries needed by an ELF binary, which are listed as @code{DT_NEEDED} entries in its @code{PT_DYNAMIC} segment, appear in the @code{DT_RUNPATH} entry of that binary. In other words, it ensures that running or using those binaries will not result in a ``file not found'' error at run time. @xref{Options, @option{-rpath},, ld, The GNU Linker}, for more information on @code{RUNPATH}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7935
- #, no-wrap
- msgid "#:substitutable?"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7939
- msgid "This Boolean, @code{#t} by default, tells whether the package outputs should be substitutable---i.e., whether users should be able to obtain substitutes for them instead of building locally (@pxref{Substitutes})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:7940
- #, no-wrap
- msgid "#:allowed-references"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:7941
- #, no-wrap
- msgid "#:disallowed-references"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7946
- msgid "When true, these arguments must be a list of dependencies that must not appear among the references of the build results. If, upon build completion, some of these references are retained, the build process fails."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:7951
- msgid "This is useful to ensure that a package does not erroneously keep a reference to some of it build-time inputs, in cases where doing so would, for example, unnecessarily increase its size (@pxref{Invoking guix size})."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:7954
- msgid "Most other build systems support these keyword arguments."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:7961
- msgid "Other @code{<build-system>} objects are defined to support other conventions and tools used by free software packages. They inherit most of @code{gnu-build-system}, and differ mainly in the set of inputs implicitly added to the build process, and in the list of phases executed. Some of these build systems are listed below."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:7962
- #, no-wrap
- msgid "{Scheme Variable} ant-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:7966
- msgid "This variable is exported by @code{(guix build-system ant)}. It implements the build procedure for Java packages that can be built with @url{https://ant.apache.org/, Ant build tool}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:7971
- msgid "It adds both @code{ant} and the @dfn{Java Development Kit} (JDK) as provided by the @code{icedtea} package to the set of inputs. Different packages can be specified with the @code{#:ant} and @code{#:jdk} parameters, respectively."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:7977
- msgid "When the original package does not provide a suitable Ant build file, the parameter @code{#:jar-name} can be used to generate a minimal Ant build file @file{build.xml} with tasks to build the specified jar archive. In this case the parameter @code{#:source-dir} can be used to specify the source sub-directory, defaulting to ``src''."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:7985
- msgid "The @code{#:main-class} parameter can be used with the minimal ant buildfile to specify the main class of the resulting jar. This makes the jar file executable. The @code{#:test-include} parameter can be used to specify the list of junit tests to run. It defaults to @code{(list \"**/*Test.java\")}. The @code{#:test-exclude} can be used to disable some tests. It defaults to @code{(list \"**/Abstract*.java\")}, because abstract classes cannot be run as tests."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:7989
- msgid "The parameter @code{#:build-target} can be used to specify the Ant task that should be run during the @code{build} phase. By default the ``jar'' task will be run."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:7992
- #, no-wrap
- msgid "{Scheme Variable} android-ndk-build-system"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:7993
- #, no-wrap
- msgid "Android distribution"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:7994
- #, no-wrap
- msgid "Android NDK build system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:7998
- msgid "This variable is exported by @code{(guix build-system android-ndk)}. It implements a build procedure for Android NDK (native development kit) packages using a Guix-specific build process."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8002
- msgid "The build system assumes that packages install their public interface (header) files to the subdirectory @file{include} of the @code{out} output and their libraries to the subdirectory @file{lib} the @code{out} output."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8005
- msgid "It's also assumed that the union of all the dependencies of a package has no conflicting files."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8008
- msgid "For the time being, cross-compilation is not supported - so right now the libraries and header files are assumed to be host tools."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8011
- #, no-wrap
- msgid "{Scheme Variable} asdf-build-system/source"
- msgstr ""
- #. type: defvrx
- #: guix-git/doc/guix.texi:8012
- #, no-wrap
- msgid "{Scheme Variable} asdf-build-system/sbcl"
- msgstr ""
- #. type: defvrx
- #: guix-git/doc/guix.texi:8013
- #, no-wrap
- msgid "{Scheme Variable} asdf-build-system/ecl"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8019
- msgid "These variables, exported by @code{(guix build-system asdf)}, implement build procedures for Common Lisp packages using @url{https://common-lisp.net/project/asdf/, ``ASDF''}. ASDF is a system definition facility for Common Lisp programs and libraries."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8026
- msgid "The @code{asdf-build-system/source} system installs the packages in source form, and can be loaded using any common lisp implementation, via ASDF@. The others, such as @code{asdf-build-system/sbcl}, install binary systems in the format which a particular implementation understands. These build systems can also be used to produce executable programs, or lisp images which contain a set of packages pre-loaded."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8030
- msgid "The build system uses naming conventions. For binary packages, the package name should be prefixed with the lisp implementation, such as @code{sbcl-} for @code{asdf-build-system/sbcl}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8034
- msgid "Additionally, the corresponding source package should be labeled using the same convention as python packages (see @ref{Python Modules}), using the @code{cl-} prefix."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8042
- msgid "In order to create executable programs and images, the build-side procedures @code{build-program} and @code{build-image} can be used. They should be called in a build phase after the @code{create-asdf-configuration} phase, so that the system which was just built can be used within the resulting image. @code{build-program} requires a list of Common Lisp expressions to be passed as the @code{#:entry-program} argument."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8051
- msgid "By default, all the @file{.asd} files present in the sources are read to find system definitions. The @code{#:asd-files} parameter can be used to specify the list of @file{.asd} files to read. Furthermore, if the package defines a system for its tests in a separate file, it will be loaded before the tests are run if it is specified by the @code{#:test-asd-file} parameter. If it is not set, the files @code{<system>-tests.asd}, @code{<system>-test.asd}, @code{tests.asd}, and @code{test.asd} will be tried if they exist."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8056
- msgid "If for some reason the package must be named in a different way than the naming conventions suggest, or if several systems must be compiled, the @code{#:asd-systems} parameter can be used to specify the list of system names."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8059
- #, no-wrap
- msgid "{Scheme Variable} cargo-build-system"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:8060
- #, no-wrap
- msgid "Rust programming language"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:8061
- #, no-wrap
- msgid "Cargo (Rust build system)"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8065
- msgid "This variable is exported by @code{(guix build-system cargo)}. It supports builds of packages using Cargo, the build tool of the @uref{https://www.rust-lang.org, Rust programming language}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8068
- msgid "It adds @code{rustc} and @code{cargo} to the set of inputs. A different Rust package can be specified with the @code{#:rust} parameter."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8078
- msgid "Regular cargo dependencies should be added to the package definition similarly to other packages; those needed only at build time to native-inputs, others to inputs. If you need to add source-only crates then you should add them to via the @code{#:cargo-inputs} parameter as a list of name and spec pairs, where the spec can be a package or a source definition. Note that the spec must evaluate to a path to a gzipped tarball which includes a @code{Cargo.toml} file at its root, or it will be ignored. Similarly, cargo dev-dependencies should be added to the package definition via the @code{#:cargo-development-inputs} parameter."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8088
- msgid "In its @code{configure} phase, this build system will make any source inputs specified in the @code{#:cargo-inputs} and @code{#:cargo-development-inputs} parameters available to cargo. It will also remove an included @code{Cargo.lock} file to be recreated by @code{cargo} during the @code{build} phase. The @code{package} phase will run @code{cargo package} to create a source crate for future use. The @code{install} phase installs the binaries defined by the crate. Unless @code{install-source? #f} is defined it will also install a source crate repository of itself and unpacked sources, to ease in future hacking on rust packages."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8090
- #, no-wrap
- msgid "{Scheme Variable} chicken-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8095
- msgid "This variable is exported by @code{(guix build-system chicken)}. It builds @uref{https://call-cc.org/, CHICKEN Scheme} modules, also called ``eggs'' or ``extensions''. CHICKEN generates C source code, which then gets compiled by a C compiler, in this case GCC."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8098
- msgid "This build system adds @code{chicken} to the package inputs, as well as the packages of @code{gnu-build-system}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8102
- msgid "The build system can't (yet) deduce the egg's name automatically, so just like with @code{go-build-system} and its @code{#:import-path}, you should define @code{#:egg-name} in the package's @code{arguments} field."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8104
- msgid "For example, if you are packaging the @code{srfi-1} egg:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:8107
- #, no-wrap
- msgid "(arguments '(#:egg-name \"srfi-1\"))\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8112
- msgid "Egg dependencies must be defined in @code{propagated-inputs}, not @code{inputs} because CHICKEN doesn't embed absolute references in compiled eggs. Test dependencies should go to @code{native-inputs}, as usual."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8114
- #, no-wrap
- msgid "{Scheme Variable} copy-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8118
- msgid "This variable is exported by @code{(guix build-system copy)}. It supports builds of simple packages that don't require much compiling, mostly just moving files around."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8123
- msgid "It adds much of the @code{gnu-build-system} packages to the set of inputs. Because of this, the @code{copy-build-system} does not require all the boilerplate code often needed for the @code{trivial-build-system}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8128
- msgid "To further simplify the file installation process, an @code{#:install-plan} argument is exposed to let the packager specify which files go where. The install plan is a list of @code{(@var{source} @var{target} [@var{filters}])}. @var{filters} are optional."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8130
- #, no-wrap
- msgid "When @var{source} matches a file or directory without trailing slash, install it to @var{target}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8132
- #, no-wrap
- msgid "If @var{target} has a trailing slash, install @var{source} basename beneath @var{target}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8133
- #, no-wrap
- msgid "Otherwise install @var{source} as @var{target}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8136
- #, no-wrap
- msgid "When @var{source} is a directory with a trailing slash, or when @var{filters} are used,"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:8139
- msgid "the trailing slash of @var{target} is implied with the same meaning as above."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8140
- #, no-wrap
- msgid "Without @var{filters}, install the full @var{source} @emph{content} to @var{target}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8141
- #, no-wrap
- msgid "With @var{filters} among @code{#:include}, @code{#:include-regexp}, @code{#:exclude},"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:8144
- msgid "@code{#:exclude-regexp}, only select files are installed depending on the filters. Each filters is specified by a list of strings."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8145
- #, no-wrap
- msgid "With @code{#:include}, install all the files which the path suffix matches"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:8147
- msgid "at least one of the elements in the given list."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8147
- #, no-wrap
- msgid "With @code{#:include-regexp}, install all the files which the"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:8150
- msgid "subpaths match at least one of the regular expressions in the given list."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8150
- #, no-wrap
- msgid "The @code{#:exclude} and @code{#:exclude-regexp} filters"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:8155
- msgid "are the complement of their inclusion counterpart. Without @code{#:include} flags, install all files but those matching the exclusion filters. If both inclusions and exclusions are specified, the exclusions are done on top of the inclusions."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:8159
- msgid "In all cases, the paths relative to @var{source} are preserved within @var{target}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8162
- msgid "Examples:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8164
- #, no-wrap
- msgid "@code{(\"foo/bar\" \"share/my-app/\")}: Install @file{bar} to @file{share/my-app/bar}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8165
- #, no-wrap
- msgid "@code{(\"foo/bar\" \"share/my-app/baz\")}: Install @file{bar} to @file{share/my-app/baz}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8166
- #, no-wrap
- msgid "@code{(\"foo/\" \"share/my-app\")}: Install the content of @file{foo} inside @file{share/my-app},"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:8168
- msgid "e.g., install @file{foo/sub/file} to @file{share/my-app/sub/file}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8168
- #, no-wrap
- msgid "@code{(\"foo/\" \"share/my-app\" #:include (\"sub/file\"))}: Install only @file{foo/sub/file} to"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:8170
- msgid "@file{share/my-app/sub/file}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8170
- #, no-wrap
- msgid "@code{(\"foo/sub\" \"share/my-app\" #:include (\"file\"))}: Install @file{foo/sub/file} to"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:8172
- msgid "@file{share/my-app/file}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:8176
- #, no-wrap
- msgid "Clojure (programming language)"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:8177
- #, no-wrap
- msgid "simple Clojure build system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8178
- #, no-wrap
- msgid "{Scheme Variable} clojure-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8183
- msgid "This variable is exported by @code{(guix build-system clojure)}. It implements a simple build procedure for @uref{https://clojure.org/, Clojure} packages using plain old @code{compile} in Clojure. Cross-compilation is not supported yet."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8187
- msgid "It adds @code{clojure}, @code{icedtea} and @code{zip} to the set of inputs. Different packages can be specified with the @code{#:clojure}, @code{#:jdk} and @code{#:zip} parameters, respectively."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8193
- msgid "A list of source directories, test directories and jar names can be specified with the @code{#:source-dirs}, @code{#:test-dirs} and @code{#:jar-names} parameters, respectively. Compile directory and main class can be specified with the @code{#:compile-dir} and @code{#:main-class} parameters, respectively. Other parameters are documented below."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8196
- msgid "This build system is an extension of @code{ant-build-system}, but with the following phases changed:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8199 guix-git/doc/guix.texi:8773
- #: guix-git/doc/guix.texi:8822 guix-git/doc/guix.texi:8891
- #: guix-git/doc/guix.texi:35042 guix-git/doc/guix.texi:37668
- #, no-wrap
- msgid "build"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8208
- msgid "This phase calls @code{compile} in Clojure to compile source files and runs @command{jar} to create jars from both source files and compiled files according to the include list and exclude list specified in @code{#:aot-include} and @code{#:aot-exclude}, respectively. The exclude list has priority over the include list. These lists consist of symbols representing Clojure libraries or the special keyword @code{#:all} representing all Clojure libraries found under the source directories. The parameter @code{#:omit-source?} decides if source should be included into the jars."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8209 guix-git/doc/guix.texi:8777
- #: guix-git/doc/guix.texi:8896
- #, no-wrap
- msgid "check"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8216
- msgid "This phase runs tests according to the include list and exclude list specified in @code{#:test-include} and @code{#:test-exclude}, respectively. Their meanings are analogous to that of @code{#:aot-include} and @code{#:aot-exclude}, except that the special keyword @code{#:all} now stands for all Clojure libraries found under the test directories. The parameter @code{#:tests?} decides if tests should be run."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8217 guix-git/doc/guix.texi:8783
- #: guix-git/doc/guix.texi:8826 guix-git/doc/guix.texi:8902
- #, no-wrap
- msgid "install"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8219
- msgid "This phase installs all jars built previously."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8222
- msgid "Apart from the above, this build system also contains an additional phase:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8225
- #, no-wrap
- msgid "install-doc"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8230
- msgid "This phase installs all top-level files with base name matching @code{%doc-regex}. A different regex can be specified with the @code{#:doc-regex} parameter. All files (recursively) inside the documentation directories specified in @code{#:doc-dirs} are installed as well."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8233
- #, no-wrap
- msgid "{Scheme Variable} cmake-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8237
- msgid "This variable is exported by @code{(guix build-system cmake)}. It implements the build procedure for packages using the @url{https://www.cmake.org, CMake build tool}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8241
- msgid "It automatically adds the @code{cmake} package to the set of inputs. Which package is used can be specified with the @code{#:cmake} parameter."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8248
- msgid "The @code{#:configure-flags} parameter is taken as a list of flags passed to the @command{cmake} command. The @code{#:build-type} parameter specifies in abstract terms the flags passed to the compiler; it defaults to @code{\"RelWithDebInfo\"} (short for ``release mode with debugging information''), which roughly means that code is compiled with @code{-O2 -g}, as is the case for Autoconf-based packages by default."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8250
- #, no-wrap
- msgid "{Scheme Variable} dune-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8257
- msgid "This variable is exported by @code{(guix build-system dune)}. It supports builds of packages using @uref{https://dune.build/, Dune}, a build tool for the OCaml programming language. It is implemented as an extension of the @code{ocaml-build-system} which is described below. As such, the @code{#:ocaml} and @code{#:findlib} parameters can be passed to this build system."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8261
- msgid "It automatically adds the @code{dune} package to the set of inputs. Which package is used can be specified with the @code{#:dune} parameter."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8265
- msgid "There is no @code{configure} phase because dune packages typically don't need to be configured. The @code{#:build-flags} parameter is taken as a list of flags passed to the @code{dune} command during the build."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8269
- msgid "The @code{#:jbuild?} parameter can be passed to use the @code{jbuild} command instead of the more recent @code{dune} command while building a package. Its default value is @code{#f}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8274
- msgid "The @code{#:package} parameter can be passed to specify a package name, which is useful when a package contains multiple packages and you want to build only one of them. This is equivalent to passing the @code{-p} argument to @code{dune}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8277
- #, no-wrap
- msgid "{Scheme Variable} go-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8282
- msgid "This variable is exported by @code{(guix build-system go)}. It implements a build procedure for Go packages using the standard @url{https://golang.org/cmd/go/#hdr-Compile_packages_and_dependencies, Go build mechanisms}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8293
- msgid "The user is expected to provide a value for the key @code{#:import-path} and, in some cases, @code{#:unpack-path}. The @url{https://golang.org/doc/code.html#ImportPaths, import path} corresponds to the file system path expected by the package's build scripts and any referring packages, and provides a unique way to refer to a Go package. It is typically based on a combination of the package source code's remote URI and file system hierarchy structure. In some cases, you will need to unpack the package's source code to a different directory structure than the one indicated by the import path, and @code{#:unpack-path} should be used in such cases."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8298
- msgid "Packages that provide Go libraries should install their source code into the built output. The key @code{#:install-source?}, which defaults to @code{#t}, controls whether or not the source code is installed. It can be set to @code{#f} for packages that only provide executable files."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8305
- msgid "Packages can be cross-built, and if a specific architecture or operating system is desired then the keywords @code{#:goarch} and @code{#:goos} can be used to force the package to be built for that architecture and operating system. The combinations known to Go can be found @url{\"https://golang.org/doc/install/source#environment\", in their documentation}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8307
- #, no-wrap
- msgid "{Scheme Variable} glib-or-gtk-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8310
- msgid "This variable is exported by @code{(guix build-system glib-or-gtk)}. It is intended for use with packages making use of GLib or GTK+."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8313
- msgid "This build system adds the following two phases to the ones defined by @code{gnu-build-system}:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8315 guix-git/doc/guix.texi:8799
- #, no-wrap
- msgid "glib-or-gtk-wrap"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8322
- msgid "The phase @code{glib-or-gtk-wrap} ensures that programs in @file{bin/} are able to find GLib ``schemas'' and @uref{https://developer.gnome.org/gtk3/stable/gtk-running.html, GTK+ modules}. This is achieved by wrapping the programs in launch scripts that appropriately set the @env{XDG_DATA_DIRS} and @env{GTK_PATH} environment variables."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8329
- msgid "It is possible to exclude specific package outputs from that wrapping process by listing their names in the @code{#:glib-or-gtk-wrap-excluded-outputs} parameter. This is useful when an output is known not to contain any GLib or GTK+ binaries, and where wrapping would gratuitously add a dependency of that output on GLib and GTK+."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8330 guix-git/doc/guix.texi:8803
- #, no-wrap
- msgid "glib-or-gtk-compile-schemas"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8338
- msgid "The phase @code{glib-or-gtk-compile-schemas} makes sure that all @uref{https://developer.gnome.org/gio/stable/glib-compile-schemas.html, GSettings schemas} of GLib are compiled. Compilation is performed by the @command{glib-compile-schemas} program. It is provided by the package @code{glib:bin} which is automatically imported by the build system. The @code{glib} package providing @command{glib-compile-schemas} can be specified with the @code{#:glib} parameter."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8341
- msgid "Both phases are executed after the @code{install} phase."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8343
- #, no-wrap
- msgid "{Scheme Variable} guile-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8350
- msgid "This build system is for Guile packages that consist exclusively of Scheme code and that are so lean that they don't even have a makefile, let alone a @file{configure} script. It compiles Scheme code using @command{guild compile} (@pxref{Compilation,,, guile, GNU Guile Reference Manual}) and installs the @file{.scm} and @file{.go} files in the right place. It also installs documentation."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8353
- msgid "This build system supports cross-compilation by using the @option{--target} option of @samp{guild compile}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8356
- msgid "Packages built with @code{guile-build-system} must provide a Guile package in their @code{native-inputs} field."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8358
- #, no-wrap
- msgid "{Scheme Variable} julia-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8365
- msgid "This variable is exported by @code{(guix build-system julia)}. It implements the build procedure used by @uref{https://julialang.org/, julia} packages, which essentially is similar to running @samp{julia -e 'using Pkg; Pkg.add(package)'} in an environment where @env{JULIA_LOAD_PATH} contains the paths to all Julia package inputs. Tests are run by calling @code{/test/runtests.jl}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8369
- msgid "The Julia package name is read from the file @file{Project.toml}. This value can be overridden by passing the argument @code{#:julia-package-name} (which must be correctly capitalized)."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8373
- msgid "Julia packages usually manage their binary dependencies via @code{JLLWrappers.jl}, a Julia package that creates a module (named after the wrapped library followed by @code{_jll.jl}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8378
- msgid "To add the binary path @code{_jll.jl} packages, you need to patch the files under @file{src/wrappers/}, replacing the call to the macro @code{JLLWrappers.@@generate_wrapper_header}, adding as a second argument containing the store path the binary."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8382
- msgid "As an example, in the MbedTLS Julia package, we add a build phase (@pxref{Build Phases}) to insert the absolute file name of the wrapped MbedTLS package:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:8394
- #, no-wrap
- msgid ""
- "(add-after 'unpack 'override-binary-path\n"
- " (lambda* (#:key inputs #:allow-other-keys)\n"
- " (for-each (lambda (wrapper)\n"
- " (substitute* wrapper\n"
- " ((\"generate_wrapper_header.*\")\n"
- " (string-append\n"
- " \"generate_wrapper_header(\\\"MbedTLS\\\", \\\"\"\n"
- " (assoc-ref inputs \"mbedtls-apache\") \"\\\")\\n\"))))\n"
- " ;; There's a Julia file for each platform, override them all.\n"
- " (find-files \"src/wrappers/\" \"\\\\.jl$\"))))\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8402
- msgid "Some older packages that aren't using @file{Package.toml} yet, will require this file to be created, too. The function @code{julia-create-package-toml} helps creating the file. You need to pass the outputs and the source of the package, its name (the same as the @code{file-name} parameter), the package uuid, the package version, and a list of dependencies specified by their name and their uuid."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8404
- #, no-wrap
- msgid "{Scheme Variable} maven-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8411
- msgid "This variable is exported by @code{(guix build-system maven)}. It implements a build procedure for @uref{https://maven.apache.org, Maven} packages. Maven is a dependency and lifecycle management tool for Java. A user of Maven specifies dependencies and plugins in a @file{pom.xml} file that Maven reads. When Maven does not have one of the dependencies or plugins in its repository, it will download them and use them to build the package."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8421
- msgid "The maven build system ensures that maven will not try to download any dependency by running in offline mode. Maven will fail if a dependency is missing. Before running Maven, the @file{pom.xml} (and subprojects) are modified to specify the version of dependencies and plugins that match the versions available in the guix build environment. Dependencies and plugins must be installed in the fake maven repository at @file{lib/m2}, and are symlinked into a proper repository before maven is run. Maven is instructed to use that repository for the build and installs built artifacts there. Changed files are copied to the @file{lib/m2} directory of the package output."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8424
- msgid "You can specify a @file{pom.xml} file with the @code{#:pom-file} argument, or let the build system use the default @file{pom.xml} file in the sources."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8430
- msgid "In case you need to specify a dependency's version manually, you can use the @code{#:local-packages} argument. It takes an association list where the key is the groupId of the package and its value is an association list where the key is the artifactId of the package and its value is the version you want to override in the @file{pom.xml}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8436
- msgid "Some packages use dependencies or plugins that are not useful at runtime nor at build time in Guix. You can alter the @file{pom.xml} file to remove them using the @code{#:exclude} argument. Its value is an association list where the key is the groupId of the plugin or dependency you want to remove, and the value is a list of artifactId you want to remove."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8439
- msgid "You can override the default @code{jdk} and @code{maven} packages with the corresponding argument, @code{#:jdk} and @code{#:maven}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8444
- msgid "The @code{#:maven-plugins} argument is a list of maven plugins used during the build, with the same format as the @code{inputs} fields of the package declaration. Its default value is @code{(default-maven-plugins)} which is also exported."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8446
- #, no-wrap
- msgid "{Scheme Variable} minetest-mod-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8452
- msgid "This variable is exported by @code{(guix build-system minetest)}. It implements a build procedure for @uref{https://www.minetest.net, Minetest} mods, which consists of copying Lua code, images and other resources to the location Minetest searches for mods. The build system also minimises PNG images and verifies that Minetest can load the mod without errors."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8454
- #, no-wrap
- msgid "{Scheme Variable} minify-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8457
- msgid "This variable is exported by @code{(guix build-system minify)}. It implements a minification procedure for simple JavaScript packages."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8463
- msgid "It adds @code{uglify-js} to the set of inputs and uses it to compress all JavaScript files in the @file{src} directory. A different minifier package can be specified with the @code{#:uglify-js} parameter, but it is expected that the package writes the minified code to the standard output."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8467
- msgid "When the input JavaScript files are not all located in the @file{src} directory, the parameter @code{#:javascript-files} can be used to specify a list of file names to feed to the minifier."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8469
- #, no-wrap
- msgid "{Scheme Variable} ocaml-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8475
- msgid "This variable is exported by @code{(guix build-system ocaml)}. It implements a build procedure for @uref{https://ocaml.org, OCaml} packages, which consists of choosing the correct set of commands to run for each package. OCaml packages can expect many different commands to be run. This build system will try some of them."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8485
- msgid "When the package has a @file{setup.ml} file present at the top-level, it will run @code{ocaml setup.ml -configure}, @code{ocaml setup.ml -build} and @code{ocaml setup.ml -install}. The build system will assume that this file was generated by @uref{http://oasis.forge.ocamlcore.org/, OASIS} and will take care of setting the prefix and enabling tests if they are not disabled. You can pass configure and build flags with the @code{#:configure-flags} and @code{#:build-flags}. The @code{#:test-flags} key can be passed to change the set of flags used to enable tests. The @code{#:use-make?} key can be used to bypass this system in the build and install phases."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8490
- msgid "When the package has a @file{configure} file, it is assumed that it is a hand-made configure script that requires a different argument format than in the @code{gnu-build-system}. You can add more flags with the @code{#:configure-flags} key."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8494
- msgid "When the package has a @file{Makefile} file (or @code{#:use-make?} is @code{#t}), it will be used and more flags can be passed to the build and install phases with the @code{#:make-flags} key."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8502
- msgid "Finally, some packages do not have these files and use a somewhat standard location for its build system. In that case, the build system will run @code{ocaml pkg/pkg.ml} or @code{ocaml pkg/build.ml} and take care of providing the path to the required findlib module. Additional flags can be passed via the @code{#:build-flags} key. Install is taken care of by @command{opam-installer}. In this case, the @code{opam} package must be added to the @code{native-inputs} field of the package definition."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8510
- msgid "Note that most OCaml packages assume they will be installed in the same directory as OCaml, which is not what we want in guix. In particular, they will install @file{.so} files in their module's directory, which is usually fine because it is in the OCaml compiler directory. In guix though, these libraries cannot be found and we use @env{CAML_LD_LIBRARY_PATH}. This variable points to @file{lib/ocaml/site-lib/stubslibs} and this is where @file{.so} libraries should be installed."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8512
- #, no-wrap
- msgid "{Scheme Variable} python-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8517
- msgid "This variable is exported by @code{(guix build-system python)}. It implements the more or less standard build procedure used by Python packages, which consists in running @code{python setup.py build} and then @code{python setup.py install --prefix=/gnu/store/@dots{}}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8522
- msgid "For packages that install stand-alone Python programs under @code{bin/}, it takes care of wrapping these programs so that their @env{GUIX_PYTHONPATH} environment variable points to all the Python libraries they depend on."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8528
- msgid "Which Python package is used to perform the build can be specified with the @code{#:python} parameter. This is a useful way to force a package to be built for a specific version of the Python interpreter, which might be necessary if the package is only compatible with a single interpreter version."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8533
- msgid "By default guix calls @code{setup.py} under control of @code{setuptools}, much like @command{pip} does. Some packages are not compatible with setuptools (and pip), thus you can disable this by setting the @code{#:use-setuptools?} parameter to @code{#f}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8539
- msgid "If a @code{\"python\"} output is available, the package is installed into it instead of the default @code{\"out\"} output. This is useful for packages that include a Python package as only a part of the software, and thus want to combine the phases of @code{python-build-system} with another build system. Python bindings are a common usecase."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8542
- #, no-wrap
- msgid "{Scheme Variable} perl-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8554
- msgid "This variable is exported by @code{(guix build-system perl)}. It implements the standard build procedure for Perl packages, which either consists in running @code{perl Build.PL --prefix=/gnu/store/@dots{}}, followed by @code{Build} and @code{Build install}; or in running @code{perl Makefile.PL PREFIX=/gnu/store/@dots{}}, followed by @code{make} and @code{make install}, depending on which of @code{Build.PL} or @code{Makefile.PL} is present in the package distribution. Preference is given to the former if both @code{Build.PL} and @code{Makefile.PL} exist in the package distribution. This preference can be reversed by specifying @code{#t} for the @code{#:make-maker?} parameter."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8558
- msgid "The initial @code{perl Makefile.PL} or @code{perl Build.PL} invocation passes flags specified by the @code{#:make-maker-flags} or @code{#:module-build-flags} parameter, respectively."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8560
- msgid "Which Perl package is used can be specified with @code{#:perl}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8562
- #, no-wrap
- msgid "{Scheme Variable} renpy-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8566
- msgid "This variable is exported by @code{(guix build-system renpy)}. It implements the more or less standard build procedure used by Ren'py games, which consists of loading @code{#:game} once, thereby creating bytecode for it."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8569
- msgid "It further creates a wrapper script in @code{bin/} and a desktop entry in @code{share/applications}, both of which can be used to launch the game."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8573
- msgid "Which Ren'py package is used can be specified with @code{#:renpy}. Games can also be installed in outputs other than ``out'' by using @code{#:output}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8575
- #, no-wrap
- msgid "{Scheme Variable} qt-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8578
- msgid "This variable is exported by @code{(guix build-system qt)}. It is intended for use with applications using Qt or KDE."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8581
- msgid "This build system adds the following two phases to the ones defined by @code{cmake-build-system}:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8583
- #, no-wrap
- msgid "check-setup"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8590
- msgid "The phase @code{check-setup} prepares the environment for running the checks as commonly used by Qt test programs. For now this only sets some environment variables: @code{QT_QPA_PLATFORM=offscreen}, @code{DBUS_FATAL_WARNINGS=0} and @code{CTEST_OUTPUT_ON_FAILURE=1}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8593
- msgid "This phase is added before the @code{check} phase. It's a separate phase to ease adjusting if necessary."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8594
- #, no-wrap
- msgid "qt-wrap"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8600
- msgid "The phase @code{qt-wrap} searches for Qt5 plugin paths, QML paths and some XDG in the inputs and output. In case some path is found, all programs in the output's @file{bin/}, @file{sbin/}, @file{libexec/} and @file{lib/libexec/} directories are wrapped in scripts defining the necessary environment variables."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8606
- msgid "It is possible to exclude specific package outputs from that wrapping process by listing their names in the @code{#:qt-wrap-excluded-outputs} parameter. This is useful when an output is known not to contain any Qt binaries, and where wrapping would gratuitously add a dependency of that output on Qt, KDE, or such."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8608
- msgid "This phase is added after the @code{install} phase."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8611
- #, no-wrap
- msgid "{Scheme Variable} r-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8619
- msgid "This variable is exported by @code{(guix build-system r)}. It implements the build procedure used by @uref{https://r-project.org, R} packages, which essentially is little more than running @samp{R CMD INSTALL --library=/gnu/store/@dots{}} in an environment where @env{R_LIBS_SITE} contains the paths to all R package inputs. Tests are run after installation using the R function @code{tools::testInstalledPackage}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8621
- #, no-wrap
- msgid "{Scheme Variable} rakudo-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8629
- msgid "This variable is exported by @code{(guix build-system rakudo)}. It implements the build procedure used by @uref{https://rakudo.org/, Rakudo} for @uref{https://perl6.org/, Perl6} packages. It installs the package to @code{/gnu/store/@dots{}/NAME-VERSION/share/perl6} and installs the binaries, library files and the resources, as well as wrap the files under the @code{bin/} directory. Tests can be skipped by passing @code{#f} to the @code{tests?} parameter."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8637
- msgid "Which rakudo package is used can be specified with @code{rakudo}. Which perl6-tap-harness package used for the tests can be specified with @code{#:prove6} or removed by passing @code{#f} to the @code{with-prove6?} parameter. Which perl6-zef package used for tests and installing can be specified with @code{#:zef} or removed by passing @code{#f} to the @code{with-zef?} parameter."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8639
- #, no-wrap
- msgid "{Scheme Variable} texlive-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8644
- msgid "This variable is exported by @code{(guix build-system texlive)}. It is used to build TeX packages in batch mode with a specified engine. The build system sets the @env{TEXINPUTS} variable to find all TeX source files in the inputs."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8653
- msgid "By default it runs @code{luatex} on all files ending on @code{ins}. A different engine and format can be specified with the @code{#:tex-format} argument. Different build targets can be specified with the @code{#:build-targets} argument, which expects a list of file names. The build system adds only @code{texlive-bin} and @code{texlive-latex-base} (both from @code{(gnu packages tex}) to the inputs. Both can be overridden with the arguments @code{#:texlive-bin} and @code{#:texlive-latex-base}, respectively."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8656
- msgid "The @code{#:tex-directory} parameter tells the build system where to install the built files under the texmf tree."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8658
- #, no-wrap
- msgid "{Scheme Variable} ruby-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8662
- msgid "This variable is exported by @code{(guix build-system ruby)}. It implements the RubyGems build procedure used by Ruby packages, which involves running @code{gem build} followed by @code{gem install}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8670
- msgid "The @code{source} field of a package that uses this build system typically references a gem archive, since this is the format that Ruby developers use when releasing their software. The build system unpacks the gem archive, potentially patches the source, runs the test suite, repackages the gem, and installs it. Additionally, directories and tarballs may be referenced to allow building unreleased gems from Git or a traditional source release tarball."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8674
- msgid "Which Ruby package is used can be specified with the @code{#:ruby} parameter. A list of additional flags to be passed to the @command{gem} command can be specified with the @code{#:gem-flags} parameter."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8676
- #, no-wrap
- msgid "{Scheme Variable} waf-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8682
- msgid "This variable is exported by @code{(guix build-system waf)}. It implements a build procedure around the @code{waf} script. The common phases---@code{configure}, @code{build}, and @code{install}---are implemented by passing their names as arguments to the @code{waf} script."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8686
- msgid "The @code{waf} script is executed by the Python interpreter. Which Python package is used to run the script can be specified with the @code{#:python} parameter."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8688
- #, no-wrap
- msgid "{Scheme Variable} scons-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8694
- msgid "This variable is exported by @code{(guix build-system scons)}. It implements the build procedure used by the SCons software construction tool. This build system runs @code{scons} to build the package, @code{scons test} to run tests, and then @code{scons install} to install the package."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8701
- msgid "Additional flags to be passed to @code{scons} can be specified with the @code{#:scons-flags} parameter. The default build and install targets can be overridden with @code{#:build-targets} and @code{#:install-targets} respectively. The version of Python used to run SCons can be specified by selecting the appropriate SCons package with the @code{#:scons} parameter."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8703
- #, no-wrap
- msgid "{Scheme Variable} haskell-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8717
- msgid "This variable is exported by @code{(guix build-system haskell)}. It implements the Cabal build procedure used by Haskell packages, which involves running @code{runhaskell Setup.hs configure --prefix=/gnu/store/@dots{}} and @code{runhaskell Setup.hs build}. Instead of installing the package by running @code{runhaskell Setup.hs install}, to avoid trying to register libraries in the read-only compiler store directory, the build system uses @code{runhaskell Setup.hs copy}, followed by @code{runhaskell Setup.hs register}. In addition, the build system generates the package documentation by running @code{runhaskell Setup.hs haddock}, unless @code{#:haddock? #f} is passed. Optional Haddock parameters can be passed with the help of the @code{#:haddock-flags} parameter. If the file @code{Setup.hs} is not found, the build system looks for @code{Setup.lhs} instead."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8720
- msgid "Which Haskell compiler is used can be specified with the @code{#:haskell} parameter which defaults to @code{ghc}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8722
- #, no-wrap
- msgid "{Scheme Variable} dub-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8727
- msgid "This variable is exported by @code{(guix build-system dub)}. It implements the Dub build procedure used by D packages, which involves running @code{dub build} and @code{dub run}. Installation is done by copying the files manually."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8730
- msgid "Which D compiler is used can be specified with the @code{#:ldc} parameter which defaults to @code{ldc}."
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:8733
- msgid "emacs-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8733
- #, no-wrap
- msgid "{Scheme Variable} emacs-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8737
- msgid "This variable is exported by @code{(guix build-system emacs)}. It implements an installation procedure similar to the packaging system of Emacs itself (@pxref{Packages,,, emacs, The GNU Emacs Manual})."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8743
- msgid "It first creates the @code{@code{package}-autoloads.el} file, then it byte compiles all Emacs Lisp files. Differently from the Emacs packaging system, the Info documentation files are moved to the standard documentation directory and the @file{dir} file is deleted. The Elisp package files are installed directly under @file{share/emacs/site-lisp}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8745
- #, no-wrap
- msgid "{Scheme Variable} font-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8751
- msgid "This variable is exported by @code{(guix build-system font)}. It implements an installation procedure for font packages where upstream provides pre-compiled TrueType, OpenType, etc.@: font files that merely need to be copied into place. It copies font files to standard locations in the output directory."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8753
- #, no-wrap
- msgid "{Scheme Variable} meson-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8757
- msgid "This variable is exported by @code{(guix build-system meson)}. It implements the build procedure for packages that use @url{https://mesonbuild.com, Meson} as their build system."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8761
- msgid "It adds both Meson and @uref{https://ninja-build.org/, Ninja} to the set of inputs, and they can be changed with the parameters @code{#:meson} and @code{#:ninja} if needed."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8764
- msgid "This build system is an extension of @code{gnu-build-system}, but with the following phases changed to some specific for Meson:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8767 guix-git/doc/guix.texi:8818
- #: guix-git/doc/guix.texi:8886
- #, no-wrap
- msgid "configure"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8772
- msgid "The phase runs @code{meson} with the flags specified in @code{#:configure-flags}. The flag @option{--buildtype} is always set to @code{debugoptimized} unless something else is specified in @code{#:build-type}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8776
- msgid "The phase runs @code{ninja} to build the package in parallel by default, but this can be changed with @code{#:parallel-build?}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8782
- msgid "The phase runs @samp{meson test} with a base set of options that cannot be overridden. This base set of options can be extended via the @code{#:test-options} argument, for example to select or skip a specific test suite."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8785
- msgid "The phase runs @code{ninja install} and can not be changed."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8788
- msgid "Apart from that, the build system also adds the following phases:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8791
- #, no-wrap
- msgid "fix-runpath"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8798
- msgid "This phase ensures that all binaries can find the libraries they need. It searches for required libraries in subdirectories of the package being built, and adds those to @code{RUNPATH} where needed. It also removes references to libraries left over from the build phase by @code{meson}, such as test dependencies, that aren't actually required for the program to run."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8802 guix-git/doc/guix.texi:8806
- msgid "This phase is the phase provided by @code{glib-or-gtk-build-system}, and it is not enabled by default. It can be enabled with @code{#:glib-or-gtk?}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8809
- #, no-wrap
- msgid "{Scheme Variable} linux-module-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8811
- msgid "@code{linux-module-build-system} allows building Linux kernel modules."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8815
- msgid "This build system is an extension of @code{gnu-build-system}, but with the following phases changed:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8821
- msgid "This phase configures the environment so that the Linux kernel's Makefile can be used to build the external kernel module."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8825
- msgid "This phase uses the Linux kernel's Makefile in order to build the external kernel module."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8829
- msgid "This phase uses the Linux kernel's Makefile in order to install the external kernel module."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8834
- msgid "It is possible and useful to specify the Linux kernel to use for building the module (in the @code{arguments} form of a package using the @code{linux-module-build-system}, use the key @code{#:linux} to specify it)."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8836
- #, no-wrap
- msgid "{Scheme Variable} node-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8841
- msgid "This variable is exported by @code{(guix build-system node)}. It implements the build procedure used by @uref{https://nodejs.org, Node.js}, which implements an approximation of the @code{npm install} command, followed by an @code{npm test} command."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8845
- msgid "Which Node.js package is used to interpret the @code{npm} commands can be specified with the @code{#:node} parameter which defaults to @code{node}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:8851
- msgid "Lastly, for packages that do not need anything as sophisticated, a ``trivial'' build system is provided. It is trivial in the sense that it provides basically no support: it does not pull any implicit inputs, and does not have a notion of build phases."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8852
- #, no-wrap
- msgid "{Scheme Variable} trivial-build-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8854
- msgid "This variable is exported by @code{(guix build-system trivial)}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:8859
- msgid "This build system requires a @code{#:builder} argument. This argument must be a Scheme expression that builds the package output(s)---as with @code{build-expression->derivation} (@pxref{Derivations, @code{build-expression->derivation}})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:8864
- #, no-wrap
- msgid "build phases, for packages"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:8870
- msgid "Almost all package build systems implement a notion @dfn{build phases}: a sequence of actions that the build system executes, when you build the package, leading to the installed byproducts in the store. A notable exception is the ``bare-bones'' @code{trivial-build-system} (@pxref{Build Systems})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:8874
- msgid "As discussed in the previous section, those build systems provide a standard list of phases. For @code{gnu-build-system}, the main build phases are the following:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8876
- #, no-wrap
- msgid "unpack"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8880
- msgid "Unpack the source tarball, and change the current directory to the extracted source tree. If the source is actually a directory, copy it to the build tree, and enter that directory."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8881
- #, no-wrap
- msgid "patch-source-shebangs"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8885
- msgid "Patch shebangs encountered in source files so they refer to the right store file names. For instance, this changes @code{#!/bin/sh} to @code{#!/gnu/store/@dots{}-bash-4.3/bin/sh}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8890
- msgid "Run the @file{configure} script with a number of default options, such as @option{--prefix=/gnu/store/@dots{}}, as well as the options specified by the @code{#:configure-flags} argument."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8895
- msgid "Run @code{make} with the list of flags specified with @code{#:make-flags}. If the @code{#:parallel-build?} argument is true (the default), build with @code{make -j}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8901
- msgid "Run @code{make check}, or some other target specified with @code{#:test-target}, unless @code{#:tests? #f} is passed. If the @code{#:parallel-tests?} argument is true (the default), run @code{make check -j}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8904
- msgid "Run @code{make install} with the flags listed in @code{#:make-flags}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8905
- #, no-wrap
- msgid "patch-shebangs"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8907
- msgid "Patch shebangs on the installed executable files."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:8908
- #, no-wrap
- msgid "strip"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:8912
- msgid "Strip debugging symbols from ELF files (unless @code{#:strip-binaries?} is false), copying them to the @code{debug} output when available (@pxref{Installing Debugging Files})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:8921
- msgid "Other build systems have similar phases, with some variations. For example, @code{cmake-build-system} has same-named phases but its @code{configure} phases runs @code{cmake} instead of @code{./configure}. Others, such as @code{python-build-system}, have a wholly different list of standard phases. All this code runs on the @dfn{build side}: it is evaluated when you actually build the package, in a dedicated build process spawned by the build daemon (@pxref{Invoking guix-daemon})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:8928
- msgid "Build phases are represented as association lists or ``alists'' (@pxref{Association Lists,,, guile, GNU Guile Reference Manual}) where each key is a symbol for the name of the phase and the associated value is a procedure that accepts an arbitrary number of arguments. By convention, those procedures receive information about the build in the form of @dfn{keyword parameters}, which they can use or ignore."
- msgstr ""
- #. type: vindex
- #: guix-git/doc/guix.texi:8929
- #, no-wrap
- msgid "%standard-phases"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:8935
- msgid "For example, here is how @code{(guix build gnu-build-system)} defines @code{%standard-phases}, the variable holding its alist of build phases@footnote{We present a simplified view of those build phases, but do take a look at @code{(guix build gnu-build-system)} to see all the details!}:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:8938
- #, no-wrap
- msgid ""
- ";; The build phases of 'gnu-build-system'.\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:8942
- #, no-wrap
- msgid ""
- "(define* (unpack #:key source #:allow-other-keys)\n"
- " ;; Extract the source tarball.\n"
- " (invoke \"tar\" \"xvf\" source))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:8948
- #, no-wrap
- msgid ""
- "(define* (configure #:key outputs #:allow-other-keys)\n"
- " ;; Run the 'configure' script. Install to output \"out\".\n"
- " (let ((out (assoc-ref outputs \"out\")))\n"
- " (invoke \"./configure\"\n"
- " (string-append \"--prefix=\" out))))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:8952
- #, no-wrap
- msgid ""
- "(define* (build #:allow-other-keys)\n"
- " ;; Compile.\n"
- " (invoke \"make\"))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:8959
- #, no-wrap
- msgid ""
- "(define* (check #:key (test-target \"check\") (tests? #true)\n"
- " #:allow-other-keys)\n"
- " ;; Run the test suite.\n"
- " (if tests?\n"
- " (invoke \"make\" test-target)\n"
- " (display \"test suite not run\\n\")))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:8963
- #, no-wrap
- msgid ""
- "(define* (install #:allow-other-keys)\n"
- " ;; Install files to the prefix 'configure' specified.\n"
- " (invoke \"make\" \"install\"))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:8972
- #, no-wrap
- msgid ""
- "(define %standard-phases\n"
- " ;; The list of standard phases (quite a few are omitted\n"
- " ;; for brevity). Each element is a symbol/procedure pair.\n"
- " (list (cons 'unpack unpack)\n"
- " (cons 'configure configure)\n"
- " (cons 'build build)\n"
- " (cons 'check check)\n"
- " (cons 'install install)))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:8982
- msgid "This shows how @code{%standard-phases} is defined as a list of symbol/procedure pairs (@pxref{Pairs,,, guile, GNU Guile Reference Manual}). The first pair associates the @code{unpack} procedure with the @code{unpack} symbol---a name; the second pair defines the @code{configure} phase similarly, and so on. When building a package that uses @code{gnu-build-system} with its default list of phases, those phases are executed sequentially. You can see the name of each phase started and completed in the build log of packages that you build."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:8988
- msgid "Let's now look at the procedures themselves. Each one is defined with @code{define*}: @code{#:key} lists keyword parameters the procedure accepts, possibly with a default value, and @code{#:allow-other-keys} specifies that other keyword parameters are ignored (@pxref{Optional Arguments,,, guile, GNU Guile Reference Manual})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9004
- msgid "The @code{unpack} procedure honors the @code{source} parameter, which the build system uses to pass the file name of the source tarball (or version control checkout), and it ignores other parameters. The @code{configure} phase only cares about the @code{outputs} parameter, an alist mapping package output names to their store file name (@pxref{Packages with Multiple Outputs}). It extracts the file name of for @code{out}, the default output, and passes it to @command{./configure} as the installation prefix, meaning that @command{make install} will eventually copy all the files in that directory (@pxref{Configuration, configuration and makefile conventions,, standards, GNU Coding Standards}). @code{build} and @code{install} ignore all their arguments. @code{check} honors the @code{test-target} argument, which specifies the name of the Makefile target to run tests; it prints a message and skips tests when @code{tests?} is false."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:9005
- #, no-wrap
- msgid "build phases, customizing"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9014
- msgid "The list of phases used for a particular package can be changed with the @code{#:phases} parameter of the build system. Changing the set of build phases boils down to building a new alist of phases based on the @code{%standard-phases} alist described above. This can be done with standard alist procedures such as @code{alist-delete} (@pxref{SRFI-1 Association Lists,,, guile, GNU Guile Reference Manual}); however, it is more convenient to do so with @code{modify-phases} (@pxref{Build Utilities, @code{modify-phases}})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9019
- msgid "Here is an example of a package definition that removes the @code{configure} phase of @code{%standard-phases} and inserts a new phase before the @code{build} phase, called @code{set-prefix-in-makefile}:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:9039
- #, no-wrap
- msgid ""
- "(define-public example\n"
- " (package\n"
- " (name \"example\")\n"
- " ;; other fields omitted\n"
- " (build-system gnu-build-system)\n"
- " (arguments\n"
- " '(#:phases (modify-phases %standard-phases\n"
- " (delete 'configure)\n"
- " (add-before 'build 'set-prefix-in-makefile\n"
- " (lambda* (#:key outputs #:allow-other-keys)\n"
- " ;; Modify the makefile so that its\n"
- " ;; 'PREFIX' variable points to \"out\".\n"
- " (let ((out (assoc-ref outputs \"out\")))\n"
- " (substitute* \"Makefile\"\n"
- " ((\"PREFIX =.*\")\n"
- " (string-append \"PREFIX = \"\n"
- " out \"\\n\")))\n"
- " #true))))))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9045
- msgid "The new phase that is inserted is written as an anonymous procedure, introduced with @code{lambda*}; it honors the @code{outputs} parameter we have seen before. @xref{Build Utilities}, for more about the helpers used by this phase, and for more examples of @code{modify-phases}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:9046 guix-git/doc/guix.texi:10046
- #, no-wrap
- msgid "code staging"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:9047 guix-git/doc/guix.texi:10047
- #, no-wrap
- msgid "staging, of code"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9054
- msgid "Keep in mind that build phases are code evaluated at the time the package is actually built. This explains why the whole @code{modify-phases} expression above is quoted (it comes after the @code{'} or apostrophe): it is @dfn{staged} for later execution. @xref{G-Expressions}, for an explanation of code staging and the @dfn{code strata} involved."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9064
- msgid "As soon as you start writing non-trivial package definitions (@pxref{Defining Packages}) or other build actions (@pxref{G-Expressions}), you will likely start looking for helpers for ``shell-like'' actions---creating directories, copying and deleting files recursively, manipulating build phases, and so on. The @code{(guix build utils)} module provides such utility procedures."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9068
- msgid "Most build systems load @code{(guix build utils)} (@pxref{Build Systems}). Thus, when writing custom build phases for your package definitions, you can usually assume those procedures are in scope."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9073
- msgid "When writing G-expressions, you can import @code{(guix build utils)} on the ``build side'' using @code{with-imported-modules} and then put it in scope with the @code{use-modules} form (@pxref{Using Guile Modules,,, guile, GNU Guile Reference Manual}):"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:9080
- #, no-wrap
- msgid ""
- "(with-imported-modules '((guix build utils)) ;import it\n"
- " (computed-file \"empty-tree\"\n"
- " #~(begin\n"
- " ;; Put it in scope.\n"
- " (use-modules (guix build utils))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:9083
- #, no-wrap
- msgid ""
- " ;; Happily use its 'mkdir-p' procedure.\n"
- " (mkdir-p (string-append #$output \"/a/b/c\")))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9087
- msgid "The remainder of this section is the reference for most of the utility procedures provided by @code{(guix build utils)}."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:9090
- #, no-wrap
- msgid "Dealing with Store File Names"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9093
- msgid "This section documents procedures that deal with store file names."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9094
- #, no-wrap
- msgid "{Scheme Procedure} %store-directory"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9096
- msgid "Return the directory name of the store."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9098
- #, no-wrap
- msgid "{Scheme Procedure} store-file-name? @var{file}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9100
- msgid "Return true if @var{file} is in the store."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9102
- #, no-wrap
- msgid "{Scheme Procedure} strip-store-file-name @var{file}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9105
- msgid "Strip the @file{/gnu/store} and hash from @var{file}, a store file name. The result is typically a @code{\"@var{package}-@var{version}\"} string."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9107
- #, no-wrap
- msgid "{Scheme Procedure} package-name->name+version @var{name}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9112
- msgid "Given @var{name}, a package name like @code{\"foo-0.9.1b\"}, return two values: @code{\"foo\"} and @code{\"0.9.1b\"}. When the version part is unavailable, @var{name} and @code{#f} are returned. The first hyphen followed by a digit is considered to introduce the version part."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:9114
- #, no-wrap
- msgid "File Types"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9117
- msgid "The procedures below deal with files and file types."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9118
- #, no-wrap
- msgid "{Scheme Procedure} directory-exists? @var{dir}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9120
- msgid "Return @code{#t} if @var{dir} exists and is a directory."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9122
- #, no-wrap
- msgid "{Scheme Procedure} executable-file? @var{file}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9124
- msgid "Return @code{#t} if @var{file} exists and is executable."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9126
- #, no-wrap
- msgid "{Scheme Procedure} symbolic-link? @var{file}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9128
- msgid "Return @code{#t} if @var{file} is a symbolic link (aka. a ``symlink'')."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9130
- #, no-wrap
- msgid "{Scheme Procedure} elf-file? @var{file}"
- msgstr ""
- #. type: deffnx
- #: guix-git/doc/guix.texi:9131
- #, no-wrap
- msgid "{Scheme Procedure} ar-file? @var{file}"
- msgstr ""
- #. type: deffnx
- #: guix-git/doc/guix.texi:9132
- #, no-wrap
- msgid "{Scheme Procedure} gzip-file? @var{file}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9135
- msgid "Return @code{#t} if @var{file} is, respectively, an ELF file, an @code{ar} archive (such as a @file{.a} static library), or a gzip file."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9137
- #, no-wrap
- msgid "{Scheme Procedure} reset-gzip-timestamp @var{file} [#:keep-mtime? #t]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9141
- msgid "If @var{file} is a gzip file, reset its embedded timestamp (as with @command{gzip --no-name}) and return true. Otherwise return @code{#f}. When @var{keep-mtime?} is true, preserve @var{file}'s modification time."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:9143
- #, no-wrap
- msgid "File Manipulation"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9150
- msgid "The following procedures and macros help create, modify, and delete files. They provide functionality comparable to common shell utilities such as @command{mkdir -p}, @command{cp -r}, @command{rm -r}, and @command{sed}. They complement Guile's extensive, but low-level, file system interface (@pxref{POSIX,,, guile, GNU Guile Reference Manual})."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9151
- #, no-wrap
- msgid "{Scheme Syntax} with-directory-excursion @var{directory} @var{body}@dots{}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9153
- msgid "Run @var{body} with @var{directory} as the process's current directory."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9160
- msgid "Essentially, this macro changes the current directory to @var{directory} before evaluating @var{body}, using @code{chdir} (@pxref{Processes,,, guile, GNU Guile Reference Manual}). It changes back to the initial directory when the dynamic extent of @var{body} is left, be it @i{via} normal procedure return or @i{via} a non-local exit such as an exception."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9162
- #, no-wrap
- msgid "{Scheme Procedure} mkdir-p @var{dir}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9164
- msgid "Create directory @var{dir} and all its ancestors."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9166
- #, no-wrap
- msgid "{Scheme Procedure} install-file @var{file} @var{directory}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9169
- msgid "Create @var{directory} if it does not exist and copy @var{file} in there under the same name."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9171
- #, no-wrap
- msgid "{Scheme Procedure} make-file-writable @var{file}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9173
- msgid "Make @var{file} writable for its owner."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9175
- #, no-wrap
- msgid "{Scheme Procedure} copy-recursively @var{source} @var{destination} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9184
- msgid "[#:log (current-output-port)] [#:follow-symlinks? #f] @ [#:copy-file copy-file] [#:keep-mtime? #f] [#:keep-permissions? #t] Copy @var{source} directory to @var{destination}. Follow symlinks if @var{follow-symlinks?} is true; otherwise, just preserve them. Call @var{copy-file} to copy regular files. When @var{keep-mtime?} is true, keep the modification time of the files in @var{source} on those of @var{destination}. When @var{keep-permissions?} is true, preserve file permissions. Write verbose output to the @var{log} port."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9186
- #, no-wrap
- msgid "{Scheme Procedure} delete-file-recursively @var{dir} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9191
- msgid "[#:follow-mounts? #f] Delete @var{dir} recursively, like @command{rm -rf}, without following symlinks. Don't follow mount points either, unless @var{follow-mounts?} is true. Report but ignore errors."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9193
- #, no-wrap
- msgid "{Scheme Syntax} substitute* @var{file} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9198
- msgid "((@var{regexp} @var{match-var}@dots{}) @var{body}@dots{}) @dots{} Substitute @var{regexp} in @var{file} by the string returned by @var{body}. @var{body} is evaluated with each @var{match-var} bound to the corresponding positional regexp sub-expression. For example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:9205
- #, no-wrap
- msgid ""
- "(substitute* file\n"
- " ((\"hello\")\n"
- " \"good morning\\n\")\n"
- " ((\"foo([a-z]+)bar(.*)$\" all letters end)\n"
- " (string-append \"baz\" letters end)))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9211
- msgid "Here, anytime a line of @var{file} contains @code{hello}, it is replaced by @code{good morning}. Anytime a line of @var{file} matches the second regexp, @code{all} is bound to the complete match, @code{letters} is bound to the first sub-expression, and @code{end} is bound to the last one."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9214
- msgid "When one of the @var{match-var} is @code{_}, no variable is bound to the corresponding match substring."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9217
- msgid "Alternatively, @var{file} may be a list of file names, in which case they are all subject to the substitutions."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9220
- msgid "Be careful about using @code{$} to match the end of a line; by itself it won't match the terminating newline of a line."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:9222
- #, no-wrap
- msgid "File Search"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:9224
- #, no-wrap
- msgid "file, searching"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9226
- msgid "This section documents procedures to search and filter files."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9227
- #, no-wrap
- msgid "{Scheme Procedure} file-name-predicate @var{regexp}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9230
- msgid "Return a predicate that returns true when passed a file name whose base name matches @var{regexp}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9232
- #, no-wrap
- msgid "{Scheme Procedure} find-files @var{dir} [@var{pred}] @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9243
- msgid "[#:stat lstat] [#:directories? #f] [#:fail-on-error? #f] Return the lexicographically sorted list of files under @var{dir} for which @var{pred} returns true. @var{pred} is passed two arguments: the absolute file name, and its stat buffer; the default predicate always returns true. @var{pred} can also be a regular expression, in which case it is equivalent to @code{(file-name-predicate @var{pred})}. @var{stat} is used to obtain file information; using @code{lstat} means that symlinks are not followed. If @var{directories?} is true, then directories will also be included. If @var{fail-on-error?} is true, raise an exception upon error."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9247
- msgid "Here are a few examples where we assume that the current directory is the root of the Guix source tree:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:9252
- #, no-wrap
- msgid ""
- ";; List all the regular files in the current directory.\n"
- "(find-files \".\")\n"
- "@result{} (\"./.dir-locals.el\" \"./.gitignore\" @dots{})\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:9256
- #, no-wrap
- msgid ""
- ";; List all the .scm files under gnu/services.\n"
- "(find-files \"gnu/services\" \"\\\\.scm$\")\n"
- "@result{} (\"gnu/services/admin.scm\" \"gnu/services/audio.scm\" @dots{})\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:9260
- #, no-wrap
- msgid ""
- ";; List ar files in the current directory.\n"
- "(find-files \".\" (lambda (file stat) (ar-file? file)))\n"
- "@result{} (\"./libformat.a\" \"./libstore.a\" @dots{})\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9262
- #, no-wrap
- msgid "{Scheme Procedure} which @var{program}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9265
- msgid "Return the complete file name for @var{program} as found in @code{$PATH}, or @code{#f} if @var{program} could not be found."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9267
- #, no-wrap
- msgid "{Scheme Procedure} search-input-file @var{inputs} @var{name}"
- msgstr ""
- #. type: deffnx
- #: guix-git/doc/guix.texi:9268
- #, no-wrap
- msgid "{Scheme Procedure} search-input-directory @var{inputs} @var{name}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9273
- msgid "Return the complete file name for @var{name} as found in @var{inputs}; @code{search-input-file} searches for a regular file and @code{search-input-directory} searches for a directory. If @var{name} could not be found, an exception is raised."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9277
- msgid "Here, @var{inputs} must be an association list like @code{inputs} and @code{native-inputs} as available to build phases (@pxref{Build Phases})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9281
- msgid "Here is a (simplified) example of how @code{search-input-file} is used in a build phase of the @code{wireguard-tools} package:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:9290
- #, no-wrap
- msgid ""
- "(add-after 'install 'wrap-wg-quick\n"
- " (lambda* (#:key inputs outputs #:allow-other-keys)\n"
- " (let ((coreutils (string-append (assoc-ref inputs \"coreutils\")\n"
- " \"/bin\")))\n"
- " (wrap-program (search-input-file outputs \"bin/wg-quick\")\n"
- " #:sh (search-input-file inputs \"bin/bash\")\n"
- " `(\"PATH\" \":\" prefix ,(list coreutils))))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9301
- msgid "The @code{(guix build utils)} also contains tools to manipulate build phases as used by build systems (@pxref{Build Systems}). Build phases are represented as association lists or ``alists'' (@pxref{Association Lists,,, guile, GNU Guile Reference Manual}) where each key is a symbol naming the phase and the associated value is a procedure (@pxref{Build Phases})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9305
- msgid "Guile core and the @code{(srfi srfi-1)} module both provide tools to manipulate alists. The @code{(guix build utils)} module complements those with tools written with build phases in mind."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:9306
- #, no-wrap
- msgid "build phases, modifying"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9307
- #, no-wrap
- msgid "{Scheme Syntax} modify-phases @var{phases} @var{clause}@dots{}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9310
- msgid "Modify @var{phases} sequentially as per each @var{clause}, which may have one of the following forms:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:9316
- #, no-wrap
- msgid ""
- "(delete @var{old-phase-name})\n"
- "(replace @var{old-phase-name} @var{new-phase})\n"
- "(add-before @var{old-phase-name} @var{new-phase-name} @var{new-phase})\n"
- "(add-after @var{old-phase-name} @var{new-phase-name} @var{new-phase})\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9320
- msgid "Where every @var{phase-name} above is an expression evaluating to a symbol, and @var{new-phase} an expression evaluating to a procedure."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9331
- msgid "The example below is taken from the definition of the @code{grep} package. It adds a phase to run after the @code{install} phase, called @code{fix-egrep-and-fgrep}. That phase is a procedure (@code{lambda*} is for anonymous procedures) that takes a @code{#:outputs} keyword argument and ignores extra keyword arguments (@pxref{Optional Arguments,,, guile, GNU Guile Reference Manual}, for more on @code{lambda*} and optional and keyword arguments.) The phase uses @code{substitute*} to modify the installed @file{egrep} and @file{fgrep} scripts so that they refer to @code{grep} by its absolute file name:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:9345
- #, no-wrap
- msgid ""
- "(modify-phases %standard-phases\n"
- " (add-after 'install 'fix-egrep-and-fgrep\n"
- " ;; Patch 'egrep' and 'fgrep' to execute 'grep' via its\n"
- " ;; absolute file name instead of searching for it in $PATH.\n"
- " (lambda* (#:key outputs #:allow-other-keys)\n"
- " (let* ((out (assoc-ref outputs \"out\"))\n"
- " (bin (string-append out \"/bin\")))\n"
- " (substitute* (list (string-append bin \"/egrep\")\n"
- " (string-append bin \"/fgrep\"))\n"
- " ((\"^exec grep\")\n"
- " (string-append \"exec \" bin \"/grep\")))\n"
- " #t))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9352
- msgid "In the example below, phases are modified in two ways: the standard @code{configure} phase is deleted, presumably because the package does not have a @file{configure} script or anything similar, and the default @code{install} phase is replaced by one that manually copies the executable files to be installed:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:9365
- #, no-wrap
- msgid ""
- "(modify-phases %standard-phases\n"
- " (delete 'configure) ;no 'configure' script\n"
- " (replace 'install\n"
- " (lambda* (#:key outputs #:allow-other-keys)\n"
- " ;; The package's Makefile doesn't provide an \"install\"\n"
- " ;; rule so do it by ourselves.\n"
- " (let ((bin (string-append (assoc-ref outputs \"out\")\n"
- " \"/bin\")))\n"
- " (install-file \"footswitch\" bin)\n"
- " (install-file \"scythe\" bin)\n"
- " #t))))\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:9373
- #, no-wrap
- msgid "store items"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:9374
- #, no-wrap
- msgid "store paths"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9385
- msgid "Conceptually, the @dfn{store} is the place where derivations that have been built successfully are stored---by default, @file{/gnu/store}. Sub-directories in the store are referred to as @dfn{store items} or sometimes @dfn{store paths}. The store has an associated database that contains information such as the store paths referred to by each store path, and the list of @emph{valid} store items---results of successful builds. This database resides in @file{@var{localstatedir}/guix/db}, where @var{localstatedir} is the state directory specified @i{via} @option{--localstatedir} at configure time, usually @file{/var}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9390
- msgid "The store is @emph{always} accessed by the daemon on behalf of its clients (@pxref{Invoking guix-daemon}). To manipulate the store, clients connect to the daemon over a Unix-domain socket, send requests to it, and read the result---these are remote procedure calls, or RPCs."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:9395
- msgid "Users must @emph{never} modify files under @file{/gnu/store} directly. This would lead to inconsistencies and break the immutability assumptions of Guix's functional model (@pxref{Introduction})."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:9399
- msgid "@xref{Invoking guix gc, @command{guix gc --verify}}, for information on how to check the integrity of the store and attempt recovery from accidental modifications."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9406
- msgid "The @code{(guix store)} module provides procedures to connect to the daemon, and to perform RPCs. These are described below. By default, @code{open-connection}, and thus all the @command{guix} commands, connect to the local daemon or to the URI specified by the @env{GUIX_DAEMON_SOCKET} environment variable."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:9407
- #, no-wrap
- msgid "{Environment Variable} GUIX_DAEMON_SOCKET"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:9412
- msgid "When set, the value of this variable should be a file name or a URI designating the daemon endpoint. When it is a file name, it denotes a Unix-domain socket to connect to. In addition to file names, the supported URI schemes are:"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:9414 guix-git/doc/guix.texi:26183
- #, no-wrap
- msgid "file"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:9415
- #, no-wrap
- msgid "unix"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:9419
- msgid "These are for Unix-domain sockets. @code{file:///var/guix/daemon-socket/socket} is equivalent to @file{/var/guix/daemon-socket/socket}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:9428
- msgid "These URIs denote connections over TCP/IP, without encryption nor authentication of the remote host. The URI must specify the host name and optionally a port number (by default port 44146 is used):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:9431
- #, no-wrap
- msgid "guix://master.guix.example.org:1234\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:9436
- msgid "This setup is suitable on local networks, such as clusters, where only trusted nodes may connect to the build daemon at @code{master.guix.example.org}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:9440
- msgid "The @option{--listen} option of @command{guix-daemon} can be used to instruct it to listen for TCP connections (@pxref{Invoking guix-daemon, @option{--listen}})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:9441
- #, no-wrap
- msgid "ssh"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:9442
- #, no-wrap
- msgid "SSH access to build daemons"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:9448
- msgid "These URIs allow you to connect to a remote daemon over SSH@. This feature requires Guile-SSH (@pxref{Requirements}) and a working @command{guile} binary in @env{PATH} on the destination machine. It supports public key and GSSAPI authentication. A typical URL might look like this:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:9451
- #, no-wrap
- msgid "ssh://charlie@@guix.example.org:22\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:9455
- msgid "As for @command{guix copy}, the usual OpenSSH client configuration files are honored (@pxref{Invoking guix copy})."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:9458
- msgid "Additional URI schemes may be supported in the future."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:9465
- msgid "The ability to connect to remote build daemons is considered experimental as of @value{VERSION}. Please get in touch with us to share any problems or suggestions you may have (@pxref{Contributing})."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9468
- #, no-wrap
- msgid "{Scheme Procedure} open-connection [@var{uri}] [#:reserve-space? #t]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9473
- msgid "Connect to the daemon over the Unix-domain socket at @var{uri} (a string). When @var{reserve-space?} is true, instruct it to reserve a little bit of extra space on the file system so that the garbage collector can still operate should the disk become full. Return a server object."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9476
- msgid "@var{file} defaults to @code{%default-socket-path}, which is the normal location given the options that were passed to @command{configure}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9478
- #, no-wrap
- msgid "{Scheme Procedure} close-connection @var{server}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9480
- msgid "Close the connection to @var{server}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:9482
- #, no-wrap
- msgid "{Scheme Variable} current-build-output-port"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:9485
- msgid "This variable is bound to a SRFI-39 parameter, which refers to the port where build and error logs sent by the daemon should be written."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9489
- msgid "Procedures that make RPCs all take a server object as their first argument."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9490
- #, no-wrap
- msgid "{Scheme Procedure} valid-path? @var{server} @var{path}"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:9491
- #, no-wrap
- msgid "invalid store items"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9496
- msgid "Return @code{#t} when @var{path} designates a valid store item and @code{#f} otherwise (an invalid item may exist on disk but still be invalid, for instance because it is the result of an aborted or failed build)."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9499
- msgid "A @code{&store-protocol-error} condition is raised if @var{path} is not prefixed by the store directory (@file{/gnu/store})."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9501
- #, no-wrap
- msgid "{Scheme Procedure} add-text-to-store @var{server} @var{name} @var{text} [@var{references}]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9505
- msgid "Add @var{text} under file @var{name} in the store, and return its store path. @var{references} is the list of store paths referred to by the resulting store path."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9507
- #, no-wrap
- msgid "{Scheme Procedure} build-derivations @var{store} @var{derivations} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9512
- msgid "[@var{mode}] Build @var{derivations}, a list of @code{<derivation>} objects, @file{.drv} file names, or derivation/output pairs, using the specified @var{mode}---@code{(build-mode normal)} by default."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9518
- msgid "Note that the @code{(guix monads)} module provides a monad as well as monadic versions of the above procedures, with the goal of making it more convenient to work with code that accesses the store (@pxref{The Store Monad})."
- msgstr ""
- #. type: i{#1}
- #: guix-git/doc/guix.texi:9521
- msgid "This section is currently incomplete."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:9525
- #, no-wrap
- msgid "derivations"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9529
- msgid "Low-level build actions and the environment in which they are performed are represented by @dfn{derivations}. A derivation contains the following pieces of information:"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:9534
- msgid "The outputs of the derivation---derivations produce at least one file or directory in the store, but may produce more."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:9536
- #, no-wrap
- msgid "build-time dependencies"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:9537
- #, no-wrap
- msgid "dependencies, build-time"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:9541
- msgid "The inputs of the derivations---i.e., its build-time dependencies---which may be other derivations or plain files in the store (patches, build scripts, etc.)."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:9544
- msgid "The system type targeted by the derivation---e.g., @code{x86_64-linux}."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:9548
- msgid "The file name of a build script in the store, along with the arguments to be passed."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:9551
- msgid "A list of environment variables to be defined."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:9554
- #, no-wrap
- msgid "derivation path"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9562
- msgid "Derivations allow clients of the daemon to communicate build actions to the store. They exist in two forms: as an in-memory representation, both on the client- and daemon-side, and as files in the store whose name end in @file{.drv}---these files are referred to as @dfn{derivation paths}. Derivations paths can be passed to the @code{build-derivations} procedure to perform the build actions they prescribe (@pxref{The Store})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:9563
- #, no-wrap
- msgid "fixed-output derivations"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9570
- msgid "Operations such as file downloads and version-control checkouts for which the expected content hash is known in advance are modeled as @dfn{fixed-output derivations}. Unlike regular derivations, the outputs of a fixed-output derivation are independent of its inputs---e.g., a source code download produces the same result regardless of the download method and tools being used."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:9571 guix-git/doc/guix.texi:13341
- #, no-wrap
- msgid "references"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:9572
- #, no-wrap
- msgid "run-time dependencies"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:9573
- #, no-wrap
- msgid "dependencies, run-time"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9580
- msgid "The outputs of derivations---i.e., the build results---have a set of @dfn{references}, as reported by the @code{references} RPC or the @command{guix gc --references} command (@pxref{Invoking guix gc}). References are the set of run-time dependencies of the build results. References are a subset of the inputs of the derivation; this subset is automatically computed by the build daemon by scanning all the files in the outputs."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9585
- msgid "The @code{(guix derivations)} module provides a representation of derivations as Scheme objects, along with procedures to create and otherwise manipulate derivations. The lowest-level primitive to create a derivation is the @code{derivation} procedure:"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9586
- #, no-wrap
- msgid "{Scheme Procedure} derivation @var{store} @var{name} @var{builder} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9595
- msgid "@var{args} [#:outputs '(\"out\")] [#:hash #f] [#:hash-algo #f] @ [#:recursive? #f] [#:inputs '()] [#:env-vars '()] @ [#:system (%current-system)] [#:references-graphs #f] @ [#:allowed-references #f] [#:disallowed-references #f] @ [#:leaked-env-vars #f] [#:local-build? #f] @ [#:substitutable? #t] [#:properties '()] Build a derivation with the given arguments, and return the resulting @code{<derivation>} object."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9602
- msgid "When @var{hash} and @var{hash-algo} are given, a @dfn{fixed-output derivation} is created---i.e., one whose result is known in advance, such as a file download. If, in addition, @var{recursive?} is true, then that fixed output may be an executable file or a directory and @var{hash} must be the hash of an archive containing this output."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9607
- msgid "When @var{references-graphs} is true, it must be a list of file name/store path pairs. In that case, the reference graph of each store path is exported in the build environment in the corresponding file, in a simple text format."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9612
- msgid "When @var{allowed-references} is true, it must be a list of store items or outputs that the derivation's output may refer to. Likewise, @var{disallowed-references}, if true, must be a list of things the outputs may @emph{not} refer to."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9619
- msgid "When @var{leaked-env-vars} is true, it must be a list of strings denoting environment variables that are allowed to ``leak'' from the daemon's environment to the build environment. This is only applicable to fixed-output derivations---i.e., when @var{hash} is true. The main use is to allow variables such as @code{http_proxy} to be passed to derivations that download files."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9624
- msgid "When @var{local-build?} is true, declare that the derivation is not a good candidate for offloading and should rather be built locally (@pxref{Daemon Offload Setup}). This is the case for small derivations where the costs of data transfers would outweigh the benefits."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9629
- msgid "When @var{substitutable?} is false, declare that substitutes of the derivation's output should not be used (@pxref{Substitutes}). This is useful, for instance, when building packages that capture details of the host CPU instruction set."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9632
- msgid "@var{properties} must be an association list describing ``properties'' of the derivation. It is kept as-is, uninterpreted, in the derivation."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9638
- msgid "Here's an example with a shell script as its builder, assuming @var{store} is an open connection to the daemon, and @var{bash} points to a Bash executable in the store:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:9643
- #, no-wrap
- msgid ""
- "(use-modules (guix utils)\n"
- " (guix store)\n"
- " (guix derivations))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:9652
- #, no-wrap
- msgid ""
- "(let ((builder ; add the Bash script to the store\n"
- " (add-text-to-store store \"my-builder.sh\"\n"
- " \"echo hello world > $out\\n\" '())))\n"
- " (derivation store \"foo\"\n"
- " bash `(\"-e\" ,builder)\n"
- " #:inputs `((,bash) (,builder))\n"
- " #:env-vars '((\"HOME\" . \"/homeless\"))))\n"
- "@result{} #<derivation /gnu/store/@dots{}-foo.drv => /gnu/store/@dots{}-foo>\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9659
- msgid "As can be guessed, this primitive is cumbersome to use directly. A better approach is to write build scripts in Scheme, of course! The best course of action for that is to write the build code as a ``G-expression'', and to pass it to @code{gexp->derivation}. For more information, @pxref{G-Expressions}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9664
- msgid "Once upon a time, @code{gexp->derivation} did not exist and constructing derivations with build code written in Scheme was achieved with @code{build-expression->derivation}, documented below. This procedure is now deprecated in favor of the much nicer @code{gexp->derivation}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9665
- #, no-wrap
- msgid "{Scheme Procedure} build-expression->derivation @var{store} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9681
- msgid "@var{name} @var{exp} @ [#:system (%current-system)] [#:inputs '()] @ [#:outputs '(\"out\")] [#:hash #f] [#:hash-algo #f] @ [#:recursive? #f] [#:env-vars '()] [#:modules '()] @ [#:references-graphs #f] [#:allowed-references #f] @ [#:disallowed-references #f] @ [#:local-build? #f] [#:substitutable? #t] [#:guile-for-build #f] Return a derivation that executes Scheme expression @var{exp} as a builder for derivation @var{name}. @var{inputs} must be a list of @code{(name drv-path sub-drv)} tuples; when @var{sub-drv} is omitted, @code{\"out\"} is assumed. @var{modules} is a list of names of Guile modules from the current search path to be copied in the store, compiled, and made available in the load path during the execution of @var{exp}---e.g., @code{((guix build utils) (guix build gnu-build-system))}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9689
- msgid "@var{exp} is evaluated in an environment where @code{%outputs} is bound to a list of output/path pairs, and where @code{%build-inputs} is bound to a list of string/output-path pairs made from @var{inputs}. Optionally, @var{env-vars} is a list of string pairs specifying the name and value of environment variables visible to the builder. The builder terminates by passing the result of @var{exp} to @code{exit}; thus, when @var{exp} returns @code{#f}, the build is considered to have failed."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9693
- msgid "@var{exp} is built using @var{guile-for-build} (a derivation). When @var{guile-for-build} is omitted or is @code{#f}, the value of the @code{%guile-for-build} fluid is used instead."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9698
- msgid "See the @code{derivation} procedure for the meaning of @var{references-graphs}, @var{allowed-references}, @var{disallowed-references}, @var{local-build?}, and @var{substitutable?}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9703
- msgid "Here's an example of a single-output derivation that creates a directory containing one file:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:9711
- #, no-wrap
- msgid ""
- "(let ((builder '(let ((out (assoc-ref %outputs \"out\")))\n"
- " (mkdir out) ; create /gnu/store/@dots{}-goo\n"
- " (call-with-output-file (string-append out \"/test\")\n"
- " (lambda (p)\n"
- " (display '(hello guix) p))))))\n"
- " (build-expression->derivation store \"goo\" builder))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:9713
- #, no-wrap
- msgid "@result{} #<derivation /gnu/store/@dots{}-goo.drv => @dots{}>\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:9719
- #, no-wrap
- msgid "monad"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9725
- msgid "The procedures that operate on the store described in the previous sections all take an open connection to the build daemon as their first argument. Although the underlying model is functional, they either have side effects or depend on the current state of the store."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9731
- msgid "The former is inconvenient: the connection to the build daemon has to be carried around in all those functions, making it impossible to compose functions that do not take that parameter with functions that do. The latter can be problematic: since store operations have side effects and/or depend on external state, they have to be properly sequenced."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:9732
- #, no-wrap
- msgid "monadic values"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:9733
- #, no-wrap
- msgid "monadic functions"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9743
- msgid "This is where the @code{(guix monads)} module comes in. This module provides a framework for working with @dfn{monads}, and a particularly useful monad for our uses, the @dfn{store monad}. Monads are a construct that allows two things: associating ``context'' with values (in our case, the context is the store), and building sequences of computations (here computations include accesses to the store). Values in a monad---values that carry this additional context---are called @dfn{monadic values}; procedures that return such values are called @dfn{monadic procedures}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9745
- msgid "Consider this ``normal'' procedure:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:9754
- #, no-wrap
- msgid ""
- "(define (sh-symlink store)\n"
- " ;; Return a derivation that symlinks the 'bash' executable.\n"
- " (let* ((drv (package-derivation store bash))\n"
- " (out (derivation->output-path drv))\n"
- " (sh (string-append out \"/bin/bash\")))\n"
- " (build-expression->derivation store \"sh\"\n"
- " `(symlink ,sh %output))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9758
- msgid "Using @code{(guix monads)} and @code{(guix gexp)}, it may be rewritten as a monadic function:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:9766
- #, no-wrap
- msgid ""
- "(define (sh-symlink)\n"
- " ;; Same, but return a monadic value.\n"
- " (mlet %store-monad ((drv (package->derivation bash)))\n"
- " (gexp->derivation \"sh\"\n"
- " #~(symlink (string-append #$drv \"/bin/bash\")\n"
- " #$output))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9773
- msgid "There are several things to note in the second version: the @code{store} parameter is now implicit and is ``threaded'' in the calls to the @code{package->derivation} and @code{gexp->derivation} monadic procedures, and the monadic value returned by @code{package->derivation} is @dfn{bound} using @code{mlet} instead of plain @code{let}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9777
- msgid "As it turns out, the call to @code{package->derivation} can even be omitted since it will take place implicitly, as we will see later (@pxref{G-Expressions}):"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:9783
- #, no-wrap
- msgid ""
- "(define (sh-symlink)\n"
- " (gexp->derivation \"sh\"\n"
- " #~(symlink (string-append #$bash \"/bin/bash\")\n"
- " #$output)))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9792
- msgid "Calling the monadic @code{sh-symlink} has no effect. As someone once said, ``you exit a monad like you exit a building on fire: by running''. So, to exit the monad and get the desired effect, one must use @code{run-with-store}:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:9796
- #, no-wrap
- msgid ""
- "(run-with-store (open-connection) (sh-symlink))\n"
- "@result{} /gnu/store/...-sh-symlink\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9802
- msgid "Note that the @code{(guix monad-repl)} module extends the Guile REPL with new ``meta-commands'' to make it easier to deal with monadic procedures: @code{run-in-store}, and @code{enter-store-monad}. The former is used to ``run'' a single monadic value through the store:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:9806
- #, no-wrap
- msgid ""
- "scheme@@(guile-user)> ,run-in-store (package->derivation hello)\n"
- "$1 = #<derivation /gnu/store/@dots{}-hello-2.9.drv => @dots{}>\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9810
- msgid "The latter enters a recursive REPL, where all the return values are automatically run through the store:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:9819
- #, no-wrap
- msgid ""
- "scheme@@(guile-user)> ,enter-store-monad\n"
- "store-monad@@(guile-user) [1]> (package->derivation hello)\n"
- "$2 = #<derivation /gnu/store/@dots{}-hello-2.9.drv => @dots{}>\n"
- "store-monad@@(guile-user) [1]> (text-file \"foo\" \"Hello!\")\n"
- "$3 = \"/gnu/store/@dots{}-foo\"\n"
- "store-monad@@(guile-user) [1]> ,q\n"
- "scheme@@(guile-user)>\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9824
- msgid "Note that non-monadic values cannot be returned in the @code{store-monad} REPL."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9827
- msgid "The main syntactic forms to deal with monads in general are provided by the @code{(guix monads)} module and are described below."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9828
- #, no-wrap
- msgid "{Scheme Syntax} with-monad @var{monad} @var{body} ..."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9831
- msgid "Evaluate any @code{>>=} or @code{return} forms in @var{body} as being in @var{monad}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9833
- #, no-wrap
- msgid "{Scheme Syntax} return @var{val}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9835
- msgid "Return a monadic value that encapsulates @var{val}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9837
- #, no-wrap
- msgid "{Scheme Syntax} >>= @var{mval} @var{mproc} ..."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9844
- msgid "@dfn{Bind} monadic value @var{mval}, passing its ``contents'' to monadic procedures @var{mproc}@dots{}@footnote{This operation is commonly referred to as ``bind'', but that name denotes an unrelated procedure in Guile. Thus we use this somewhat cryptic symbol inherited from the Haskell language.}. There can be one @var{mproc} or several of them, as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:9852
- #, no-wrap
- msgid ""
- "(run-with-state\n"
- " (with-monad %state-monad\n"
- " (>>= (return 1)\n"
- " (lambda (x) (return (+ 1 x)))\n"
- " (lambda (x) (return (* 2 x)))))\n"
- " 'some-state)\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:9855
- #, no-wrap
- msgid ""
- "@result{} 4\n"
- "@result{} some-state\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9858
- #, no-wrap
- msgid "{Scheme Syntax} mlet @var{monad} ((@var{var} @var{mval}) ...) @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9860
- msgid "@var{body} ..."
- msgstr ""
- #. type: deffnx
- #: guix-git/doc/guix.texi:9860
- #, no-wrap
- msgid "{Scheme Syntax} mlet* @var{monad} ((@var{var} @var{mval}) ...) @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9872
- msgid "@var{body} ... Bind the variables @var{var} to the monadic values @var{mval} in @var{body}, which is a sequence of expressions. As with the bind operator, this can be thought of as ``unpacking'' the raw, non-monadic value ``contained'' in @var{mval} and making @var{var} refer to that raw, non-monadic value within the scope of the @var{body}. The form (@var{var} -> @var{val}) binds @var{var} to the ``normal'' value @var{val}, as per @code{let}. The binding operations occur in sequence from left to right. The last expression of @var{body} must be a monadic expression, and its result will become the result of the @code{mlet} or @code{mlet*} when run in the @var{monad}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9875
- msgid "@code{mlet*} is to @code{mlet} what @code{let*} is to @code{let} (@pxref{Local Bindings,,, guile, GNU Guile Reference Manual})."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9877
- #, no-wrap
- msgid "{Scheme System} mbegin @var{monad} @var{mexp} ..."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9881
- msgid "Bind @var{mexp} and the following monadic expressions in sequence, returning the result of the last expression. Every expression in the sequence must be a monadic expression."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9885
- msgid "This is akin to @code{mlet}, except that the return values of the monadic expressions are ignored. In that sense, it is analogous to @code{begin}, but applied to monadic expressions."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9887
- #, no-wrap
- msgid "{Scheme System} mwhen @var{condition} @var{mexp0} @var{mexp*} ..."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9892
- msgid "When @var{condition} is true, evaluate the sequence of monadic expressions @var{mexp0}..@var{mexp*} as in an @code{mbegin}. When @var{condition} is false, return @code{*unspecified*} in the current monad. Every expression in the sequence must be a monadic expression."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9894
- #, no-wrap
- msgid "{Scheme System} munless @var{condition} @var{mexp0} @var{mexp*} ..."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9899
- msgid "When @var{condition} is false, evaluate the sequence of monadic expressions @var{mexp0}..@var{mexp*} as in an @code{mbegin}. When @var{condition} is true, return @code{*unspecified*} in the current monad. Every expression in the sequence must be a monadic expression."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:9901
- #, no-wrap
- msgid "state monad"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9905
- msgid "The @code{(guix monads)} module provides the @dfn{state monad}, which allows an additional value---the state---to be @emph{threaded} through monadic procedure calls."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:9906
- #, no-wrap
- msgid "{Scheme Variable} %state-monad"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:9909
- msgid "The state monad. Procedures in the state monad can access and change the state that is threaded."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:9913
- msgid "Consider the example below. The @code{square} procedure returns a value in the state monad. It returns the square of its argument, but also increments the current state value:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:9920
- #, no-wrap
- msgid ""
- "(define (square x)\n"
- " (mlet %state-monad ((count (current-state)))\n"
- " (mbegin %state-monad\n"
- " (set-current-state (+ 1 count))\n"
- " (return (* x x)))))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:9924
- #, no-wrap
- msgid ""
- "(run-with-state (sequence %state-monad (map square (iota 3))) 0)\n"
- "@result{} (0 1 4)\n"
- "@result{} 3\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:9928
- msgid "When ``run'' through @code{%state-monad}, we obtain that additional state value, which is the number of @code{square} calls."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9930
- #, no-wrap
- msgid "{Monadic Procedure} current-state"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9932
- msgid "Return the current state as a monadic value."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9934
- #, no-wrap
- msgid "{Monadic Procedure} set-current-state @var{value}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9937
- msgid "Set the current state to @var{value} and return the previous state as a monadic value."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9939
- #, no-wrap
- msgid "{Monadic Procedure} state-push @var{value}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9942
- msgid "Push @var{value} to the current state, which is assumed to be a list, and return the previous state as a monadic value."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9944
- #, no-wrap
- msgid "{Monadic Procedure} state-pop"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9947
- msgid "Pop a value from the current state and return it as a monadic value. The state is assumed to be a list."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9949
- #, no-wrap
- msgid "{Scheme Procedure} run-with-state @var{mval} [@var{state}]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9952
- msgid "Run monadic value @var{mval} starting with @var{state} as the initial state. Return two values: the resulting value, and the resulting state."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:9956
- msgid "The main interface to the store monad, provided by the @code{(guix store)} module, is as follows."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:9957
- #, no-wrap
- msgid "{Scheme Variable} %store-monad"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:9959
- msgid "The store monad---an alias for @code{%state-monad}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:9963
- msgid "Values in the store monad encapsulate accesses to the store. When its effect is needed, a value of the store monad must be ``evaluated'' by passing it to the @code{run-with-store} procedure (see below)."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9965
- #, no-wrap
- msgid "{Scheme Procedure} run-with-store @var{store} @var{mval} [#:guile-for-build] [#:system (%current-system)]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9968
- msgid "Run @var{mval}, a monadic value in the store monad, in @var{store}, an open store connection."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9970
- #, no-wrap
- msgid "{Monadic Procedure} text-file @var{name} @var{text} [@var{references}]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9974
- msgid "Return as a monadic value the absolute file name in the store of the file containing @var{text}, a string. @var{references} is a list of store items that the resulting text file refers to; it defaults to the empty list."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9976
- #, no-wrap
- msgid "{Monadic Procedure} binary-file @var{name} @var{data} [@var{references}]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9980
- msgid "Return as a monadic value the absolute file name in the store of the file containing @var{data}, a bytevector. @var{references} is a list of store items that the resulting binary file refers to; it defaults to the empty list."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9982
- #, no-wrap
- msgid "{Monadic Procedure} interned-file @var{file} [@var{name}] @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9987
- msgid "[#:recursive? #t] [#:select? (const #t)] Return the name of @var{file} once interned in the store. Use @var{name} as its store name, or the basename of @var{file} if @var{name} is omitted."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9991 guix-git/doc/guix.texi:10414
- msgid "When @var{recursive?} is true, the contents of @var{file} are added recursively; if @var{file} designates a flat file and @var{recursive?} is true, its contents are added, and its permission bits are kept."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9996 guix-git/doc/guix.texi:10419
- msgid "When @var{recursive?} is true, call @code{(@var{select?} @var{file} @var{stat})} for each directory entry, where @var{file} is the entry's absolute file name and @var{stat} is the result of @code{lstat}; exclude entries for which @var{select?} does not return true."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:9998
- msgid "The example below adds a file to the store, under two different names:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:10004
- #, no-wrap
- msgid ""
- "(run-with-store (open-connection)\n"
- " (mlet %store-monad ((a (interned-file \"README\"))\n"
- " (b (interned-file \"README\" \"LEGU-MIN\")))\n"
- " (return (list a b))))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:10006
- #, no-wrap
- msgid "@result{} (\"/gnu/store/rwm@dots{}-README\" \"/gnu/store/44i@dots{}-LEGU-MIN\")\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10012
- msgid "The @code{(guix packages)} module exports the following package-related monadic procedures:"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10013
- #, no-wrap
- msgid "{Monadic Procedure} package-file @var{package} [@var{file}] @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10021
- msgid "[#:system (%current-system)] [#:target #f] @ [#:output \"out\"] Return as a monadic value in the absolute file name of @var{file} within the @var{output} directory of @var{package}. When @var{file} is omitted, return the name of the @var{output} directory of @var{package}. When @var{target} is true, use it as a cross-compilation target triplet."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10025
- msgid "Note that this procedure does @emph{not} build @var{package}. Thus, the result might or might not designate an existing file. We recommend not using this procedure unless you know what you are doing."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10027
- #, no-wrap
- msgid "{Monadic Procedure} package->derivation @var{package} [@var{system}]"
- msgstr ""
- #. type: deffnx
- #: guix-git/doc/guix.texi:10028
- #, no-wrap
- msgid "{Monadic Procedure} package->cross-derivation @var{package} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10032
- msgid "@var{target} [@var{system}] Monadic version of @code{package-derivation} and @code{package-cross-derivation} (@pxref{Defining Packages})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:10038
- #, no-wrap
- msgid "G-expression"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:10039
- #, no-wrap
- msgid "build code quoting"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10045
- msgid "So we have ``derivations'', which represent a sequence of build actions to be performed to produce an item in the store (@pxref{Derivations}). These build actions are performed when asking the daemon to actually build the derivations; they are run by the daemon in a container (@pxref{Invoking guix-daemon})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:10048
- #, no-wrap
- msgid "strata of code"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10060
- msgid "It should come as no surprise that we like to write these build actions in Scheme. When we do that, we end up with two @dfn{strata} of Scheme code@footnote{The term @dfn{stratum} in this context was coined by Manuel Serrano et al.@: in the context of their work on Hop. Oleg Kiselyov, who has written insightful @url{http://okmij.org/ftp/meta-programming/#meta-scheme, essays and code on this topic}, refers to this kind of code generation as @dfn{staging}.}: the ``host code''---code that defines packages, talks to the daemon, etc.---and the ``build code''---code that actually performs build actions, such as making directories, invoking @command{make}, and so on (@pxref{Build Phases})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10067
- msgid "To describe a derivation and its build actions, one typically needs to embed build code inside host code. It boils down to manipulating build code as data, and the homoiconicity of Scheme---code has a direct representation as data---comes in handy for that. But we need more than the normal @code{quasiquote} mechanism in Scheme to construct build expressions."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10076
- msgid "The @code{(guix gexp)} module implements @dfn{G-expressions}, a form of S-expressions adapted to build expressions. G-expressions, or @dfn{gexps}, consist essentially of three syntactic forms: @code{gexp}, @code{ungexp}, and @code{ungexp-splicing} (or simply: @code{#~}, @code{#$}, and @code{#$@@}), which are comparable to @code{quasiquote}, @code{unquote}, and @code{unquote-splicing}, respectively (@pxref{Expression Syntax, @code{quasiquote},, guile, GNU Guile Reference Manual}). However, there are major differences:"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:10081
- msgid "Gexps are meant to be written to a file and run or manipulated by other processes."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:10086
- msgid "When a high-level object such as a package or derivation is unquoted inside a gexp, the result is as if its output file name had been introduced."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:10091
- msgid "Gexps carry information about the packages or derivations they refer to, and these dependencies are automatically added as inputs to the build processes that use them."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:10093 guix-git/doc/guix.texi:10650
- #, no-wrap
- msgid "lowering, of high-level objects in gexps"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10103
- msgid "This mechanism is not limited to package and derivation objects: @dfn{compilers} able to ``lower'' other high-level objects to derivations or files in the store can be defined, such that these objects can also be inserted into gexps. For example, a useful type of high-level objects that can be inserted in a gexp is ``file-like objects'', which make it easy to add files to the store and to refer to them in derivations and such (see @code{local-file} and @code{plain-file} below)."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10105
- msgid "To illustrate the idea, here is an example of a gexp:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:10113
- #, no-wrap
- msgid ""
- "(define build-exp\n"
- " #~(begin\n"
- " (mkdir #$output)\n"
- " (chdir #$output)\n"
- " (symlink (string-append #$coreutils \"/bin/ls\")\n"
- " \"list-files\")))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10118
- msgid "This gexp can be passed to @code{gexp->derivation}; we obtain a derivation that builds a directory containing exactly one symlink to @file{/gnu/store/@dots{}-coreutils-8.22/bin/ls}:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:10121
- #, no-wrap
- msgid "(gexp->derivation \"the-thing\" build-exp)\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10129
- msgid "As one would expect, the @code{\"/gnu/store/@dots{}-coreutils-8.22\"} string is substituted to the reference to the @var{coreutils} package in the actual build code, and @var{coreutils} is automatically made an input to the derivation. Likewise, @code{#$output} (equivalent to @code{(ungexp output)}) is replaced by a string containing the directory name of the output of the derivation."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:10130
- #, no-wrap
- msgid "cross compilation"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10136
- msgid "In a cross-compilation context, it is useful to distinguish between references to the @emph{native} build of a package---that can run on the host---versus references to cross builds of a package. To that end, the @code{#+} plays the same role as @code{#$}, but is a reference to a native package build:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:10147
- #, no-wrap
- msgid ""
- "(gexp->derivation \"vi\"\n"
- " #~(begin\n"
- " (mkdir #$output)\n"
- " (mkdir (string-append #$output \"/bin\"))\n"
- " (system* (string-append #+coreutils \"/bin/ln\")\n"
- " \"-s\"\n"
- " (string-append #$emacs \"/bin/emacs\")\n"
- " (string-append #$output \"/bin/vi\")))\n"
- " #:target \"aarch64-linux-gnu\")\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10153
- msgid "In the example above, the native build of @var{coreutils} is used, so that @command{ln} can actually run on the host; but then the cross-compiled build of @var{emacs} is referenced."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:10154
- #, no-wrap
- msgid "imported modules, for gexps"
- msgstr ""
- #. type: findex
- #: guix-git/doc/guix.texi:10155
- #, no-wrap
- msgid "with-imported-modules"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10160
- msgid "Another gexp feature is @dfn{imported modules}: sometimes you want to be able to use certain Guile modules from the ``host environment'' in the gexp, so those modules should be imported in the ``build environment''. The @code{with-imported-modules} form allows you to express that:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:10171
- #, no-wrap
- msgid ""
- "(let ((build (with-imported-modules '((guix build utils))\n"
- " #~(begin\n"
- " (use-modules (guix build utils))\n"
- " (mkdir-p (string-append #$output \"/bin\"))))))\n"
- " (gexp->derivation \"empty-dir\"\n"
- " #~(begin\n"
- " #$build\n"
- " (display \"success!\\n\")\n"
- " #t)))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10177
- msgid "In this example, the @code{(guix build utils)} module is automatically pulled into the isolated build environment of our gexp, such that @code{(use-modules (guix build utils))} works as expected."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:10178
- #, no-wrap
- msgid "module closure"
- msgstr ""
- #. type: findex
- #: guix-git/doc/guix.texi:10179
- #, no-wrap
- msgid "source-module-closure"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10186
- msgid "Usually you want the @emph{closure} of the module to be imported---i.e., the module itself and all the modules it depends on---rather than just the module; failing to do that, attempts to use the module will fail because of missing dependent modules. The @code{source-module-closure} procedure computes the closure of a module by looking at its source file headers, which comes in handy in this case:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:10189
- #, no-wrap
- msgid ""
- "(use-modules (guix modules)) ;for 'source-module-closure'\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:10198
- #, no-wrap
- msgid ""
- "(with-imported-modules (source-module-closure\n"
- " '((guix build utils)\n"
- " (gnu build image)))\n"
- " (gexp->derivation \"something-with-vms\"\n"
- " #~(begin\n"
- " (use-modules (guix build utils)\n"
- " (gnu build image))\n"
- " @dots{})))\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:10200
- #, no-wrap
- msgid "extensions, for gexps"
- msgstr ""
- #. type: findex
- #: guix-git/doc/guix.texi:10201
- #, no-wrap
- msgid "with-extensions"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10206
- msgid "In the same vein, sometimes you want to import not just pure-Scheme modules, but also ``extensions'' such as Guile bindings to C libraries or other ``full-blown'' packages. Say you need the @code{guile-json} package available on the build side, here's how you would do it:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:10209
- #, no-wrap
- msgid ""
- "(use-modules (gnu packages guile)) ;for 'guile-json'\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:10215
- #, no-wrap
- msgid ""
- "(with-extensions (list guile-json)\n"
- " (gexp->derivation \"something-with-json\"\n"
- " #~(begin\n"
- " (use-modules (json))\n"
- " @dots{})))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10218
- msgid "The syntactic form to construct gexps is summarized below."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10219
- #, no-wrap
- msgid "{Scheme Syntax} #~@var{exp}"
- msgstr ""
- #. type: deffnx
- #: guix-git/doc/guix.texi:10220
- #, no-wrap
- msgid "{Scheme Syntax} (gexp @var{exp})"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10223
- msgid "Return a G-expression containing @var{exp}. @var{exp} may contain one or more of the following forms:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:10225
- #, no-wrap
- msgid "#$@var{obj}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:10226
- #, no-wrap
- msgid "(ungexp @var{obj})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10231
- msgid "Introduce a reference to @var{obj}. @var{obj} may have one of the supported types, for example a package or a derivation, in which case the @code{ungexp} form is replaced by its output file name---e.g., @code{\"/gnu/store/@dots{}-coreutils-8.22}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10234
- msgid "If @var{obj} is a list, it is traversed and references to supported objects are substituted similarly."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10237
- msgid "If @var{obj} is another gexp, its contents are inserted and its dependencies are added to those of the containing gexp."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10239
- msgid "If @var{obj} is another kind of object, it is inserted as is."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:10240
- #, no-wrap
- msgid "#$@var{obj}:@var{output}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:10241
- #, no-wrap
- msgid "(ungexp @var{obj} @var{output})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10245
- msgid "This is like the form above, but referring explicitly to the @var{output} of @var{obj}---this is useful when @var{obj} produces multiple outputs (@pxref{Packages with Multiple Outputs})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:10246
- #, no-wrap
- msgid "#+@var{obj}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:10247
- #, no-wrap
- msgid "#+@var{obj}:output"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:10248
- #, no-wrap
- msgid "(ungexp-native @var{obj})"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:10249
- #, no-wrap
- msgid "(ungexp-native @var{obj} @var{output})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10252
- msgid "Same as @code{ungexp}, but produces a reference to the @emph{native} build of @var{obj} when used in a cross compilation context."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:10253
- #, no-wrap
- msgid "#$output[:@var{output}]"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:10254
- #, no-wrap
- msgid "(ungexp output [@var{output}])"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10257
- msgid "Insert a reference to derivation output @var{output}, or to the main output when @var{output} is omitted."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10259
- msgid "This only makes sense for gexps passed to @code{gexp->derivation}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:10260
- #, no-wrap
- msgid "#$@@@var{lst}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:10261
- #, no-wrap
- msgid "(ungexp-splicing @var{lst})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10264
- msgid "Like the above, but splices the contents of @var{lst} inside the containing list."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:10265
- #, no-wrap
- msgid "#+@@@var{lst}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:10266
- #, no-wrap
- msgid "(ungexp-native-splicing @var{lst})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10269
- msgid "Like the above, but refers to native builds of the objects listed in @var{lst}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10274
- msgid "G-expressions created by @code{gexp} or @code{#~} are run-time objects of the @code{gexp?} type (see below)."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10276
- #, no-wrap
- msgid "{Scheme Syntax} with-imported-modules @var{modules} @var{body}@dots{}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10279
- msgid "Mark the gexps defined in @var{body}@dots{} as requiring @var{modules} in their execution environment."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10283
- msgid "Each item in @var{modules} can be the name of a module, such as @code{(guix build utils)}, or it can be a module name, followed by an arrow, followed by a file-like object:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:10289
- #, no-wrap
- msgid ""
- "`((guix build utils)\n"
- " (guix gcrypt)\n"
- " ((guix config) => ,(scheme-file \"config.scm\"\n"
- " #~(define-module @dots{}))))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10294
- msgid "In the example above, the first two modules are taken from the search path, and the last one is created from the given file-like object."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10298
- msgid "This form has @emph{lexical} scope: it has an effect on the gexps directly defined in @var{body}@dots{}, but not on those defined, say, in procedures called from @var{body}@dots{}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10300
- #, no-wrap
- msgid "{Scheme Syntax} with-extensions @var{extensions} @var{body}@dots{}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10305
- msgid "Mark the gexps defined in @var{body}@dots{} as requiring @var{extensions} in their build and execution environment. @var{extensions} is typically a list of package objects such as those defined in the @code{(gnu packages guile)} module."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10310
- msgid "Concretely, the packages listed in @var{extensions} are added to the load path while compiling imported modules in @var{body}@dots{}; they are also added to the load path of the gexp returned by @var{body}@dots{}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10312
- #, no-wrap
- msgid "{Scheme Procedure} gexp? @var{obj}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10314
- msgid "Return @code{#t} if @var{obj} is a G-expression."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10320
- msgid "G-expressions are meant to be written to disk, either as code building some derivation, or as plain files in the store. The monadic procedures below allow you to do that (@pxref{The Store Monad}, for more information about monads)."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10321
- #, no-wrap
- msgid "{Monadic Procedure} gexp->derivation @var{name} @var{exp} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10339
- msgid "[#:system (%current-system)] [#:target #f] [#:graft? #t] @ [#:hash #f] [#:hash-algo #f] @ [#:recursive? #f] [#:env-vars '()] [#:modules '()] @ [#:module-path @code{%load-path}] @ [#:effective-version \"2.2\"] @ [#:references-graphs #f] [#:allowed-references #f] @ [#:disallowed-references #f] @ [#:leaked-env-vars #f] @ [#:script-name (string-append @var{name} \"-builder\")] @ [#:deprecation-warnings #f] @ [#:local-build? #f] [#:substitutable? #t] @ [#:properties '()] [#:guile-for-build #f] Return a derivation @var{name} that runs @var{exp} (a gexp) with @var{guile-for-build} (a derivation) on @var{system}; @var{exp} is stored in a file called @var{script-name}. When @var{target} is true, it is used as the cross-compilation target triplet for packages referred to by @var{exp}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10347
- msgid "@var{modules} is deprecated in favor of @code{with-imported-modules}. Its meaning is to make @var{modules} available in the evaluation context of @var{exp}; @var{modules} is a list of names of Guile modules searched in @var{module-path} to be copied in the store, compiled, and made available in the load path during the execution of @var{exp}---e.g., @code{((guix build utils) (guix build gnu-build-system))}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10350
- msgid "@var{effective-version} determines the string to use when adding extensions of @var{exp} (see @code{with-extensions}) to the search path---e.g., @code{\"2.2\"}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10353
- msgid "@var{graft?} determines whether packages referred to by @var{exp} should be grafted when applicable."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10356
- msgid "When @var{references-graphs} is true, it must be a list of tuples of one of the following forms:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:10363
- #, no-wrap
- msgid ""
- "(@var{file-name} @var{package})\n"
- "(@var{file-name} @var{package} @var{output})\n"
- "(@var{file-name} @var{derivation})\n"
- "(@var{file-name} @var{derivation} @var{output})\n"
- "(@var{file-name} @var{store-item})\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10369
- msgid "The right-hand-side of each element of @var{references-graphs} is automatically made an input of the build process of @var{exp}. In the build environment, each @var{file-name} contains the reference graph of the corresponding item, in a simple text format."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10375
- msgid "@var{allowed-references} must be either @code{#f} or a list of output names and packages. In the latter case, the list denotes store items that the result is allowed to refer to. Any reference to another store item will lead to a build error. Similarly for @var{disallowed-references}, which can list items that must not be referenced by the outputs."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10378
- msgid "@var{deprecation-warnings} determines whether to show deprecation warnings while compiling modules. It can be @code{#f}, @code{#t}, or @code{'detailed}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10380
- msgid "The other arguments are as for @code{derivation} (@pxref{Derivations})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:10382
- #, no-wrap
- msgid "file-like objects"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10387
- msgid "The @code{local-file}, @code{plain-file}, @code{computed-file}, @code{program-file}, and @code{scheme-file} procedures below return @dfn{file-like objects}. That is, when unquoted in a G-expression, these objects lead to a file in the store. Consider this G-expression:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:10391
- #, no-wrap
- msgid ""
- "#~(system* #$(file-append glibc \"/sbin/nscd\") \"-f\"\n"
- " #$(local-file \"/tmp/my-nscd.conf\"))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10400
- msgid "The effect here is to ``intern'' @file{/tmp/my-nscd.conf} by copying it to the store. Once expanded, for instance @i{via} @code{gexp->derivation}, the G-expression refers to that copy under @file{/gnu/store}; thus, modifying or removing the file in @file{/tmp} does not have any effect on what the G-expression does. @code{plain-file} can be used similarly; it differs in that the file content is directly passed as a string."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10401
- #, no-wrap
- msgid "{Scheme Procedure} local-file @var{file} [@var{name}] @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10410
- msgid "[#:recursive? #f] [#:select? (const #t)] Return an object representing local file @var{file} to add to the store; this object can be used in a gexp. If @var{file} is a literal string denoting a relative file name, it is looked up relative to the source file where it appears; if @var{file} is not a literal string, it is looked up relative to the current working directory at run time. @var{file} will be added to the store under @var{name}--by default the base name of @var{file}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10422
- msgid "This is the declarative counterpart of the @code{interned-file} monadic procedure (@pxref{The Store Monad, @code{interned-file}})."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10424
- #, no-wrap
- msgid "{Scheme Procedure} plain-file @var{name} @var{content}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10427
- msgid "Return an object representing a text file called @var{name} with the given @var{content} (a string or a bytevector) to be added to the store."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10429
- msgid "This is the declarative counterpart of @code{text-file}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10431
- #, no-wrap
- msgid "{Scheme Procedure} computed-file @var{name} @var{gexp} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10438
- msgid "[#:local-build? #t] [#:options '()] Return an object representing the store item @var{name}, a file or directory computed by @var{gexp}. When @var{local-build?} is true (the default), the derivation is built locally. @var{options} is a list of additional arguments to pass to @code{gexp->derivation}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10440
- msgid "This is the declarative counterpart of @code{gexp->derivation}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10442
- #, no-wrap
- msgid "{Monadic Procedure} gexp->script @var{name} @var{exp} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10448
- msgid "[#:guile (default-guile)] [#:module-path %load-path] @ [#:system (%current-system)] [#:target #f] Return an executable script @var{name} that runs @var{exp} using @var{guile}, with @var{exp}'s imported modules in its search path. Look up @var{exp}'s modules in @var{module-path}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10451
- msgid "The example below builds a script that simply invokes the @command{ls} command:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:10454
- #, no-wrap
- msgid ""
- "(use-modules (guix gexp) (gnu packages base))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:10458
- #, no-wrap
- msgid ""
- "(gexp->script \"list-files\"\n"
- " #~(execl #$(file-append coreutils \"/bin/ls\")\n"
- " \"ls\"))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10463
- msgid "When ``running'' it through the store (@pxref{The Store Monad, @code{run-with-store}}), we obtain a derivation that produces an executable file @file{/gnu/store/@dots{}-list-files} along these lines:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:10468
- #, no-wrap
- msgid ""
- "#!/gnu/store/@dots{}-guile-2.0.11/bin/guile -ds\n"
- "!#\n"
- "(execl \"/gnu/store/@dots{}-coreutils-8.22\"/bin/ls\" \"ls\")\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10471
- #, no-wrap
- msgid "{Scheme Procedure} program-file @var{name} @var{exp} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10476
- msgid "[#:guile #f] [#:module-path %load-path] Return an object representing the executable store item @var{name} that runs @var{gexp}. @var{guile} is the Guile package used to execute that script. Imported modules of @var{gexp} are looked up in @var{module-path}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10478
- msgid "This is the declarative counterpart of @code{gexp->script}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10480
- #, no-wrap
- msgid "{Monadic Procedure} gexp->file @var{name} @var{exp} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10487
- msgid "[#:set-load-path? #t] [#:module-path %load-path] @ [#:splice? #f] @ [#:guile (default-guile)] Return a derivation that builds a file @var{name} containing @var{exp}. When @var{splice?} is true, @var{exp} is considered to be a list of expressions that will be spliced in the resulting file."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10492
- msgid "When @var{set-load-path?} is true, emit code in the resulting file to set @code{%load-path} and @code{%load-compiled-path} to honor @var{exp}'s imported modules. Look up @var{exp}'s modules in @var{module-path}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10495
- msgid "The resulting file holds references to all the dependencies of @var{exp} or a subset thereof."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10497
- #, no-wrap
- msgid "{Scheme Procedure} scheme-file @var{name} @var{exp} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10501
- msgid "[#:splice? #f] [#:set-load-path? #t] Return an object representing the Scheme file @var{name} that contains @var{exp}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10503
- msgid "This is the declarative counterpart of @code{gexp->file}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10505
- #, no-wrap
- msgid "{Monadic Procedure} text-file* @var{name} @var{text} @dots{}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10511
- msgid "Return as a monadic value a derivation that builds a text file containing all of @var{text}. @var{text} may list, in addition to strings, objects of any type that can be used in a gexp: packages, derivations, local file objects, etc. The resulting store file holds references to all these."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10516
- msgid "This variant should be preferred over @code{text-file} anytime the file to create will reference items from the store. This is typically the case when building a configuration file that embeds store file names, like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:10524
- #, no-wrap
- msgid ""
- "(define (profile.sh)\n"
- " ;; Return the name of a shell script in the store that\n"
- " ;; initializes the 'PATH' environment variable.\n"
- " (text-file* \"profile.sh\"\n"
- " \"export PATH=\" coreutils \"/bin:\"\n"
- " grep \"/bin:\" sed \"/bin\\n\"))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10529
- msgid "In this example, the resulting @file{/gnu/store/@dots{}-profile.sh} file will reference @var{coreutils}, @var{grep}, and @var{sed}, thereby preventing them from being garbage-collected during its lifetime."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10531
- #, no-wrap
- msgid "{Scheme Procedure} mixed-text-file @var{name} @var{text} @dots{}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10535
- msgid "Return an object representing store file @var{name} containing @var{text}. @var{text} is a sequence of strings and file-like objects, as in:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:10539
- #, no-wrap
- msgid ""
- "(mixed-text-file \"profile\"\n"
- " \"export PATH=\" coreutils \"/bin:\" grep \"/bin\")\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10542
- msgid "This is the declarative counterpart of @code{text-file*}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10544
- #, no-wrap
- msgid "{Scheme Procedure} file-union @var{name} @var{files}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10549
- msgid "Return a @code{<computed-file>} that builds a directory containing all of @var{files}. Each item in @var{files} must be a two-element list where the first element is the file name to use in the new directory, and the second element is a gexp denoting the target file. Here's an example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:10556
- #, no-wrap
- msgid ""
- "(file-union \"etc\"\n"
- " `((\"hosts\" ,(plain-file \"hosts\"\n"
- " \"127.0.0.1 localhost\"))\n"
- " (\"bashrc\" ,(plain-file \"bashrc\"\n"
- " \"alias ls='ls --color=auto'\"))))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10559
- msgid "This yields an @code{etc} directory containing these two files."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10561
- #, no-wrap
- msgid "{Scheme Procedure} directory-union @var{name} @var{things}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10564
- msgid "Return a directory that is the union of @var{things}, where @var{things} is a list of file-like objects denoting directories. For example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:10567
- #, no-wrap
- msgid "(directory-union \"guile+emacs\" (list guile emacs))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10570
- msgid "yields a directory that is the union of the @code{guile} and @code{emacs} packages."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10572
- #, no-wrap
- msgid "{Scheme Procedure} file-append @var{obj} @var{suffix} @dots{}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10576
- msgid "Return a file-like object that expands to the concatenation of @var{obj} and @var{suffix}, where @var{obj} is a lowerable object and each @var{suffix} is a string."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10578
- msgid "As an example, consider this gexp:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:10583
- #, no-wrap
- msgid ""
- "(gexp->script \"run-uname\"\n"
- " #~(system* #$(file-append coreutils\n"
- " \"/bin/uname\")))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10586
- msgid "The same effect could be achieved with:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:10591
- #, no-wrap
- msgid ""
- "(gexp->script \"run-uname\"\n"
- " #~(system* (string-append #$coreutils\n"
- " \"/bin/uname\")))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10597
- msgid "There is one difference though: in the @code{file-append} case, the resulting script contains the absolute file name as a string, whereas in the second case, the resulting script contains a @code{(string-append @dots{})} expression to construct the file name @emph{at run time}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10599
- #, no-wrap
- msgid "{Scheme Syntax} let-system @var{system} @var{body}@dots{}"
- msgstr ""
- #. type: deffnx
- #: guix-git/doc/guix.texi:10600
- #, no-wrap
- msgid "{Scheme Syntax} let-system (@var{system} @var{target}) @var{body}@dots{}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10603
- msgid "Bind @var{system} to the currently targeted system---e.g., @code{\"x86_64-linux\"}---within @var{body}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10608
- msgid "In the second case, additionally bind @var{target} to the current cross-compilation target---a GNU triplet such as @code{\"arm-linux-gnueabihf\"}---or @code{#f} if we are not cross-compiling."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10611
- msgid "@code{let-system} is useful in the occasional case where the object spliced into the gexp depends on the target system, as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:10622
- #, no-wrap
- msgid ""
- "#~(system*\n"
- " #+(let-system system\n"
- " (cond ((string-prefix? \"armhf-\" system)\n"
- " (file-append qemu \"/bin/qemu-system-arm\"))\n"
- " ((string-prefix? \"x86_64-\" system)\n"
- " (file-append qemu \"/bin/qemu-system-x86_64\"))\n"
- " (else\n"
- " (error \"dunno!\"))))\n"
- " \"-net\" \"user\" #$image)\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10625
- #, no-wrap
- msgid "{Scheme Syntax} with-parameters ((@var{parameter} @var{value}) @dots{}) @var{exp}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10631
- msgid "This macro is similar to the @code{parameterize} form for dynamically-bound @dfn{parameters} (@pxref{Parameters,,, guile, GNU Guile Reference Manual}). The key difference is that it takes effect when the file-like object returned by @var{exp} is lowered to a derivation or store item."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10634
- msgid "A typical use of @code{with-parameters} is to force the system in effect for a given object:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:10638
- #, no-wrap
- msgid ""
- "(with-parameters ((%current-system \"i686-linux\"))\n"
- " coreutils)\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10642
- msgid "The example above returns an object that corresponds to the i686 build of Coreutils, regardless of the current value of @code{%current-system}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10649
- msgid "Of course, in addition to gexps embedded in ``host'' code, there are also modules containing build tools. To make it clear that they are meant to be used in the build stratum, these modules are kept in the @code{(guix build @dots{})} name space."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10655
- msgid "Internally, high-level objects are @dfn{lowered}, using their compiler, to either derivations or store items. For instance, lowering a package yields a derivation, and lowering a @code{plain-file} yields a store item. This is achieved using the @code{lower-object} monadic procedure."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10656
- #, no-wrap
- msgid "{Monadic Procedure} lower-object @var{obj} [@var{system}] @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10662
- msgid "[#:target #f] Return as a value in @code{%store-monad} the derivation or store item corresponding to @var{obj} for @var{system}, cross-compiling for @var{target} if @var{target} is true. @var{obj} must be an object that has an associated gexp compiler, such as a @code{<package>}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10664
- #, no-wrap
- msgid "{Procedure} gexp->approximate-sexp @var{gexp}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:10672
- msgid "Sometimes, it may be useful to convert a G-exp into a S-exp. For example, some linters (@pxref{Invoking guix lint}) peek into the build phases of a package to detect potential problems. This conversion can be achieved with this procedure. However, some information can be lost in the process. More specifically, lowerable objects will be silently replaced with some arbitrary object -- currently the list @code{(*approximate*)}, but this may change."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:10675
- #, no-wrap
- msgid "Invoking @command{guix repl}"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:10677
- #, no-wrap
- msgid "REPL, read-eval-print loop, script"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10687
- msgid "The @command{guix repl} command makes it easier to program Guix in Guile by launching a Guile @dfn{read-eval-print loop} (REPL) for interactive programming (@pxref{Using Guile Interactively,,, guile, GNU Guile Reference Manual}), or by running Guile scripts (@pxref{Running Guile Scripts,,, guile, GNU Guile Reference Manual}). Compared to just launching the @command{guile} command, @command{guix repl} guarantees that all the Guix modules and all its dependencies are available in the search path."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:10692
- #, no-wrap
- msgid "guix repl @var{options} [@var{file} @var{args}]\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10696
- msgid "When a @var{file} argument is provided, @var{file} is executed as a Guile scripts:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:10699
- #, no-wrap
- msgid "guix repl my-script.scm\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10703
- msgid "To pass arguments to the script, use @code{--} to prevent them from being interpreted as arguments to @command{guix repl} itself:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:10706
- #, no-wrap
- msgid "guix repl -- my-script.scm --input=foo.txt\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10711
- msgid "To make a script executable directly from the shell, using the guix executable that is on the user's search path, add the following two lines at the top of the script:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:10715
- #, no-wrap
- msgid ""
- "@code{#!/usr/bin/env -S guix repl --}\n"
- "@code{!#}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10718
- msgid "Without a file name argument, a Guile REPL is started:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:10724
- #, no-wrap
- msgid ""
- "$ guix repl\n"
- "scheme@@(guile-user)> ,use (gnu packages base)\n"
- "scheme@@(guile-user)> coreutils\n"
- "$1 = #<package coreutils@@8.29 gnu/packages/base.scm:327 3e28300>\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10731
- msgid "In addition, @command{guix repl} implements a simple machine-readable REPL protocol for use by @code{(guix inferior)}, a facility to interact with @dfn{inferiors}, separate processes running a potentially different revision of Guix."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10733
- msgid "The available options are as follows:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:10735 guix-git/doc/guix.texi:13411
- #, no-wrap
- msgid "--type=@var{type}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:10736 guix-git/doc/guix.texi:13412
- #: guix-git/doc/guix.texi:35281
- #, no-wrap
- msgid "-t @var{type}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10738
- msgid "Start a REPL of the given @var{TYPE}, which can be one of the following:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:10740
- #, no-wrap
- msgid "guile"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10742
- msgid "This is default, and it spawns a standard full-featured Guile REPL."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:10742
- #, no-wrap
- msgid "machine"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10745
- msgid "Spawn a REPL that uses the machine-readable protocol. This is the protocol that the @code{(guix inferior)} module speaks."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10751
- msgid "By default, @command{guix repl} reads from standard input and writes to standard output. When this option is passed, it will instead listen for connections on @var{endpoint}. Here are examples of valid options:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:10753
- #, no-wrap
- msgid "--listen=tcp:37146"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10755
- msgid "Accept connections on localhost on port 37146."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:10756
- #, no-wrap
- msgid "--listen=unix:/tmp/socket"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10758
- msgid "Accept connections on the Unix-domain socket @file{/tmp/socket}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:10760 guix-git/doc/guix.texi:10865
- #: guix-git/doc/guix.texi:12763 guix-git/doc/guix.texi:12840
- #: guix-git/doc/guix.texi:13046 guix-git/doc/guix.texi:13191
- #: guix-git/doc/guix.texi:13459
- #, no-wrap
- msgid "--load-path=@var{directory}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:10761 guix-git/doc/guix.texi:10866
- #: guix-git/doc/guix.texi:12841 guix-git/doc/guix.texi:13047
- #: guix-git/doc/guix.texi:13192 guix-git/doc/guix.texi:13460
- #, no-wrap
- msgid "-L @var{directory}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10764 guix-git/doc/guix.texi:10869
- #: guix-git/doc/guix.texi:12766 guix-git/doc/guix.texi:12844
- #: guix-git/doc/guix.texi:13050 guix-git/doc/guix.texi:13195
- #: guix-git/doc/guix.texi:13463
- msgid "Add @var{directory} to the front of the package module search path (@pxref{Package Modules})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10767
- msgid "This allows users to define their own packages and make them visible to the script or REPL."
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:10768 guix-git/doc/guix.texi:11390
- #, no-wrap
- msgid "-q"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10771
- msgid "Inhibit loading of the @file{~/.guile} file. By default, that configuration file is loaded when spawning a @code{guile} REPL."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10781
- msgid "This section describes Guix command-line utilities. Some of them are primarily targeted at developers and users who write new package definitions, while others are more generally useful. They complement the Scheme programming interface of Guix in a convenient way."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:10804
- #, no-wrap
- msgid "package building"
- msgstr ""
- #. type: command{#1}
- #: guix-git/doc/guix.texi:10805
- #, no-wrap
- msgid "guix build"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10811
- msgid "The @command{guix build} command builds packages or derivations and their dependencies, and prints the resulting store paths. Note that it does not modify the user's profile---this is the job of the @command{guix package} command (@pxref{Invoking guix package}). Thus, it is mainly useful for distribution developers."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:10816
- #, no-wrap
- msgid "guix build @var{options} @var{package-or-derivation}@dots{}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10821
- msgid "As an example, the following command builds the latest versions of Emacs and of Guile, displays their build logs, and finally displays the resulting directories:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:10824
- #, no-wrap
- msgid "guix build emacs guile\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10827
- msgid "Similarly, the following command builds all the available packages:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:10831
- #, no-wrap
- msgid ""
- "guix build --quiet --keep-going \\\n"
- " $(guix package -A | awk '@{ print $1 \"@@\" $2 @}')\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10839
- msgid "@var{package-or-derivation} may be either the name of a package found in the software distribution such as @code{coreutils} or @code{coreutils@@8.20}, or a derivation such as @file{/gnu/store/@dots{}-coreutils-8.19.drv}. In the former case, a package with the corresponding name (and optionally version) is searched for among the GNU distribution modules (@pxref{Package Modules})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10844
- msgid "Alternatively, the @option{--expression} option may be used to specify a Scheme expression that evaluates to a package; this is useful when disambiguating among several same-named packages or package variants is needed."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10847
- msgid "There may be zero or more @var{options}. The available options are described in the subsections below."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10862
- msgid "A number of options that control the build process are common to @command{guix build} and other commands that can spawn builds, such as @command{guix package} or @command{guix archive}. These are the following:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10872 guix-git/doc/guix.texi:12769
- #: guix-git/doc/guix.texi:13053 guix-git/doc/guix.texi:13198
- #: guix-git/doc/guix.texi:13466
- msgid "This allows users to define their own packages and make them visible to the command-line tools."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:10873
- #, no-wrap
- msgid "--keep-failed"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:10874
- #, no-wrap
- msgid "-K"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10880
- msgid "Keep the build tree of failed builds. Thus, if a build fails, its build tree is kept under @file{/tmp}, in a directory whose name is shown at the end of the build log. This is useful when debugging build issues. @xref{Debugging Build Failures}, for tips and tricks on how to debug build issues."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10884
- msgid "This option implies @option{--no-offload}, and it has no effect when connecting to a remote daemon with a @code{guix://} URI (@pxref{The Store, the @env{GUIX_DAEMON_SOCKET} variable})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:10885
- #, no-wrap
- msgid "--keep-going"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:10886
- #, no-wrap
- msgid "-k"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10889
- msgid "Keep going when some of the derivations fail to build; return only once all the builds have either completed or failed."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10892
- msgid "The default behavior is to stop as soon as one of the specified derivations has failed."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10896
- msgid "Do not build the derivations."
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:10898
- msgid "fallback-option"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:10898
- #, no-wrap
- msgid "--fallback"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10901
- msgid "When substituting a pre-built binary fails, fall back to building packages locally (@pxref{Substitution Failure})."
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:10907
- msgid "client-substitute-urls"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10907
- msgid "Consider @var{urls} the whitespace-separated list of substitute source URLs, overriding the default list of URLs of @command{guix-daemon} (@pxref{daemon-substitute-urls,, @command{guix-daemon} URLs})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10911
- msgid "This means that substitutes may be downloaded from @var{urls}, provided they are signed by a key authorized by the system administrator (@pxref{Substitutes})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10914
- msgid "When @var{urls} is the empty string, substitutes are effectively disabled."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:10920
- #, no-wrap
- msgid "--no-grafts"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10924
- msgid "Do not ``graft'' packages. In practice, this means that package updates available as grafts are not applied. @xref{Security Updates}, for more information on grafts."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:10925
- #, no-wrap
- msgid "--rounds=@var{n}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10928
- msgid "Build each derivation @var{n} times in a row, and raise an error if consecutive build results are not bit-for-bit identical."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10933
- msgid "This is a useful way to detect non-deterministic builds processes. Non-deterministic build processes are a problem because they make it practically impossible for users to @emph{verify} whether third-party binaries are genuine. @xref{Invoking guix challenge}, for more."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10949
- msgid "By default, the daemon's setting is honored (@pxref{Invoking guix-daemon, @option{--max-silent-time}})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10956
- msgid "By default, the daemon's setting is honored (@pxref{Invoking guix-daemon, @option{--timeout}})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:10959
- #, no-wrap
- msgid "verbosity, of the command-line tools"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:10960
- #, no-wrap
- msgid "build logs, verbosity"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:10961
- #, no-wrap
- msgid "-v @var{level}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:10962
- #, no-wrap
- msgid "--verbosity=@var{level}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10967
- msgid "Use the given verbosity @var{level}, an integer. Choosing 0 means that no output is produced, 1 is for quiet output; 2 is similar to 1 but it additionally displays download URLs; 3 shows all the build log output on standard error."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10972
- msgid "Allow the use of up to @var{n} CPU cores for the build. The special value @code{0} means to use as many CPU cores as available."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10978
- msgid "Allow at most @var{n} build jobs in parallel. @xref{Invoking guix-daemon, @option{--max-jobs}}, for details about this option and the equivalent @command{guix-daemon} option."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:10979
- #, no-wrap
- msgid "--debug=@var{level}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:10983
- msgid "Produce debugging output coming from the build daemon. @var{level} must be an integer between 0 and 5; higher means more verbose output. Setting a level of 4 or more may be helpful when debugging setup issues with the build daemon."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10990
- msgid "Behind the scenes, @command{guix build} is essentially an interface to the @code{package-derivation} procedure of the @code{(guix packages)} module, and to the @code{build-derivations} procedure of the @code{(guix derivations)} module."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:10994
- msgid "In addition to options explicitly passed on the command line, @command{guix build} and other @command{guix} commands that support building honor the @env{GUIX_BUILD_OPTIONS} environment variable."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:10995
- #, no-wrap
- msgid "{Environment Variable} GUIX_BUILD_OPTIONS"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:11000
- msgid "Users can define this variable to a list of command line options that will automatically be used by @command{guix build} and other @command{guix} commands that can perform builds, as in the example below:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11003
- #, no-wrap
- msgid "$ export GUIX_BUILD_OPTIONS=\"--no-substitutes -c 2 -L /foo/bar\"\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:11007
- msgid "These options are parsed independently, and the result is appended to the parsed command-line options."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11013
- #, no-wrap
- msgid "package variants"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11021
- msgid "Another set of command-line options supported by @command{guix build} and also @command{guix package} are @dfn{package transformation options}. These are options that make it possible to define @dfn{package variants}---for instance, packages built from different source code. This is a convenient way to create customized packages on the fly without having to type in the definitions of package variants (@pxref{Defining Packages})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11025
- msgid "Package transformation options are preserved across upgrades: @command{guix upgrade} attempts to apply transformation options initially used when creating the profile to the upgraded packages."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11030
- msgid "The available options are listed below. Most commands support them and also support a @option{--help-transform} option that lists all the available options and a synopsis (these options are not shown in the @option{--help} output for brevity)."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11033
- #, no-wrap
- msgid "performance, tuning code"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11034
- #, no-wrap
- msgid "optimization, of package code"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11035
- #, no-wrap
- msgid "tuning, of package code"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11036
- #, no-wrap
- msgid "SIMD support"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11037
- #, fuzzy, no-wrap
- #| msgid "Java Packages"
- msgid "tunable packages"
- msgstr "بستههای جاوا"
- #. type: cindex
- #: guix-git/doc/guix.texi:11038
- #, no-wrap
- msgid "package multi-versioning"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11039
- #, no-wrap
- msgid "--tune[=@var{cpu}]"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11043
- msgid "Use versions of the packages marked as ``tunable'' optimized for @var{cpu}. When @var{cpu} is @code{native}, or when it is omitted, tune for the CPU on which the @command{guix} command is running."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11049
- msgid "Valid @var{cpu} names are those recognized by the underlying compiler, by default the GNU Compiler Collection. On x86_64 processors, this includes CPU names such as @code{nehalem}, @code{haswell}, and @code{skylake} (@pxref{x86 Options, @code{-march},, gcc, Using the GNU Compiler Collection (GCC)})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11056
- msgid "As new generations of CPUs come out, they augment the standard instruction set architecture (ISA) with additional instructions, in particular instructions for single-instruction/multiple-data (SIMD) parallel processing. For example, while Core2 and Skylake CPUs both implement the x86_64 ISA, only the latter supports AVX2 SIMD instructions."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11063
- msgid "The primary gain one can expect from @option{--tune} is for programs that can make use of those SIMD capabilities @emph{and} that do not already have a mechanism to select the right optimized code at run time. Packages that have the @code{tunable?} property set are considered @dfn{tunable packages} by the @option{--tune} option; a package definition with the property set looks like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:11068
- #, no-wrap
- msgid ""
- "(package\n"
- " (name \"hello-simd\")\n"
- " ;; ...\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:11072
- #, no-wrap
- msgid ""
- " ;; This package may benefit from SIMD extensions so\n"
- " ;; mark it as \"tunable\".\n"
- " (properties '((tunable? . #t))))\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11077
- msgid "Other packages are not considered tunable. This allows Guix to use generic binaries in the cases where tuning for a specific CPU is unlikely to provide any gain."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11083
- msgid "Tuned packages are built with @code{-march=@var{CPU}}; under the hood, the @option{-march} option is passed to the actual wrapper by a compiler wrapper. Since the build machine may not be able to run code for the target CPU micro-architecture, the test suite is not run when building a tuned package."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11087
- msgid "To reduce rebuilds to the minimum, tuned packages are @emph{grafted} onto packages that depend on them (@pxref{Security Updates, grafts}). Thus, using @option{--no-grafts} cancels the effect of @option{--tune}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11093
- msgid "We call this technique @dfn{package multi-versioning}: several variants of tunable packages may be built, one for each CPU variant. It is the coarse-grain counterpart of @dfn{function multi-versioning} as implemented by the GNU tool chain (@pxref{Function Multiversioning,,, gcc, Using the GNU Compiler Collection (GCC)})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11094
- #, no-wrap
- msgid "--with-source=@var{source}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:11095
- #, no-wrap
- msgid "--with-source=@var{package}=@var{source}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:11096
- #, no-wrap
- msgid "--with-source=@var{package}@@@var{version}=@var{source}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11101
- msgid "Use @var{source} as the source of @var{package}, and @var{version} as its version number. @var{source} must be a file name or a URL, as for @command{guix download} (@pxref{Invoking guix download})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11107
- msgid "When @var{package} is omitted, it is taken to be the package name specified on the command line that matches the base of @var{source}---e.g., if @var{source} is @code{/src/guile-2.0.10.tar.gz}, the corresponding package is @code{guile}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11110
- msgid "Likewise, when @var{version} is omitted, the version string is inferred from @var{source}; in the previous example, it is @code{2.0.10}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11115
- msgid "This option allows users to try out versions of packages other than the one provided by the distribution. The example below downloads @file{ed-1.7.tar.gz} from a GNU mirror and uses that as the source for the @code{ed} package:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11118
- #, no-wrap
- msgid "guix build ed --with-source=mirror://gnu/ed/ed-1.7.tar.gz\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11122
- msgid "As a developer, @option{--with-source} makes it easy to test release candidates:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11125
- #, no-wrap
- msgid "guix build guile --with-source=../guile-2.0.9.219-e1bb7.tar.xz\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11128
- msgid "@dots{} or to build from a checkout in a pristine environment:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11132
- #, no-wrap
- msgid ""
- "$ git clone git://git.sv.gnu.org/guix.git\n"
- "$ guix build guix --with-source=guix@@1.0=./guix\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11134
- #, no-wrap
- msgid "--with-input=@var{package}=@var{replacement}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11139
- msgid "Replace dependency on @var{package} by a dependency on @var{replacement}. @var{package} must be a package name, and @var{replacement} must be a package specification such as @code{guile} or @code{guile@@1.8}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11143
- msgid "For instance, the following command builds Guix, but replaces its dependency on the current stable version of Guile with a dependency on the legacy version of Guile, @code{guile@@2.0}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11146
- #, no-wrap
- msgid "guix build --with-input=guile=guile@@2.0 guix\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11151
- msgid "This is a recursive, deep replacement. So in this example, both @code{guix} and its dependency @code{guile-json} (which also depends on @code{guile}) get rebuilt against @code{guile@@2.0}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11154
- msgid "This is implemented using the @code{package-input-rewriting} Scheme procedure (@pxref{Defining Packages, @code{package-input-rewriting}})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11155
- #, no-wrap
- msgid "--with-graft=@var{package}=@var{replacement}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11161
- msgid "This is similar to @option{--with-input} but with an important difference: instead of rebuilding the whole dependency chain, @var{replacement} is built and then @dfn{grafted} onto the binaries that were initially referring to @var{package}. @xref{Security Updates}, for more information on grafts."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11165
- msgid "For example, the command below grafts version 3.5.4 of GnuTLS onto Wget and all its dependencies, replacing references to the version of GnuTLS they currently refer to:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11168
- #, no-wrap
- msgid "guix build --with-graft=gnutls=gnutls@@3.5.4 wget\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11177
- msgid "This has the advantage of being much faster than rebuilding everything. But there is a caveat: it works if and only if @var{package} and @var{replacement} are strictly compatible---for example, if they provide a library, the application binary interface (ABI) of those libraries must be compatible. If @var{replacement} is somehow incompatible with @var{package}, then the resulting package may be unusable. Use with care!"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11178 guix-git/doc/guix.texi:37882
- #, no-wrap
- msgid "debugging info, rebuilding"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11179
- #, no-wrap
- msgid "--with-debug-info=@var{package}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11184
- msgid "Build @var{package} in a way that preserves its debugging info and graft it onto packages that depend on it. This is useful if @var{package} does not already provide debugging info as a @code{debug} output (@pxref{Installing Debugging Files})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11190
- msgid "For example, suppose you're experiencing a crash in Inkscape and would like to see what's up in GLib, a library deep down in Inkscape's dependency graph. GLib lacks a @code{debug} output, so debugging is tough. Fortunately, you rebuild GLib with debugging info and tack it on Inkscape:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11193 guix-git/doc/guix.texi:37913
- #, no-wrap
- msgid "guix install inkscape --with-debug-info=glib\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11197
- msgid "Only GLib needs to be recompiled so this takes a reasonable amount of time. @xref{Installing Debugging Files}, for more info."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:11203
- msgid "Under the hood, this option works by passing the @samp{#:strip-binaries? #f} to the build system of the package of interest (@pxref{Build Systems}). Most build systems support that option but some do not. In that case, an error is raised."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:11207
- msgid "Likewise, if a C/C++ package is built without @code{-g} (which is rarely the case), debugging info will remain unavailable even when @code{#:strip-binaries?} is false."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11209
- #, no-wrap
- msgid "tool chain, changing the build tool chain of a package"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11210
- #, no-wrap
- msgid "--with-c-toolchain=@var{package}=@var{toolchain}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11214
- msgid "This option changes the compilation of @var{package} and everything that depends on it so that they get built with @var{toolchain} instead of the default GNU tool chain for C/C++."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11221
- #, no-wrap
- msgid ""
- "guix build octave-cli \\\n"
- " --with-c-toolchain=fftw=gcc-toolchain@@10 \\\n"
- " --with-c-toolchain=fftwf=gcc-toolchain@@10\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11228
- msgid "The command above builds a variant of the @code{fftw} and @code{fftwf} packages using version 10 of @code{gcc-toolchain} instead of the default tool chain, and then builds a variant of the GNU@tie{}Octave command-line interface using them. GNU@tie{}Octave itself is also built with @code{gcc-toolchain@@10}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11232
- msgid "This other example builds the Hardware Locality (@code{hwloc}) library and its dependents up to @code{intel-mpi-benchmarks} with the Clang C compiler:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11236
- #, no-wrap
- msgid ""
- "guix build --with-c-toolchain=hwloc=clang-toolchain \\\n"
- " intel-mpi-benchmarks\n"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:11245
- msgid "There can be application binary interface (ABI) incompatibilities among tool chains. This is particularly true of the C++ standard library and run-time support libraries such as that of OpenMP@. By rebuilding all dependents with the same tool chain, @option{--with-c-toolchain} minimizes the risks of incompatibility but cannot entirely eliminate them. Choose @var{package} wisely."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11247
- #, no-wrap
- msgid "--with-git-url=@var{package}=@var{url}"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11248
- #, no-wrap
- msgid "Git, using the latest commit"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11249
- #, no-wrap
- msgid "latest commit, building"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11253
- msgid "Build @var{package} from the latest commit of the @code{master} branch of the Git repository at @var{url}. Git sub-modules of the repository are fetched, recursively."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11256
- msgid "For example, the following command builds the NumPy Python library against the latest commit of the master branch of Python itself:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11260
- #, no-wrap
- msgid ""
- "guix build python-numpy \\\n"
- " --with-git-url=python=https://github.com/python/cpython\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11264
- msgid "This option can also be combined with @option{--with-branch} or @option{--with-commit} (see below)."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11265 guix-git/doc/guix.texi:28957
- #, no-wrap
- msgid "continuous integration"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11271
- msgid "Obviously, since it uses the latest commit of the given branch, the result of such a command varies over time. Nevertheless it is a convenient way to rebuild entire software stacks against the latest commit of one or more packages. This is particularly useful in the context of continuous integration (CI)."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11275
- msgid "Checkouts are kept in a cache under @file{~/.cache/guix/checkouts} to speed up consecutive accesses to the same repository. You may want to clean it up once in a while to save disk space."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11276
- #, no-wrap
- msgid "--with-branch=@var{package}=@var{branch}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11282
- msgid "Build @var{package} from the latest commit of @var{branch}. If the @code{source} field of @var{package} is an origin with the @code{git-fetch} method (@pxref{origin Reference}) or a @code{git-checkout} object, the repository URL is taken from that @code{source}. Otherwise you have to use @option{--with-git-url} to specify the URL of the Git repository."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11287
- msgid "For instance, the following command builds @code{guile-sqlite3} from the latest commit of its @code{master} branch, and then builds @code{guix} (which depends on it) and @code{cuirass} (which depends on @code{guix}) against this specific @code{guile-sqlite3} build:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11290
- #, no-wrap
- msgid "guix build --with-branch=guile-sqlite3=master cuirass\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11292
- #, no-wrap
- msgid "--with-commit=@var{package}=@var{commit}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11297
- msgid "This is similar to @option{--with-branch}, except that it builds from @var{commit} rather than the tip of a branch. @var{commit} must be a valid Git commit SHA1 identifier, a tag, or a @command{git describe} style identifier such as @code{1.0-3-gabc123}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11298
- #, no-wrap
- msgid "--with-patch=@var{package}=@var{file}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11305
- msgid "Add @var{file} to the list of patches applied to @var{package}, where @var{package} is a spec such as @code{python@@3.8} or @code{glibc}. @var{file} must contain a patch; it is applied with the flags specified in the @code{origin} of @var{package} (@pxref{origin Reference}), which by default includes @code{-p1} (@pxref{patch Directories,,, diffutils, Comparing and Merging Files})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11308
- msgid "As an example, the command below rebuilds Coreutils with the GNU C Library (glibc) patched with the given patch:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11311
- #, no-wrap
- msgid "guix build coreutils --with-patch=glibc=./glibc-frob.patch\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11315
- msgid "In this example, glibc itself as well as everything that leads to Coreutils in the dependency graph is rebuilt."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11316
- #, no-wrap
- msgid "upstream, latest version"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11317
- #, no-wrap
- msgid "--with-latest=@var{package}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11322
- msgid "So you like living on the bleeding edge? This option is for you! It replaces occurrences of @var{package} in the dependency graph with its latest upstream version, as reported by @command{guix refresh} (@pxref{Invoking guix refresh})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11326
- msgid "It does so by determining the latest upstream release of @var{package} (if possible), downloading it, and authenticating it @emph{if} it comes with an OpenPGP signature."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11329
- msgid "As an example, the command below builds Guix against the latest version of Guile-JSON:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11332
- #, no-wrap
- msgid "guix build guix --with-latest=guile-json\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11341
- msgid "There are limitations. First, in cases where the tool cannot or does not know how to authenticate source code, you are at risk of running malicious code; a warning is emitted in this case. Second, this option simply changes the source used in the existing package definitions, which is not always sufficient: there might be additional dependencies that need to be added, patches to apply, and more generally the quality assurance work that Guix developers normally do will be missing."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11346
- msgid "You've been warned! In all the other cases, it's a snappy way to stay on top. We encourage you to submit patches updating the actual package definitions once you have successfully tested an upgrade (@pxref{Contributing})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11347
- #, no-wrap
- msgid "test suite, skipping"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11348
- #, no-wrap
- msgid "--without-tests=@var{package}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11354
- msgid "Build @var{package} without running its tests. This can be useful in situations where you want to skip the lengthy test suite of a intermediate package, or if a package's test suite fails in a non-deterministic fashion. It should be used with care because running the test suite is a good way to ensure a package is working as intended."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11358
- msgid "Turning off tests leads to a different store item. Consequently, when using this option, anything that depends on @var{package} must be rebuilt, as in this example:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11361
- #, no-wrap
- msgid "guix install --without-tests=python python-notebook\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11367
- msgid "The command above installs @code{python-notebook} on top of @code{python} built without running its test suite. To do so, it also rebuilds everything that depends on @code{python}, including @code{python-notebook} itself."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11373
- msgid "Internally, @option{--without-tests} relies on changing the @code{#:tests?} option of a package's @code{check} phase (@pxref{Build Systems}). Note that some packages use a customized @code{check} phase that does not respect a @code{#:tests? #f} setting. Therefore, @option{--without-tests} has no effect on these packages."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11380
- msgid "Wondering how to achieve the same effect using Scheme code, for example in your manifest, or how to write your own package transformation? @xref{Defining Package Variants}, for an overview of the programming interfaces available."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11386
- msgid "The command-line options presented below are specific to @command{guix build}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11389
- #, no-wrap
- msgid "--quiet"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11394
- msgid "Build quietly, without displaying the build log; this is equivalent to @option{--verbosity=0}. Upon completion, the build log is kept in @file{/var} (or similar) and can always be retrieved using the @option{--log-file} option."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11399
- msgid "Build the package, derivation, or other file-like object that the code within @var{file} evaluates to (@pxref{G-Expressions, file-like objects})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11402
- msgid "As an example, @var{file} might contain a package definition like this (@pxref{Defining Packages}):"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11411
- msgid "The @var{file} may also contain a JSON representation of one or more package definitions. Running @code{guix build -f} on @file{hello.json} with the following contents would result in building the packages @code{myhello} and @code{greeter}:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11416
- #, no-wrap
- msgid "--manifest=@var{manifest}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:11417
- #, no-wrap
- msgid "-m @var{manifest}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11420
- msgid "Build all packages listed in the given @var{manifest} (@pxref{profile-manifest, @option{--manifest}})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11424
- msgid "Build the package or derivation @var{expr} evaluates to."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11428
- msgid "For example, @var{expr} may be @code{(@@ (gnu packages guile) guile-1.8)}, which unambiguously designates this specific variant of version 1.8 of Guile."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11432
- msgid "Alternatively, @var{expr} may be a G-expression, in which case it is used as a build program passed to @code{gexp->derivation} (@pxref{G-Expressions})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11436
- msgid "Lastly, @var{expr} may refer to a zero-argument monadic procedure (@pxref{The Store Monad}). The procedure must return a derivation as a monadic value, which is then passed through @code{run-with-store}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11437
- #, no-wrap
- msgid "--source"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:11438 guix-git/doc/guix.texi:11835
- #, no-wrap
- msgid "-S"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11441
- msgid "Build the source derivations of the packages, rather than the packages themselves."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11445
- msgid "For instance, @code{guix build -S gcc} returns something like @file{/gnu/store/@dots{}-gcc-4.7.2.tar.bz2}, which is the GCC source tarball."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11449
- msgid "The returned source tarball is the result of applying any patches and code snippets specified in the package @code{origin} (@pxref{Defining Packages})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11450
- #, no-wrap
- msgid "source, verification"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11456
- msgid "As with other derivations, the result of building a source derivation can be verified using the @option{--check} option (@pxref{build-check}). This is useful to validate that a (potentially already built or substituted, thus cached) package source matches against its declared hash."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11461
- msgid "Note that @command{guix build -S} compiles the sources only of the specified packages. They do not include the sources of statically linked dependencies and by themselves are insufficient for reproducing the packages."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11462
- #, no-wrap
- msgid "--sources"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11469
- msgid "Fetch and return the source of @var{package-or-derivation} and all their dependencies, recursively. This is a handy way to obtain a local copy of all the source code needed to build @var{packages}, allowing you to eventually build them even without network access. It is an extension of the @option{--source} option and can accept one of the following optional argument values:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11471 guix-git/doc/guix.texi:13252
- #, no-wrap
- msgid "package"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11474
- msgid "This value causes the @option{--sources} option to behave in the same way as the @option{--source} option."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11475 guix-git/doc/guix.texi:19682
- #, no-wrap
- msgid "all"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11478
- msgid "Build the source derivations of all packages, including any source that might be listed as @code{inputs}. This is the default value."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11484
- #, no-wrap
- msgid ""
- "$ guix build --sources tzdata\n"
- "The following derivations will be built:\n"
- " /gnu/store/@dots{}-tzdata2015b.tar.gz.drv\n"
- " /gnu/store/@dots{}-tzcode2015b.tar.gz.drv\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11486
- #, no-wrap
- msgid "transitive"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11490
- msgid "Build the source derivations of all packages, as well of all transitive inputs to the packages. This can be used e.g.@: to prefetch package source for later offline building."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11501
- #, no-wrap
- msgid ""
- "$ guix build --sources=transitive tzdata\n"
- "The following derivations will be built:\n"
- " /gnu/store/@dots{}-tzcode2015b.tar.gz.drv\n"
- " /gnu/store/@dots{}-findutils-4.4.2.tar.xz.drv\n"
- " /gnu/store/@dots{}-grep-2.21.tar.xz.drv\n"
- " /gnu/store/@dots{}-coreutils-8.23.tar.xz.drv\n"
- " /gnu/store/@dots{}-make-4.1.tar.xz.drv\n"
- " /gnu/store/@dots{}-bash-4.3.tar.xz.drv\n"
- "@dots{}\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11511
- msgid "Attempt to build for @var{system}---e.g., @code{i686-linux}---instead of the system type of the build host. The @command{guix build} command allows you to repeat this option several times, in which case it builds for all the specified systems; other commands ignore extraneous @option{-s} options."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:11516
- msgid "The @option{--system} flag is for @emph{native} compilation and must not be confused with cross-compilation. See @option{--target} below for information on cross-compilation."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11523
- msgid "An example use of this is on Linux-based systems, which can emulate different personalities. For instance, passing @option{--system=i686-linux} on an @code{x86_64-linux} system or @option{--system=armhf-linux} on an @code{aarch64-linux} system allows you to build packages in a complete 32-bit environment."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:11528
- msgid "Building for an @code{armhf-linux} system is unconditionally enabled on @code{aarch64-linux} machines, although certain aarch64 chipsets do not allow for this functionality, notably the ThunderX."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11534
- msgid "Similarly, when transparent emulation with QEMU and @code{binfmt_misc} is enabled (@pxref{Virtualization Services, @code{qemu-binfmt-service-type}}), you can build for any system for which a QEMU @code{binfmt_misc} handler is installed."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11538
- msgid "Builds for a system other than that of the machine you are using can also be offloaded to a remote machine of the right architecture. @xref{Daemon Offload Setup}, for more information on offloading."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11544
- msgid "Cross-build for @var{triplet}, which must be a valid GNU triplet, such as @code{\"aarch64-linux-gnu\"} (@pxref{Specifying Target Triplets, GNU configuration triplets,, autoconf, Autoconf})."
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:11546
- msgid "build-check"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11547
- #, no-wrap
- msgid "determinism, checking"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11548
- #, no-wrap
- msgid "reproducibility, checking"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11552
- msgid "Rebuild @var{package-or-derivation}, which are already available in the store, and raise an error if the build results are not bit-for-bit identical."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11557
- msgid "This mechanism allows you to check whether previously installed substitutes are genuine (@pxref{Substitutes}), or whether the build result of a package is deterministic. @xref{Invoking guix challenge}, for more background information and tools."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11562
- #, no-wrap
- msgid "--repair"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11563
- #, no-wrap
- msgid "repairing store items"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11567
- msgid "Attempt to repair the specified store items, if they are corrupt, by re-downloading or rebuilding them."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11569
- msgid "This operation is not atomic and thus restricted to @code{root}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11570
- #, no-wrap
- msgid "--derivations"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11574
- msgid "Return the derivation paths, not the output paths, of the given packages."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11577
- #, no-wrap
- msgid "GC roots, adding"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11578
- #, no-wrap
- msgid "garbage collector roots, adding"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11581 guix-git/doc/guix.texi:35312
- msgid "Make @var{file} a symlink to the result, and register it as a garbage collector root."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11587
- msgid "Consequently, the results of this @command{guix build} invocation are protected from garbage collection until @var{file} is removed. When that option is omitted, build results are eligible for garbage collection as soon as the build completes. @xref{Invoking guix gc}, for more on GC roots."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11588
- #, no-wrap
- msgid "--log-file"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11589
- #, no-wrap
- msgid "build logs, access"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11593
- msgid "Return the build log file names or URLs for the given @var{package-or-derivation}, or raise an error if build logs are missing."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11596
- msgid "This works regardless of how packages or derivations are specified. For instance, the following invocations are equivalent:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11602
- #, no-wrap
- msgid ""
- "guix build --log-file $(guix build -d guile)\n"
- "guix build --log-file $(guix build guile)\n"
- "guix build --log-file guile\n"
- "guix build --log-file -e '(@@ (gnu packages guile) guile-2.0)'\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11607
- msgid "If a log is unavailable locally, and unless @option{--no-substitutes} is passed, the command looks for a corresponding log on one of the substitute servers (as specified with @option{--substitute-urls})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11610
- msgid "So for instance, imagine you want to see the build log of GDB on MIPS, but you are actually on an @code{x86_64} machine:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11614
- #, no-wrap
- msgid ""
- "$ guix build --log-file gdb -s aarch64-linux\n"
- "https://@value{SUBSTITUTE-SERVER-1}/log/@dots{}-gdb-7.10\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11617
- msgid "You can freely access a huge library of build logs!"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11622
- #, no-wrap
- msgid "build failures, debugging"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11628
- msgid "When defining a new package (@pxref{Defining Packages}), you will probably find yourself spending some time debugging and tweaking the build until it succeeds. To do that, you need to operate the build commands yourself in an environment as close as possible to the one the build daemon uses."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11633
- msgid "To that end, the first thing to do is to use the @option{--keep-failed} or @option{-K} option of @command{guix build}, which will keep the failed build tree in @file{/tmp} or whatever directory you specified as @env{TMPDIR} (@pxref{Common Build Options, @option{--keep-failed}})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11639
- msgid "From there on, you can @command{cd} to the failed build tree and source the @file{environment-variables} file, which contains all the environment variable definitions that were in place when the build failed. So let's say you're debugging a build failure in package @code{foo}; a typical session would look like this:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11646
- #, no-wrap
- msgid ""
- "$ guix build foo -K\n"
- "@dots{} @i{build fails}\n"
- "$ cd /tmp/guix-build-foo.drv-0\n"
- "$ source ./environment-variables\n"
- "$ cd foo-1.2\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11650
- msgid "Now, you can invoke commands as if you were the daemon (almost) and troubleshoot your build process."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11656
- msgid "Sometimes it happens that, for example, a package's tests pass when you run them manually but they fail when the daemon runs them. This can happen because the daemon runs builds in containers where, unlike in our environment above, network access is missing, @file{/bin/sh} does not exist, etc. (@pxref{Build Environment Setup})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11659
- msgid "In such cases, you may need to run inspect the build process from within a container similar to the one the build daemon creates:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11667
- #, no-wrap
- msgid ""
- "$ guix build -K foo\n"
- "@dots{}\n"
- "$ cd /tmp/guix-build-foo.drv-0\n"
- "$ guix shell --no-grafts -C -D foo strace gdb\n"
- "[env]# source ./environment-variables\n"
- "[env]# cd foo-1.2\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11676
- msgid "Here, @command{guix shell -C} creates a container and spawns a new shell in it (@pxref{Invoking guix shell}). The @command{strace gdb} part adds the @command{strace} and @command{gdb} commands to the container, which you may find handy while debugging. The @option{--no-grafts} option makes sure we get the exact same environment, with ungrafted packages (@pxref{Security Updates}, for more info on grafts)."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11679
- msgid "To get closer to a container like that used by the build daemon, we can remove @file{/bin/sh}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11682
- #, no-wrap
- msgid "[env]# rm /bin/sh\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11686
- msgid "(Don't worry, this is harmless: this is all happening in the throw-away container created by @command{guix shell}.)"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11689
- msgid "The @command{strace} command is probably not in the search path, but we can run:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11692
- #, no-wrap
- msgid "[env]# $GUIX_ENVIRONMENT/bin/strace -f -o log make check\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11697
- msgid "In this way, not only you will have reproduced the environment variables the daemon uses, you will also be running the build process in a container similar to the one the daemon uses."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:11700
- #, no-wrap
- msgid "Invoking @command{guix edit}"
- msgstr ""
- #. type: command{#1}
- #: guix-git/doc/guix.texi:11702
- #, no-wrap
- msgid "guix edit"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11703
- #, no-wrap
- msgid "package definition, editing"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11708
- msgid "So many packages, so many source files! The @command{guix edit} command facilitates the life of users and packagers by pointing their editor at the source file containing the definition of the specified packages. For instance:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11711
- #, no-wrap
- msgid "guix edit gcc@@4.9 vim\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11717
- msgid "launches the program specified in the @env{VISUAL} or in the @env{EDITOR} environment variable to view the recipe of GCC@tie{}4.9.3 and that of Vim."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11723
- msgid "If you are using a Guix Git checkout (@pxref{Building from Git}), or have created your own packages on @env{GUIX_PACKAGE_PATH} (@pxref{Package Modules}), you will be able to edit the package recipes. In other cases, you will be able to examine the read-only recipes for packages currently in the store."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11728
- msgid "Instead of @env{GUIX_PACKAGE_PATH}, the command-line option @option{--load-path=@var{directory}} (or in short @option{-L @var{directory}}) allows you to add @var{directory} to the front of the package module search path and so make your own packages visible."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:11730
- #, no-wrap
- msgid "Invoking @command{guix download}"
- msgstr ""
- #. type: command{#1}
- #: guix-git/doc/guix.texi:11732
- #, no-wrap
- msgid "guix download"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11733
- #, no-wrap
- msgid "downloading package sources"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11740
- msgid "When writing a package definition, developers typically need to download a source tarball, compute its SHA256 hash, and write that hash in the package definition (@pxref{Defining Packages}). The @command{guix download} tool helps with this task: it downloads a file from the given URI, adds it to the store, and prints both its file name in the store and its SHA256 hash."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11747
- msgid "The fact that the downloaded file is added to the store saves bandwidth: when the developer eventually tries to build the newly defined package with @command{guix build}, the source tarball will not have to be downloaded again because it is already in the store. It is also a convenient way to temporarily stash files, which may be deleted eventually (@pxref{Invoking guix gc})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11755
- msgid "The @command{guix download} command supports the same URIs as used in package definitions. In particular, it supports @code{mirror://} URIs. @code{https} URIs (HTTP over TLS) are supported @emph{provided} the Guile bindings for GnuTLS are available in the user's environment; when they are not available, an error is raised. @xref{Guile Preparations, how to install the GnuTLS bindings for Guile,, gnutls-guile, GnuTLS-Guile}, for more information."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11760
- msgid "@command{guix download} verifies HTTPS server certificates by loading the certificates of X.509 authorities from the directory pointed to by the @env{SSL_CERT_DIR} environment variable (@pxref{X.509 Certificates}), unless @option{--no-check-certificate} is used."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11762 guix-git/doc/guix.texi:13565
- msgid "The following options are available:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11764 guix-git/doc/guix.texi:11808
- #, no-wrap
- msgid "--hash=@var{algorithm}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:11765 guix-git/doc/guix.texi:11809
- #, no-wrap
- msgid "-H @var{algorithm}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11768
- msgid "Compute a hash using the specified @var{algorithm}. @xref{Invoking guix hash}, for more information."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11769 guix-git/doc/guix.texi:11818
- #, no-wrap
- msgid "--format=@var{fmt}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:11770 guix-git/doc/guix.texi:11819
- #, no-wrap
- msgid "-f @var{fmt}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11773
- msgid "Write the hash in the format specified by @var{fmt}. For more information on the valid values for @var{fmt}, @pxref{Invoking guix hash}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11774
- #, no-wrap
- msgid "--no-check-certificate"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11776
- msgid "Do not validate the X.509 certificates of HTTPS servers."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11780
- msgid "When using this option, you have @emph{absolutely no guarantee} that you are communicating with the authentic server responsible for the given URL, which makes you vulnerable to ``man-in-the-middle'' attacks."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11781
- #, no-wrap
- msgid "--output=@var{file}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:11782
- #, no-wrap
- msgid "-o @var{file}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11785
- msgid "Save the downloaded file to @var{file} instead of adding it to the store."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:11788
- #, no-wrap
- msgid "Invoking @command{guix hash}"
- msgstr ""
- #. type: command{#1}
- #: guix-git/doc/guix.texi:11790
- #, no-wrap
- msgid "guix hash"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11795
- msgid "The @command{guix hash} command computes the hash of a file. It is primarily a convenience tool for anyone contributing to the distribution: it computes the cryptographic hash of one or more files, which can be used in the definition of a package (@pxref{Defining Packages})."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11800
- #, no-wrap
- msgid "guix hash @var{option} @var{file} ...\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11805
- msgid "When @var{file} is @code{-} (a hyphen), @command{guix hash} computes the hash of data read from standard input. @command{guix hash} has the following options:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11812
- msgid "Compute a hash using the specified @var{algorithm}, @code{sha256} by default."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11817
- msgid "@var{algorithm} must the name of a cryptographic hash algorithm supported by Libgcrypt @i{via} Guile-Gcrypt---e.g., @code{sha512} or @code{sha3-256} (@pxref{Hash Functions,,, guile-gcrypt, Guile-Gcrypt Reference Manual})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11821
- msgid "Write the hash in the format specified by @var{fmt}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11824
- msgid "Supported formats: @code{base64}, @code{nix-base32}, @code{base32}, @code{base16} (@code{hex} and @code{hexadecimal} can be used as well)."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11828
- msgid "If the @option{--format} option is not specified, @command{guix hash} will output the hash in @code{nix-base32}. This representation is used in the definitions of packages."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11833
- msgid "This option is deprecated in favor of @option{--serializer}. It is a legacy alias for @var{type} sets to @code{nar}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11834
- #, no-wrap
- msgid "--serializer=@var{type}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11837
- msgid "Compute the hash on @var{file} using @var{type} serialization."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11839
- msgid "@var{type} may be one of the following:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11841 guix-git/doc/guix.texi:13918
- #: guix-git/doc/guix.texi:17405 guix-git/doc/guix.texi:19679
- #, no-wrap
- msgid "none"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11843
- msgid "This is the default: it computes the hash of a file's contents."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11844
- #, no-wrap
- msgid "nar"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11854
- msgid "Compute the hash of a ``normalized archive'' (or ``nar'') containing @var{file}, including its children if it is a directory. Some of the metadata of @var{file} is part of the archive; for instance, when @var{file} is a regular file, the hash is different depending on whether @var{file} is executable or not. Metadata such as time stamps has no impact on the hash (@pxref{Invoking guix archive}, for more info on the nar format)."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11855
- #, no-wrap
- msgid "git"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11858
- msgid "Compute the has of the file or directory as a Git ``tree'', following the same method as the Git version control system."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11860
- #, no-wrap
- msgid "--exclude-vcs"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:11861 guix-git/doc/guix.texi:13038
- #, no-wrap
- msgid "-x"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11864
- msgid "When combined with @option{--recursive}, exclude version control system directories (@file{.bzr}, @file{.git}, @file{.hg}, etc.)."
- msgstr ""
- #. type: vindex
- #: guix-git/doc/guix.texi:11865
- #, no-wrap
- msgid "git-fetch"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11869
- msgid "As an example, here is how you would compute the hash of a Git checkout, which is useful when using the @code{git-fetch} method (@pxref{origin Reference}):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11874
- #, no-wrap
- msgid ""
- "$ git clone http://example.org/foo.git\n"
- "$ cd foo\n"
- "$ guix hash -rx .\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11878 guix-git/doc/guix.texi:11883
- #, no-wrap
- msgid "Invoking @command{guix import}"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11880
- #, no-wrap
- msgid "importing packages"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11881
- #, no-wrap
- msgid "package import"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11882
- #, no-wrap
- msgid "package conversion"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11890
- msgid "The @command{guix import} command is useful for people who would like to add a package to the distribution with as little work as possible---a legitimate demand. The command knows of a few repositories from which it can ``import'' package metadata. The result is a package definition, or a template thereof, in the format we know (@pxref{Defining Packages})."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11895
- #, no-wrap
- msgid "guix import @var{importer} @var{options}@dots{}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11900
- msgid "@var{importer} specifies the source from which to import package metadata, and @var{options} specifies a package identifier and other options specific to @var{importer}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11904
- msgid "Some of the importers rely on the ability to run the @command{gpgv} command. For these, GnuPG must be installed and in @code{$PATH}; run @code{guix install gnupg} if needed."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:11906
- msgid "Currently, the available ``importers'' are:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11908 guix-git/doc/guix.texi:12546
- #, no-wrap
- msgid "gnu"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11912
- msgid "Import metadata for the given GNU package. This provides a template for the latest version of that GNU package, including the hash of its source tarball, and its canonical synopsis and description."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11915
- msgid "Additional information such as the package dependencies and its license needs to be figured out manually."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11918
- msgid "For example, the following command returns a package definition for GNU@tie{}Hello:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11921
- #, no-wrap
- msgid "guix import gnu hello\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11924 guix-git/doc/guix.texi:12165
- #: guix-git/doc/guix.texi:12215 guix-git/doc/guix.texi:12244
- msgid "Specific command-line options are:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11926 guix-git/doc/guix.texi:12743
- #, no-wrap
- msgid "--key-download=@var{policy}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11930
- msgid "As for @command{guix refresh}, specify the policy to handle missing OpenPGP keys when verifying the package signature. @xref{Invoking guix refresh, @option{--key-download}}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11932 guix-git/doc/guix.texi:11933
- #: guix-git/doc/guix.texi:12570
- #, no-wrap
- msgid "pypi"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11940
- msgid "Import metadata from the @uref{https://pypi.python.org/, Python Package Index}. Information is taken from the JSON-formatted description available at @code{pypi.python.org} and usually includes all the relevant information, including package dependencies. For maximum efficiency, it is recommended to install the @command{unzip} utility, so that the importer can unzip Python wheels and gather data from them."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11943
- msgid "The command below imports metadata for the latest version of the @code{itsdangerous} Python package:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11946
- #, no-wrap
- msgid "guix import pypi itsdangerous\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11949 guix-git/doc/guix.texi:12052
- #: guix-git/doc/guix.texi:12393
- msgid "You can also ask for a specific version:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11952
- #, no-wrap
- msgid "guix import pypi itsdangerous@@1.1.0\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11960 guix-git/doc/guix.texi:11985
- #: guix-git/doc/guix.texi:12017 guix-git/doc/guix.texi:12188
- #: guix-git/doc/guix.texi:12229 guix-git/doc/guix.texi:12280
- #: guix-git/doc/guix.texi:12305 guix-git/doc/guix.texi:12321
- #: guix-git/doc/guix.texi:12369 guix-git/doc/guix.texi:12405
- msgid "Traverse the dependency graph of the given upstream package recursively and generate package expressions for all those packages that are not yet in Guix."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:11962 guix-git/doc/guix.texi:11963
- #: guix-git/doc/guix.texi:12572
- #, no-wrap
- msgid "gem"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11972
- msgid "Import metadata from @uref{https://rubygems.org/, RubyGems}. Information is taken from the JSON-formatted description available at @code{rubygems.org} and includes most relevant information, including runtime dependencies. There are some caveats, however. The metadata doesn't distinguish between synopses and descriptions, so the same string is used for both fields. Additionally, the details of non-Ruby dependencies required to build native extensions is unavailable and left as an exercise to the packager."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11974
- msgid "The command below imports metadata for the @code{rails} Ruby package:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:11977
- #, no-wrap
- msgid "guix import gem rails\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11987 guix-git/doc/guix.texi:11988
- #, no-wrap
- msgid "minetest"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:11989
- #, no-wrap
- msgid "ContentDB"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:11998
- msgid "Import metadata from @uref{https://content.minetest.net, ContentDB}. Information is taken from the JSON-formatted metadata provided through @uref{https://content.minetest.net/help/api/, ContentDB's API} and includes most relevant information, including dependencies. There are some caveats, however. The license information is often incomplete. The commit hash is sometimes missing. The descriptions are in the Markdown format, but Guix uses Texinfo instead. Texture packs and subgames are unsupported."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12000
- msgid "The command below imports metadata for the Mesecons mod by Jeija:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12003
- #, no-wrap
- msgid "guix import minetest Jeija/mesecons\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12006
- msgid "The author name can also be left out:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12009
- #, no-wrap
- msgid "guix import minetest mesecons\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12019 guix-git/doc/guix.texi:12568
- #, no-wrap
- msgid "cpan"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:12020
- #, no-wrap
- msgid "CPAN"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12028
- msgid "Import metadata from @uref{https://www.metacpan.org/, MetaCPAN}. Information is taken from the JSON-formatted metadata provided through @uref{https://fastapi.metacpan.org/, MetaCPAN's API} and includes most relevant information, such as module dependencies. License information should be checked closely. If Perl is available in the store, then the @code{corelist} utility will be used to filter core modules out of the list of dependencies."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12031
- msgid "The command command below imports metadata for the Acme::Boolean Perl module:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12034
- #, no-wrap
- msgid "guix import cpan Acme::Boolean\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12036 guix-git/doc/guix.texi:12564
- #, no-wrap
- msgid "cran"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:12037
- #, no-wrap
- msgid "CRAN"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:12038
- #, no-wrap
- msgid "Bioconductor"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12042
- msgid "Import metadata from @uref{https://cran.r-project.org/, CRAN}, the central repository for the @uref{https://r-project.org, GNU@tie{}R statistical and graphical environment}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12044
- msgid "Information is extracted from the @file{DESCRIPTION} file of the package."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12046
- msgid "The command command below imports metadata for the Cairo R package:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12049
- #, no-wrap
- msgid "guix import cran Cairo\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12055
- #, no-wrap
- msgid "guix import cran rasterVis@@0.50.3\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12060
- msgid "When @option{--recursive} is added, the importer will traverse the dependency graph of the given upstream package recursively and generate package expressions for all those packages that are not yet in Guix."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12067
- msgid "When @option{--style=specification} is added, the importer will generate package definitions whose inputs are package specifications instead of references to package variables. This is useful when generated package definitions are to be appended to existing user modules, as the list of used package modules need not be changed. The default is @option{--style=variable}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12072
- msgid "When @option{--archive=bioconductor} is added, metadata is imported from @uref{https://www.bioconductor.org/, Bioconductor}, a repository of R packages for the analysis and comprehension of high-throughput genomic data in bioinformatics."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12075
- msgid "Information is extracted from the @file{DESCRIPTION} file contained in the package archive."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12077
- msgid "The command below imports metadata for the GenomicRanges R package:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12080
- #, no-wrap
- msgid "guix import cran --archive=bioconductor GenomicRanges\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12085
- msgid "Finally, you can also import R packages that have not yet been published on CRAN or Bioconductor as long as they are in a git repository. Use @option{--archive=git} followed by the URL of the git repository:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12088
- #, no-wrap
- msgid "guix import cran --archive=git https://github.com/immunogenomics/harmony\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12090
- #, no-wrap
- msgid "texlive"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:12091
- #, no-wrap
- msgid "TeX Live"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:12092
- #, no-wrap
- msgid "CTAN"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12096
- msgid "Import TeX package information from the TeX Live package database for TeX packages that are part of the @uref{https://www.tug.org/texlive/, TeX Live distribution}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12101
- msgid "Information about the package is obtained from the TeX Live package database, a plain text file that is included in the @code{texlive-bin} package. The source code is downloaded from possibly multiple locations in the SVN repository of the Tex Live project."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12104
- msgid "The command command below imports metadata for the @code{fontspec} TeX package:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12107
- #, no-wrap
- msgid "guix import texlive fontspec\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:12110
- #, no-wrap
- msgid "JSON, import"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12113
- msgid "Import package metadata from a local JSON file. Consider the following example package definition in JSON format:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12126
- #, no-wrap
- msgid ""
- "@{\n"
- " \"name\": \"hello\",\n"
- " \"version\": \"2.10\",\n"
- " \"source\": \"mirror://gnu/hello/hello-2.10.tar.gz\",\n"
- " \"build-system\": \"gnu\",\n"
- " \"home-page\": \"https://www.gnu.org/software/hello/\",\n"
- " \"synopsis\": \"Hello, GNU world: An example GNU package\",\n"
- " \"description\": \"GNU Hello prints a greeting.\",\n"
- " \"license\": \"GPL-3.0+\",\n"
- " \"native-inputs\": [\"gettext\"]\n"
- "@}\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12132
- msgid "The field names are the same as for the @code{<package>} record (@xref{Defining Packages}). References to other packages are provided as JSON lists of quoted package specification strings such as @code{guile} or @code{guile@@2.0}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12135
- msgid "The importer also supports a more explicit source definition using the common fields for @code{<origin>} records:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12148
- #, no-wrap
- msgid ""
- "@{\n"
- " @dots{}\n"
- " \"source\": @{\n"
- " \"method\": \"url-fetch\",\n"
- " \"uri\": \"mirror://gnu/hello/hello-2.10.tar.gz\",\n"
- " \"sha256\": @{\n"
- " \"base32\": \"0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i\"\n"
- " @}\n"
- " @}\n"
- " @dots{}\n"
- "@}\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12152
- msgid "The command below reads metadata from the JSON file @code{hello.json} and outputs a package expression:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12155
- #, no-wrap
- msgid "guix import json hello.json\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12157 guix-git/doc/guix.texi:12158
- #: guix-git/doc/guix.texi:12576
- #, no-wrap
- msgid "hackage"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12163
- msgid "Import metadata from the Haskell community's central package archive @uref{https://hackage.haskell.org/, Hackage}. Information is taken from Cabal files and includes all the relevant information, including package dependencies."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12167
- #, no-wrap
- msgid "--stdin"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:12168
- #, no-wrap
- msgid "-s"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12170
- msgid "Read a Cabal file from standard input."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12170 guix-git/doc/guix.texi:12217
- #, no-wrap
- msgid "--no-test-dependencies"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12173 guix-git/doc/guix.texi:12220
- msgid "Do not include dependencies required only by the test suites."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12173
- #, no-wrap
- msgid "--cabal-environment=@var{alist}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:12174
- #, no-wrap
- msgid "-e @var{alist}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12183
- msgid "@var{alist} is a Scheme alist defining the environment in which the Cabal conditionals are evaluated. The accepted keys are: @code{os}, @code{arch}, @code{impl} and a string representing the name of a flag. The value associated with a flag has to be either the symbol @code{true} or @code{false}. The value associated with other keys has to conform to the Cabal file format definition. The default value associated with the keys @code{os}, @code{arch} and @code{impl} is @samp{linux}, @samp{x86_64} and @samp{ghc}, respectively."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12193
- msgid "The command below imports metadata for the latest version of the HTTP Haskell package without including test dependencies and specifying the value of the flag @samp{network-uri} as @code{false}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12196
- #, no-wrap
- msgid "guix import hackage -t -e \"'((\\\"network-uri\\\" . false))\" HTTP\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12200
- msgid "A specific package version may optionally be specified by following the package name by an at-sign and a version number as in the following example:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12203
- #, no-wrap
- msgid "guix import hackage mtl@@2.1.3.1\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12205 guix-git/doc/guix.texi:12206
- #: guix-git/doc/guix.texi:12578
- #, no-wrap
- msgid "stackage"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12213
- msgid "The @code{stackage} importer is a wrapper around the @code{hackage} one. It takes a package name, looks up the package version included in a long-term support (LTS) @uref{https://www.stackage.org, Stackage} release and uses the @code{hackage} importer to retrieve its metadata. Note that it is up to you to select an LTS release compatible with the GHC compiler used by Guix."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12220
- #, no-wrap
- msgid "--lts-version=@var{version}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:12221
- #, no-wrap
- msgid "-l @var{version}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12224
- msgid "@var{version} is the desired LTS release version. If omitted the latest release is used."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12233
- msgid "The command below imports metadata for the HTTP Haskell package included in the LTS Stackage release version 7.18:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12236
- #, no-wrap
- msgid "guix import stackage --lts-version=7.18 HTTP\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12238 guix-git/doc/guix.texi:12239
- #: guix-git/doc/guix.texi:12562
- #, no-wrap
- msgid "elpa"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12242
- msgid "Import metadata from an Emacs Lisp Package Archive (ELPA) package repository (@pxref{Packages,,, emacs, The GNU Emacs Manual})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12246
- #, no-wrap
- msgid "--archive=@var{repo}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:12247
- #, no-wrap
- msgid "-a @var{repo}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12251
- msgid "@var{repo} identifies the archive repository from which to retrieve the information. Currently the supported repositories and their identifiers are:"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:12255
- msgid "@uref{https://elpa.gnu.org/packages, GNU}, selected by the @code{gnu} identifier. This is the default."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:12261
- msgid "Packages from @code{elpa.gnu.org} are signed with one of the keys contained in the GnuPG keyring at @file{share/emacs/25.1/etc/package-keyring.gpg} (or similar) in the @code{emacs} package (@pxref{Package Installation, ELPA package signatures,, emacs, The GNU Emacs Manual})."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:12265
- msgid "@uref{https://elpa.nongnu.org/nongnu/, NonGNU}, selected by the @code{nongnu} identifier."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:12269
- msgid "@uref{https://stable.melpa.org/packages, MELPA-Stable}, selected by the @code{melpa-stable} identifier."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:12273
- msgid "@uref{https://melpa.org/packages, MELPA}, selected by the @code{melpa} identifier."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12282 guix-git/doc/guix.texi:12283
- #: guix-git/doc/guix.texi:12580
- #, no-wrap
- msgid "crate"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12286
- msgid "Import metadata from the crates.io Rust package repository @uref{https://crates.io, crates.io}, as in this example:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12289
- #, no-wrap
- msgid "guix import crate blake2-rfc\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12292
- msgid "The crate importer also allows you to specify a version string:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12295
- #, no-wrap
- msgid "guix import crate constant-time-eq@@0.1.0\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12298 guix-git/doc/guix.texi:12314
- #: guix-git/doc/guix.texi:12362 guix-git/doc/guix.texi:12399
- msgid "Additional options include:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12307
- #, no-wrap
- msgid "opam"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:12308
- #, no-wrap
- msgid "OPAM"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:12309
- #, no-wrap
- msgid "OCaml"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12312
- msgid "Import metadata from the @uref{https://opam.ocaml.org/, OPAM} package repository used by the OCaml community."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12321
- #, no-wrap
- msgid "--repo"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12325
- msgid "By default, packages are searched in the official OPAM repository. This option, which can be used more than once, lets you add other repositories which will be searched for packages. It accepts as valid arguments:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12327
- #, no-wrap
- msgid "the name of a known repository - can be one of @code{opam},"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:12330
- msgid "@code{coq} (equivalent to @code{coq-released}), @code{coq-core-dev}, @code{coq-extra-dev} or @code{grew}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12330
- #, no-wrap
- msgid "the URL of a repository as expected by the"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:12334
- msgid "@code{opam repository add} command (for instance, the URL equivalent of the above @code{opam} name would be @uref{https://opam.ocaml.org})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12334
- #, no-wrap
- msgid "the path to a local copy of a repository (a directory containing a"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:12336
- msgid "@file{packages/} sub-directory)."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12341
- msgid "Repositories are assumed to be passed to this option by order of preference. The additional repositories will not replace the default @code{opam} repository, which is always kept as a fallback."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12346
- msgid "Also, please note that versions are not compared across repositories. The first repository (from left to right) that has at least one version of a given package will prevail over any others, and the version imported will be the latest one found @emph{in this repository only}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:12349 guix-git/doc/guix.texi:12350
- #, no-wrap
- msgid "go"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12353
- msgid "Import metadata for a Go module using @uref{https://proxy.golang.org, proxy.golang.org}."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12356
- #, no-wrap
- msgid "guix import go gopkg.in/yaml.v2\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12360
- msgid "It is possible to use a package specification with a @code{@@VERSION} suffix to import a specific version."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12369
- #, no-wrap
- msgid "--pin-versions"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12377
- msgid "When using this option, the importer preserves the exact versions of the Go modules dependencies instead of using their latest available versions. This can be useful when attempting to import packages that recursively depend on former versions of themselves to build. When using this mode, the symbol of the package is made by appending the version to its name, so that multiple versions of the same package can coexist."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12379 guix-git/doc/guix.texi:12380
- #: guix-git/doc/guix.texi:12560
- #, no-wrap
- msgid "egg"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12387
- msgid "Import metadata for @uref{https://wiki.call-cc.org/eggs, CHICKEN eggs}. The information is taken from @file{PACKAGE.egg} files found in the @uref{git://code.call-cc.org/eggs-5-all, eggs-5-all} Git repository. However, it does not provide all the information that we need, there is no ``description'' field, and the licenses used are not always precise (BSD is often used instead of BSD-N)."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12390
- #, no-wrap
- msgid "guix import egg sourcehut\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12396
- #, no-wrap
- msgid "guix import egg arrays@@1.0\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:12411
- msgid "The structure of the @command{guix import} code is modular. It would be useful to have more importers for other package formats, and your help is welcome here (@pxref{Contributing})."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:12413
- #, no-wrap
- msgid "Invoking @command{guix refresh}"
- msgstr ""
- #. type: command{#1}
- #: guix-git/doc/guix.texi:12415
- #, no-wrap
- msgid "guix refresh"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:12423
- msgid "The primary audience of the @command{guix refresh} command is packagers. As a user, you may be interested in the @option{--with-latest} option, which can bring you package update superpowers built upon @command{guix refresh} (@pxref{Package Transformation Options, @option{--with-latest}}). By default, @command{guix refresh} reports any packages provided by the distribution that are outdated compared to the latest upstream version, like this:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12428
- #, no-wrap
- msgid ""
- "$ guix refresh\n"
- "gnu/packages/gettext.scm:29:13: gettext would be upgraded from 0.18.1.1 to 0.18.2.1\n"
- "gnu/packages/glib.scm:77:12: glib would be upgraded from 2.34.3 to 2.37.0\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:12432
- msgid "Alternatively, one can specify packages to consider, in which case a warning is emitted for packages that lack an updater:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12437
- #, no-wrap
- msgid ""
- "$ guix refresh coreutils guile guile-ssh\n"
- "gnu/packages/ssh.scm:205:2: warning: no updater for guile-ssh\n"
- "gnu/packages/guile.scm:136:12: guile would be upgraded from 2.0.12 to 2.0.13\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:12446
- msgid "@command{guix refresh} browses the upstream repository of each package and determines the highest version number of the releases therein. The command knows how to update specific types of packages: GNU packages, ELPA packages, etc.---see the documentation for @option{--type} below. There are many packages, though, for which it lacks a method to determine whether a new upstream release is available. However, the mechanism is extensible, so feel free to get in touch with us to add a new method!"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12451
- msgid "Consider the packages specified, and all the packages upon which they depend."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12459
- #, no-wrap
- msgid ""
- "$ guix refresh --recursive coreutils\n"
- "gnu/packages/acl.scm:40:13: acl would be upgraded from 2.2.53 to 2.3.1\n"
- "gnu/packages/m4.scm:30:12: 1.4.18 is already the latest version of m4\n"
- "gnu/packages/xml.scm:68:2: warning: no updater for expat\n"
- "gnu/packages/multiprecision.scm:40:12: 6.1.2 is already the latest version of gmp\n"
- "@dots{}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:12467
- msgid "Sometimes the upstream name differs from the package name used in Guix, and @command{guix refresh} needs a little help. Most updaters honor the @code{upstream-name} property in package definitions, which can be used to that effect:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:12474
- #, no-wrap
- msgid ""
- "(define-public network-manager\n"
- " (package\n"
- " (name \"network-manager\")\n"
- " ;; @dots{}\n"
- " (properties '((upstream-name . \"NetworkManager\")))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:12483
- msgid "When passed @option{--update}, it modifies distribution source files to update the version numbers and source tarball hashes of those package recipes (@pxref{Defining Packages}). This is achieved by downloading each package's latest source tarball and its associated OpenPGP signature, authenticating the downloaded tarball against its signature using @command{gpgv}, and finally computing its hash---note that GnuPG must be installed and in @code{$PATH}; run @code{guix install gnupg} if needed."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:12489
- msgid "When the public key used to sign the tarball is missing from the user's keyring, an attempt is made to automatically retrieve it from a public key server; when this is successful, the key is added to the user's keyring; otherwise, @command{guix refresh} reports an error."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:12491
- msgid "The following options are supported:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12499 guix-git/doc/guix.texi:13447
- msgid "This is useful to precisely refer to a package, as in this example:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12502
- #, no-wrap
- msgid "guix refresh -l -e '(@@@@ (gnu packages commencement) glibc-final)'\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12506
- msgid "This command lists the dependents of the ``final'' libc (essentially all the packages)."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12507
- #, no-wrap
- msgid "--update"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:12508
- #, no-wrap
- msgid "-u"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12512
- msgid "Update distribution source files (package recipes) in place. This is usually run from a checkout of the Guix source tree (@pxref{Running Guix Before It Is Installed}):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12515
- #, no-wrap
- msgid "$ ./pre-inst-env guix refresh -s non-core -u\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12518
- msgid "@xref{Defining Packages}, for more information on package definitions."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12519
- #, no-wrap
- msgid "--select=[@var{subset}]"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:12520
- #, no-wrap
- msgid "-s @var{subset}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12523
- msgid "Select all the packages in @var{subset}, one of @code{core} or @code{non-core}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12530
- msgid "The @code{core} subset refers to all the packages at the core of the distribution---i.e., packages that are used to build ``everything else''. This includes GCC, libc, Binutils, Bash, etc. Usually, changing one of these packages in the distribution entails a rebuild of all the others. Thus, such updates are an inconvenience to users in terms of build time or bandwidth used to achieve the upgrade."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12534
- msgid "The @code{non-core} subset refers to the remaining packages. It is typically useful in cases where an update of the core packages would be inconvenient."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12539
- msgid "Select all the packages from the manifest in @var{file}. This is useful to check if any packages of the user manifest can be updated."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12540
- #, no-wrap
- msgid "--type=@var{updater}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:12541
- #, no-wrap
- msgid "-t @var{updater}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12544
- msgid "Select only packages handled by @var{updater} (may be a comma-separated list of updaters). Currently, @var{updater} may be one of:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12548
- msgid "the updater for GNU packages;"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12548
- #, no-wrap
- msgid "savannah"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12550
- msgid "the updater for packages hosted at @uref{https://savannah.gnu.org, Savannah};"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12550
- #, no-wrap
- msgid "sourceforge"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12552
- msgid "the updater for packages hosted at @uref{https://sourceforge.net, SourceForge};"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12552
- #, no-wrap
- msgid "gnome"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12554
- msgid "the updater for GNOME packages;"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12554
- #, no-wrap
- msgid "kde"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12556
- msgid "the updater for KDE packages;"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12556
- #, no-wrap
- msgid "xorg"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12558
- msgid "the updater for X.org packages;"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12558
- #, no-wrap
- msgid "kernel.org"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12560
- msgid "the updater for packages hosted on kernel.org;"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12562
- msgid "the updater for @uref{https://wiki.call-cc.org/eggs/, Egg} packages;"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12564
- msgid "the updater for @uref{https://elpa.gnu.org/, ELPA} packages;"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12566
- msgid "the updater for @uref{https://cran.r-project.org/, CRAN} packages;"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12566
- #, no-wrap
- msgid "bioconductor"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12568
- msgid "the updater for @uref{https://www.bioconductor.org/, Bioconductor} R packages;"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12570
- msgid "the updater for @uref{https://www.cpan.org/, CPAN} packages;"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12572
- msgid "the updater for @uref{https://pypi.python.org, PyPI} packages."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12574
- msgid "the updater for @uref{https://rubygems.org, RubyGems} packages."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12574
- #, no-wrap
- msgid "github"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12576
- msgid "the updater for @uref{https://github.com, GitHub} packages."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12578
- msgid "the updater for @uref{https://hackage.haskell.org, Hackage} packages."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12580
- msgid "the updater for @uref{https://www.stackage.org, Stackage} packages."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12582
- msgid "the updater for @uref{https://crates.io, Crates} packages."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12582
- #, no-wrap
- msgid "launchpad"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12584
- msgid "the updater for @uref{https://launchpad.net, Launchpad} packages."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12584
- #, no-wrap
- msgid "generic-html"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12587
- msgid "a generic updater that crawls the HTML page where the source tarball of the package is hosted, when applicable."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12588
- #, no-wrap
- msgid "generic-git"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12593
- msgid "a generic updater for packages hosted on Git repositories. It tries to be smart about parsing Git tag names, but if it is not able to parse the tag name and compare tags correctly, users can define the following properties for a package."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12595
- #, no-wrap
- msgid "@code{release-tag-prefix}: a regular expression for matching a prefix of"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:12597 guix-git/doc/guix.texi:12600
- msgid "the tag name."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12598
- #, no-wrap
- msgid "@code{release-tag-suffix}: a regular expression for matching a suffix of"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12601
- #, no-wrap
- msgid "@code{release-tag-version-delimiter}: a string used as the delimiter in"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:12603
- msgid "the tag name for separating the numbers of the version."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12604
- #, no-wrap
- msgid "@code{accept-pre-releases}: by default, the updater will ignore"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:12607
- msgid "pre-releases; to make it also look for pre-releases, set the this property to @code{#t}."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:12618
- #, no-wrap
- msgid ""
- "(package\n"
- " (name \"foo\")\n"
- " ;; ...\n"
- " (properties\n"
- " '((release-tag-prefix . \"^release0-\")\n"
- " (release-tag-suffix . \"[a-z]?$\")\n"
- " (release-tag-version-delimiter . \":\"))))\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12625
- msgid "For instance, the following command only checks for updates of Emacs packages hosted at @code{elpa.gnu.org} and for updates of CRAN packages:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12630
- #, no-wrap
- msgid ""
- "$ guix refresh --type=elpa,cran\n"
- "gnu/packages/statistics.scm:819:13: r-testthat would be upgraded from 0.10.0 to 0.11.0\n"
- "gnu/packages/emacs.scm:856:13: emacs-auctex would be upgraded from 11.88.6 to 11.88.9\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12632
- #, no-wrap
- msgid "--list-updaters"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:12633
- #, no-wrap
- msgid "-L"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12635
- msgid "List available updaters and exit (see @option{--type} above)."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12638
- msgid "For each updater, display the fraction of packages it covers; at the end, display the fraction of packages covered by all these updaters."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:12642
- msgid "In addition, @command{guix refresh} can be passed one or more package names, as in this example:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12645
- #, no-wrap
- msgid "$ ./pre-inst-env guix refresh -u emacs idutils gcc@@4.8\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:12652
- msgid "The command above specifically updates the @code{emacs} and @code{idutils} packages. The @option{--select} option would have no effect in this case. You might also want to update definitions that correspond to the packages installed in your profile:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12656
- #, no-wrap
- msgid ""
- "$ ./pre-inst-env guix refresh -u \\\n"
- " $(guix package --list-installed | cut -f1)\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:12662
- msgid "When considering whether to upgrade a package, it is sometimes convenient to know which packages would be affected by the upgrade and should be checked for compatibility. For this the following option may be used when passing @command{guix refresh} one or more package names:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12665
- #, no-wrap
- msgid "--list-dependent"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:12666 guix-git/doc/guix.texi:13028
- #, no-wrap
- msgid "-l"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12669
- msgid "List top-level dependent packages that would need to be rebuilt as a result of upgrading one or more packages."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12673
- msgid "@xref{Invoking guix graph, the @code{reverse-package} type of @command{guix graph}}, for information on how to visualize the list of dependents of a package."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:12679
- msgid "Be aware that the @option{--list-dependent} option only @emph{approximates} the rebuilds that would be required as a result of an upgrade. More rebuilds might be required under some circumstances."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12684
- #, no-wrap
- msgid ""
- "$ guix refresh --list-dependent flex\n"
- "Building the following 120 packages would ensure 213 dependent packages are rebuilt:\n"
- "hop@@2.4.0 emacs-geiser@@0.13 notmuch@@0.18 mu@@0.9.9.5 cflow@@1.4 idutils@@4.6 @dots{}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:12688
- msgid "The command above lists a set of packages that could be built to check for compatibility with an upgraded @code{flex} package."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12691
- #, no-wrap
- msgid "--list-transitive"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12693
- msgid "List all the packages which one or more packages depend upon."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12698
- #, no-wrap
- msgid ""
- "$ guix refresh --list-transitive flex\n"
- "flex@@2.6.4 depends on the following 25 packages: perl@@5.28.0 help2man@@1.47.6\n"
- "bison@@3.0.5 indent@@2.2.10 tar@@1.30 gzip@@1.9 bzip2@@1.0.6 xz@@5.2.4 file@@5.33 @dots{}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:12704
- msgid "The command above lists a set of packages which, when changed, would cause @code{flex} to be rebuilt."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:12706
- msgid "The following options can be used to customize GnuPG operation:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12709
- #, no-wrap
- msgid "--gpg=@var{command}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12712
- msgid "Use @var{command} as the GnuPG 2.x command. @var{command} is searched for in @code{$PATH}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12713
- #, no-wrap
- msgid "--keyring=@var{file}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12719
- msgid "Use @var{file} as the keyring for upstream keys. @var{file} must be in the @dfn{keybox format}. Keybox files usually have a name ending in @file{.kbx} and the GNU@tie{}Privacy Guard (GPG) can manipulate these files (@pxref{kbxutil, @command{kbxutil},, gnupg, Using the GNU Privacy Guard}, for information on a tool to manipulate keybox files)."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12725
- msgid "When this option is omitted, @command{guix refresh} uses @file{~/.config/guix/upstream/trustedkeys.kbx} as the keyring for upstream signing keys. OpenPGP signatures are checked against keys from this keyring; missing keys are downloaded to this keyring as well (see @option{--key-download} below)."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12728
- msgid "You can export keys from your default GPG keyring into a keybox file using commands like this one:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12731
- #, no-wrap
- msgid "gpg --export rms@@gnu.org | kbxutil --import-openpgp >> mykeyring.kbx\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12734
- msgid "Likewise, you can fetch keys to a specific keybox file like this:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12738
- #, no-wrap
- msgid ""
- "gpg --no-default-keyring --keyring mykeyring.kbx \\\n"
- " --recv-keys @value{OPENPGP-SIGNING-KEY-ID}\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12742
- msgid "@xref{GPG Configuration Options, @option{--keyring},, gnupg, Using the GNU Privacy Guard}, for more information on GPG's @option{--keyring} option."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12746
- msgid "Handle missing OpenPGP keys according to @var{policy}, which may be one of:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12748 guix-git/doc/guix.texi:12871
- #: guix-git/doc/guix.texi:22249
- #, no-wrap
- msgid "always"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12751
- msgid "Always download missing OpenPGP keys from the key server, and add them to the user's GnuPG keyring."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12752 guix-git/doc/guix.texi:22251
- #, no-wrap
- msgid "never"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12754
- msgid "Never try to download missing OpenPGP keys. Instead just bail out."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12755
- #, no-wrap
- msgid "interactive"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12758
- msgid "When a package signed with an unknown OpenPGP key is encountered, ask the user whether to download it or not. This is the default behavior."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12760
- #, no-wrap
- msgid "--key-server=@var{host}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12762
- msgid "Use @var{host} as the OpenPGP key server when importing a public key."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:12782
- msgid "The @code{github} updater uses the @uref{https://developer.github.com/v3/, GitHub API} to query for new releases. When used repeatedly e.g.@: when refreshing all packages, GitHub will eventually refuse to answer any further API requests. By default 60 API requests per hour are allowed, and a full refresh on all GitHub packages in Guix requires more than this. Authentication with GitHub through the use of an API token alleviates these limits. To use an API token, set the environment variable @env{GUIX_GITHUB_TOKEN} to a token procured from @uref{https://github.com/settings/tokens} or otherwise."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:12785
- #, no-wrap
- msgid "Invoking @command{guix style}"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:12791
- msgid "The @command{guix style} command helps packagers style their package definitions according to the latest fashionable trends. The command currently focuses on one aspect: the style of package inputs. It may eventually be extended to handle other stylistic matters."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:12796
- msgid "The way package inputs are written is going through a transition (@pxref{package Reference}, for more on package inputs). Until version 1.3.0, package inputs were written using the ``old style'', where each input was given an explicit label, most of the time the package name:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:12803
- #, no-wrap
- msgid ""
- "(package\n"
- " ;; @dots{}\n"
- " ;; The \"old style\" (deprecated).\n"
- " (inputs `((\"libunistring\" ,libunistring)\n"
- " (\"libffi\" ,libffi))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:12807
- msgid "Today, the old style is deprecated and the preferred style looks like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:12813
- #, no-wrap
- msgid ""
- "(package\n"
- " ;; @dots{}\n"
- " ;; The \"new style\".\n"
- " (inputs (list libunistring libffi)))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:12818
- msgid "Likewise, uses of @code{alist-delete} and friends to manipulate inputs is now deprecated in favor of @code{modify-inputs} (@pxref{Defining Package Variants}, for more info on @code{modify-inputs})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:12823
- msgid "In the vast majority of cases, this is a purely mechanical change on the surface syntax that does not even incur a package rebuild. Running @command{guix style} can do that for you, whether you're working on packages in Guix proper or in an external channel."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12828
- #, no-wrap
- msgid "guix style [@var{options}] @var{package}@dots{}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:12834
- msgid "This causes @command{guix style} to analyze and rewrite the definition of @var{package}@dots{}. It does so in a conservative way: preserving comments and bailing out if it cannot make sense of the code that appears in an inputs field. The available options are listed below."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12839
- msgid "Show source file locations that would be edited but do not modify them."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12848
- msgid "Style the package @var{expr} evaluates to."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:12853
- #, no-wrap
- msgid "guix style -e '(@@ (gnu packages gcc) gcc-5)'\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12856
- msgid "styles the @code{gcc-5} package definition."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12857
- #, no-wrap
- msgid "--input-simplification=@var{policy}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12861
- msgid "Specify the package input simplification policy for cases where an input label does not match the corresponding package name. @var{policy} may be one of the following:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12863
- #, no-wrap
- msgid "silent"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12866
- msgid "Simplify inputs only when the change is ``silent'', meaning that the package does not need to be rebuilt (its derivation is unchanged)."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12867
- #, no-wrap
- msgid "safe"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12870
- msgid "Simplify inputs only when that is ``safe'' to do: the package might need to be rebuilt, but the change is known to have no observable effect."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12874
- msgid "Simplify inputs even when input labels do not match package names, and even if that might have an observable effect."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12878
- msgid "The default is @code{silent}, meaning that input simplifications do not trigger any package rebuild."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:12881
- #, no-wrap
- msgid "Invoking @command{guix lint}"
- msgstr ""
- #. type: command{#1}
- #: guix-git/doc/guix.texi:12883
- #, no-wrap
- msgid "guix lint"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:12884
- #, no-wrap
- msgid "package, checking for errors"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:12890
- msgid "The @command{guix lint} command is meant to help package developers avoid common errors and use a consistent style. It runs a number of checks on a given set of packages in order to find common mistakes in their definitions. Available @dfn{checkers} include (see @option{--list-checkers} for a complete list):"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12896
- msgid "Validate certain typographical and stylistic rules about package descriptions and synopses."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12897
- #, no-wrap
- msgid "inputs-should-be-native"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12899
- msgid "Identify inputs that should most likely be native inputs."
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:12902
- #, no-wrap
- msgid "mirror-url"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:12903
- #, no-wrap
- msgid "github-url"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:12904
- #, no-wrap
- msgid "source-file-name"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12911
- msgid "Probe @code{home-page} and @code{source} URLs and report those that are invalid. Suggest a @code{mirror://} URL when applicable. If the @code{source} URL redirects to a GitHub URL, recommend usage of the GitHub URL@. Check that the source file name is meaningful, e.g.@: is not just a version number or ``git-checkout'', without a declared @code{file-name} (@pxref{origin Reference})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12912
- #, no-wrap
- msgid "source-unstable-tarball"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12916
- msgid "Parse the @code{source} URL to determine if a tarball from GitHub is autogenerated or if it is a release tarball. Unfortunately GitHub's autogenerated tarballs are sometimes regenerated."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12920
- msgid "Check that the derivation of the given packages can be successfully computed for all the supported systems (@pxref{Derivations})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12921
- #, no-wrap
- msgid "profile-collisions"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12927
- msgid "Check whether installing the given packages in a profile would lead to collisions. Collisions occur when several packages with the same name but a different version or a different store file name are propagated. @xref{package Reference, @code{propagated-inputs}}, for more information on propagated inputs."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12928
- #, no-wrap
- msgid "archival"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:12929
- #, no-wrap
- msgid "Software Heritage, source code archive"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:12930
- #, no-wrap
- msgid "archival of source code, Software Heritage"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12933
- msgid "Checks whether the package's source code is archived at @uref{https://www.softwareheritage.org, Software Heritage}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12941
- msgid "When the source code that is not archived comes from a version-control system (VCS)---e.g., it's obtained with @code{git-fetch}, send Software Heritage a ``save'' request so that it eventually archives it. This ensures that the source will remain available in the long term, and that Guix can fall back to Software Heritage should the source code disappear from its original host. The status of recent ``save'' requests can be @uref{https://archive.softwareheritage.org/save/#requests, viewed on-line}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12946
- msgid "When source code is a tarball obtained with @code{url-fetch}, simply print a message when it is not archived. As of this writing, Software Heritage does not allow requests to save arbitrary tarballs; we are working on ways to ensure that non-VCS source code is also archived."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12952
- msgid "Software Heritage @uref{https://archive.softwareheritage.org/api/#rate-limiting, limits the request rate per IP address}. When the limit is reached, @command{guix lint} prints a message and the @code{archival} checker stops doing anything until that limit has been reset."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:12953
- #, no-wrap
- msgid "cve"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:12954 guix-git/doc/guix.texi:37946
- #, no-wrap
- msgid "security vulnerabilities"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:12955
- #, no-wrap
- msgid "CVE, Common Vulnerabilities and Exposures"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12960
- msgid "Report known vulnerabilities found in the Common Vulnerabilities and Exposures (CVE) databases of the current and past year @uref{https://nvd.nist.gov/vuln/data-feeds, published by the US NIST}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12962
- msgid "To view information about a particular vulnerability, visit pages such as:"
- msgstr ""
- #. type: indicateurl{#1}
- #: guix-git/doc/guix.texi:12966
- msgid "https://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-YYYY-ABCD"
- msgstr ""
- #. type: indicateurl{#1}
- #: guix-git/doc/guix.texi:12968
- msgid "https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-YYYY-ABCD"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12973
- msgid "where @code{CVE-YYYY-ABCD} is the CVE identifier---e.g., @code{CVE-2015-7554}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12978
- msgid "Package developers can specify in package recipes the @uref{https://nvd.nist.gov/products/cpe,Common Platform Enumeration (CPE)} name and version of the package when they differ from the name or version that Guix uses, as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:12986
- #, no-wrap
- msgid ""
- "(package\n"
- " (name \"grub\")\n"
- " ;; @dots{}\n"
- " ;; CPE calls this package \"grub2\".\n"
- " (properties '((cpe-name . \"grub2\")\n"
- " (cpe-version . \"2.3\"))))\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:12993
- msgid "Some entries in the CVE database do not specify which version of a package they apply to, and would thus ``stick around'' forever. Package developers who found CVE alerts and verified they can be ignored can declare them as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:13003
- #, no-wrap
- msgid ""
- "(package\n"
- " (name \"t1lib\")\n"
- " ;; @dots{}\n"
- " ;; These CVEs no longer apply and can be safely ignored.\n"
- " (properties `((lint-hidden-cve . (\"CVE-2011-0433\"\n"
- " \"CVE-2011-1553\"\n"
- " \"CVE-2011-1554\"\n"
- " \"CVE-2011-5244\")))))\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13005
- #, no-wrap
- msgid "formatting"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13008
- msgid "Warn about obvious source code formatting issues: trailing white space, use of tabulations, etc."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13009
- #, no-wrap
- msgid "input-labels"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13015
- msgid "Report old-style input labels that do not match the name of the corresponding package. This aims to help migrate from the ``old input style''. @xref{package Reference}, for more information on package inputs and input styles. @xref{Invoking guix style}, on how to migrate to the new style."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13021
- #, no-wrap
- msgid "guix lint @var{options} @var{package}@dots{}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13025
- msgid "If no package is given on the command line, then all packages are checked. The @var{options} may be zero or more of the following:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13027
- #, no-wrap
- msgid "--list-checkers"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13031
- msgid "List and describe all the available checkers that will be run on packages and exit."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13032
- #, no-wrap
- msgid "--checkers"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:13033
- #, no-wrap
- msgid "-c"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13036
- msgid "Only enable the checkers specified in a comma-separated list using the names returned by @option{--list-checkers}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13037
- #, no-wrap
- msgid "--exclude"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13041
- msgid "Only disable the checkers specified in a comma-separated list using the names returned by @option{--list-checkers}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13042
- #, no-wrap
- msgid "--no-network"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13045
- msgid "Only enable the checkers that do not depend on Internet access."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:13057
- #, no-wrap
- msgid "Invoking @command{guix size}"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:13059 guix-git/doc/guix.texi:35624
- #, no-wrap
- msgid "size"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:13060
- #, no-wrap
- msgid "package size"
- msgstr ""
- #. type: command{#1}
- #: guix-git/doc/guix.texi:13062
- #, no-wrap
- msgid "guix size"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13069
- msgid "The @command{guix size} command helps package developers profile the disk usage of packages. It is easy to overlook the impact of an additional dependency added to a package, or the impact of using a single output for a package that could easily be split (@pxref{Packages with Multiple Outputs}). Such are the typical issues that @command{guix size} can highlight."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13074
- msgid "The command can be passed one or more package specifications such as @code{gcc@@4.8} or @code{guile:debug}, or a file name in the store. Consider this example:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13087
- #, no-wrap
- msgid ""
- "$ guix size coreutils\n"
- "store item total self\n"
- "/gnu/store/@dots{}-gcc-5.5.0-lib 60.4 30.1 38.1%\n"
- "/gnu/store/@dots{}-glibc-2.27 30.3 28.8 36.6%\n"
- "/gnu/store/@dots{}-coreutils-8.28 78.9 15.0 19.0%\n"
- "/gnu/store/@dots{}-gmp-6.1.2 63.1 2.7 3.4%\n"
- "/gnu/store/@dots{}-bash-static-4.4.12 1.5 1.5 1.9%\n"
- "/gnu/store/@dots{}-acl-2.2.52 61.1 0.4 0.5%\n"
- "/gnu/store/@dots{}-attr-2.4.47 60.6 0.2 0.3%\n"
- "/gnu/store/@dots{}-libcap-2.25 60.5 0.2 0.2%\n"
- "total: 78.9 MiB\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13093
- msgid "The store items listed here constitute the @dfn{transitive closure} of Coreutils---i.e., Coreutils and all its dependencies, recursively---as would be returned by:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13096
- #, no-wrap
- msgid "$ guix gc -R /gnu/store/@dots{}-coreutils-8.23\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13104
- msgid "Here the output shows three columns next to store items. The first column, labeled ``total'', shows the size in mebibytes (MiB) of the closure of the store item---that is, its own size plus the size of all its dependencies. The next column, labeled ``self'', shows the size of the item itself. The last column shows the ratio of the size of the item itself to the space occupied by all the items listed here."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13110
- msgid "In this example, we see that the closure of Coreutils weighs in at 79@tie{}MiB, most of which is taken by libc and GCC's run-time support libraries. (That libc and GCC's libraries represent a large fraction of the closure is not a problem @i{per se} because they are always available on the system anyway.)"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13113
- msgid "Since the command also accepts store file names, assessing the size of a build result is straightforward:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13116
- #, no-wrap
- msgid "guix size $(guix system build config.scm)\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13126
- msgid "When the package(s) passed to @command{guix size} are available in the store@footnote{More precisely, @command{guix size} looks for the @emph{ungrafted} variant of the given package(s), as returned by @code{guix build @var{package} --no-grafts}. @xref{Security Updates}, for information on grafts.}, @command{guix size} queries the daemon to determine its dependencies, and measures its size in the store, similar to @command{du -ms --apparent-size} (@pxref{du invocation,,, coreutils, GNU Coreutils})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13131
- msgid "When the given packages are @emph{not} in the store, @command{guix size} reports information based on the available substitutes (@pxref{Substitutes}). This makes it possible it to profile disk usage of store items that are not even on disk, only available remotely."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13133
- msgid "You can also specify several package names:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13143
- #, no-wrap
- msgid ""
- "$ guix size coreutils grep sed bash\n"
- "store item total self\n"
- "/gnu/store/@dots{}-coreutils-8.24 77.8 13.8 13.4%\n"
- "/gnu/store/@dots{}-grep-2.22 73.1 0.8 0.8%\n"
- "/gnu/store/@dots{}-bash-4.3.42 72.3 4.7 4.6%\n"
- "/gnu/store/@dots{}-readline-6.3 67.6 1.2 1.2%\n"
- "@dots{}\n"
- "total: 102.3 MiB\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13149
- msgid "In this example we see that the combination of the four packages takes 102.3@tie{}MiB in total, which is much less than the sum of each closure since they have a lot of dependencies in common."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13155
- msgid "When looking at the profile returned by @command{guix size}, you may find yourself wondering why a given package shows up in the profile at all. To understand it, you can use @command{guix graph --path -t references} to display the shortest path between the two packages (@pxref{Invoking guix graph})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13157
- msgid "The available options are:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13163
- msgid "Use substitute information from @var{urls}. @xref{client-substitute-urls, the same option for @code{guix build}}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13164
- #, no-wrap
- msgid "--sort=@var{key}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13166
- msgid "Sort lines according to @var{key}, one of the following options:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13168
- #, no-wrap
- msgid "self"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13170
- msgid "the size of each item (the default);"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13172
- msgid "the total size of the item's closure."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13174
- #, no-wrap
- msgid "--map-file=@var{file}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13176
- msgid "Write a graphical map of disk usage in PNG format to @var{file}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13178
- msgid "For the example above, the map looks like this:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13181
- msgid "@image{images/coreutils-size-map,5in,, map of Coreutils disk usage produced by @command{guix size}}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13186
- msgid "This option requires that @uref{https://wingolog.org/software/guile-charting/, Guile-Charting} be installed and visible in Guile's module search path. When that is not the case, @command{guix size} fails as it tries to load it."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13190
- msgid "Consider packages for @var{system}---e.g., @code{x86_64-linux}."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:13201
- #, no-wrap
- msgid "Invoking @command{guix graph}"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:13203
- #, no-wrap
- msgid "DAG"
- msgstr ""
- #. type: command{#1}
- #: guix-git/doc/guix.texi:13204
- #, no-wrap
- msgid "guix graph"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13219
- msgid "Packages and their dependencies form a @dfn{graph}, specifically a directed acyclic graph (DAG). It can quickly become difficult to have a mental model of the package DAG, so the @command{guix graph} command provides a visual representation of the DAG@. By default, @command{guix graph} emits a DAG representation in the input format of @uref{https://www.graphviz.org/, Graphviz}, so its output can be passed directly to the @command{dot} command of Graphviz. It can also emit an HTML page with embedded JavaScript code to display a ``chord diagram'' in a Web browser, using the @uref{https://d3js.org/, d3.js} library, or emit Cypher queries to construct a graph in a graph database supporting the @uref{https://www.opencypher.org/, openCypher} query language. With @option{--path}, it simply displays the shortest path between two packages. The general syntax is:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13222
- #, no-wrap
- msgid "guix graph @var{options} @var{package}@dots{}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13227
- msgid "For example, the following command generates a PDF file representing the package DAG for the GNU@tie{}Core Utilities, showing its build-time dependencies:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13230
- #, no-wrap
- msgid "guix graph coreutils | dot -Tpdf > dag.pdf\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13233
- msgid "The output looks like this:"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13235
- msgid "@image{images/coreutils-graph,2in,,Dependency graph of the GNU Coreutils}"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13237
- msgid "Nice little graph, no?"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13240
- msgid "You may find it more pleasant to navigate the graph interactively with @command{xdot} (from the @code{xdot} package):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13243
- #, no-wrap
- msgid "guix graph coreutils | xdot -\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13250
- msgid "But there is more than one graph! The one above is concise: it is the graph of package objects, omitting implicit inputs such as GCC, libc, grep, etc. It is often useful to have such a concise graph, but sometimes one may want to see more details. @command{guix graph} supports several types of graphs, allowing you to choose the level of detail:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13256
- msgid "This is the default type used in the example above. It shows the DAG of package objects, excluding implicit dependencies. It is concise, but filters out many details."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13257
- #, no-wrap
- msgid "reverse-package"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13259
- msgid "This shows the @emph{reverse} DAG of packages. For example:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13262
- #, no-wrap
- msgid "guix graph --type=reverse-package ocaml\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13267
- msgid "...@: yields the graph of packages that @emph{explicitly} depend on OCaml (if you are also interested in cases where OCaml is an implicit dependency, see @code{reverse-bag} below)."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13272
- msgid "Note that for core packages this can yield huge graphs. If all you want is to know the number of packages that depend on a given package, use @command{guix refresh --list-dependent} (@pxref{Invoking guix refresh, @option{--list-dependent}})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13273
- #, no-wrap
- msgid "bag-emerged"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13275
- msgid "This is the package DAG, @emph{including} implicit inputs."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13277
- msgid "For instance, the following command:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13280
- #, no-wrap
- msgid "guix graph --type=bag-emerged coreutils\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13283
- msgid "...@: yields this bigger graph:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13285
- msgid "@image{images/coreutils-bag-graph,,5in,Detailed dependency graph of the GNU Coreutils}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13288
- msgid "At the bottom of the graph, we see all the implicit inputs of @var{gnu-build-system} (@pxref{Build Systems, @code{gnu-build-system}})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13292
- msgid "Now, note that the dependencies of these implicit inputs---that is, the @dfn{bootstrap dependencies} (@pxref{Bootstrapping})---are not shown here, for conciseness."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13293
- #, no-wrap
- msgid "bag"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13296
- msgid "Similar to @code{bag-emerged}, but this time including all the bootstrap dependencies."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13297
- #, no-wrap
- msgid "bag-with-origins"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13299
- msgid "Similar to @code{bag}, but also showing origins and their dependencies."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13300
- #, no-wrap
- msgid "reverse-bag"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13303
- msgid "This shows the @emph{reverse} DAG of packages. Unlike @code{reverse-package}, it also takes implicit dependencies into account. For example:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13306
- #, no-wrap
- msgid "guix graph -t reverse-bag dune\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13313
- msgid "...@: yields the graph of all packages that depend on Dune, directly or indirectly. Since Dune is an @emph{implicit} dependency of many packages @i{via} @code{dune-build-system}, this shows a large number of packages, whereas @code{reverse-package} would show very few if any."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13319
- msgid "This is the most detailed representation: It shows the DAG of derivations (@pxref{Derivations}) and plain store items. Compared to the above representation, many additional nodes are visible, including build scripts, patches, Guile modules, etc."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13322
- msgid "For this type of graph, it is also possible to pass a @file{.drv} file name instead of a package name, as in:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13325
- #, no-wrap
- msgid "guix graph -t derivation $(guix system build -d my-config.scm)\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13327
- #, no-wrap
- msgid "module"
- msgstr "پیمانه"
- #. type: table
- #: guix-git/doc/guix.texi:13331
- msgid "This is the graph of @dfn{package modules} (@pxref{Package Modules}). For example, the following command shows the graph for the package module that defines the @code{guile} package:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13334
- #, no-wrap
- msgid "guix graph -t module guile | xdot -\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13339
- msgid "All the types above correspond to @emph{build-time dependencies}. The following graph type represents the @emph{run-time dependencies}:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13344
- msgid "This is the graph of @dfn{references} of a package output, as returned by @command{guix gc --references} (@pxref{Invoking guix gc})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13347
- msgid "If the given package output is not available in the store, @command{guix graph} attempts to obtain dependency information from substitutes."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13351
- msgid "Here you can also pass a store file name instead of a package name. For example, the command below produces the reference graph of your profile (which can be big!):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13354
- #, no-wrap
- msgid "guix graph -t references $(readlink -f ~/.guix-profile)\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13356
- #, no-wrap
- msgid "referrers"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13359
- msgid "This is the graph of the @dfn{referrers} of a store item, as returned by @command{guix gc --referrers} (@pxref{Invoking guix gc})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13365
- msgid "This relies exclusively on local information from your store. For instance, let us suppose that the current Inkscape is available in 10 profiles on your machine; @command{guix graph -t referrers inkscape} will show a graph rooted at Inkscape and with those 10 profiles linked to it."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13368
- msgid "It can help determine what is preventing a store item from being garbage collected."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:13371
- #, no-wrap
- msgid "shortest path, between packages"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13378
- msgid "Often, the graph of the package you are interested in does not fit on your screen, and anyway all you want to know is @emph{why} that package actually depends on some seemingly unrelated package. The @option{--path} option instructs @command{guix graph} to display the shortest path between two packages (or derivations, or store items, etc.):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13392
- #, no-wrap
- msgid ""
- "$ guix graph --path emacs libunistring\n"
- "emacs@@26.3\n"
- "mailutils@@3.9\n"
- "libunistring@@0.9.10\n"
- "$ guix graph --path -t derivation emacs libunistring\n"
- "/gnu/store/@dots{}-emacs-26.3.drv\n"
- "/gnu/store/@dots{}-mailutils-3.9.drv\n"
- "/gnu/store/@dots{}-libunistring-0.9.10.drv\n"
- "$ guix graph --path -t references emacs libunistring\n"
- "/gnu/store/@dots{}-emacs-26.3\n"
- "/gnu/store/@dots{}-libidn2-2.2.0\n"
- "/gnu/store/@dots{}-libunistring-0.9.10\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13400
- msgid "Sometimes you still want to visualize the graph but would like to trim it so it can actually be displayed. One way to do it is via the @option{--max-depth} (or @option{-M}) option, which lets you specify the maximum depth of the graph. In the example below, we visualize only @code{libreoffice} and the nodes whose distance to @code{libreoffice} is at most 2:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13403
- #, no-wrap
- msgid "guix graph -M 2 libreoffice | xdot -f fdp -\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13407
- msgid "Mind you, that's still a big ball of spaghetti, but at least @command{dot} can render it quickly and it can be browsed somewhat."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13409
- msgid "The available options are the following:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13415
- msgid "Produce a graph output of @var{type}, where @var{type} must be one of the values listed above."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13416
- #, no-wrap
- msgid "--list-types"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13418
- msgid "List the supported graph types."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13419
- #, no-wrap
- msgid "--backend=@var{backend}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:13420
- #, no-wrap
- msgid "-b @var{backend}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13422
- msgid "Produce a graph using the selected @var{backend}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13423
- #, no-wrap
- msgid "--list-backends"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13425
- msgid "List the supported graph backends."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13427
- msgid "Currently, the available backends are Graphviz and d3.js."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13428
- #, no-wrap
- msgid "--path"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13433
- msgid "Display the shortest path between two nodes of the type specified by @option{--type}. The example below shows the shortest path between @code{libreoffice} and @code{llvm} according to the references of @code{libreoffice}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13440
- #, no-wrap
- msgid ""
- "$ guix graph --path -t references libreoffice llvm\n"
- "/gnu/store/@dots{}-libreoffice-6.4.2.2\n"
- "/gnu/store/@dots{}-libepoxy-1.5.4\n"
- "/gnu/store/@dots{}-mesa-19.3.4\n"
- "/gnu/store/@dots{}-llvm-9.0.1\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13450
- #, no-wrap
- msgid "guix graph -e '(@@@@ (gnu packages commencement) gnu-make-final)'\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13455
- msgid "Display the graph for @var{system}---e.g., @code{i686-linux}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13458
- msgid "The package dependency graph is largely architecture-independent, but there are some architecture-dependent bits that this option allows you to visualize."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13474
- msgid "On top of that, @command{guix graph} supports all the usual package transformation options (@pxref{Package Transformation Options}). This makes it easy to view the effect of a graph-rewriting transformation such as @option{--with-input}. For example, the command below outputs the graph of @code{git} once @code{openssl} has been replaced by @code{libressl} everywhere in the graph:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13477
- #, no-wrap
- msgid "guix graph git --with-input=openssl=libressl\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13480
- msgid "So many possibilities, so much fun!"
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:13482
- #, no-wrap
- msgid "Invoking @command{guix publish}"
- msgstr ""
- #. type: command{#1}
- #: guix-git/doc/guix.texi:13484
- #, no-wrap
- msgid "guix publish"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13488
- msgid "The purpose of @command{guix publish} is to enable users to easily share their store with others, who can then use it as a substitute server (@pxref{Substitutes})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13494
- msgid "When @command{guix publish} runs, it spawns an HTTP server which allows anyone with network access to obtain substitutes from it. This means that any machine running Guix can also act as if it were a build farm, since the HTTP interface is compatible with Cuirass, the software behind the @code{@value{SUBSTITUTE-SERVER-1}} build farm."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13500
- msgid "For security, each substitute is signed, allowing recipients to check their authenticity and integrity (@pxref{Substitutes}). Because @command{guix publish} uses the signing key of the system, which is only readable by the system administrator, it must be started as root; the @option{--user} option makes it drop root privileges early on."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13504
- msgid "The signing key pair must be generated before @command{guix publish} is launched, using @command{guix archive --generate-key} (@pxref{Invoking guix archive})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13509
- msgid "When the @option{--advertise} option is passed, the server advertises its availability on the local network using multicast DNS (mDNS) and DNS service discovery (DNS-SD), currently @i{via} Guile-Avahi (@pxref{Top,,, guile-avahi, Using Avahi in Guile Scheme Programs})."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13514
- #, no-wrap
- msgid "guix publish @var{options}@dots{}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13518
- msgid "Running @command{guix publish} without any additional arguments will spawn an HTTP server on port 8080:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13521
- #, no-wrap
- msgid "guix publish\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13525
- msgid "Once a publishing server has been authorized, the daemon may download substitutes from it. @xref{Getting Substitutes from Other Servers}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13533
- msgid "By default, @command{guix publish} compresses archives on the fly as it serves them. This ``on-the-fly'' mode is convenient in that it requires no setup and is immediately available. However, when serving lots of clients, we recommend using the @option{--cache} option, which enables caching of the archives before they are sent to clients---see below for details. The @command{guix weather} command provides a handy way to check what a server provides (@pxref{Invoking guix weather})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13540
- msgid "As a bonus, @command{guix publish} also serves as a content-addressed mirror for source files referenced in @code{origin} records (@pxref{origin Reference}). For instance, assuming @command{guix publish} is running on @code{example.org}, the following URL returns the raw @file{hello-2.10.tar.gz} file with the given SHA256 hash (represented in @code{nix-base32} format, @pxref{Invoking guix hash}):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13543
- #, no-wrap
- msgid "http://example.org/file/hello-2.10.tar.gz/sha256/0ssi1@dots{}ndq1i\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13547
- msgid "Obviously, these URLs only work for files that are in the store; in other cases, they return 404 (``Not Found'')."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:13548
- #, no-wrap
- msgid "build logs, publication"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13550
- msgid "Build logs are available from @code{/log} URLs like:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13553
- #, no-wrap
- msgid "http://example.org/log/gwspk@dots{}-guile-2.2.3\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13563
- msgid "When @command{guix-daemon} is configured to save compressed build logs, as is the case by default (@pxref{Invoking guix-daemon}), @code{/log} URLs return the compressed log as-is, with an appropriate @code{Content-Type} and/or @code{Content-Encoding} header. We recommend running @command{guix-daemon} with @option{--log-compression=gzip} since Web browsers can automatically decompress it, which is not the case with Bzip2 compression."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13567
- #, no-wrap
- msgid "--port=@var{port}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:13568
- #, no-wrap
- msgid "-p @var{port}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13570
- msgid "Listen for HTTP requests on @var{port}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13571
- #, no-wrap
- msgid "--listen=@var{host}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13574
- msgid "Listen on the network interface for @var{host}. The default is to accept connections from any interface."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13579
- msgid "Change privileges to @var{user} as soon as possible---i.e., once the server socket is open and the signing key has been read."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13580
- #, no-wrap
- msgid "--compression[=@var{method}[:@var{level}]]"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:13581
- #, no-wrap
- msgid "-C [@var{method}[:@var{level}]]"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13585
- msgid "Compress data using the given @var{method} and @var{level}. @var{method} is one of @code{lzip}, @code{zstd}, and @code{gzip}; when @var{method} is omitted, @code{gzip} is used."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13589
- msgid "When @var{level} is zero, disable compression. The range 1 to 9 corresponds to different compression levels: 1 is the fastest, and 9 is the best (CPU-intensive). The default is 3."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13596
- msgid "Usually, @code{lzip} compresses noticeably better than @code{gzip} for a small increase in CPU usage; see @uref{https://nongnu.org/lzip/lzip_benchmark.html,benchmarks on the lzip Web page}. However, @code{lzip} achieves low decompression throughput (on the order of 50@tie{}MiB/s on modern hardware), which can be a bottleneck for someone who downloads over a fast network connection."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13600
- msgid "The compression ratio of @code{zstd} is between that of @code{lzip} and that of @code{gzip}; its main advantage is a @uref{https://facebook.github.io/zstd/,high decompression speed}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13609
- msgid "Unless @option{--cache} is used, compression occurs on the fly and the compressed streams are not cached. Thus, to reduce load on the machine that runs @command{guix publish}, it may be a good idea to choose a low compression level, to run @command{guix publish} behind a caching proxy, or to use @option{--cache}. Using @option{--cache} has the advantage that it allows @command{guix publish} to add @code{Content-Length} HTTP header to its responses."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13614
- msgid "This option can be repeated, in which case every substitute gets compressed using all the selected methods, and all of them are advertised. This is useful when users may not support all the compression methods: they can select the one they support."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13615
- #, no-wrap
- msgid "--cache=@var{directory}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:13616
- #, no-wrap
- msgid "-c @var{directory}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13619
- msgid "Cache archives and meta-data (@code{.narinfo} URLs) to @var{directory} and only serve archives that are in cache."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13627
- msgid "When this option is omitted, archives and meta-data are created on-the-fly. This can reduce the available bandwidth, especially when compression is enabled, since this may become CPU-bound. Another drawback of the default mode is that the length of archives is not known in advance, so @command{guix publish} does not add a @code{Content-Length} HTTP header to its responses, which in turn prevents clients from knowing the amount of data being downloaded."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13635
- msgid "Conversely, when @option{--cache} is used, the first request for a store item (@i{via} a @code{.narinfo} URL) triggers a background process to @dfn{bake} the archive---computing its @code{.narinfo} and compressing the archive, if needed. Once the archive is cached in @var{directory}, subsequent requests succeed and are served directly from the cache, which guarantees that clients get the best possible bandwidth."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13642
- msgid "That first @code{.narinfo} request nonetheless returns 200, provided the requested store item is ``small enough'', below the cache bypass threshold---see @option{--cache-bypass-threshold} below. That way, clients do not have to wait until the archive is baked. For larger store items, the first @code{.narinfo} request returns 404, meaning that clients have to wait until the archive is baked."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13646
- msgid "The ``baking'' process is performed by worker threads. By default, one thread per CPU core is created, but this can be customized. See @option{--workers} below."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13649
- msgid "When @option{--ttl} is used, cached entries are automatically deleted when they have expired."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13650
- #, no-wrap
- msgid "--workers=@var{N}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13653
- msgid "When @option{--cache} is used, request the allocation of @var{N} worker threads to ``bake'' archives."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13654
- #, no-wrap
- msgid "--ttl=@var{ttl}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13658
- msgid "Produce @code{Cache-Control} HTTP headers that advertise a time-to-live (TTL) of @var{ttl}. @var{ttl} must denote a duration: @code{5d} means 5 days, @code{1m} means 1 month, and so on."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13663
- msgid "This allows the user's Guix to keep substitute information in cache for @var{ttl}. However, note that @code{guix publish} does not itself guarantee that the store items it provides will indeed remain available for as long as @var{ttl}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13667
- msgid "Additionally, when @option{--cache} is used, cached entries that have not been accessed for @var{ttl} and that no longer have a corresponding item in the store, may be deleted."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13668
- #, no-wrap
- msgid "--negative-ttl=@var{ttl}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13673
- msgid "Similarly produce @code{Cache-Control} HTTP headers to advertise the time-to-live (TTL) of @emph{negative} lookups---missing store items, for which the HTTP 404 code is returned. By default, no negative TTL is advertised."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13677
- msgid "This parameter can help adjust server load and substitute latency by instructing cooperating clients to be more or less patient when a store item is missing."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13678
- #, no-wrap
- msgid "--cache-bypass-threshold=@var{size}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13683
- msgid "When used in conjunction with @option{--cache}, store items smaller than @var{size} are immediately available, even when they are not yet in cache. @var{size} is a size in bytes, or it can be suffixed by @code{M} for megabytes and so on. The default is @code{10M}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13688
- msgid "``Cache bypass'' allows you to reduce the publication delay for clients at the expense of possibly additional I/O and CPU use on the server side: depending on the client access patterns, those store items can end up being baked several times until a copy is available in cache."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13692
- msgid "Increasing the threshold may be useful for sites that have few users, or to guarantee that users get substitutes even for store items that are not popular."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13693
- #, no-wrap
- msgid "--nar-path=@var{path}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13696
- msgid "Use @var{path} as the prefix for the URLs of ``nar'' files (@pxref{Invoking guix archive, normalized archives})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13700
- msgid "By default, nars are served at a URL such as @code{/nar/gzip/@dots{}-coreutils-8.25}. This option allows you to change the @code{/nar} part to @var{path}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13701
- #, no-wrap
- msgid "--public-key=@var{file}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:13702
- #, no-wrap
- msgid "--private-key=@var{file}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13705 guix-git/doc/guix.texi:29141
- #: guix-git/doc/guix.texi:29178
- msgid "Use the specific @var{file}s as the public/private key pair used to sign the store items being published."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13712
- msgid "The files must correspond to the same key pair (the private key is used for signing and the public key is merely advertised in the signature metadata). They must contain keys in the canonical s-expression format as produced by @command{guix archive --generate-key} (@pxref{Invoking guix archive}). By default, @file{/etc/guix/signing-key.pub} and @file{/etc/guix/signing-key.sec} are used."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13713
- #, no-wrap
- msgid "--repl[=@var{port}]"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:13714
- #, no-wrap
- msgid "-r [@var{port}]"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13718
- msgid "Spawn a Guile REPL server (@pxref{REPL Servers,,, guile, GNU Guile Reference Manual}) on @var{port} (37146 by default). This is used primarily for debugging a running @command{guix publish} server."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13724
- msgid "Enabling @command{guix publish} on Guix System is a one-liner: just instantiate a @code{guix-publish-service-type} service in the @code{services} field of the @code{operating-system} declaration (@pxref{guix-publish-service-type, @code{guix-publish-service-type}})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13727
- msgid "If you are instead running Guix on a ``foreign distro'', follow these instructions:"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:13731
- msgid "If your host distro uses the systemd init system:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13736
- #, no-wrap
- msgid ""
- "# ln -s ~root/.guix-profile/lib/systemd/system/guix-publish.service \\\n"
- " /etc/systemd/system/\n"
- "# systemctl start guix-publish && systemctl enable guix-publish\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13744
- #, no-wrap
- msgid ""
- "# ln -s ~root/.guix-profile/lib/upstart/system/guix-publish.conf /etc/init/\n"
- "# start guix-publish\n"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:13748
- msgid "Otherwise, proceed similarly with your distro's init system."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:13751
- #, no-wrap
- msgid "Invoking @command{guix challenge}"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:13754
- #, no-wrap
- msgid "verifiable builds"
- msgstr ""
- #. type: command{#1}
- #: guix-git/doc/guix.texi:13755
- #, no-wrap
- msgid "guix challenge"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:13756
- #, no-wrap
- msgid "challenge"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13761
- msgid "Do the binaries provided by this server really correspond to the source code it claims to build? Is a package build process deterministic? These are the questions the @command{guix challenge} command attempts to answer."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13769
- msgid "The former is obviously an important question: Before using a substitute server (@pxref{Substitutes}), one had better @emph{verify} that it provides the right binaries, and thus @emph{challenge} it. The latter is what enables the former: If package builds are deterministic, then independent builds of the package should yield the exact same result, bit for bit; if a server provides a binary different from the one obtained locally, it may be either corrupt or malicious."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13778
- msgid "We know that the hash that shows up in @file{/gnu/store} file names is the hash of all the inputs of the process that built the file or directory---compilers, libraries, build scripts, etc. (@pxref{Introduction}). Assuming deterministic build processes, one store file name should map to exactly one build output. @command{guix challenge} checks whether there is, indeed, a single mapping by comparing the build outputs of several independent builds of any given store item."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13780
- msgid "The command output looks like this:"
- msgstr ""
- #. type: smallexample
- #: guix-git/doc/guix.texi:13792
- #, no-wrap
- msgid ""
- "$ guix challenge --substitute-urls=\"https://@value{SUBSTITUTE-SERVER-1} https://guix.example.org\"\n"
- "updating list of substitutes from 'https://@value{SUBSTITUTE-SERVER-1}'... 100.0%\n"
- "updating list of substitutes from 'https://guix.example.org'... 100.0%\n"
- "/gnu/store/@dots{}-openssl-1.0.2d contents differ:\n"
- " local hash: 0725l22r5jnzazaacncwsvp9kgf42266ayyp814v7djxs7nk963q\n"
- " https://@value{SUBSTITUTE-SERVER-1}/nar/@dots{}-openssl-1.0.2d: 0725l22r5jnzazaacncwsvp9kgf42266ayyp814v7djxs7nk963q\n"
- " https://guix.example.org/nar/@dots{}-openssl-1.0.2d: 1zy4fmaaqcnjrzzajkdn3f5gmjk754b43qkq47llbyak9z0qjyim\n"
- " differing files:\n"
- " /lib/libcrypto.so.1.1\n"
- " /lib/libssl.so.1.1\n"
- "\n"
- msgstr ""
- #. type: smallexample
- #: guix-git/doc/guix.texi:13799
- #, no-wrap
- msgid ""
- "/gnu/store/@dots{}-git-2.5.0 contents differ:\n"
- " local hash: 00p3bmryhjxrhpn2gxs2fy0a15lnip05l97205pgbk5ra395hyha\n"
- " https://@value{SUBSTITUTE-SERVER-1}/nar/@dots{}-git-2.5.0: 069nb85bv4d4a6slrwjdy8v1cn4cwspm3kdbmyb81d6zckj3nq9f\n"
- " https://guix.example.org/nar/@dots{}-git-2.5.0: 0mdqa9w1p6cmli6976v4wi0sw9r4p5prkj7lzfd1877wk11c9c73\n"
- " differing file:\n"
- " /libexec/git-core/git-fsck\n"
- "\n"
- msgstr ""
- #. type: smallexample
- #: guix-git/doc/guix.texi:13806
- #, no-wrap
- msgid ""
- "/gnu/store/@dots{}-pius-2.1.1 contents differ:\n"
- " local hash: 0k4v3m9z1zp8xzzizb7d8kjj72f9172xv078sq4wl73vnq9ig3ax\n"
- " https://@value{SUBSTITUTE-SERVER-1}/nar/@dots{}-pius-2.1.1: 0k4v3m9z1zp8xzzizb7d8kjj72f9172xv078sq4wl73vnq9ig3ax\n"
- " https://guix.example.org/nar/@dots{}-pius-2.1.1: 1cy25x1a4fzq5rk0pmvc8xhwyffnqz95h2bpvqsz2mpvlbccy0gs\n"
- " differing file:\n"
- " /share/man/man1/pius.1.gz\n"
- "\n"
- msgstr ""
- #. type: smallexample
- #: guix-git/doc/guix.texi:13808
- #, no-wrap
- msgid ""
- "@dots{}\n"
- "\n"
- msgstr ""
- #. type: smallexample
- #: guix-git/doc/guix.texi:13813
- #, no-wrap
- msgid ""
- "6,406 store items were analyzed:\n"
- " - 4,749 (74.1%) were identical\n"
- " - 525 (8.2%) differed\n"
- " - 1,132 (17.7%) were inconclusive\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13821
- msgid "In this example, @command{guix challenge} first scans the store to determine the set of locally-built derivations---as opposed to store items that were downloaded from a substitute server---and then queries all the substitute servers. It then reports those store items for which the servers obtained a result different from the local build."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:13822
- #, no-wrap
- msgid "non-determinism, in package builds"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13833
- msgid "As an example, @code{guix.example.org} always gets a different answer. Conversely, @code{@value{SUBSTITUTE-SERVER-1}} agrees with local builds, except in the case of Git. This might indicate that the build process of Git is non-deterministic, meaning that its output varies as a function of various things that Guix does not fully control, in spite of building packages in isolated environments (@pxref{Features}). Most common sources of non-determinism include the addition of timestamps in build results, the inclusion of random numbers, and directory listings sorted by inode number. See @uref{https://reproducible-builds.org/docs/}, for more information."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13836
- msgid "To find out what is wrong with this Git binary, the easiest approach is to run:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13841
- #, no-wrap
- msgid ""
- "guix challenge git \\\n"
- " --diff=diffoscope \\\n"
- " --substitute-urls=\"https://@value{SUBSTITUTE-SERVER-1} https://guix.example.org\"\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13845
- msgid "This automatically invokes @command{diffoscope}, which displays detailed information about files that differ."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13848
- msgid "Alternatively, we can do something along these lines (@pxref{Invoking guix archive}):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13853
- #, no-wrap
- msgid ""
- "$ wget -q -O - https://@value{SUBSTITUTE-SERVER-1}/nar/lzip/@dots{}-git-2.5.0 \\\n"
- " | lzip -d | guix archive -x /tmp/git\n"
- "$ diff -ur --no-dereference /gnu/store/@dots{}-git.2.5.0 /tmp/git\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13862
- msgid "This command shows the difference between the files resulting from the local build, and the files resulting from the build on @code{@value{SUBSTITUTE-SERVER-1}} (@pxref{Overview, Comparing and Merging Files,, diffutils, Comparing and Merging Files}). The @command{diff} command works great for text files. When binary files differ, a better option is @uref{https://diffoscope.org/, Diffoscope}, a tool that helps visualize differences for all kinds of files."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13870
- msgid "Once you have done that work, you can tell whether the differences are due to a non-deterministic build process or to a malicious server. We try hard to remove sources of non-determinism in packages to make it easier to verify substitutes, but of course, this is a process that involves not just Guix, but a large part of the free software community. In the meantime, @command{guix challenge} is one tool to help address the problem."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13874
- msgid "If you are writing packages for Guix, you are encouraged to check whether @code{@value{SUBSTITUTE-SERVER-1}} and other substitute servers obtain the same build result as you did with:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13877
- #, no-wrap
- msgid "$ guix challenge @var{package}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13882
- msgid "where @var{package} is a package specification such as @code{guile@@2.0} or @code{glibc:debug}."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13887
- #, no-wrap
- msgid "guix challenge @var{options} [@var{packages}@dots{}]\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13894
- msgid "When a difference is found between the hash of a locally-built item and that of a server-provided substitute, or among substitutes provided by different servers, the command displays it as in the example above and its exit code is 2 (other non-zero exit codes denote other kinds of errors)."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13896
- msgid "The one option that matters is:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13902
- msgid "Consider @var{urls} the whitespace-separated list of substitute source URLs to compare to."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13903
- #, no-wrap
- msgid "--diff=@var{mode}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13905
- msgid "Upon mismatches, show differences according to @var{mode}, one of:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13907
- #, no-wrap
- msgid "@code{simple} (the default)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13909
- msgid "Show the list of files that differ."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:13910
- #, no-wrap
- msgid "diffoscope"
- msgstr ""
- #. type: var{#1}
- #: guix-git/doc/guix.texi:13911
- #, no-wrap
- msgid "command"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13914
- msgid "Invoke @uref{https://diffoscope.org/, Diffoscope}, passing it two directories whose contents do not match."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13917
- msgid "When @var{command} is an absolute file name, run @var{command} instead of Diffoscope."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13920
- msgid "Do not show further details about the differences."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13925
- msgid "Thus, unless @option{--diff=none} is passed, @command{guix challenge} downloads the store items from the given substitute servers so that it can compare them."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13926
- #, no-wrap
- msgid "--verbose"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:13927
- #, no-wrap
- msgid "-v"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13930
- msgid "Show details about matches (identical contents) in addition to information about mismatches."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:13934
- #, no-wrap
- msgid "Invoking @command{guix copy}"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:13936
- #, no-wrap
- msgid "copy, of store items, over SSH"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:13937
- #, no-wrap
- msgid "SSH, copy of store items"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:13938
- #, no-wrap
- msgid "sharing store items across machines"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:13939
- #, no-wrap
- msgid "transferring store items across machines"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13946
- msgid "The @command{guix copy} command copies items from the store of one machine to that of another machine over a secure shell (SSH) connection@footnote{This command is available only when Guile-SSH was found. @xref{Requirements}, for details.}. For example, the following command copies the @code{coreutils} package, the user's profile, and all their dependencies over to @var{host}, logged in as @var{user}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13950
- #, no-wrap
- msgid ""
- "guix copy --to=@var{user}@@@var{host} \\\n"
- " coreutils $(readlink -f ~/.guix-profile)\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13954
- msgid "If some of the items to be copied are already present on @var{host}, they are not actually sent."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13957
- msgid "The command below retrieves @code{libreoffice} and @code{gimp} from @var{host}, assuming they are available there:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13960
- #, no-wrap
- msgid "guix copy --from=@var{host} libreoffice gimp\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13965
- msgid "The SSH connection is established using the Guile-SSH client, which is compatible with OpenSSH: it honors @file{~/.ssh/known_hosts} and @file{~/.ssh/config}, and uses the SSH agent for authentication."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13971
- msgid "The key used to sign items that are sent must be accepted by the remote machine. Likewise, the key used by the remote machine to sign items you are retrieving must be in @file{/etc/guix/acl} so it is accepted by your own daemon. @xref{Invoking guix archive}, for more information about store item authentication."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:13976
- #, no-wrap
- msgid "guix copy [--to=@var{spec}|--from=@var{spec}] @var{items}@dots{}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13979
- msgid "You must always specify one of the following options:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:13981
- #, no-wrap
- msgid "--to=@var{spec}"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:13982
- #, no-wrap
- msgid "--from=@var{spec}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:13986
- msgid "Specify the host to send to or receive from. @var{spec} must be an SSH spec such as @code{example.org}, @code{charlie@@example.org}, or @code{charlie@@example.org:2222}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13990
- msgid "The @var{items} can be either package names, such as @code{gimp}, or store items, such as @file{/gnu/store/@dots{}-idutils-4.6}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:13994
- msgid "When specifying the name of a package to send, it is first built if needed, unless @option{--dry-run} was specified. Common build options are supported (@pxref{Common Build Options})."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:13997
- #, no-wrap
- msgid "Invoking @command{guix container}"
- msgstr ""
- #. type: command{#1}
- #: guix-git/doc/guix.texi:13999
- #, no-wrap
- msgid "guix container"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:14003
- msgid "As of version @value{VERSION}, this tool is experimental. The interface is subject to radical change in the future."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14010
- msgid "The purpose of @command{guix container} is to manipulate processes running within an isolated environment, commonly known as a ``container'', typically created by the @command{guix shell} (@pxref{Invoking guix shell}) and @command{guix system container} (@pxref{Invoking guix system}) commands."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:14015
- #, no-wrap
- msgid "guix container @var{action} @var{options}@dots{}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14019
- msgid "@var{action} specifies the operation to perform with a container, and @var{options} specifies the context-specific arguments for the action."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14021
- msgid "The following actions are available:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14023
- #, no-wrap
- msgid "exec"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14025
- msgid "Execute a command within the context of a running container."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14027
- msgid "The syntax is:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:14030
- #, no-wrap
- msgid "guix container exec @var{pid} @var{program} @var{arguments}@dots{}\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14036
- msgid "@var{pid} specifies the process ID of the running container. @var{program} specifies an executable file name within the root file system of the container. @var{arguments} are the additional options that will be passed to @var{program}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14040
- msgid "The following command launches an interactive login shell inside a Guix system container, started by @command{guix system container}, and whose process ID is 9001:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:14043
- #, no-wrap
- msgid "guix container exec 9001 /run/current-system/profile/bin/bash --login\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14047
- msgid "Note that the @var{pid} cannot be the parent process of a container. It must be PID 1 of the container or one of its child processes."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:14051
- #, no-wrap
- msgid "Invoking @command{guix weather}"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14060
- msgid "Occasionally you're grumpy because substitutes are lacking and you end up building packages by yourself (@pxref{Substitutes}). The @command{guix weather} command reports on substitute availability on the specified servers so you can have an idea of whether you'll be grumpy today. It can sometimes be useful info as a user, but it is primarily useful to people running @command{guix publish} (@pxref{Invoking guix publish})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:14061
- #, no-wrap
- msgid "statistics, for substitutes"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:14062
- #, no-wrap
- msgid "availability of substitutes"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:14063
- #, no-wrap
- msgid "substitute availability"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:14064
- #, no-wrap
- msgid "weather, substitute availability"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14066
- msgid "Here's a sample run:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:14078
- #, no-wrap
- msgid ""
- "$ guix weather --substitute-urls=https://guix.example.org\n"
- "computing 5,872 package derivations for x86_64-linux...\n"
- "looking for 6,128 store items on https://guix.example.org..\n"
- "updating list of substitutes from 'https://guix.example.org'... 100.0%\n"
- "https://guix.example.org\n"
- " 43.4% substitutes available (2,658 out of 6,128)\n"
- " 7,032.5 MiB of nars (compressed)\n"
- " 19,824.2 MiB on disk (uncompressed)\n"
- " 0.030 seconds per request (182.9 seconds in total)\n"
- " 33.5 requests per second\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:14088
- #, no-wrap
- msgid ""
- " 9.8% (342 out of 3,470) of the missing items are queued\n"
- " 867 queued builds\n"
- " x86_64-linux: 518 (59.7%)\n"
- " i686-linux: 221 (25.5%)\n"
- " aarch64-linux: 128 (14.8%)\n"
- " build rate: 23.41 builds per hour\n"
- " x86_64-linux: 11.16 builds per hour\n"
- " i686-linux: 6.03 builds per hour\n"
- " aarch64-linux: 6.41 builds per hour\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:14090
- #, no-wrap
- msgid "continuous integration, statistics"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14101
- msgid "As you can see, it reports the fraction of all the packages for which substitutes are available on the server---regardless of whether substitutes are enabled, and regardless of whether this server's signing key is authorized. It also reports the size of the compressed archives (``nars'') provided by the server, the size the corresponding store items occupy in the store (assuming deduplication is turned off), and the server's throughput. The second part gives continuous integration (CI) statistics, if the server supports it. In addition, using the @option{--coverage} option, @command{guix weather} can list ``important'' package substitutes missing on the server (see below)."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14107
- msgid "To achieve that, @command{guix weather} queries over HTTP(S) meta-data (@dfn{narinfos}) for all the relevant store items. Like @command{guix challenge}, it ignores signatures on those substitutes, which is innocuous since the command only gathers statistics and cannot install those substitutes."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:14112
- #, no-wrap
- msgid "guix weather @var{options}@dots{} [@var{packages}@dots{}]\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14120
- msgid "When @var{packages} is omitted, @command{guix weather} checks the availability of substitutes for @emph{all} the packages, or for those specified with @option{--manifest}; otherwise it only considers the specified packages. It is also possible to query specific system types with @option{--system}. @command{guix weather} exits with a non-zero code when the fraction of available substitutes is below 100%."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14122
- msgid "The available options are listed below."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14128
- msgid "@var{urls} is the space-separated list of substitute server URLs to query. When this option is omitted, the default set of substitute servers is queried."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14134
- msgid "Query substitutes for @var{system}---e.g., @code{aarch64-linux}. This option can be repeated, in which case @command{guix weather} will query substitutes for several system types."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14140
- msgid "Instead of querying substitutes for all the packages, only ask for those specified in @var{file}. @var{file} must contain a @dfn{manifest}, as with the @code{-m} option of @command{guix package} (@pxref{Invoking guix package})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14143
- msgid "This option can be repeated several times, in which case the manifests are concatenated."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14144
- #, no-wrap
- msgid "--coverage[=@var{count}]"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:14145
- #, no-wrap
- msgid "-c [@var{count}]"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14151
- msgid "Report on substitute coverage for packages: list packages with at least @var{count} dependents (zero by default) for which substitutes are unavailable. Dependent packages themselves are not listed: if @var{b} depends on @var{a} and @var{a} has no substitutes, only @var{a} is listed, even though @var{b} usually lacks substitutes as well. The result looks like this:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:14165
- #, no-wrap
- msgid ""
- "$ guix weather --substitute-urls=@value{SUBSTITUTE-URLS} -c 10\n"
- "computing 8,983 package derivations for x86_64-linux...\n"
- "looking for 9,343 store items on @value{SUBSTITUTE-URLS}...\n"
- "updating substitutes from '@value{SUBSTITUTE-URLS}'... 100.0%\n"
- "@value{SUBSTITUTE-URLS}\n"
- " 64.7% substitutes available (6,047 out of 9,343)\n"
- "@dots{}\n"
- "2502 packages are missing from '@value{SUBSTITUTE-URLS}' for 'x86_64-linux', among which:\n"
- " 58 kcoreaddons@@5.49.0 /gnu/store/@dots{}-kcoreaddons-5.49.0\n"
- " 46 qgpgme@@1.11.1 /gnu/store/@dots{}-qgpgme-1.11.1\n"
- " 37 perl-http-cookiejar@@0.008 /gnu/store/@dots{}-perl-http-cookiejar-0.008\n"
- " @dots{}\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14171
- msgid "What this example shows is that @code{kcoreaddons} and presumably the 58 packages that depend on it have no substitutes at @code{@value{SUBSTITUTE-SERVER-1}}; likewise for @code{qgpgme} and the 46 packages that depend on it."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14175
- msgid "If you are a Guix developer, or if you are taking care of this build farm, you'll probably want to have a closer look at these packages: they may simply fail to build."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14176
- #, no-wrap
- msgid "--display-missing"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14178
- msgid "Display the list of store items for which substitutes are missing."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:14181
- #, no-wrap
- msgid "Invoking @command{guix processes}"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14189
- msgid "The @command{guix processes} command can be useful to developers and system administrators, especially on multi-user machines and on build farms: it lists the current sessions (connections to the daemon), as well as information about the processes involved@footnote{Remote sessions, when @command{guix-daemon} is started with @option{--listen} specifying a TCP endpoint, are @emph{not} listed.}. Here's an example of the information it returns:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:14195
- #, no-wrap
- msgid ""
- "$ sudo guix processes\n"
- "SessionPID: 19002\n"
- "ClientPID: 19090\n"
- "ClientCommand: guix shell python\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:14199
- #, no-wrap
- msgid ""
- "SessionPID: 19402\n"
- "ClientPID: 19367\n"
- "ClientCommand: guix publish -u guix-publish -p 3000 -C 9 @dots{}\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:14212
- #, no-wrap
- msgid ""
- "SessionPID: 19444\n"
- "ClientPID: 19419\n"
- "ClientCommand: cuirass --cache-directory /var/cache/cuirass @dots{}\n"
- "LockHeld: /gnu/store/@dots{}-perl-ipc-cmd-0.96.lock\n"
- "LockHeld: /gnu/store/@dots{}-python-six-bootstrap-1.11.0.lock\n"
- "LockHeld: /gnu/store/@dots{}-libjpeg-turbo-2.0.0.lock\n"
- "ChildPID: 20495\n"
- "ChildCommand: guix offload x86_64-linux 7200 1 28800\n"
- "ChildPID: 27733\n"
- "ChildCommand: guix offload x86_64-linux 7200 1 28800\n"
- "ChildPID: 27793\n"
- "ChildCommand: guix offload x86_64-linux 7200 1 28800\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14219
- msgid "In this example we see that @command{guix-daemon} has three clients: @command{guix environment}, @command{guix publish}, and the Cuirass continuous integration tool; their process identifier (PID) is given by the @code{ClientPID} field. The @code{SessionPID} field gives the PID of the @command{guix-daemon} sub-process of this particular session."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14226
- msgid "The @code{LockHeld} fields show which store items are currently locked by this session, which corresponds to store items being built or substituted (the @code{LockHeld} field is not displayed when @command{guix processes} is not running as root). Last, by looking at the @code{ChildPID} and @code{ChildCommand} fields, we understand that these three builds are being offloaded (@pxref{Daemon Offload Setup})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14231
- msgid "The output is in Recutils format so we can use the handy @command{recsel} command to select sessions of interest (@pxref{Selection Expressions,,, recutils, GNU recutils manual}). As an example, the command shows the command line and PID of the client that triggered the build of a Perl package:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:14237
- #, no-wrap
- msgid ""
- "$ sudo guix processes | \\\n"
- " recsel -p ClientPID,ClientCommand -e 'LockHeld ~ \"perl\"'\n"
- "ClientPID: 19419\n"
- "ClientCommand: cuirass --cache-directory /var/cache/cuirass @dots{}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14240
- msgid "Additional options are listed below."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14250
- msgid "The default option. It outputs a set of Session recutils records that include each @code{ChildProcess} as a field."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14251
- #, no-wrap
- msgid "normalized"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14258
- msgid "Normalize the output records into record sets (@pxref{Record Sets,,, recutils, GNU recutils manual}). Normalizing into record sets allows joins across record types. The example below lists the PID of each @code{ChildProcess} and the associated PID for @code{Session} that spawned the @code{ChildProcess} where the @code{Session} was started using @command{guix build}."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:14268
- #, no-wrap
- msgid ""
- "$ guix processes --format=normalized | \\\n"
- " recsel \\\n"
- " -j Session \\\n"
- " -t ChildProcess \\\n"
- " -p Session.PID,PID \\\n"
- " -e 'Session.ClientCommand ~ \"guix build\"'\n"
- "PID: 4435\n"
- "Session_PID: 4278\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:14271
- #, no-wrap
- msgid ""
- "PID: 4554\n"
- "Session_PID: 4278\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:14274
- #, no-wrap
- msgid ""
- "PID: 4646\n"
- "Session_PID: 4278\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:14281
- #, no-wrap
- msgid "system configuration"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14287
- msgid "Guix System supports a consistent whole-system configuration mechanism. By that we mean that all aspects of the global system configuration---such as the available system services, timezone and locale settings, user accounts---are declared in a single place. Such a @dfn{system configuration} can be @dfn{instantiated}---i.e., effected."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14297
- msgid "One of the advantages of putting all the system configuration under the control of Guix is that it supports transactional system upgrades, and makes it possible to roll back to a previous system instantiation, should something go wrong with the new one (@pxref{Features}). Another advantage is that it makes it easy to replicate the exact same configuration across different machines, or at different points in time, without having to resort to additional administration tools layered on top of the own tools of the system."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14302
- msgid "This section describes this mechanism. First we focus on the system administrator's viewpoint---explaining how the system is configured and instantiated. Then we show how this mechanism can be extended, for instance to support new system services."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14332
- msgid "The operating system is configured by providing an @code{operating-system} declaration in a file that can then be passed to the @command{guix system} command (@pxref{Invoking guix system}). A simple setup, with the default system services, the default Linux-Libre kernel, initial RAM disk, and boot loader looks like this:"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:14333 guix-git/doc/guix.texi:35553
- #, no-wrap
- msgid "operating-system"
- msgstr ""
- #. type: include
- #: guix-git/doc/guix.texi:14335
- #, no-wrap
- msgid "os-config-bare-bones.texi"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14342
- msgid "This example should be self-describing. Some of the fields defined above, such as @code{host-name} and @code{bootloader}, are mandatory. Others, such as @code{packages} and @code{services}, can be omitted, in which case they get a default value."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14347
- msgid "Below we discuss the effect of some of the most important fields (@pxref{operating-system Reference}, for details about all the available fields), and how to @dfn{instantiate} the operating system using @command{guix system}."
- msgstr ""
- #. type: unnumberedsubsec
- #: guix-git/doc/guix.texi:14348
- #, no-wrap
- msgid "Bootloader"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:14350
- #, no-wrap
- msgid "legacy boot, on Intel machines"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:14351
- #, no-wrap
- msgid "BIOS boot, on Intel machines"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:14352
- #, no-wrap
- msgid "UEFI boot"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:14353
- #, no-wrap
- msgid "EFI boot"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14359
- msgid "The @code{bootloader} field describes the method that will be used to boot your system. Machines based on Intel processors can boot in ``legacy'' BIOS mode, as in the example above. However, more recent machines rely instead on the @dfn{Unified Extensible Firmware Interface} (UEFI) to boot. In that case, the @code{bootloader} field should contain something along these lines:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:14364
- #, no-wrap
- msgid ""
- "(bootloader-configuration\n"
- " (bootloader grub-efi-bootloader)\n"
- " (targets '(\"/boot/efi\")))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14368
- msgid "@xref{Bootloader Configuration}, for more information on the available configuration options."
- msgstr ""
- #. type: unnumberedsubsec
- #: guix-git/doc/guix.texi:14369
- #, no-wrap
- msgid "Globally-Visible Packages"
- msgstr ""
- #. type: vindex
- #: guix-git/doc/guix.texi:14371
- #, no-wrap
- msgid "%base-packages"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14384
- msgid "The @code{packages} field lists packages that will be globally visible on the system, for all user accounts---i.e., in every user's @env{PATH} environment variable---in addition to the per-user profiles (@pxref{Invoking guix package}). The @code{%base-packages} variable provides all the tools one would expect for basic user and administrator tasks---including the GNU Core Utilities, the GNU Networking Utilities, the @command{mg} lightweight text editor, @command{find}, @command{grep}, etc. The example above adds GNU@tie{}Screen to those, taken from the @code{(gnu packages screen)} module (@pxref{Package Modules}). The @code{(list package output)} syntax can be used to add a specific output of a package:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:14388
- #, no-wrap
- msgid ""
- "(use-modules (gnu packages))\n"
- "(use-modules (gnu packages dns))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:14393
- #, no-wrap
- msgid ""
- "(operating-system\n"
- " ;; ...\n"
- " (packages (cons (list isc-bind \"utils\")\n"
- " %base-packages)))\n"
- msgstr ""
- #. type: findex
- #: guix-git/doc/guix.texi:14395
- #, no-wrap
- msgid "specification->package"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14404
- msgid "Referring to packages by variable name, like @code{isc-bind} above, has the advantage of being unambiguous; it also allows typos and such to be diagnosed right away as ``unbound variables''. The downside is that one needs to know which module defines which package, and to augment the @code{use-package-modules} line accordingly. To avoid that, one can use the @code{specification->package} procedure of the @code{(gnu packages)} module, which returns the best package for a given name or name and version:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:14407
- #, no-wrap
- msgid ""
- "(use-modules (gnu packages))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:14413
- #, no-wrap
- msgid ""
- "(operating-system\n"
- " ;; ...\n"
- " (packages (append (map specification->package\n"
- " '(\"tcpdump\" \"htop\" \"gnupg@@2.0\"))\n"
- " %base-packages)))\n"
- msgstr ""
- #. type: unnumberedsubsec
- #: guix-git/doc/guix.texi:14415
- #, no-wrap
- msgid "System Services"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:14417 guix-git/doc/guix.texi:34307
- #: guix-git/doc/guix.texi:35783
- #, no-wrap
- msgid "services"
- msgstr ""
- #. type: vindex
- #: guix-git/doc/guix.texi:14418
- #, no-wrap
- msgid "%base-services"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14428
- msgid "The @code{services} field lists @dfn{system services} to be made available when the system starts (@pxref{Services}). The @code{operating-system} declaration above specifies that, in addition to the basic services, we want the OpenSSH secure shell daemon listening on port 2222 (@pxref{Networking Services, @code{openssh-service-type}}). Under the hood, @code{openssh-service-type} arranges so that @command{sshd} is started with the right command-line options, possibly with supporting configuration files generated as needed (@pxref{Defining Services})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:14429
- #, no-wrap
- msgid "customization, of services"
- msgstr ""
- #. type: findex
- #: guix-git/doc/guix.texi:14430
- #, no-wrap
- msgid "modify-services"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14434
- msgid "Occasionally, instead of using the base services as is, you will want to customize them. To do this, use @code{modify-services} (@pxref{Service Reference, @code{modify-services}}) to modify the list."
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:14440
- msgid "auto-login to TTY"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14440
- msgid "For example, suppose you want to modify @code{guix-daemon} and Mingetty (the console log-in) in the @code{%base-services} list (@pxref{Base Services, @code{%base-services}}). To do that, you can write the following in your operating system declaration:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:14457
- #, no-wrap
- msgid ""
- "(define %my-services\n"
- " ;; My very own list of services.\n"
- " (modify-services %base-services\n"
- " (guix-service-type config =>\n"
- " (guix-configuration\n"
- " (inherit config)\n"
- " ;; Fetch substitutes from example.org.\n"
- " (substitute-urls\n"
- " (list \"https://example.org/guix\"\n"
- " \"https://ci.guix.gnu.org\"))))\n"
- " (mingetty-service-type config =>\n"
- " (mingetty-configuration\n"
- " (inherit config)\n"
- " ;; Automatially log in as \"guest\".\n"
- " (auto-login \"guest\")))))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:14461
- #, no-wrap
- msgid ""
- "(operating-system\n"
- " ;; @dots{}\n"
- " (services %my-services))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14474
- msgid "This changes the configuration---i.e., the service parameters---of the @code{guix-service-type} instance, and that of all the @code{mingetty-service-type} instances in the @code{%base-services} list (@pxref{Auto-Login to a Specific TTY, see the cookbook for how to auto-login one user to a specific TTY,, guix-cookbook, GNU Guix Cookbook})). Observe how this is accomplished: first, we arrange for the original configuration to be bound to the identifier @code{config} in the @var{body}, and then we write the @var{body} so that it evaluates to the desired configuration. In particular, notice how we use @code{inherit} to create a new configuration which has the same values as the old configuration, but with a few modifications."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14481
- msgid "The configuration for a typical ``desktop'' usage, with an encrypted root partition, a swap file on the root partition, the X11 display server, GNOME and Xfce (users can choose which of these desktop environments to use at the log-in screen by pressing @kbd{F1}), network management, power management, and more, would look like this:"
- msgstr ""
- #. type: include
- #: guix-git/doc/guix.texi:14483
- #, no-wrap
- msgid "os-config-desktop.texi"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14488
- msgid "A graphical system with a choice of lightweight window managers instead of full-blown desktop environments would look like this:"
- msgstr ""
- #. type: include
- #: guix-git/doc/guix.texi:14490
- #, no-wrap
- msgid "os-config-lightweight-desktop.texi"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14496
- msgid "This example refers to the @file{/boot/efi} file system by its UUID, @code{1234-ABCD}. Replace this UUID with the right UUID on your system, as returned by the @command{blkid} command."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14500
- msgid "@xref{Desktop Services}, for the exact list of services provided by @code{%desktop-services}. @xref{X.509 Certificates}, for background information about the @code{nss-certs} package that is used here."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14507
- msgid "Again, @code{%desktop-services} is just a list of service objects. If you want to remove services from there, you can do so using the procedures for list filtering (@pxref{SRFI-1 Filtering and Partitioning,,, guile, GNU Guile Reference Manual}). For instance, the following expression returns a list that contains all the services in @code{%desktop-services} minus the Avahi service:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:14512
- #, no-wrap
- msgid ""
- "(remove (lambda (service)\n"
- " (eq? (service-kind service) avahi-service-type))\n"
- " %desktop-services)\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14515
- msgid "Alternatively, the @code{modify-services} macro can be used:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:14519
- #, no-wrap
- msgid ""
- "(modify-services %desktop-services\n"
- " (delete avahi-service-type))\n"
- msgstr ""
- #. type: unnumberedsubsec
- #: guix-git/doc/guix.texi:14522
- #, no-wrap
- msgid "Instantiating the System"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14529
- msgid "Assuming the @code{operating-system} declaration is stored in the @file{my-system-config.scm} file, the @command{guix system reconfigure my-system-config.scm} command instantiates that configuration, and makes it the default GRUB boot entry (@pxref{Invoking guix system})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14537
- msgid "The normal way to change the system configuration is by updating this file and re-running @command{guix system reconfigure}. One should never have to touch files in @file{/etc} or to run commands that modify the system state such as @command{useradd} or @command{grub-install}. In fact, you must avoid that since that would not only void your warranty but also prevent you from rolling back to previous versions of your system, should you ever need to."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:14538
- #, no-wrap
- msgid "roll-back, of the operating system"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14548
- msgid "Speaking of roll-back, each time you run @command{guix system reconfigure}, a new @dfn{generation} of the system is created---without modifying or deleting previous generations. Old system generations get an entry in the bootloader boot menu, allowing you to boot them in case something went wrong with the latest generation. Reassuring, no? The @command{guix system list-generations} command lists the system generations available on disk. It is also possible to roll back the system via the commands @command{guix system roll-back} and @command{guix system switch-generation}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14554
- msgid "Although the @command{guix system reconfigure} command will not modify previous generations, you must take care when the current generation is not the latest (e.g., after invoking @command{guix system roll-back}), since the operation might overwrite a later generation (@pxref{Invoking guix system})."
- msgstr ""
- #. type: unnumberedsubsec
- #: guix-git/doc/guix.texi:14555
- #, no-wrap
- msgid "The Programming Interface"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14560
- msgid "At the Scheme level, the bulk of an @code{operating-system} declaration is instantiated with the following monadic procedure (@pxref{The Store Monad}):"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:14561
- #, no-wrap
- msgid "{Monadic Procedure} operating-system-derivation os"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:14564
- msgid "Return a derivation that builds @var{os}, an @code{operating-system} object (@pxref{Derivations})."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:14568
- msgid "The output of the derivation is a single directory that refers to all the packages, configuration files, and other supporting files needed to instantiate @var{os}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14573
- msgid "This procedure is provided by the @code{(gnu system)} module. Along with @code{(gnu services)} (@pxref{Services}), this module contains the guts of Guix System. Make sure to visit it!"
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:14576
- #, no-wrap
- msgid "@code{operating-system} Reference"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14581
- msgid "This section summarizes all the options available in @code{operating-system} declarations (@pxref{Using the Configuration System})."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:14582
- #, no-wrap
- msgid "{Data Type} operating-system"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:14586
- msgid "This is the data type representing an operating system configuration. By that, we mean all the global system configuration, not per-user configuration (@pxref{Using the Configuration System})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14588
- #, no-wrap
- msgid "@code{kernel} (default: @code{linux-libre})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14593
- msgid "The package object of the operating system kernel to use@footnote{Currently only the Linux-libre kernel is fully supported. Using GNU@tie{}mach with the GNU@tie{}Hurd is experimental and only available when building a virtual machine disk image.}."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:14594 guix-git/doc/guix.texi:30733
- #, no-wrap
- msgid "hurd"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14595
- #, no-wrap
- msgid "@code{hurd} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14600
- msgid "The package object of the Hurd to be started by the kernel. When this field is set, produce a GNU/Hurd operating system. In that case, @code{kernel} must also be set to the @code{gnumach} package---the microkernel the Hurd runs on."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:14603
- msgid "This feature is experimental and only supported for disk images."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14605
- #, no-wrap
- msgid "@code{kernel-loadable-modules} (default: '())"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14608
- msgid "A list of objects (usually packages) to collect loadable kernel modules from--e.g. @code{(list ddcci-driver-linux)}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14609
- #, no-wrap
- msgid "@code{kernel-arguments} (default: @code{%default-kernel-arguments})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14612
- msgid "List of strings or gexps representing additional arguments to pass on the command-line of the kernel---e.g., @code{(\"console=ttyS0\")}."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:14613 guix-git/doc/guix.texi:34539
- #: guix-git/doc/guix.texi:34558
- #, no-wrap
- msgid "bootloader"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14615
- msgid "The system bootloader configuration object. @xref{Bootloader Configuration}."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:14616 guix-git/doc/guix.texi:34732
- #, no-wrap
- msgid "label"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14619
- msgid "This is the label (a string) as it appears in the bootloader's menu entry. The default label includes the kernel name and version."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14620 guix-git/doc/guix.texi:16318
- #: guix-git/doc/guix.texi:19503 guix-git/doc/guix.texi:34662
- #, no-wrap
- msgid "@code{keyboard-layout} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14625
- msgid "This field specifies the keyboard layout to use in the console. It can be either @code{#f}, in which case the default keyboard layout is used (usually US English), or a @code{<keyboard-layout>} record. @xref{Keyboard Layout}, for more information."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14630
- msgid "This keyboard layout is in effect as soon as the kernel has booted. For instance, it is the keyboard layout in effect when you type a passphrase if your root file system is on a @code{luks-device-mapping} mapped device (@pxref{Mapped Devices})."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:14637
- msgid "This does @emph{not} specify the keyboard layout used by the bootloader, nor that used by the graphical display server. @xref{Bootloader Configuration}, for information on how to specify the bootloader's keyboard layout. @xref{X Window}, for information on how to specify the keyboard layout used by the X Window System."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14639
- #, no-wrap
- msgid "@code{initrd-modules} (default: @code{%base-initrd-modules})"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:14640 guix-git/doc/guix.texi:34344
- #: guix-git/doc/guix.texi:34467
- #, no-wrap
- msgid "initrd"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:14641 guix-git/doc/guix.texi:34345
- #: guix-git/doc/guix.texi:34468
- #, no-wrap
- msgid "initial RAM disk"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14644
- msgid "The list of Linux kernel modules that need to be available in the initial RAM disk. @xref{Initial RAM Disk}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14645
- #, no-wrap
- msgid "@code{initrd} (default: @code{base-initrd})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14649
- msgid "A procedure that returns an initial RAM disk for the Linux kernel. This field is provided to support low-level customization and should rarely be needed for casual use. @xref{Initial RAM Disk}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14650
- #, no-wrap
- msgid "@code{firmware} (default: @code{%base-firmware})"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:14651
- #, no-wrap
- msgid "firmware"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14653
- msgid "List of firmware packages loadable by the operating system kernel."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14658
- msgid "The default includes firmware needed for Atheros- and Broadcom-based WiFi devices (Linux-libre modules @code{ath9k} and @code{b43-open}, respectively). @xref{Hardware Considerations}, for more info on supported hardware."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:14659 guix-git/doc/guix.texi:35572
- #, no-wrap
- msgid "host-name"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14661
- msgid "The host name."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:14662
- #, no-wrap
- msgid "hosts-file"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:14663
- #, no-wrap
- msgid "hosts file"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14668
- msgid "A file-like object (@pxref{G-Expressions, file-like objects}) for use as @file{/etc/hosts} (@pxref{Host Names,,, libc, The GNU C Library Reference Manual}). The default is a file with entries for @code{localhost} and @var{host-name}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14669
- #, no-wrap
- msgid "@code{mapped-devices} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14671
- msgid "A list of mapped devices. @xref{Mapped Devices}."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:14672
- #, no-wrap
- msgid "file-systems"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14674
- msgid "A list of file systems. @xref{File Systems}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14675
- #, no-wrap
- msgid "@code{swap-devices} (default: @code{'()})"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:14676
- #, no-wrap
- msgid "swap devices"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14678
- msgid "A list of swap spaces. @xref{Swap Space}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14679
- #, no-wrap
- msgid "@code{users} (default: @code{%base-user-accounts})"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:14680
- #, no-wrap
- msgid "@code{groups} (default: @code{%base-groups})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14682
- msgid "List of user accounts and groups. @xref{User Accounts}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14685
- msgid "If the @code{users} list lacks a user account with UID@tie{}0, a ``root'' account with UID@tie{}0 is automatically added."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14686
- #, no-wrap
- msgid "@code{skeletons} (default: @code{(default-skeletons)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14690
- msgid "A list of target file name/file-like object tuples (@pxref{G-Expressions, file-like objects}). These are the skeleton files that will be added to the home directory of newly-created user accounts."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14692
- msgid "For instance, a valid value may look like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:14698
- #, no-wrap
- msgid ""
- "`((\".bashrc\" ,(plain-file \"bashrc\" \"echo Hello\\n\"))\n"
- " (\".guile\" ,(plain-file \"guile\"\n"
- " \"(use-modules (ice-9 readline))\n"
- " (activate-readline)\")))\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14700
- #, no-wrap
- msgid "@code{issue} (default: @code{%default-issue})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14703
- msgid "A string denoting the contents of the @file{/etc/issue} file, which is displayed when users log in on a text console."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14704
- #, no-wrap
- msgid "@code{packages} (default: @code{%base-packages})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14708
- msgid "A list of packages to be installed in the global profile, which is accessible at @file{/run/current-system/profile}. Each element is either a package variable or a package/output tuple. Here's a simple example of both:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:14713
- #, no-wrap
- msgid ""
- "(cons* git ; the default \"out\" output\n"
- " (list git \"send-email\") ; another output of git\n"
- " %base-packages) ; the default set\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14718
- msgid "The default set includes core utilities and it is good practice to install non-core utilities in user profiles (@pxref{Invoking guix package})."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:14719
- #, no-wrap
- msgid "timezone"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14721
- msgid "A timezone identifying string---e.g., @code{\"Europe/Paris\"}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14725
- msgid "You can run the @command{tzselect} command to find out which timezone string corresponds to your region. Choosing an invalid timezone name causes @command{guix system} to fail."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14726 guix-git/doc/guix.texi:21115
- #, no-wrap
- msgid "@code{locale} (default: @code{\"en_US.utf8\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14729
- msgid "The name of the default locale (@pxref{Locale Names,,, libc, The GNU C Library Reference Manual}). @xref{Locales}, for more information."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14730
- #, no-wrap
- msgid "@code{locale-definitions} (default: @code{%default-locale-definitions})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14733
- msgid "The list of locale definitions to be compiled and that may be used at run time. @xref{Locales}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14734
- #, no-wrap
- msgid "@code{locale-libcs} (default: @code{(list @var{glibc})})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14738
- msgid "The list of GNU@tie{}libc packages whose locale data and tools are used to build the locale definitions. @xref{Locales}, for compatibility considerations that justify this option."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14739
- #, no-wrap
- msgid "@code{name-service-switch} (default: @code{%default-nss})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14743
- msgid "Configuration of the libc name service switch (NSS)---a @code{<name-service-switch>} object. @xref{Name Service Switch}, for details."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14744
- #, no-wrap
- msgid "@code{services} (default: @code{%base-services})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14746
- msgid "A list of service objects denoting system services. @xref{Services}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:14747
- #, no-wrap
- msgid "essential services"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14748
- #, no-wrap
- msgid "@code{essential-services} (default: ...)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14753
- msgid "The list of ``essential services''---i.e., things like instances of @code{system-service-type} and @code{host-name-service-type} (@pxref{Service Reference}), which are derived from the operating system definition itself. As a user you should @emph{never} need to touch this field."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14754
- #, no-wrap
- msgid "@code{pam-services} (default: @code{(base-pam-services)})"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:14755
- #, no-wrap
- msgid "PAM"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:14756
- #, no-wrap
- msgid "pluggable authentication modules"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14759
- msgid "Linux @dfn{pluggable authentication module} (PAM) services."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14760
- #, no-wrap
- msgid "@code{setuid-programs} (default: @code{%setuid-programs})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14763
- msgid "List of @code{<setuid-program>}. @xref{Setuid Programs}, for more information."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14764
- #, no-wrap
- msgid "@code{sudoers-file} (default: @code{%sudoers-specification})"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:14765
- #, no-wrap
- msgid "sudoers file"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14768
- msgid "The contents of the @file{/etc/sudoers} file as a file-like object (@pxref{G-Expressions, @code{local-file} and @code{plain-file}})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14773
- msgid "This file specifies which users can use the @command{sudo} command, what they are allowed to do, and what privileges they may gain. The default is that only @code{root} and members of the @code{wheel} group may use @code{sudo}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:14776
- #, no-wrap
- msgid "{Scheme Syntax} this-operating-system"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:14779
- msgid "When used in the @emph{lexical scope} of an operating system field definition, this identifier resolves to the operating system being defined."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:14782
- msgid "The example below shows how to refer to the operating system being defined in the definition of the @code{label} field:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:14785 guix-git/doc/guix.texi:18711
- #, no-wrap
- msgid ""
- "(use-modules (gnu) (guix))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:14790
- #, no-wrap
- msgid ""
- "(operating-system\n"
- " ;; ...\n"
- " (label (package-full-name\n"
- " (operating-system-kernel this-operating-system))))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:14794
- msgid "It is an error to refer to @code{this-operating-system} outside an operating system definition."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14805
- msgid "The list of file systems to be mounted is specified in the @code{file-systems} field of the operating system declaration (@pxref{Using the Configuration System}). Each file system is declared using the @code{file-system} form, like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:14811
- #, no-wrap
- msgid ""
- "(file-system\n"
- " (mount-point \"/home\")\n"
- " (device \"/dev/sda3\")\n"
- " (type \"ext4\"))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14815
- msgid "As usual, some of the fields are mandatory---those shown in the example above---while others can be omitted. These are described below."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:14816
- #, no-wrap
- msgid "{Data Type} file-system"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:14819
- msgid "Objects of this type represent file systems to be mounted. They contain the following members:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14821 guix-git/doc/guix.texi:15201
- #: guix-git/doc/guix.texi:17317
- #, no-wrap
- msgid "type"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14824
- msgid "This is a string specifying the type of the file system---e.g., @code{\"ext4\"}."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:14825
- #, no-wrap
- msgid "mount-point"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14827
- msgid "This designates the place where the file system is to be mounted."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14828 guix-git/doc/guix.texi:17267
- #, no-wrap
- msgid "device"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14838
- msgid "This names the ``source'' of the file system. It can be one of three things: a file system label, a file system UUID, or the name of a @file{/dev} node. Labels and UUIDs offer a way to refer to file systems without having to hard-code their actual device name@footnote{Note that, while it is tempting to use @file{/dev/disk/by-uuid} and similar device names to achieve the same result, this is not recommended: These special device nodes are created by the udev daemon and may be unavailable at the time the device is mounted.}."
- msgstr ""
- #. type: findex
- #: guix-git/doc/guix.texi:14839
- #, no-wrap
- msgid "file-system-label"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14844
- msgid "File system labels are created using the @code{file-system-label} procedure, UUIDs are created using @code{uuid}, and @file{/dev} node are plain strings. Here's an example of a file system referred to by its label, as shown by the @command{e2label} command:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:14850
- #, no-wrap
- msgid ""
- "(file-system\n"
- " (mount-point \"/home\")\n"
- " (type \"ext4\")\n"
- " (device (file-system-label \"my-home\")))\n"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:14852 guix-git/doc/guix.texi:33130
- #: guix-git/doc/guix.texi:33146
- #, no-wrap
- msgid "uuid"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14860
- msgid "UUIDs are converted from their string representation (as shown by the @command{tune2fs -l} command) using the @code{uuid} form@footnote{The @code{uuid} form expects 16-byte UUIDs as defined in @uref{https://tools.ietf.org/html/rfc4122, RFC@tie{}4122}. This is the form of UUID used by the ext2 family of file systems and others, but it is different from ``UUIDs'' found in FAT file systems, for instance.}, like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:14866
- #, no-wrap
- msgid ""
- "(file-system\n"
- " (mount-point \"/home\")\n"
- " (type \"ext4\")\n"
- " (device (uuid \"4dab5feb-d176-45de-b287-9b0a6e4c01cb\")))\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14874
- msgid "When the source of a file system is a mapped device (@pxref{Mapped Devices}), its @code{device} field @emph{must} refer to the mapped device name---e.g., @file{\"/dev/mapper/root-partition\"}. This is required so that the system knows that mounting the file system depends on having the corresponding device mapping established."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14875
- #, no-wrap
- msgid "@code{flags} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14885
- msgid "This is a list of symbols denoting mount flags. Recognized flags include @code{read-only}, @code{bind-mount}, @code{no-dev} (disallow access to special files), @code{no-suid} (ignore setuid and setgid bits), @code{no-atime} (do not update file access times), @code{strict-atime} (update file access time), @code{lazy-time} (only update time on the in-memory version of the file inode), and @code{no-exec} (disallow program execution). @xref{Mount-Unmount-Remount,,, libc, The GNU C Library Reference Manual}, for more information on these flags."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14886
- #, no-wrap
- msgid "@code{options} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14895
- msgid "This is either @code{#f}, or a string denoting mount options passed to the file system driver. @xref{Mount-Unmount-Remount,,, libc, The GNU C Library Reference Manual}, for details and run @command{man 8 mount} for options for various file systems. Note that the @code{file-system-options->alist} and @code{alist->file-system-options} procedures from @code{(gnu system file-systems)} can be used to convert file system options given as an association list to the string representation, and vice-versa."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14896
- #, no-wrap
- msgid "@code{mount?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14901
- msgid "This value indicates whether to automatically mount the file system when the system is brought up. When set to @code{#f}, the file system gets an entry in @file{/etc/fstab} (read by the @command{mount} command) but is not automatically mounted."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14902
- #, no-wrap
- msgid "@code{needed-for-boot?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14907
- msgid "This Boolean value indicates whether the file system is needed when booting. If that is true, then the file system is mounted when the initial RAM disk (initrd) is loaded. This is always the case, for instance, for the root file system."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14908
- #, no-wrap
- msgid "@code{check?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14912
- msgid "This Boolean indicates whether the file system should be checked for errors before being mounted. How and when this happens can be further adjusted with the following options."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14913
- #, no-wrap
- msgid "@code{skip-check-if-clean?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14918
- msgid "When true, this Boolean indicates that a file system check triggered by @code{check?} may exit early if the file system is marked as ``clean'', meaning that it was previously correctly unmounted and should not contain errors."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14922
- msgid "Setting this to false will always force a full consistency check when @code{check?} is true. This may take a very long time and is not recommended on healthy systems---in fact, it may reduce reliability!"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14926
- msgid "Conversely, some primitive file systems like @code{fat} do not keep track of clean shutdowns and will perform a full scan regardless of the value of this option."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14927
- #, no-wrap
- msgid "@code{repair} (default: @code{'preen})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14930
- msgid "When @code{check?} finds errors, it can (try to) repair them and continue booting. This option controls when and how to do so."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14934
- msgid "If false, try not to modify the file system at all. Checking certain file systems like @code{jfs} may still write to the device to replay the journal. No repairs will be attempted."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14937
- msgid "If @code{#t}, try to repair any errors found and assume ``yes'' to all questions. This will fix the most errors, but may be risky."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14941
- msgid "If @code{'preen}, repair only errors that are safe to fix without human interaction. What that means is left up to the developers of each file system and may be equivalent to ``none'' or ``all''."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14942
- #, no-wrap
- msgid "@code{create-mount-point?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14944
- msgid "When true, the mount point is created if it does not exist yet."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14945
- #, no-wrap
- msgid "@code{mount-may-fail?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14950
- msgid "When true, this indicates that mounting this file system can fail but that should not be considered an error. This is useful in unusual cases; an example of this is @code{efivarfs}, a file system that can only be mounted on EFI/UEFI systems."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:14951 guix-git/doc/guix.texi:15347
- #, no-wrap
- msgid "@code{dependencies} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14955
- msgid "This is a list of @code{<file-system>} or @code{<mapped-device>} objects representing file systems that must be mounted or mapped devices that must be opened before (and unmounted or closed after) this one."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14959
- msgid "As an example, consider a hierarchy of mounts: @file{/sys/fs/cgroup} is a dependency of @file{/sys/fs/cgroup/cpu} and @file{/sys/fs/cgroup/memory}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:14962
- msgid "Another example is a file system that depends on a mapped device, for example for an encrypted partition (@pxref{Mapped Devices})."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:14965
- #, no-wrap
- msgid "{Scheme Procedure} file-system-label @var{str}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:14968
- msgid "This procedure returns an opaque file system label from @var{str}, a string:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:14972
- #, no-wrap
- msgid ""
- "(file-system-label \"home\")\n"
- "@result{} #<file-system-label \"home\">\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:14976
- msgid "File system labels are used to refer to file systems by label rather than by device name. See above for examples."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:14980
- msgid "The @code{(gnu system file-systems)} exports the following useful variables."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:14981
- #, no-wrap
- msgid "{Scheme Variable} %base-file-systems"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:14986
- msgid "These are essential file systems that are required on normal systems, such as @code{%pseudo-terminal-file-system} and @code{%immutable-store} (see below). Operating system declarations should always contain at least these."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:14988
- #, no-wrap
- msgid "{Scheme Variable} %pseudo-terminal-file-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:14994
- msgid "This is the file system to be mounted as @file{/dev/pts}. It supports @dfn{pseudo-terminals} created @i{via} @code{openpty} and similar functions (@pxref{Pseudo-Terminals,,, libc, The GNU C Library Reference Manual}). Pseudo-terminals are used by terminal emulators such as @command{xterm}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:14996
- #, no-wrap
- msgid "{Scheme Variable} %shared-memory-file-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15000
- msgid "This file system is mounted as @file{/dev/shm} and is used to support memory sharing across processes (@pxref{Memory-mapped I/O, @code{shm_open},, libc, The GNU C Library Reference Manual})."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15002
- #, no-wrap
- msgid "{Scheme Variable} %immutable-store"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15007
- msgid "This file system performs a read-only ``bind mount'' of @file{/gnu/store}, making it read-only for all the users including @code{root}. This prevents against accidental modification by software running as @code{root} or by system administrators."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15010
- msgid "The daemon itself is still able to write to the store: it remounts it read-write in its own ``name space.''"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15012
- #, no-wrap
- msgid "{Scheme Variable} %binary-format-file-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15016
- msgid "The @code{binfmt_misc} file system, which allows handling of arbitrary executable file types to be delegated to user space. This requires the @code{binfmt.ko} kernel module to be loaded."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15018
- #, no-wrap
- msgid "{Scheme Variable} %fuse-control-file-system"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15022
- msgid "The @code{fusectl} file system, which allows unprivileged users to mount and unmount user-space FUSE file systems. This requires the @code{fuse.ko} kernel module to be loaded."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15026
- msgid "The @code{(gnu system uuid)} module provides tools to deal with file system ``unique identifiers'' (UUIDs)."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:15027
- #, no-wrap
- msgid "{Scheme Procedure} uuid @var{str} [@var{type}]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:15030
- msgid "Return an opaque UUID (unique identifier) object of the given @var{type} (a symbol) by parsing @var{str} (a string):"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15034
- #, no-wrap
- msgid ""
- "(uuid \"4dab5feb-d176-45de-b287-9b0a6e4c01cb\")\n"
- "@result{} #<<uuid> type: dce bv: @dots{}>\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15037
- #, no-wrap
- msgid ""
- "(uuid \"1234-ABCD\" 'fat)\n"
- "@result{} #<<uuid> type: fat bv: @dots{}>\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:15041
- msgid "@var{type} may be one of @code{dce}, @code{iso9660}, @code{fat}, @code{ntfs}, or one of the commonly found synonyms for these."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:15044
- msgid "UUIDs are another way to unambiguously refer to file systems in operating system configuration. See the examples above."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:15047 guix-git/doc/guix.texi:15048
- #, no-wrap
- msgid "Btrfs file system"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15054
- msgid "The Btrfs has special features, such as subvolumes, that merit being explained in more details. The following section attempts to cover basic as well as complex uses of a Btrfs file system with the Guix System."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15057
- msgid "In its simplest usage, a Btrfs file system can be described, for example, by:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15063
- #, no-wrap
- msgid ""
- "(file-system\n"
- " (mount-point \"/home\")\n"
- " (type \"btrfs\")\n"
- " (device (file-system-label \"my-home\")))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15069
- msgid "The example below is more complex, as it makes use of a Btrfs subvolume, named @code{rootfs}. The parent Btrfs file system is labeled @code{my-btrfs-pool}, and is located on an encrypted device (hence the dependency on @code{mapped-devices}):"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15077
- #, no-wrap
- msgid ""
- "(file-system\n"
- " (device (file-system-label \"my-btrfs-pool\"))\n"
- " (mount-point \"/\")\n"
- " (type \"btrfs\")\n"
- " (options \"subvol=rootfs\")\n"
- " (dependencies mapped-devices))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15088
- msgid "Some bootloaders, for example GRUB, only mount a Btrfs partition at its top level during the early boot, and rely on their configuration to refer to the correct subvolume path within that top level. The bootloaders operating in this way typically produce their configuration on a running system where the Btrfs partitions are already mounted and where the subvolume information is readily available. As an example, @command{grub-mkconfig}, the configuration generator command shipped with GRUB, reads @file{/proc/self/mountinfo} to determine the top-level path of a subvolume."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15096
- msgid "The Guix System produces a bootloader configuration using the operating system configuration as its sole input; it is therefore necessary to extract the subvolume name on which @file{/gnu/store} lives (if any) from that operating system configuration. To better illustrate, consider a subvolume named 'rootfs' which contains the root file system data. In such situation, the GRUB bootloader would only see the top level of the root Btrfs partition, e.g.:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:15103
- #, no-wrap
- msgid ""
- "/ (top level)\n"
- "├── rootfs (subvolume directory)\n"
- " ├── gnu (normal directory)\n"
- " ├── store (normal directory)\n"
- "[...]\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15108
- msgid "Thus, the subvolume name must be prepended to the @file{/gnu/store} path of the kernel, initrd binaries and any other files referred to in the GRUB configuration that must be found during the early boot."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15111
- msgid "The next example shows a nested hierarchy of subvolumes and directories:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:15118
- #, no-wrap
- msgid ""
- "/ (top level)\n"
- "├── rootfs (subvolume)\n"
- " ├── gnu (normal directory)\n"
- " ├── store (subvolume)\n"
- "[...]\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15125
- msgid "This scenario would work without mounting the 'store' subvolume. Mounting 'rootfs' is sufficient, since the subvolume name matches its intended mount point in the file system hierarchy. Alternatively, the 'store' subvolume could be referred to by setting the @code{subvol} option to either @code{/rootfs/gnu/store} or @code{rootfs/gnu/store}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15127
- msgid "Finally, a more contrived example of nested subvolumes:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:15134
- #, no-wrap
- msgid ""
- "/ (top level)\n"
- "├── root-snapshots (subvolume)\n"
- " ├── root-current (subvolume)\n"
- " ├── guix-store (subvolume)\n"
- "[...]\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15141
- msgid "Here, the 'guix-store' subvolume doesn't match its intended mount point, so it is necessary to mount it. The subvolume must be fully specified, by passing its file name to the @code{subvol} option. To illustrate, the 'guix-store' subvolume could be mounted on @file{/gnu/store} by using a file system declaration such as:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15149
- #, no-wrap
- msgid ""
- "(file-system\n"
- " (device (file-system-label \"btrfs-pool-1\"))\n"
- " (mount-point \"/gnu/store\")\n"
- " (type \"btrfs\")\n"
- " (options \"subvol=root-snapshots/root-current/guix-store,\\\n"
- "compress-force=zstd,space_cache=v2\"))\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:15154
- #, no-wrap
- msgid "device mapping"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:15155
- #, no-wrap
- msgid "mapped devices"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15172
- msgid "The Linux kernel has a notion of @dfn{device mapping}: a block device, such as a hard disk partition, can be @dfn{mapped} into another device, usually in @code{/dev/mapper/}, with additional processing over the data that flows through it@footnote{Note that the GNU@tie{}Hurd makes no difference between the concept of a ``mapped device'' and that of a file system: both boil down to @emph{translating} input/output operations made on a file to operations on its backing store. Thus, the Hurd implements mapped devices, like file systems, using the generic @dfn{translator} mechanism (@pxref{Translators,,, hurd, The GNU Hurd Reference Manual}).}. A typical example is encryption device mapping: all writes to the mapped device are encrypted, and all reads are deciphered, transparently. Guix extends this notion by considering any device or set of devices that are @dfn{transformed} in some way to create a new device; for instance, RAID devices are obtained by @dfn{assembling} several other devices, such as hard disks or partitions, into a new one that behaves as one partition."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15175
- msgid "Mapped devices are declared using the @code{mapped-device} form, defined as follows; for examples, see below."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:15176
- #, no-wrap
- msgid "{Data Type} mapped-device"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:15179
- msgid "Objects of this type represent device mappings that will be made when the system boots up."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15186
- msgid "This is either a string specifying the name of the block device to be mapped, such as @code{\"/dev/sda3\"}, or a list of such strings when several devices need to be assembled for creating a new one. In case of LVM this is a string specifying name of the volume group to be mapped."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:15187 guix-git/doc/guix.texi:15342
- #, no-wrap
- msgid "target"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15196
- msgid "This string specifies the name of the resulting mapped device. For kernel mappers such as encrypted devices of type @code{luks-device-mapping}, specifying @code{\"my-partition\"} leads to the creation of the @code{\"/dev/mapper/my-partition\"} device. For RAID devices of type @code{raid-device-mapping}, the full device name such as @code{\"/dev/md0\"} needs to be given. LVM logical volumes of type @code{lvm-device-mapping} need to be specified as @code{\"VGNAME-LVNAME\"}."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:15197 guix-git/doc/guix.texi:34634
- #, no-wrap
- msgid "targets"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15200
- msgid "This list of strings specifies names of the resulting mapped devices in case there are several. The format is identical to @var{target}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15204
- msgid "This must be a @code{mapped-device-kind} object, which specifies how @var{source} is mapped to @var{target}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15207
- #, no-wrap
- msgid "{Scheme Variable} luks-device-mapping"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15211
- msgid "This defines LUKS block device encryption using the @command{cryptsetup} command from the package with the same name. It relies on the @code{dm-crypt} Linux kernel module."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15213
- #, no-wrap
- msgid "{Scheme Variable} raid-device-mapping"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15218
- msgid "This defines a RAID device, which is assembled using the @code{mdadm} command from the package with the same name. It requires a Linux kernel module for the appropriate RAID level to be loaded, such as @code{raid456} for RAID-4, RAID-5 or RAID-6, or @code{raid10} for RAID-10."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:15220
- #, no-wrap
- msgid "LVM, logical volume manager"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15221
- #, no-wrap
- msgid "{Scheme Variable} lvm-device-mapping"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15226
- msgid "This defines one or more logical volumes for the Linux @uref{https://www.sourceware.org/lvm2/, Logical Volume Manager (LVM)}. The volume group is activated by the @command{vgchange} command from the @code{lvm2} package."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:15228
- #, no-wrap
- msgid "disk encryption"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:15229
- #, no-wrap
- msgid "LUKS"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15237
- msgid "The following example specifies a mapping from @file{/dev/sda3} to @file{/dev/mapper/home} using LUKS---the @url{https://gitlab.com/cryptsetup/cryptsetup,Linux Unified Key Setup}, a standard mechanism for disk encryption. The @file{/dev/mapper/home} device can then be used as the @code{device} of a @code{file-system} declaration (@pxref{File Systems})."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15243
- #, no-wrap
- msgid ""
- "(mapped-device\n"
- " (source \"/dev/sda3\")\n"
- " (target \"home\")\n"
- " (type luks-device-mapping))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15248
- msgid "Alternatively, to become independent of device numbering, one may obtain the LUKS UUID (@dfn{unique identifier}) of the source device by a command like:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:15251
- #, no-wrap
- msgid "cryptsetup luksUUID /dev/sda3\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15254
- msgid "and use it as follows:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15260
- #, no-wrap
- msgid ""
- "(mapped-device\n"
- " (source (uuid \"cb67fc72-0d54-4c88-9d4b-b225f30b0f44\"))\n"
- " (target \"home\")\n"
- " (type luks-device-mapping))\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:15262
- #, no-wrap
- msgid "swap encryption"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15269
- msgid "It is also desirable to encrypt swap space, since swap space may contain sensitive data. One way to accomplish that is to use a swap file in a file system on a device mapped via LUKS encryption. In this way, the swap file is encrypted because the entire device is encrypted. @xref{Swap Space}, or @xref{Preparing for Installation,,Disk Partitioning}, for an example."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15272
- msgid "A RAID device formed of the partitions @file{/dev/sda1} and @file{/dev/sdb1} may be declared as follows:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15278
- #, no-wrap
- msgid ""
- "(mapped-device\n"
- " (source (list \"/dev/sda1\" \"/dev/sdb1\"))\n"
- " (target \"/dev/md0\")\n"
- " (type raid-device-mapping))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15285
- msgid "The @file{/dev/md0} device can then be used as the @code{device} of a @code{file-system} declaration (@pxref{File Systems}). Note that the RAID level need not be given; it is chosen during the initial creation and formatting of the RAID device and is determined automatically later."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15288
- msgid "LVM logical volumes ``alpha'' and ``beta'' from volume group ``vg0'' can be declared as follows:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15294
- #, no-wrap
- msgid ""
- "(mapped-device\n"
- " (source \"vg0\")\n"
- " (targets (list \"vg0-alpha\" \"vg0-beta\"))\n"
- " (type lvm-device-mapping))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15299
- msgid "Devices @file{/dev/mapper/vg0-alpha} and @file{/dev/mapper/vg0-beta} can then be used as the @code{device} of a @code{file-system} declaration (@pxref{File Systems})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:15302
- #, no-wrap
- msgid "swap space"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15312
- msgid "Swap space, as it is commonly called, is a disk area specifically designated for paging: the process in charge of memory management (the Linux kernel or Hurd's default pager) can decide that some memory pages stored in RAM which belong to a running program but are unused should be stored on disk instead. It unloads those from the RAM, freeing up precious fast memory, and writes them to the swap space. If the program tries to access that very page, the memory management process loads it back into memory for the program to use."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15318
- msgid "A common misconception about swap is that it is only useful when small amounts of RAM are available to the system. However, it should be noted that kernels often use all available RAM for disk access caching to make I/O faster, and thus paging out unused portions of program memory will expand the RAM available for such caching."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15322
- msgid "For a more detailed description of how memory is managed from the viewpoint of a monolithic kernel, @xref{Memory Concepts,,, libc, The GNU C Library Reference Manual}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15331
- msgid "The Linux kernel has support for swap partitions and swap files: the former uses a whole disk partition for paging, whereas the second uses a file on a file system for that (the file system driver needs to support it). On a comparable setup, both have the same performance, so one should consider ease of use when deciding between them. Partitions are ``simpler'' and do not need file system support, but need to be allocated at disk formatting time (logical volumes notwithstanding), whereas files can be allocated and deallocated at any time."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15336
- msgid "Note that swap space is not zeroed on shutdown, so sensitive data (such as passwords) may linger on it if it was paged out. As such, you should consider having your swap reside on an encrypted device (@pxref{Mapped Devices})."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:15337
- #, no-wrap
- msgid "{Data Type} swap-space"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:15340
- msgid "Objects of this type represent swap spaces. They contain the following members:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15346
- msgid "The device or file to use, either a UUID, a @code{file-system-label} or a string, as in the definition of a @code{file-system} (@pxref{File Systems})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15353
- msgid "A list of @code{file-system} or @code{mapped-device} objects, upon which the availability of the space depends. Note that just like for @code{file-system} objects, dependencies which are needed for boot and mounted in early userspace are not managed by the Shepherd, and so automatically filtered out for you."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:15354
- #, no-wrap
- msgid "@code{priority} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15361
- msgid "Only supported by the Linux kernel. Either @code{#f} to disable swap priority, or an integer between 0 and 32767. The kernel will first use swap spaces of higher priority when paging, and use same priority spaces on a round-robin basis. The kernel will use swap spaces without a set priority after prioritized spaces, and in the order that they appeared in (not round-robin)."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:15362
- #, no-wrap
- msgid "@code{discard?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15366
- msgid "Only supported by the Linux kernel. When true, the kernel will notify the disk controller of discarded pages, for example with the TRIM operation on Solid State Drives."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15371
- msgid "Here are some examples:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15374
- #, no-wrap
- msgid "(swap-space (target (uuid \"4dab5feb-d176-45de-b287-9b0a6e4c01cb\")))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15379
- msgid "Use the swap partition with the given UUID@. You can learn the UUID of a Linux swap partition by running @command{swaplabel @var{device}}, where @var{device} is the @file{/dev} file name of that partition."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15384
- #, no-wrap
- msgid ""
- "(swap-space\n"
- " (target (file-system-label \"swap\"))\n"
- " (dependencies (list lvm-device)))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15390
- msgid "Use the partition with label @code{swap}, which can be found after the @var{lvm-device} mapped device has been opened. Again, the @command{swaplabel} command allows you to view and change the label of a Linux swap partition."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15395
- #, no-wrap
- msgid ""
- "(swap-space\n"
- " (target \"/btrfs/swapfile\")\n"
- " (dependencies (list btrfs-fs)))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15399
- msgid "Use the file @file{/btrfs/swapfile} as swap space, which is present on the @var{btrfs-fs} filesystem."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:15403
- #, no-wrap
- msgid "users"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:15404
- #, no-wrap
- msgid "accounts"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:15405
- #, no-wrap
- msgid "user accounts"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15409
- msgid "User accounts and groups are entirely managed through the @code{operating-system} declaration. They are specified with the @code{user-account} and @code{user-group} forms:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15419
- #, no-wrap
- msgid ""
- "(user-account\n"
- " (name \"alice\")\n"
- " (group \"users\")\n"
- " (supplementary-groups '(\"wheel\" ;allow use of sudo, etc.\n"
- " \"audio\" ;sound card\n"
- " \"video\" ;video devices such as webcams\n"
- " \"cdrom\")) ;the good ol' CD-ROM\n"
- " (comment \"Bob's sister\"))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15423
- msgid "Here's a user account that uses a different shell and a custom home directory (the default would be @file{\"/home/bob\"}):"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15431
- #, no-wrap
- msgid ""
- "(user-account\n"
- " (name \"bob\")\n"
- " (group \"users\")\n"
- " (comment \"Alice's bro\")\n"
- " (shell (file-append zsh \"/bin/zsh\"))\n"
- " (home-directory \"/home/robert\"))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15440
- msgid "When booting or upon completion of @command{guix system reconfigure}, the system ensures that only the user accounts and groups specified in the @code{operating-system} declaration exist, and with the specified properties. Thus, account or group creations or modifications made by directly invoking commands such as @command{useradd} are lost upon reconfiguration or reboot. This ensures that the system remains exactly as declared."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:15441
- #, no-wrap
- msgid "{Data Type} user-account"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:15444
- msgid "Objects of this type represent user accounts. The following members may be specified:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15448
- msgid "The name of the user account."
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:15449 guix-git/doc/guix.texi:34298
- #, no-wrap
- msgid "group"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:15450 guix-git/doc/guix.texi:15534
- #, no-wrap
- msgid "groups"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15453
- msgid "This is the name (a string) or identifier (a number) of the user group this account belongs to."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:15454
- #, no-wrap
- msgid "@code{supplementary-groups} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15457
- msgid "Optionally, this can be defined as a list of group names that this account belongs to."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:15458
- #, no-wrap
- msgid "@code{uid} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15462
- msgid "This is the user ID for this account (a number), or @code{#f}. In the latter case, a number is automatically chosen by the system when the account is created."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:15463 guix-git/doc/guix.texi:18217
- #, no-wrap
- msgid "@code{comment} (default: @code{\"\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15465
- msgid "A comment about the account, such as the account owner's full name."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15470
- msgid "Note that, for non-system accounts, users are free to change their real name as it appears in @file{/etc/passwd} using the @command{chfn} command. When they do, their choice prevails over the system administrator's choice; reconfiguring does @emph{not} change their name."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:15471
- #, no-wrap
- msgid "home-directory"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15473
- msgid "This is the name of the home directory for the account."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:15474
- #, no-wrap
- msgid "@code{create-home-directory?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15477
- msgid "Indicates whether the home directory of this account should be created if it does not exist yet."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:15478
- #, no-wrap
- msgid "@code{shell} (default: Bash)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15482
- msgid "This is a G-expression denoting the file name of a program to be used as the shell (@pxref{G-Expressions}). For example, you would refer to the Bash executable like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15485
- #, no-wrap
- msgid "(file-append bash \"/bin/bash\")\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15489
- msgid "... and to the Zsh executable like that:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15492
- #, no-wrap
- msgid "(file-append zsh \"/bin/zsh\")\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:15494 guix-git/doc/guix.texi:15552
- #, no-wrap
- msgid "@code{system?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15498
- msgid "This Boolean value indicates whether the account is a ``system'' account. System accounts are sometimes treated specially; for instance, graphical login managers do not list them."
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:15500
- msgid "user-account-password"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:15500
- #, no-wrap
- msgid "password, for user accounts"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:15501 guix-git/doc/guix.texi:15556
- #, no-wrap
- msgid "@code{password} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15507
- msgid "You would normally leave this field to @code{#f}, initialize user passwords as @code{root} with the @command{passwd} command, and then let users change it with @command{passwd}. Passwords set with @command{passwd} are of course preserved across reboot and reconfiguration."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15511
- msgid "If you @emph{do} want to set an initial password for an account, then this field must contain the encrypted password, as a string. You can use the @code{crypt} procedure for this purpose:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15516
- #, no-wrap
- msgid ""
- "(user-account\n"
- " (name \"charlie\")\n"
- " (group \"users\")\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15519
- #, no-wrap
- msgid ""
- " ;; Specify a SHA-512-hashed initial password.\n"
- " (password (crypt \"InitialPassword!\" \"$6$abc\")))\n"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:15525
- msgid "The hash of this initial password will be available in a file in @file{/gnu/store}, readable by all the users, so this method must be used with care."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15530
- msgid "@xref{Passphrase Storage,,, libc, The GNU C Library Reference Manual}, for more information on password encryption, and @ref{Encryption,,, guile, GNU Guile Reference Manual}, for information on Guile's @code{crypt} procedure."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15536
- msgid "User group declarations are even simpler:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15539
- #, no-wrap
- msgid "(user-group (name \"students\"))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:15541
- #, no-wrap
- msgid "{Data Type} user-group"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:15543
- msgid "This type is for, well, user groups. There are just a few fields:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15547
- msgid "The name of the group."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:15548 guix-git/doc/guix.texi:30819
- #, no-wrap
- msgid "@code{id} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15551
- msgid "The group identifier (a number). If @code{#f}, a new number is automatically allocated when the group is created."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15555
- msgid "This Boolean value indicates whether the group is a ``system'' group. System groups have low numerical IDs."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15559
- msgid "What, user groups can have a password? Well, apparently yes. Unless @code{#f}, this field specifies the password of the group."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15565
- msgid "For convenience, a variable lists all the basic user groups one may expect:"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15566
- #, no-wrap
- msgid "{Scheme Variable} %base-groups"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15571
- msgid "This is the list of basic user groups that users and/or packages expect to be present on the system. This includes groups such as ``root'', ``wheel'', and ``users'', as well as groups used to control access to specific devices such as ``audio'', ``disk'', and ``cdrom''."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15573
- #, no-wrap
- msgid "{Scheme Variable} %base-user-accounts"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15576
- msgid "This is the list of basic system accounts that programs may expect to find on a GNU/Linux system, such as the ``nobody'' account."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15579
- msgid "Note that the ``root'' account is not included here. It is a special-case and is automatically added whether or not it is specified."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:15585
- #, no-wrap
- msgid "keymap"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15593
- msgid "To specify what each key of your keyboard does, you need to tell the operating system what @dfn{keyboard layout} you want to use. The default, when nothing is specified, is the US English QWERTY layout for 105-key PC keyboards. However, German speakers will usually prefer the German QWERTZ layout, French speakers will want the AZERTY layout, and so on; hackers might prefer Dvorak or bépo, and they might even want to further customize the effect of some of the keys. This section explains how to get that done."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:15594
- #, no-wrap
- msgid "keyboard layout, definition"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15596
- msgid "There are three components that will want to know about your keyboard layout:"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:15603
- msgid "The @emph{bootloader} may want to know what keyboard layout you want to use (@pxref{Bootloader Configuration, @code{keyboard-layout}}). This is useful if you want, for instance, to make sure that you can type the passphrase of your encrypted root partition using the right layout."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:15608
- msgid "The @emph{operating system kernel}, Linux, will need that so that the console is properly configured (@pxref{operating-system Reference, @code{keyboard-layout}})."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:15612
- msgid "The @emph{graphical display server}, usually Xorg, also has its own idea of the keyboard layout (@pxref{X Window, @code{keyboard-layout}})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15616
- msgid "Guix allows you to configure all three separately but, fortunately, it allows you to share the same keyboard layout for all three components."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:15617
- #, no-wrap
- msgid "XKB, keyboard layouts"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15625
- msgid "Keyboard layouts are represented by records created by the @code{keyboard-layout} procedure of @code{(gnu system keyboard)}. Following the X Keyboard extension (XKB), each layout has four attributes: a name (often a language code such as ``fi'' for Finnish or ``jp'' for Japanese), an optional variant name, an optional keyboard model name, and a possibly empty list of additional options. In most cases the layout name is all you care about."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:15626
- #, no-wrap
- msgid "{Scheme Procedure} keyboard-layout @var{name} [@var{variant}] @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:15629
- msgid "[#:model] [#:options '()] Return a new keyboard layout with the given @var{name} and @var{variant}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:15633
- msgid "@var{name} must be a string such as @code{\"fr\"}; @var{variant} must be a string such as @code{\"bepo\"} or @code{\"nodeadkeys\"}. See the @code{xkeyboard-config} package for valid options."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15636
- msgid "Here are a few examples:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15641
- #, no-wrap
- msgid ""
- ";; The German QWERTZ layout. Here we assume a standard\n"
- ";; \"pc105\" keyboard model.\n"
- "(keyboard-layout \"de\")\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15644
- #, no-wrap
- msgid ""
- ";; The bépo variant of the French layout.\n"
- "(keyboard-layout \"fr\" \"bepo\")\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15647
- #, no-wrap
- msgid ""
- ";; The Catalan layout.\n"
- "(keyboard-layout \"es\" \"cat\")\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15650
- #, no-wrap
- msgid ""
- ";; Arabic layout with \"Alt-Shift\" to switch to US layout.\n"
- "(keyboard-layout \"ar,us\" #:options '(\"grp:alt_shift_toggle\"))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15657
- #, no-wrap
- msgid ""
- ";; The Latin American Spanish layout. In addition, the\n"
- ";; \"Caps Lock\" key is used as an additional \"Ctrl\" key,\n"
- ";; and the \"Menu\" key is used as a \"Compose\" key to enter\n"
- ";; accented letters.\n"
- "(keyboard-layout \"latam\"\n"
- " #:options '(\"ctrl:nocaps\" \"compose:menu\"))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15660
- #, no-wrap
- msgid ""
- ";; The Russian layout for a ThinkPad keyboard.\n"
- "(keyboard-layout \"ru\" #:model \"thinkpad\")\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15665
- #, no-wrap
- msgid ""
- ";; The \"US international\" layout, which is the US layout plus\n"
- ";; dead keys to enter accented characters. This is for an\n"
- ";; Apple MacBook keyboard.\n"
- "(keyboard-layout \"us\" \"intl\" #:model \"macbook78\")\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15669
- msgid "See the @file{share/X11/xkb} directory of the @code{xkeyboard-config} package for a complete list of supported layouts, variants, and models."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:15670
- #, no-wrap
- msgid "keyboard layout, configuration"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15674
- msgid "Let's say you want your system to use the Turkish keyboard layout throughout your system---bootloader, console, and Xorg. Here's what your system configuration would look like:"
- msgstr ""
- #. type: findex
- #: guix-git/doc/guix.texi:15675
- #, no-wrap
- msgid "set-xorg-configuration"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15679
- #, no-wrap
- msgid ""
- ";; Using the Turkish layout for the bootloader, the console,\n"
- ";; and for Xorg.\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15691
- #, no-wrap
- msgid ""
- "(operating-system\n"
- " ;; ...\n"
- " (keyboard-layout (keyboard-layout \"tr\")) ;for the console\n"
- " (bootloader (bootloader-configuration\n"
- " (bootloader grub-efi-bootloader)\n"
- " (targets '(\"/boot/efi\"))\n"
- " (keyboard-layout keyboard-layout))) ;for GRUB\n"
- " (services (cons (set-xorg-configuration\n"
- " (xorg-configuration ;for Xorg\n"
- " (keyboard-layout keyboard-layout)))\n"
- " %desktop-services)))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15698
- msgid "In the example above, for GRUB and for Xorg, we just refer to the @code{keyboard-layout} field defined above, but we could just as well refer to a different layout. The @code{set-xorg-configuration} procedure communicates the desired Xorg configuration to the graphical log-in manager, by default GDM."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15701
- msgid "We've discussed how to specify the @emph{default} keyboard layout of your system when it starts, but you can also adjust it at run time:"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:15706
- msgid "If you're using GNOME, its settings panel has a ``Region & Language'' entry where you can select one or more keyboard layouts."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:15711
- msgid "Under Xorg, the @command{setxkbmap} command (from the same-named package) allows you to change the current layout. For example, this is how you would change the layout to US Dvorak:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:15714
- #, no-wrap
- msgid "setxkbmap us dvorak\n"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:15721
- msgid "The @code{loadkeys} command changes the keyboard layout in effect in the Linux console. However, note that @code{loadkeys} does @emph{not} use the XKB keyboard layout categorization described above. The command below loads the French bépo layout:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:15724
- #, no-wrap
- msgid "loadkeys fr-bepo\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:15730
- #, no-wrap
- msgid "locale"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15737
- msgid "A @dfn{locale} defines cultural conventions for a particular language and region of the world (@pxref{Locales,,, libc, The GNU C Library Reference Manual}). Each locale has a name that typically has the form @code{@var{language}_@var{territory}.@var{codeset}}---e.g., @code{fr_LU.utf8} designates the locale for the French language, with cultural conventions from Luxembourg, and using the UTF-8 encoding."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:15738
- #, no-wrap
- msgid "locale definition"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15742
- msgid "Usually, you will want to specify the default locale for the machine using the @code{locale} field of the @code{operating-system} declaration (@pxref{operating-system Reference, @code{locale}})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15751
- msgid "The selected locale is automatically added to the @dfn{locale definitions} known to the system if needed, with its codeset inferred from its name---e.g., @code{bo_CN.utf8} will be assumed to use the @code{UTF-8} codeset. Additional locale definitions can be specified in the @code{locale-definitions} slot of @code{operating-system}---this is useful, for instance, if the codeset could not be inferred from the locale name. The default set of locale definitions includes some widely used locales, but not all the available locales, in order to save space."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15754
- msgid "For instance, to add the North Frisian locale for Germany, the value of that field may be:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15759
- #, no-wrap
- msgid ""
- "(cons (locale-definition\n"
- " (name \"fy_DE.utf8\") (source \"fy_DE\"))\n"
- " %default-locale-definitions)\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15763
- msgid "Likewise, to save space, one might want @code{locale-definitions} to list only the locales that are actually used, as in:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15768
- #, no-wrap
- msgid ""
- "(list (locale-definition\n"
- " (name \"ja_JP.eucjp\") (source \"ja_JP\")\n"
- " (charset \"EUC-JP\")))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15777
- msgid "The compiled locale definitions are available at @file{/run/current-system/locale/X.Y}, where @code{X.Y} is the libc version, which is the default location where the GNU@tie{}libc provided by Guix looks for locale data. This can be overridden using the @env{LOCPATH} environment variable (@pxref{locales-and-locpath, @env{LOCPATH} and locale packages})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15780
- msgid "The @code{locale-definition} form is provided by the @code{(gnu system locale)} module. Details are given below."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:15781
- #, no-wrap
- msgid "{Data Type} locale-definition"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:15783
- msgid "This is the data type of a locale definition."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15789
- msgid "The name of the locale. @xref{Locale Names,,, libc, The GNU C Library Reference Manual}, for more information on locale names."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15793
- msgid "The name of the source for that locale. This is typically the @code{@var{language}_@var{territory}} part of the locale name."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:15794
- #, no-wrap
- msgid "@code{charset} (default: @code{\"UTF-8\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:15798
- msgid "The ``character set'' or ``code set'' for that locale, @uref{https://www.iana.org/assignments/character-sets, as defined by IANA}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15802
- #, no-wrap
- msgid "{Scheme Variable} %default-locale-definitions"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15806
- msgid "A list of commonly used UTF-8 locales, used as the default value of the @code{locale-definitions} field of @code{operating-system} declarations."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:15807
- #, no-wrap
- msgid "locale name"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:15808
- #, no-wrap
- msgid "normalized codeset in locale names"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15814
- msgid "These locale definitions use the @dfn{normalized codeset} for the part that follows the dot in the name (@pxref{Using gettextized software, normalized codeset,, libc, The GNU C Library Reference Manual}). So for instance it has @code{uk_UA.utf8} but @emph{not}, say, @code{uk_UA.UTF-8}."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:15816
- #, no-wrap
- msgid "Locale Data Compatibility Considerations"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:15818
- #, no-wrap
- msgid "incompatibility, of locale data"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15825
- msgid "@code{operating-system} declarations provide a @code{locale-libcs} field to specify the GNU@tie{}libc packages that are used to compile locale declarations (@pxref{operating-system Reference}). ``Why would I care?'', you may ask. Well, it turns out that the binary format of locale data is occasionally incompatible from one libc version to another."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15837
- msgid "For instance, a program linked against libc version 2.21 is unable to read locale data produced with libc 2.22; worse, that program @emph{aborts} instead of simply ignoring the incompatible locale data@footnote{Versions 2.23 and later of GNU@tie{}libc will simply skip the incompatible locale data, which is already an improvement.}. Similarly, a program linked against libc 2.22 can read most, but not all, of the locale data from libc 2.21 (specifically, @env{LC_COLLATE} data is incompatible); thus calls to @code{setlocale} may fail, but programs will not abort."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15842
- msgid "The ``problem'' with Guix is that users have a lot of freedom: They can choose whether and when to upgrade software in their profiles, and might be using a libc version different from the one the system administrator used to build the system-wide locale data."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15846
- msgid "Fortunately, unprivileged users can also install their own locale data and define @env{GUIX_LOCPATH} accordingly (@pxref{locales-and-locpath, @env{GUIX_LOCPATH} and locale packages})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15853
- msgid "Still, it is best if the system-wide locale data at @file{/run/current-system/locale} is built for all the libc versions actually in use on the system, so that all the programs can access it---this is especially crucial on a multi-user system. To do that, the administrator can specify several libc packages in the @code{locale-libcs} field of @code{operating-system}:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15856
- #, no-wrap
- msgid ""
- "(use-package-modules base)\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15860
- #, no-wrap
- msgid ""
- "(operating-system\n"
- " ;; @dots{}\n"
- " (locale-libcs (list glibc-2.21 (canonical-package glibc))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15865
- msgid "This example would lead to a system containing locale definitions for both libc 2.21 and the current version of libc in @file{/run/current-system/locale}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:15870
- #, no-wrap
- msgid "system services"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15876
- msgid "An important part of preparing an @code{operating-system} declaration is listing @dfn{system services} and their configuration (@pxref{Using the Configuration System}). System services are typically daemons launched when the system boots, or other actions needed at that time---e.g., configuring network access."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15883
- msgid "Guix has a broad definition of ``service'' (@pxref{Service Composition}), but many services are managed by the GNU@tie{}Shepherd (@pxref{Shepherd Services}). On a running system, the @command{herd} command allows you to list the available services, show their status, start and stop them, or do other specific operations (@pxref{Jump Start,,, shepherd, The GNU Shepherd Manual}). For example:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:15886
- #, no-wrap
- msgid "# herd status\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15891
- msgid "The above command, run as @code{root}, lists the currently defined services. The @command{herd doc} command shows a synopsis of the given service and its associated actions:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:15895
- #, no-wrap
- msgid ""
- "# herd doc nscd\n"
- "Run libc's name service cache daemon (nscd).\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:15898
- #, no-wrap
- msgid ""
- "# herd doc nscd action invalidate\n"
- "invalidate: Invalidate the given cache--e.g., 'hosts' for host name lookups.\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15903
- msgid "The @command{start}, @command{stop}, and @command{restart} sub-commands have the effect you would expect. For instance, the commands below stop the nscd service and restart the Xorg display server:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:15910
- #, no-wrap
- msgid ""
- "# herd stop nscd\n"
- "Service nscd has been stopped.\n"
- "# herd restart xorg-server\n"
- "Service xorg-server has been stopped.\n"
- "Service xorg-server has been started.\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15915
- msgid "The following sections document the available services, starting with the core services, that may be used in an @code{operating-system} declaration."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:15951 guix-git/doc/guix.texi:24198
- #: guix-git/doc/guix.texi:24199
- #, no-wrap
- msgid "File-Sharing Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:15951
- msgid "File-sharing services."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:15959
- msgid "The @code{(gnu services base)} module provides definitions for the basic services that one expects from the system. The services exported by this module are listed below."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15960
- #, no-wrap
- msgid "{Scheme Variable} %base-services"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15966
- msgid "This variable contains a list of basic services (@pxref{Service Types and Services}, for more information on service objects) one would expect from the system: a login service (mingetty) on each tty, syslogd, the libc name service cache daemon (nscd), the udev device manager, and more."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15971
- msgid "This is the default value of the @code{services} field of @code{operating-system} declarations. Usually, when customizing a system, you will want to append services to @code{%base-services}, like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15976
- #, no-wrap
- msgid ""
- "(append (list (service avahi-service-type)\n"
- " (service openssh-service-type))\n"
- " %base-services)\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15979
- #, no-wrap
- msgid "{Scheme Variable} special-files-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15982
- msgid "This is the service that sets up ``special files'' such as @file{/bin/sh}; an instance of it is part of @code{%base-services}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15986
- msgid "The value associated with @code{special-files-service-type} services must be a list of tuples where the first element is the ``special file'' and the second element is its target. By default it is:"
- msgstr ""
- #. type: file{#1}
- #: guix-git/doc/guix.texi:15987
- #, no-wrap
- msgid "/bin/sh"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:15988
- #, no-wrap
- msgid "@file{sh}, in @file{/bin}"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:15991
- #, no-wrap
- msgid "`((\"/bin/sh\" ,(file-append bash \"/bin/sh\")))\n"
- msgstr ""
- #. type: file{#1}
- #: guix-git/doc/guix.texi:15993
- #, no-wrap
- msgid "/usr/bin/env"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:15994
- #, no-wrap
- msgid "@file{env}, in @file{/usr/bin}"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:15997
- msgid "If you want to add, say, @code{/usr/bin/env} to your system, you can change it to:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:16001
- #, no-wrap
- msgid ""
- "`((\"/bin/sh\" ,(file-append bash \"/bin/sh\"))\n"
- " (\"/usr/bin/env\" ,(file-append coreutils \"/bin/env\")))\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:16008
- msgid "Since this is part of @code{%base-services}, you can use @code{modify-services} to customize the set of special files (@pxref{Service Reference, @code{modify-services}}). But the simple way to add a special file is @i{via} the @code{extra-special-file} procedure (see below)."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16010
- #, no-wrap
- msgid "{Scheme Procedure} extra-special-file @var{file} @var{target}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16012
- msgid "Use @var{target} as the ``special file'' @var{file}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16016
- msgid "For example, adding the following lines to the @code{services} field of your operating system declaration leads to a @file{/usr/bin/env} symlink:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:16020
- #, no-wrap
- msgid ""
- "(extra-special-file \"/usr/bin/env\"\n"
- " (file-append coreutils \"/bin/env\"))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16023
- #, no-wrap
- msgid "{Scheme Procedure} host-name-service @var{name}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16025
- msgid "Return a service that sets the host name to @var{name}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:16027
- #, no-wrap
- msgid "{Scheme Variable} console-font-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:16032
- msgid "Install the given fonts on the specified ttys (fonts are per virtual console on the kernel Linux). The value of this service is a list of tty/font pairs. The font can be the name of a font provided by the @code{kbd} package or any valid argument to @command{setfont}, as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:16041
- #, no-wrap
- msgid ""
- "`((\"tty1\" . \"LatGrkCyr-8x16\")\n"
- " (\"tty2\" . ,(file-append\n"
- " font-tamzen\n"
- " \"/share/kbd/consolefonts/TamzenForPowerline10x20.psf\"))\n"
- " (\"tty3\" . ,(file-append\n"
- " font-terminus\n"
- " \"/share/consolefonts/ter-132n\"))) ; for HDPI\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16044
- #, no-wrap
- msgid "{Scheme Procedure} login-service @var{config}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16048
- msgid "Return a service to run login according to @var{config}, a @code{<login-configuration>} object, which specifies the message of the day, among other things."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:16050
- #, no-wrap
- msgid "{Data Type} login-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:16052
- msgid "This is the data type representing the configuration of login."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:16055
- #, no-wrap
- msgid "motd"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:16056
- #, no-wrap
- msgid "message of the day"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16058
- msgid "A file-like object containing the ``message of the day''."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16059 guix-git/doc/guix.texi:19280
- #, no-wrap
- msgid "@code{allow-empty-passwords?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16062
- msgid "Allow empty passwords by default so that first-time users can log in when the 'root' account has just been created."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16066
- #, no-wrap
- msgid "{Scheme Procedure} mingetty-service @var{config}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16070
- msgid "Return a service to run mingetty according to @var{config}, a @code{<mingetty-configuration>} object, which specifies the tty to run, among other things."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:16072
- #, no-wrap
- msgid "{Data Type} mingetty-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:16075
- msgid "This is the data type representing the configuration of Mingetty, which provides the default implementation of virtual console log-in."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:16078 guix-git/doc/guix.texi:16117
- #: guix-git/doc/guix.texi:33550
- #, no-wrap
- msgid "tty"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16080
- msgid "The name of the console this Mingetty runs on---e.g., @code{\"tty1\"}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16081 guix-git/doc/guix.texi:16146
- #: guix-git/doc/guix.texi:16305
- #, no-wrap
- msgid "@code{auto-login} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16085
- msgid "When true, this field must be a string denoting the user name under which the system automatically logs in. When it is @code{#f}, a user name and password must be entered to log in."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16086
- #, no-wrap
- msgid "@code{login-program} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16090
- msgid "This must be either @code{#f}, in which case the default log-in program is used (@command{login} from the Shadow tool suite), or a gexp denoting the name of the log-in program."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16091
- #, no-wrap
- msgid "@code{login-pause?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16094
- msgid "When set to @code{#t} in conjunction with @var{auto-login}, the user will have to press a key before the log-in shell is launched."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16095
- #, no-wrap
- msgid "@code{clear-on-logout?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16097
- msgid "When set to @code{#t}, the screen will be cleared after logout."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16098
- #, no-wrap
- msgid "@code{mingetty} (default: @var{mingetty})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16100
- msgid "The Mingetty package to use."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16104
- #, no-wrap
- msgid "{Scheme Procedure} agetty-service @var{config}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16108
- msgid "Return a service to run agetty according to @var{config}, an @code{<agetty-configuration>} object, which specifies the tty to run, among other things."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:16110
- #, no-wrap
- msgid "{Data Type} agetty-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:16114
- msgid "This is the data type representing the configuration of agetty, which implements virtual and serial console log-in. See the @code{agetty(8)} man page for more information."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16121
- msgid "The name of the console this agetty runs on, as a string---e.g., @code{\"ttyS0\"}. This argument is optional, it will default to a reasonable default serial port used by the kernel Linux."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16125
- msgid "For this, if there is a value for an option @code{agetty.tty} in the kernel command line, agetty will extract the device name of the serial port from it and use that."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16129
- msgid "If not and if there is a value for an option @code{console} with a tty in the Linux command line, agetty will extract the device name of the serial port from it and use that."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16133
- msgid "In both cases, agetty will leave the other serial device settings (baud rate etc.)@: alone---in the hope that Linux pinned them to the correct values."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16134 guix-git/doc/guix.texi:33711
- #, no-wrap
- msgid "@code{baud-rate} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16137
- msgid "A string containing a comma-separated list of one or more baud rates, in descending order."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16138
- #, no-wrap
- msgid "@code{term} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16141
- msgid "A string containing the value used for the @env{TERM} environment variable."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16142
- #, no-wrap
- msgid "@code{eight-bits?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16145
- msgid "When @code{#t}, the tty is assumed to be 8-bit clean, and parity detection is disabled."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16149 guix-git/doc/guix.texi:16308
- msgid "When passed a login name, as a string, the specified user will be logged in automatically without prompting for their login name or password."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16150
- #, no-wrap
- msgid "@code{no-reset?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16152
- msgid "When @code{#t}, don't reset terminal cflags (control modes)."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16153
- #, no-wrap
- msgid "@code{host} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16156
- msgid "This accepts a string containing the ``login_host'', which will be written into the @file{/var/run/utmpx} file."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16157
- #, no-wrap
- msgid "@code{remote?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16161
- msgid "When set to @code{#t} in conjunction with @var{host}, this will add an @code{-r} fakehost option to the command line of the login program specified in @var{login-program}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16162
- #, no-wrap
- msgid "@code{flow-control?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16164
- msgid "When set to @code{#t}, enable hardware (RTS/CTS) flow control."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16165
- #, no-wrap
- msgid "@code{no-issue?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16168
- msgid "When set to @code{#t}, the contents of the @file{/etc/issue} file will not be displayed before presenting the login prompt."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16169
- #, no-wrap
- msgid "@code{init-string} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16172
- msgid "This accepts a string that will be sent to the tty or modem before sending anything else. It can be used to initialize a modem."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16173
- #, no-wrap
- msgid "@code{no-clear?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16176
- msgid "When set to @code{#t}, agetty will not clear the screen before showing the login prompt."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16177
- #, no-wrap
- msgid "@code{login-program} (default: (file-append shadow \"/bin/login\"))"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16181
- msgid "This must be either a gexp denoting the name of a log-in program, or unset, in which case the default value is the @command{login} from the Shadow tool suite."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16182
- #, no-wrap
- msgid "@code{local-line} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16186
- msgid "Control the CLOCAL line flag. This accepts one of three symbols as arguments, @code{'auto}, @code{'always}, or @code{'never}. If @code{#f}, the default value chosen by agetty is @code{'auto}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16187
- #, no-wrap
- msgid "@code{extract-baud?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16190
- msgid "When set to @code{#t}, instruct agetty to try to extract the baud rate from the status messages produced by certain types of modems."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16191
- #, no-wrap
- msgid "@code{skip-login?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16195
- msgid "When set to @code{#t}, do not prompt the user for a login name. This can be used with @var{login-program} field to use non-standard login systems."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16196
- #, no-wrap
- msgid "@code{no-newline?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16199
- msgid "When set to @code{#t}, do not print a newline before printing the @file{/etc/issue} file."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16201
- #, no-wrap
- msgid "@code{login-options} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16206
- msgid "This option accepts a string containing options that are passed to the login program. When used with the @var{login-program}, be aware that a malicious user could try to enter a login name containing embedded options that could be parsed by the login program."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16207
- #, no-wrap
- msgid "@code{login-pause} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16211
- msgid "When set to @code{#t}, wait for any key before showing the login prompt. This can be used in conjunction with @var{auto-login} to save memory by lazily spawning shells."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16212
- #, no-wrap
- msgid "@code{chroot} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16215
- msgid "Change root to the specified directory. This option accepts a directory path as a string."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16216
- #, no-wrap
- msgid "@code{hangup?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16219
- msgid "Use the Linux system call @code{vhangup} to do a virtual hangup of the specified terminal."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16220
- #, no-wrap
- msgid "@code{keep-baud?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16224
- msgid "When set to @code{#t}, try to keep the existing baud rate. The baud rates from @var{baud-rate} are used when agetty receives a @key{BREAK} character."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16225
- #, no-wrap
- msgid "@code{timeout} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16228
- msgid "When set to an integer value, terminate if no user name could be read within @var{timeout} seconds."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16229
- #, no-wrap
- msgid "@code{detect-case?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16235
- msgid "When set to @code{#t}, turn on support for detecting an uppercase-only terminal. This setting will detect a login name containing only uppercase letters as indicating an uppercase-only terminal and turn on some upper-to-lower case conversions. Note that this will not support Unicode characters."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16236
- #, no-wrap
- msgid "@code{wait-cr?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16241
- msgid "When set to @code{#t}, wait for the user or modem to send a carriage-return or linefeed character before displaying @file{/etc/issue} or login prompt. This is typically used with the @var{init-string} option."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16242
- #, no-wrap
- msgid "@code{no-hints?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16245
- msgid "When set to @code{#t}, do not print hints about Num, Caps, and Scroll locks."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16246
- #, no-wrap
- msgid "@code{no-hostname?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16249
- msgid "By default, the hostname is printed. When this option is set to @code{#t}, no hostname will be shown at all."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16250
- #, no-wrap
- msgid "@code{long-hostname?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16254
- msgid "By default, the hostname is only printed until the first dot. When this option is set to @code{#t}, the fully qualified hostname by @code{gethostname} or @code{getaddrinfo} is shown."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16255
- #, no-wrap
- msgid "@code{erase-characters} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16258
- msgid "This option accepts a string of additional characters that should be interpreted as backspace when the user types their login name."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16259
- #, no-wrap
- msgid "@code{kill-characters} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16263
- msgid "This option accepts a string that should be interpreted to mean ``ignore all previous characters'' (also called a ``kill'' character) when the user types their login name."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16264
- #, no-wrap
- msgid "@code{chdir} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16267
- msgid "This option accepts, as a string, a directory path that will be changed to before login."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16268
- #, no-wrap
- msgid "@code{delay} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16271
- msgid "This options accepts, as an integer, the number of seconds to sleep before opening the tty and displaying the login prompt."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16272
- #, no-wrap
- msgid "@code{nice} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16275
- msgid "This option accepts, as an integer, the nice value with which to run the @command{login} program."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16276 guix-git/doc/guix.texi:16564
- #: guix-git/doc/guix.texi:17478 guix-git/doc/guix.texi:25181
- #: guix-git/doc/guix.texi:26658 guix-git/doc/guix.texi:29074
- #: guix-git/doc/guix.texi:29869 guix-git/doc/guix.texi:31622
- #: guix-git/doc/guix.texi:34051
- #, no-wrap
- msgid "@code{extra-options} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16279
- msgid "This option provides an ``escape hatch'' for the user to provide arbitrary command-line arguments to @command{agetty} as a list of strings."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16283
- #, no-wrap
- msgid "{Scheme Procedure} kmscon-service-type @var{config}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16287
- msgid "Return a service to run @uref{https://www.freedesktop.org/wiki/Software/kmscon,kmscon} according to @var{config}, a @code{<kmscon-configuration>} object, which specifies the tty to run, among other things."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:16289
- #, no-wrap
- msgid "{Data Type} kmscon-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:16292
- msgid "This is the data type representing the configuration of Kmscon, which implements virtual console log-in."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:16295
- #, no-wrap
- msgid "virtual-terminal"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16297
- msgid "The name of the console this Kmscon runs on---e.g., @code{\"tty1\"}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16298
- #, no-wrap
- msgid "@code{login-program} (default: @code{#~(string-append #$shadow \"/bin/login\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16301
- msgid "A gexp denoting the name of the log-in program. The default log-in program is @command{login} from the Shadow tool suite."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16302
- #, no-wrap
- msgid "@code{login-arguments} (default: @code{'(\"-p\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16304
- msgid "A list of arguments to pass to @command{login}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16309
- #, no-wrap
- msgid "@code{hardware-acceleration?} (default: #f)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16311
- msgid "Whether to use hardware acceleration."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16312
- #, no-wrap
- msgid "@code{font-engine} (default: @code{\"pango\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16314
- msgid "Font engine used in Kmscon."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16315
- #, no-wrap
- msgid "@code{font-size} (default: @code{12})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16317
- msgid "Font size used in Kmscon."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16321
- msgid "If this is @code{#f}, Kmscon uses the default keyboard layout---usually US English (``qwerty'') for a 105-key PC keyboard."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16325
- msgid "Otherwise this must be a @code{keyboard-layout} object specifying the keyboard layout. @xref{Keyboard Layout}, for more information on how to specify the keyboard layout."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16326
- #, no-wrap
- msgid "@code{kmscon} (default: @var{kmscon})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16328
- msgid "The Kmscon package to use."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:16332
- #, no-wrap
- msgid "name service cache daemon"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:16333
- #, no-wrap
- msgid "nscd"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16334
- #, no-wrap
- msgid "{Scheme Procedure} nscd-service [@var{config}] [#:glibc glibc] @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16339
- msgid "[#:name-services '()] Return a service that runs the libc name service cache daemon (nscd) with the given @var{config}---an @code{<nscd-configuration>} object. @xref{Name Service Switch}, for an example."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16341
- msgid "For convenience, the Shepherd service for nscd provides the following actions:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16343
- #, no-wrap
- msgid "invalidate"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:16344
- #, no-wrap
- msgid "cache invalidation, nscd"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:16345
- #, no-wrap
- msgid "nscd, cache invalidation"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16347
- msgid "This invalidate the given cache. For instance, running:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:16350
- #, no-wrap
- msgid "herd invalidate nscd hosts\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16354
- msgid "invalidates the host name lookup cache of nscd."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16355
- #, no-wrap
- msgid "statistics"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16358
- msgid "Running @command{herd statistics nscd} displays information about nscd usage and caches."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:16362
- #, no-wrap
- msgid "{Scheme Variable} %nscd-default-configuration"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:16366
- msgid "This is the default @code{<nscd-configuration>} value (see below) used by @code{nscd-service}. It uses the caches defined by @code{%nscd-default-caches}; see below."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:16368
- #, no-wrap
- msgid "{Data Type} nscd-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:16371
- msgid "This is the data type representing the name service cache daemon (nscd) configuration."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16374
- #, no-wrap
- msgid "@code{name-services} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16377
- msgid "List of packages denoting @dfn{name services} that must be visible to the nscd---e.g., @code{(list @var{nss-mdns})}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16378
- #, no-wrap
- msgid "@code{glibc} (default: @var{glibc})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16381
- msgid "Package object denoting the GNU C Library providing the @command{nscd} command."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16382
- #, no-wrap
- msgid "@code{log-file} (default: @code{\"/var/log/nscd.log\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16385
- msgid "Name of the nscd log file. This is where debugging output goes when @code{debug-level} is strictly positive."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16386
- #, no-wrap
- msgid "@code{debug-level} (default: @code{0})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16389
- msgid "Integer denoting the debugging levels. Higher numbers mean that more debugging output is logged."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16390
- #, no-wrap
- msgid "@code{caches} (default: @code{%nscd-default-caches})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16393
- msgid "List of @code{<nscd-cache>} objects denoting things to be cached; see below."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:16397
- #, no-wrap
- msgid "{Data Type} nscd-cache"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:16399
- msgid "Data type representing a cache database of nscd and its parameters."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:16402 guix-git/doc/guix.texi:21071
- #, no-wrap
- msgid "database"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16407
- msgid "This is a symbol representing the name of the database to be cached. Valid values are @code{passwd}, @code{group}, @code{hosts}, and @code{services}, which designate the corresponding NSS database (@pxref{NSS Basics,,, libc, The GNU C Library Reference Manual})."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:16408
- #, no-wrap
- msgid "positive-time-to-live"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:16409
- #, no-wrap
- msgid "@code{negative-time-to-live} (default: @code{20})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16412
- msgid "A number representing the number of seconds during which a positive or negative lookup result remains in cache."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16413
- #, no-wrap
- msgid "@code{check-files?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16416
- msgid "Whether to check for updates of the files corresponding to @var{database}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16420
- msgid "For instance, when @var{database} is @code{hosts}, setting this flag instructs nscd to check for updates in @file{/etc/hosts} and to take them into account."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16421
- #, no-wrap
- msgid "@code{persistent?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16423
- msgid "Whether the cache should be stored persistently on disk."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16424
- #, no-wrap
- msgid "@code{shared?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16426
- msgid "Whether the cache should be shared among users."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16427
- #, no-wrap
- msgid "@code{max-database-size} (default: 32@tie{}MiB)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16429
- msgid "Maximum size in bytes of the database cache."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:16436
- #, no-wrap
- msgid "{Scheme Variable} %nscd-default-caches"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:16439
- msgid "List of @code{<nscd-cache>} objects used by default by @code{nscd-configuration} (see above)."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:16445
- msgid "It enables persistent and aggressive caching of service and host name lookups. The latter provides better host name lookup performance, resilience in the face of unreliable name servers, and also better privacy---often the result of host name lookups is in local cache, so external name servers do not even need to be queried."
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:16448
- msgid "syslog-configuration-type"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:16448 guix-git/doc/guix.texi:16464
- #, no-wrap
- msgid "syslog"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:16449 guix-git/doc/guix.texi:17035
- #, no-wrap
- msgid "logging"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:16450
- #, no-wrap
- msgid "{Data Type} syslog-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:16452
- msgid "This data type represents the configuration of the syslog daemon."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16454
- #, no-wrap
- msgid "@code{syslogd} (default: @code{#~(string-append #$inetutils \"/libexec/syslogd\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16456
- msgid "The syslog daemon to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16457
- #, no-wrap
- msgid "@code{config-file} (default: @code{%default-syslog.conf})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16459
- msgid "The syslog configuration file to use."
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:16464
- msgid "syslog-service"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16465
- #, no-wrap
- msgid "{Scheme Procedure} syslog-service @var{config}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16467
- msgid "Return a service that runs a syslog daemon according to @var{config}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16470
- msgid "@xref{syslogd invocation,,, inetutils, GNU Inetutils}, for more information on the configuration file syntax."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:16472
- #, no-wrap
- msgid "{Scheme Variable} guix-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:16476
- msgid "This is the type of the service that runs the build daemon, @command{guix-daemon} (@pxref{Invoking guix-daemon}). Its value must be a @code{guix-configuration} record as described below."
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:16479
- msgid "guix-configuration-type"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:16479
- #, no-wrap
- msgid "{Data Type} guix-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:16482
- msgid "This data type represents the configuration of the Guix build daemon. @xref{Invoking guix-daemon}, for more information."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16484
- #, no-wrap
- msgid "@code{guix} (default: @var{guix})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16486 guix-git/doc/guix.texi:16763
- msgid "The Guix package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16487
- #, no-wrap
- msgid "@code{build-group} (default: @code{\"guixbuild\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16489
- msgid "Name of the group for build user accounts."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16490
- #, no-wrap
- msgid "@code{build-accounts} (default: @code{10})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16492
- msgid "Number of build user accounts to create."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16493
- #, no-wrap
- msgid "@code{authorize-key?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16500
- msgid "Whether to authorize the substitute keys listed in @code{authorized-keys}---by default that of @code{@value{SUBSTITUTE-SERVER-1}} and @code{@value{SUBSTITUTE-SERVER-2}} (@pxref{Substitutes})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16506
- msgid "When @code{authorize-key?} is true, @file{/etc/guix/acl} cannot be changed by invoking @command{guix archive --authorize}. You must instead adjust @code{guix-configuration} as you wish and reconfigure the system. This ensures that your operating system configuration file is self-contained."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:16513
- msgid "When booting or reconfiguring to a system where @code{authorize-key?} is true, the existing @file{/etc/guix/acl} file is backed up as @file{/etc/guix/acl.bak} if it was determined to be a manually modified file. This is to facilitate migration from earlier versions, which allowed for in-place modifications to @file{/etc/guix/acl}."
- msgstr ""
- #. type: vindex
- #: guix-git/doc/guix.texi:16515
- #, no-wrap
- msgid "%default-authorized-guix-keys"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16516
- #, no-wrap
- msgid "@code{authorized-keys} (default: @code{%default-authorized-guix-keys})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16522
- msgid "The list of authorized key files for archive imports, as a list of string-valued gexps (@pxref{Invoking guix archive}). By default, it contains that of @code{@value{SUBSTITUTE-SERVER-1}} and @code{@value{SUBSTITUTE-SERVER-2}} (@pxref{Substitutes}). See @code{substitute-urls} below for an example on how to change it."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16523
- #, no-wrap
- msgid "@code{use-substitutes?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16525
- msgid "Whether to use substitutes."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16526 guix-git/doc/guix.texi:29171
- #, no-wrap
- msgid "@code{substitute-urls} (default: @code{%default-substitute-urls})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16528 guix-git/doc/guix.texi:29173
- msgid "The list of URLs where to look for substitutes by default."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16535
- msgid "Suppose you would like to fetch substitutes from @code{guix.example.org} in addition to @code{@value{SUBSTITUTE-SERVER-1}}. You will need to do two things: (1) add @code{guix.example.org} to @code{substitute-urls}, and (2) authorize its signing key, having done appropriate checks (@pxref{Substitute Server Authorization}). The configuration below does exactly that:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:16544
- #, no-wrap
- msgid ""
- "(guix-configuration\n"
- " (substitute-urls\n"
- " (append (list \"https://guix.example.org\")\n"
- " %default-substitute-urls))\n"
- " (authorized-keys\n"
- " (append (list (local-file \"./guix.example.org-key.pub\"))\n"
- " %default-authorized-guix-keys)))\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16549
- msgid "This example assumes that the file @file{./guix.example.org-key.pub} contains the public key that @code{guix.example.org} uses to sign substitutes."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16550
- #, no-wrap
- msgid "@code{max-silent-time} (default: @code{0})"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:16551
- #, no-wrap
- msgid "@code{timeout} (default: @code{0})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16555
- msgid "The number of seconds of silence and the number of seconds of activity, respectively, after which a build process times out. A value of zero disables the timeout."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16556
- #, no-wrap
- msgid "@code{log-compression} (default: @code{'bzip2})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16559
- msgid "The type of compression used for build logs---one of @code{gzip}, @code{bzip2}, or @code{none}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16560
- #, no-wrap
- msgid "@code{discover?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16566
- msgid "List of extra command-line options for @command{guix-daemon}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16567
- #, no-wrap
- msgid "@code{log-file} (default: @code{\"/var/log/guix-daemon.log\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16570
- msgid "File where @command{guix-daemon}'s standard output and standard error are written."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:16571
- #, no-wrap
- msgid "HTTP proxy, for @code{guix-daemon}"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:16572
- #, no-wrap
- msgid "proxy, for @code{guix-daemon} HTTP access"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16573
- #, no-wrap
- msgid "@code{http-proxy} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16576
- msgid "The URL of the HTTP and HTTPS proxy used for downloading fixed-output derivations and substitutes."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16579
- msgid "It is also possible to change the daemon's proxy at run time through the @code{set-http-proxy} action, which restarts it:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:16582
- #, no-wrap
- msgid "herd set-http-proxy guix-daemon http://localhost:8118\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16585
- msgid "To clear the proxy settings, run:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:16588
- #, no-wrap
- msgid "herd set-http-proxy guix-daemon\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16590
- #, no-wrap
- msgid "@code{tmpdir} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16592
- msgid "A directory path where the @command{guix-daemon} will perform builds."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16596
- #, no-wrap
- msgid "{Scheme Procedure} udev-service [#:udev @var{eudev} #:rules @code{'()}]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16602
- msgid "Run @var{udev}, which populates the @file{/dev} directory dynamically. udev rules can be provided as a list of files through the @var{rules} variable. The procedures @code{udev-rule}, @code{udev-rules-service} and @code{file->udev-rule} from @code{(gnu services base)} simplify the creation of such rule files."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16605
- msgid "The @command{herd rules udev} command, as root, returns the name of the directory containing all the active udev rules."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16607
- #, no-wrap
- msgid "{Scheme Procedure} udev-rule [@var{file-name} @var{contents}]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16610
- msgid "Return a udev-rule file named @var{file-name} containing the rules defined by the @var{contents} literal."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16614
- msgid "In the following example, a rule for a USB device is defined to be stored in the file @file{90-usb-thing.rules}. The rule runs a script upon detecting a USB device with a given product identifier."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:16622
- #, no-wrap
- msgid ""
- "(define %example-udev-rule\n"
- " (udev-rule\n"
- " \"90-usb-thing.rules\"\n"
- " (string-append \"ACTION==\\\"add\\\", SUBSYSTEM==\\\"usb\\\", \"\n"
- " \"ATTR@{product@}==\\\"Example\\\", \"\n"
- " \"RUN+=\\\"/path/to/script\\\"\")))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16625
- #, no-wrap
- msgid "{Scheme Procedure} udev-rules-service [@var{name} @var{rules}] @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16632
- msgid "[#:groups @var{groups}] Return a service that extends @code{udev-service-type } with @var{rules} and @code{account-service-type} with @var{groups} as system groups. This works by creating a singleton service type @code{@var{name}-udev-rules}, of which the returned service is an instance."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16635
- msgid "Here we show how it can be used to extend @code{udev-service-type} with the previously defined rule @code{%example-udev-rule}."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:16642
- #, no-wrap
- msgid ""
- "(operating-system\n"
- " ;; @dots{}\n"
- " (services\n"
- " (cons (udev-rules-service 'usb-thing %example-udev-rule)\n"
- " %desktop-services)))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16645
- #, no-wrap
- msgid "{Scheme Procedure} file->udev-rule [@var{file-name} @var{file}]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16648
- msgid "Return a udev file named @var{file-name} containing the rules defined within @var{file}, a file-like object."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16650
- msgid "The following example showcases how we can use an existing rule file."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:16655
- #, no-wrap
- msgid ""
- "(use-modules (guix download) ;for url-fetch\n"
- " (guix packages) ;for origin\n"
- " @dots{})\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:16666
- #, no-wrap
- msgid ""
- "(define %android-udev-rules\n"
- " (file->udev-rule\n"
- " \"51-android-udev.rules\"\n"
- " (let ((version \"20170910\"))\n"
- " (origin\n"
- " (method url-fetch)\n"
- " (uri (string-append \"https://raw.githubusercontent.com/M0Rf30/\"\n"
- " \"android-udev-rules/\" version \"/51-android.rules\"))\n"
- " (sha256\n"
- " (base32 \"0lmmagpyb6xsq6zcr2w1cyx9qmjqmajkvrdbhjx32gqf1d9is003\"))))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:16675
- msgid "Additionally, Guix package definitions can be included in @var{rules} in order to extend the udev rules with the definitions found under their @file{lib/udev/rules.d} sub-directory. In lieu of the previous @var{file->udev-rule} example, we could have used the @var{android-udev-rules} package which exists in Guix in the @code{(gnu packages android)} module."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:16684
- msgid "The following example shows how to use the @var{android-udev-rules} package so that the Android tool @command{adb} can detect devices without root privileges. It also details how to create the @code{adbusers} group, which is required for the proper functioning of the rules defined within the @code{android-udev-rules} package. To create such a group, we must define it both as part of the @code{supplementary-groups} of our @code{user-account} declaration, as well as in the @var{groups} of the @code{udev-rules-service} procedure."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:16689
- #, no-wrap
- msgid ""
- "(use-modules (gnu packages android) ;for android-udev-rules\n"
- " (gnu system shadow) ;for user-group\n"
- " @dots{})\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:16702
- #, no-wrap
- msgid ""
- "(operating-system\n"
- " ;; @dots{}\n"
- " (users (cons (user-account\n"
- " ;; @dots{}\n"
- " (supplementary-groups\n"
- " '(\"adbusers\" ;for adb\n"
- " \"wheel\" \"netdev\" \"audio\" \"video\")))))\n"
- " ;; @dots{}\n"
- " (services\n"
- " (cons (udev-rules-service 'android android-udev-rules\n"
- " #:groups '(\"adbusers\"))\n"
- " %desktop-services)))\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:16704
- #, no-wrap
- msgid "{Scheme Variable} urandom-seed-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:16709
- msgid "Save some entropy in @code{%random-seed-file} to seed @file{/dev/urandom} when rebooting. It also tries to seed @file{/dev/urandom} from @file{/dev/hwrng} while booting, if @file{/dev/hwrng} exists and is readable."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:16711
- #, no-wrap
- msgid "{Scheme Variable} %random-seed-file"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:16715
- msgid "This is the name of the file where some random bytes are saved by @var{urandom-seed-service} to seed @file{/dev/urandom} when rebooting. It defaults to @file{/var/lib/random-seed}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:16717
- #, no-wrap
- msgid "mouse"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:16718
- #, no-wrap
- msgid "gpm"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:16719
- #, no-wrap
- msgid "{Scheme Variable} gpm-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:16724
- msgid "This is the type of the service that runs GPM, the @dfn{general-purpose mouse daemon}, which provides mouse support to the Linux console. GPM allows users to use the mouse in the console, notably to select, copy, and paste text."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:16727
- msgid "The value for services of this type must be a @code{gpm-configuration} (see below). This service is not part of @code{%base-services}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:16729
- #, no-wrap
- msgid "{Data Type} gpm-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:16731
- msgid "Data type representing the configuration of GPM."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16733
- #, no-wrap
- msgid "@code{options} (default: @code{%default-gpm-options})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16738
- msgid "Command-line options passed to @command{gpm}. The default set of options instruct @command{gpm} to listen to mouse events on @file{/dev/input/mice}. @xref{Command Line,,, gpm, gpm manual}, for more information."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16739
- #, no-wrap
- msgid "@code{gpm} (default: @code{gpm})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16741
- msgid "The GPM package to use."
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:16746
- msgid "guix-publish-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16746
- #, no-wrap
- msgid "{Scheme Variable} guix-publish-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16750
- msgid "This is the service type for @command{guix publish} (@pxref{Invoking guix publish}). Its value must be a @code{guix-publish-configuration} object, as described below."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16754
- msgid "This assumes that @file{/etc/guix} already contains a signing key pair as created by @command{guix archive --generate-key} (@pxref{Invoking guix archive}). If that is not the case, the service will fail to start."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:16756
- #, no-wrap
- msgid "{Data Type} guix-publish-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:16759
- msgid "Data type representing the configuration of the @code{guix publish} service."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16761
- #, no-wrap
- msgid "@code{guix} (default: @code{guix})"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16764 guix-git/doc/guix.texi:31477
- #, no-wrap
- msgid "@code{port} (default: @code{80})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16766
- msgid "The TCP port to listen for connections."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16767 guix-git/doc/guix.texi:29054
- #: guix-git/doc/guix.texi:32858
- #, no-wrap
- msgid "@code{host} (default: @code{\"localhost\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16770
- msgid "The host (and thus, network interface) to listen to. Use @code{\"0.0.0.0\"} to listen on all the network interfaces."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16771
- #, no-wrap
- msgid "@code{advertise?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16774
- msgid "When true, advertise the service on the local network @i{via} the DNS-SD protocol, using Avahi."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16778
- msgid "This allows neighboring Guix devices with discovery on (see @code{guix-configuration} above) to discover this @command{guix publish} instance and to automatically download substitutes from it."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16779
- #, no-wrap
- msgid "@code{compression} (default: @code{'((\"gzip\" 3) (\"zstd\" 3))})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16783
- msgid "This is a list of compression method/level tuple used when compressing substitutes. For example, to compress all substitutes with @emph{both} lzip at level 7 and gzip at level 9, write:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:16786
- #, no-wrap
- msgid "'((\"lzip\" 7) (\"gzip\" 9))\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16792
- msgid "Level 9 achieves the best compression ratio at the expense of increased CPU usage, whereas level 1 achieves fast compression. @xref{Invoking guix publish}, for more information on the available compression methods and the tradeoffs involved."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16794
- msgid "An empty list disables compression altogether."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16795
- #, no-wrap
- msgid "@code{nar-path} (default: @code{\"nar\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16798
- msgid "The URL path at which ``nars'' can be fetched. @xref{Invoking guix publish, @option{--nar-path}}, for details."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16799
- #, no-wrap
- msgid "@code{cache} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16805
- msgid "When it is @code{#f}, disable caching and instead generate archives on demand. Otherwise, this should be the name of a directory---e.g., @code{\"/var/cache/guix/publish\"}---where @command{guix publish} caches archives and meta-data ready to be sent. @xref{Invoking guix publish, @option{--cache}}, for more information on the tradeoffs involved."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16806
- #, no-wrap
- msgid "@code{workers} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16810
- msgid "When it is an integer, this is the number of worker threads used for caching; when @code{#f}, the number of processors is used. @xref{Invoking guix publish, @option{--workers}}, for more information."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16811
- #, no-wrap
- msgid "@code{cache-bypass-threshold} (default: 10 MiB)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16816
- msgid "When @code{cache} is true, this is the maximum size in bytes of a store item for which @command{guix publish} may bypass its cache in case of a cache miss. @xref{Invoking guix publish, @option{--cache-bypass-threshold}}, for more information."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:16817
- #, no-wrap
- msgid "@code{ttl} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:16821
- msgid "When it is an integer, this denotes the @dfn{time-to-live} in seconds of the published archives. @xref{Invoking guix publish, @option{--ttl}}, for more information."
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:16825
- msgid "rngd-service"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16825
- #, no-wrap
- msgid "{Scheme Procedure} rngd-service [#:rng-tools @var{rng-tools}] @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16830
- msgid "[#:device \"/dev/hwrng\"] Return a service that runs the @command{rngd} program from @var{rng-tools} to add @var{device} to the kernel's entropy pool. The service will fail if @var{device} does not exist."
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:16833
- msgid "pam-limits-service"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:16833
- #, no-wrap
- msgid "session limits"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:16834
- #, no-wrap
- msgid "ulimit"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:16835
- #, no-wrap
- msgid "priority"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:16836
- #, no-wrap
- msgid "realtime"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:16837
- #, no-wrap
- msgid "jackd"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:16838
- #, no-wrap
- msgid "nofile"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:16839
- #, no-wrap
- msgid "open file descriptors"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16840
- #, no-wrap
- msgid "{Scheme Procedure} pam-limits-service [#:limits @code{'()}]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16847
- msgid "Return a service that installs a configuration file for the @uref{http://linux-pam.org/Linux-PAM-html/sag-pam_limits.html, @code{pam_limits} module}. The procedure optionally takes a list of @code{pam-limits-entry} values, which can be used to specify @code{ulimit} limits and @code{nice} priority limits to user sessions."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16850
- msgid "The following limits definition sets two hard and soft limits for all login sessions of users in the @code{realtime} group:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:16856
- #, no-wrap
- msgid ""
- "(pam-limits-service\n"
- " (list\n"
- " (pam-limits-entry \"@@realtime\" 'both 'rtprio 99)\n"
- " (pam-limits-entry \"@@realtime\" 'both 'memlock 'unlimited)))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16862
- msgid "The first entry increases the maximum realtime priority for non-privileged processes; the second entry lifts any restriction of the maximum address space that can be locked in memory. These settings are commonly used for real-time audio systems."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16865
- msgid "Another useful example is raising the maximum number of open file descriptors that can be used:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:16870
- #, no-wrap
- msgid ""
- "(pam-limits-service\n"
- " (list\n"
- " (pam-limits-entry \"*\" 'both 'nofile 100000)))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:16878
- msgid "In the above example, the asterisk means the limit should apply to any user. It is important to ensure the chosen value doesn't exceed the maximum system value visible in the @file{/proc/sys/fs/file-max} file, else the users would be prevented from login in. For more information about the Pluggable Authentication Module (PAM) limits, refer to the @samp{pam_limits} man page from the @code{linux-pam} package."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:16883 guix-git/doc/guix.texi:37407
- #, no-wrap
- msgid "cron"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:16884 guix-git/doc/guix.texi:37408
- #, no-wrap
- msgid "mcron"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:16885 guix-git/doc/guix.texi:37409
- #, no-wrap
- msgid "scheduling jobs"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:16892
- msgid "The @code{(gnu services mcron)} module provides an interface to GNU@tie{}mcron, a daemon to run jobs at scheduled times (@pxref{Top,,, mcron, GNU@tie{}mcron}). GNU@tie{}mcron is similar to the traditional Unix @command{cron} daemon; the main difference is that it is implemented in Guile Scheme, which provides a lot of flexibility when specifying the scheduling of jobs and their actions."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:16900
- msgid "The example below defines an operating system that runs the @command{updatedb} (@pxref{Invoking updatedb,,, find, Finding Files}) and the @command{guix gc} commands (@pxref{Invoking guix gc}) daily, as well as the @command{mkid} command on behalf of an unprivileged user (@pxref{mkid invocation,,, idutils, ID Database Utilities}). It uses gexps to introduce job definitions that are passed to mcron (@pxref{G-Expressions})."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:16904
- #, no-wrap
- msgid ""
- "(use-modules (guix) (gnu) (gnu services mcron))\n"
- "(use-package-modules base idutils)\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:16914
- #, no-wrap
- msgid ""
- "(define updatedb-job\n"
- " ;; Run 'updatedb' at 3AM every day. Here we write the\n"
- " ;; job's action as a Scheme procedure.\n"
- " #~(job '(next-hour '(3))\n"
- " (lambda ()\n"
- " (execl (string-append #$findutils \"/bin/updatedb\")\n"
- " \"updatedb\"\n"
- " \"--prunepaths=/tmp /var/tmp /gnu/store\"))\n"
- " \"updatedb\"))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:16920
- #, no-wrap
- msgid ""
- "(define garbage-collector-job\n"
- " ;; Collect garbage 5 minutes after midnight every day.\n"
- " ;; The job's action is a shell command.\n"
- " #~(job \"5 0 * * *\" ;Vixie cron syntax\n"
- " \"guix gc -F 1G\"))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:16927
- #, no-wrap
- msgid ""
- "(define idutils-job\n"
- " ;; Update the index database as user \"charlie\" at 12:15PM\n"
- " ;; and 19:15PM. This runs from the user's home directory.\n"
- " #~(job '(next-minute-from (next-hour '(12 19)) '(15))\n"
- " (string-append #$idutils \"/bin/mkid src\")\n"
- " #:user \"charlie\"))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:16930
- #, no-wrap
- msgid ""
- "(operating-system\n"
- " ;; @dots{}\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:16940
- #, no-wrap
- msgid ""
- " ;; %BASE-SERVICES already includes an instance of\n"
- " ;; 'mcron-service-type', which we extend with additional\n"
- " ;; jobs using 'simple-service'.\n"
- " (services (cons (simple-service 'my-cron-jobs\n"
- " mcron-service-type\n"
- " (list garbage-collector-job\n"
- " updatedb-job\n"
- " idutils-job))\n"
- " %base-services)))\n"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:16942
- #, no-wrap
- msgid "Tip"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:16948
- msgid "When providing the action of a job specification as a procedure, you should provide an explicit name for the job via the optional 3rd argument as done in the @code{updatedb-job} example above. Otherwise, the job would appear as ``Lambda function'' in the output of @command{herd schedule mcron}, which is not nearly descriptive enough!"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:16955
- msgid "For more complex jobs defined in Scheme where you need control over the top level, for instance to introduce a @code{use-modules} form, you can move your code to a separate program using the @code{program-file} procedure of the @code{(guix gexp)} module (@pxref{G-Expressions}). The example below illustrates that."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:16971
- #, no-wrap
- msgid ""
- "(define %battery-alert-job\n"
- " ;; Beep when the battery percentage falls below %MIN-LEVEL.\n"
- " #~(job\n"
- " '(next-minute (range 0 60 1))\n"
- " #$(program-file\n"
- " \"battery-alert.scm\"\n"
- " (with-imported-modules (source-module-closure\n"
- " '((guix build utils)))\n"
- " #~(begin\n"
- " (use-modules (guix build utils)\n"
- " (ice-9 popen)\n"
- " (ice-9 regex)\n"
- " (ice-9 textual-ports)\n"
- " (srfi srfi-2))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:16973
- #, no-wrap
- msgid ""
- " (define %min-level 20)\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:16984
- #, no-wrap
- msgid ""
- " (setenv \"LC_ALL\" \"C\") ;ensure English output\n"
- " (and-let* ((input-pipe (open-pipe*\n"
- " OPEN_READ\n"
- " #$(file-append acpi \"/bin/acpi\")))\n"
- " (output (get-string-all input-pipe))\n"
- " (m (string-match \"Discharging, ([0-9]+)%\" output))\n"
- " (level (string->number (match:substring m 1)))\n"
- " ((< level %min-level)))\n"
- " (format #t \"warning: Battery level is low (~a%)~%\" level)\n"
- " (invoke #$(file-append beep \"/bin/beep\") \"-r5\")))))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:16989
- msgid "@xref{Guile Syntax, mcron job specifications,, mcron, GNU@tie{}mcron}, for more information on mcron job specifications. Below is the reference of the mcron service."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:16992
- msgid "On a running system, you can use the @code{schedule} action of the service to visualize the mcron jobs that will be executed next:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:16995
- #, no-wrap
- msgid "# herd schedule mcron\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:17000
- msgid "The example above lists the next five tasks that will be executed, but you can also specify the number of tasks to display:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:17003
- #, no-wrap
- msgid "# herd schedule mcron 10\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17005
- #, no-wrap
- msgid "{Scheme Variable} mcron-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17008
- msgid "This is the type of the @code{mcron} service, whose value is an @code{mcron-configuration} object."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17013 guix-git/doc/guix.texi:37428
- msgid "This service type can be the target of a service extension that provides additional job specifications (@pxref{Service Composition}). In other words, it is possible to define services that provide additional mcron jobs to run."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17015
- #, no-wrap
- msgid "{Data Type} mcron-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17017 guix-git/doc/guix.texi:37432
- msgid "Data type representing the configuration of mcron."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17019 guix-git/doc/guix.texi:37434
- #, no-wrap
- msgid "@code{mcron} (default: @var{mcron})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17021 guix-git/doc/guix.texi:37436
- msgid "The mcron package to use."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:17022 guix-git/doc/guix.texi:17091
- #: guix-git/doc/guix.texi:37437
- #, no-wrap
- msgid "jobs"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17026 guix-git/doc/guix.texi:37441
- msgid "This is a list of gexps (@pxref{G-Expressions}), where each gexp corresponds to an mcron job specification (@pxref{Syntax, mcron job specifications,, mcron, GNU@tie{}mcron})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17033
- #, no-wrap
- msgid "rottlog"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17034
- #, no-wrap
- msgid "log rotation"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:17041
- msgid "Log files such as those found in @file{/var/log} tend to grow endlessly, so it's a good idea to @dfn{rotate} them once in a while---i.e., archive their contents in separate files, possibly compressed. The @code{(gnu services admin)} module provides an interface to GNU@tie{}Rot[t]log, a log rotation tool (@pxref{Top,,, rottlog, GNU Rot[t]log Manual})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:17047
- msgid "This service is part of @code{%base-services}, and thus enabled by default, with the default settings, for commonly encountered log files. The example below shows how to extend it with an additional @dfn{rotation}, should you need to do that (usually, services that produce log files already take care of that):"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:17051
- #, no-wrap
- msgid ""
- "(use-modules (guix) (gnu))\n"
- "(use-service-modules admin)\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:17055
- #, no-wrap
- msgid ""
- "(define my-log-files\n"
- " ;; Log files that I want to rotate.\n"
- " '(\"/var/log/something.log\" \"/var/log/another.log\"))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:17064
- #, no-wrap
- msgid ""
- "(operating-system\n"
- " ;; @dots{}\n"
- " (services (cons (simple-service 'rotate-my-stuff\n"
- " rottlog-service-type\n"
- " (list (log-rotation\n"
- " (frequency 'daily)\n"
- " (files my-log-files))))\n"
- " %base-services)))\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17066
- #, no-wrap
- msgid "{Scheme Variable} rottlog-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17069
- msgid "This is the type of the Rottlog service, whose value is a @code{rottlog-configuration} object."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17072
- msgid "Other services can extend this one with new @code{log-rotation} objects (see below), thereby augmenting the set of files to be rotated."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17075
- msgid "This service type can define mcron jobs (@pxref{Scheduled Job Execution}) to run the rottlog service."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17077
- #, no-wrap
- msgid "{Data Type} rottlog-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17079
- msgid "Data type representing the configuration of rottlog."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17081
- #, no-wrap
- msgid "@code{rottlog} (default: @code{rottlog})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17083
- msgid "The Rottlog package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17084
- #, no-wrap
- msgid "@code{rc-file} (default: @code{(file-append rottlog \"/etc/rc\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17087
- msgid "The Rottlog configuration file to use (@pxref{Mandatory RC Variables,,, rottlog, GNU Rot[t]log Manual})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17088
- #, no-wrap
- msgid "@code{rotations} (default: @code{%default-rotations})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17090
- msgid "A list of @code{log-rotation} objects as defined below."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17094
- msgid "This is a list of gexps where each gexp corresponds to an mcron job specification (@pxref{Scheduled Job Execution})."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17097
- #, no-wrap
- msgid "{Data Type} log-rotation"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17099
- msgid "Data type representing the rotation of a group of log files."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17103
- msgid "Taking an example from the Rottlog manual (@pxref{Period Related File Examples,,, rottlog, GNU Rot[t]log Manual}), a log rotation might be defined like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:17112
- #, no-wrap
- msgid ""
- "(log-rotation\n"
- " (frequency 'daily)\n"
- " (files '(\"/var/log/apache/*\"))\n"
- " (options '(\"storedir apache-archives\"\n"
- " \"rotate 6\"\n"
- " \"notifempty\"\n"
- " \"nocompress\")))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17115
- msgid "The list of fields is as follows:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17117
- #, no-wrap
- msgid "@code{frequency} (default: @code{'weekly})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17119
- msgid "The log rotation frequency, a symbol."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:17120
- #, no-wrap
- msgid "files"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17122
- msgid "The list of files or file glob patterns to rotate."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17123
- #, no-wrap
- msgid "@code{options} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17126
- msgid "The list of rottlog options for this rotation (@pxref{Configuration parameters,,, rottlog, GNU Rot[t]lg Manual})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17127
- #, no-wrap
- msgid "@code{post-rotate} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17129
- msgid "Either @code{#f} or a gexp to execute once the rotation has completed."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17132
- #, no-wrap
- msgid "{Scheme Variable} %default-rotations"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17135
- msgid "Specifies weekly rotation of @code{%rotated-files} and of @file{/var/log/guix-daemon.log}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17137
- #, no-wrap
- msgid "{Scheme Variable} %rotated-files"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17141
- msgid "The list of syslog-controlled files to be rotated. By default it is: @code{'(\"/var/log/messages\" \"/var/log/secure\" \"/var/log/debug\" \\ \"/var/log/maillog\")}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:17154
- msgid "The @code{(gnu services networking)} module provides services to configure network interfaces and set up networking on your machine. Those services provide different ways for you to set up your machine: by declaring a static network configuration, by running a Dynamic Host Configuration Protocol (DHCP) client, or by running daemons such as NetworkManager and Connman that automate the whole process, automatically adapt to connectivity changes, and provide a high-level user interface."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:17160
- msgid "On a laptop, NetworkManager and Connman are by far the most convenient options, which is why the default desktop services include NetworkManager (@pxref{Desktop Services, @code{%desktop-services}}). For a server, or for a virtual machine or a container, static network configuration or a simple DHCP client are often more appropriate."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:17163
- msgid "This section describes the various network setup services available, starting with static network configuration."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17164
- #, no-wrap
- msgid "{Scheme Variable} static-networking-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17169
- msgid "This is the type for statically-configured network interfaces. Its value must be a list of @code{static-networking} records. Each of them declares a set of @dfn{addresses}, @dfn{routes}, and @dfn{links}, as show below."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17170
- #, no-wrap
- msgid "network interface controller (NIC)"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17171
- #, no-wrap
- msgid "NIC, networking interface controller"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17174
- msgid "Here is the simplest configuration, with only one network interface controller (NIC) and only IPv4 connectivity:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:17188
- #, no-wrap
- msgid ""
- ";; Static networking for one NIC, IPv4-only.\n"
- "(service static-networking-service-type\n"
- " (list (static-networking\n"
- " (addresses\n"
- " (list (network-address\n"
- " (device \"eno1\")\n"
- " (value \"10.0.2.15/24\"))))\n"
- " (routes\n"
- " (list (network-route\n"
- " (destination \"default\")\n"
- " (gateway \"10.0.2.2\"))))\n"
- " (name-servers '(\"10.0.2.3\")))))\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17197
- msgid "The snippet above can be added to the @code{services} field of your operating system configuration (@pxref{Using the Configuration System}). It will configure your machine to have 10.0.2.15 as its IP address, with a 24-bit netmask for the local network---meaning that any 10.0.2.@var{x} address is on the local area network (LAN). Traffic to addresses outside the local network is routed @i{via} 10.0.2.2. Host names are resolved by sending domain name system (DNS) queries to 10.0.2.3."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17199
- #, no-wrap
- msgid "{Data Type} static-networking"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17201
- msgid "This is the data type representing a static network configuration."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17205
- msgid "As an example, here is how you would declare the configuration of a machine with a single network interface controller (NIC) available as @code{eno1}, and with one IPv4 and one IPv6 address:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:17222
- #, no-wrap
- msgid ""
- ";; Network configuration for one NIC, IPv4 + IPv6.\n"
- "(static-networking\n"
- " (addresses (list (network-address\n"
- " (device \"eno1\")\n"
- " (value \"10.0.2.15/24\"))\n"
- " (network-address\n"
- " (device \"eno1\")\n"
- " (value \"2001:123:4567:101::1/64\"))))\n"
- " (routes (list (network-route\n"
- " (destination \"default\")\n"
- " (gateway \"10.0.2.2\"))\n"
- " (network-route\n"
- " (destination \"default\")\n"
- " (gateway \"2020:321:4567:42::1\"))))\n"
- " (name-servers '(\"10.0.2.3\")))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17228
- msgid "If you are familiar with the @command{ip} command of the @uref{https://wiki.linuxfoundation.org/networking/iproute2, @code{iproute2} package} found on Linux-based systems, the declaration above is equivalent to typing:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:17234
- #, no-wrap
- msgid ""
- "ip address add 10.0.2.15/24 dev eno1\n"
- "ip address add 2001:123:4567:101::1/64 dev eno1\n"
- "ip route add default via inet 10.0.2.2\n"
- "ip route add default via inet6 2020:321:4567:42::1\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17239
- msgid "Run @command{man 8 ip} for more info. Venerable GNU/Linux users will certainly know how to do it with @command{ifconfig} and @command{route}, but we'll spare you that."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17241
- msgid "The available fields of this data type are as follows:"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:17243
- #, no-wrap
- msgid "addresses"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:17244
- #, no-wrap
- msgid "@code{links} (default: @code{'()})"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:17245
- #, no-wrap
- msgid "@code{routes} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17248
- msgid "The list of @code{network-address}, @code{network-link}, and @code{network-route} records for this network (see below)."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17249
- #, no-wrap
- msgid "@code{name-servers} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17252
- msgid "The list of IP addresses (strings) of domain name servers. These IP addresses go to @file{/etc/resolv.conf}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17253
- #, no-wrap
- msgid "@code{provision} (default: @code{'(networking)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17256
- msgid "If true, this should be a list of symbols for the Shepherd service corresponding to this network configuration."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17257
- #, no-wrap
- msgid "@code{requirement} (default @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17259
- msgid "The list of Shepherd services depended on."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17262
- #, no-wrap
- msgid "{Data Type} network-address"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17265
- msgid "This is the data type representing the IP address of a network interface."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17270
- msgid "The name of the network interface for this address---e.g., @code{\"eno1\"}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17271
- #, no-wrap
- msgid "value"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17275
- msgid "The actual IP address and network mask, in @uref{https://en.wikipedia.org/wiki/CIDR#CIDR_notation, @acronym{CIDR, Classless Inter-Domain Routing} notation}, as a string."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17279
- msgid "For example, @code{\"10.0.2.15/24\"} denotes IPv4 address 10.0.2.15 on a 24-bit sub-network---all 10.0.2.@var{x} addresses are on the same local network."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17280
- #, no-wrap
- msgid "ipv6?"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17283
- msgid "Whether @code{value} denotes an IPv6 address. By default this is automatically determined."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17286
- #, no-wrap
- msgid "{Data Type} network-route"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17288
- msgid "This is the data type representing a network route."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:17290
- #, no-wrap
- msgid "destination"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17293
- msgid "The route destination (a string), either an IP address or @code{\"default\"} to denote the default route."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17294
- #, no-wrap
- msgid "@code{source} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17296
- msgid "The route source."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17297 guix-git/doc/guix.texi:34761
- #, no-wrap
- msgid "@code{device} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17299
- msgid "The device used for this route---e.g., @code{\"eno2\"}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17300
- #, no-wrap
- msgid "@code{ipv6?} (default: auto)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17303
- msgid "Whether this is an IPv6 route. By default this is automatically determined based on @code{destination} or @code{gateway}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17304
- #, no-wrap
- msgid "@code{gateway} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17306
- msgid "IP address (a string) through which traffic is routed."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17309
- #, no-wrap
- msgid "{Data Type} network-link"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17312
- msgid "Data type for a network link (@pxref{Link,,, guile-netlink, Guile-Netlink Manual})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17316
- msgid "The name of the link---e.g., @code{\"v0p0\"}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17319
- msgid "A symbol denoting the type of the link---e.g., @code{'veth}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17320
- #, no-wrap
- msgid "arguments"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17322
- msgid "List of arguments for this type of link."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17325
- #, no-wrap
- msgid "loopback device"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17326
- #, no-wrap
- msgid "{Scheme Variable} %loopback-static-networking"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17330
- msgid "This is the @code{static-networking} record representing the ``loopback device'', @code{lo}, for IP addresses 127.0.0.1 and ::1, and providing the @code{loopback} Shepherd service."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17332
- #, no-wrap
- msgid "networking, with QEMU"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17333
- #, no-wrap
- msgid "QEMU, networking"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17334
- #, no-wrap
- msgid "{Scheme Variable} %qemu-static-networking"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17338
- msgid "This is the @code{static-networking} record representing network setup when using QEMU's user-mode network stack on @code{eth0} (@pxref{Using the user mode network stack,,, QEMU, QEMU Documentation})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17340
- #, no-wrap
- msgid "DHCP, networking service"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17341
- #, no-wrap
- msgid "{Scheme Variable} dhcp-client-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17345
- msgid "This is the type of services that run @var{dhcp}, a Dynamic Host Configuration Protocol (DHCP) client, on all the non-loopback network interfaces. Its value is the DHCP client package to use, @code{isc-dhcp} by default."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17347
- #, no-wrap
- msgid "NetworkManager"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17349
- #, no-wrap
- msgid "{Scheme Variable} network-manager-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17354
- msgid "This is the service type for the @uref{https://wiki.gnome.org/Projects/NetworkManager, NetworkManager} service. The value for this service type is a @code{network-manager-configuration} record."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17357 guix-git/doc/guix.texi:17509
- #: guix-git/doc/guix.texi:17538
- msgid "This service is part of @code{%desktop-services} (@pxref{Desktop Services})."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17359
- #, no-wrap
- msgid "{Data Type} network-manager-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17361
- msgid "Data type representing the configuration of NetworkManager."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17363
- #, no-wrap
- msgid "@code{network-manager} (default: @code{network-manager})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17365
- msgid "The NetworkManager package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17366
- #, no-wrap
- msgid "@code{dns} (default: @code{\"default\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17369
- msgid "Processing mode for DNS, which affects how NetworkManager uses the @code{resolv.conf} configuration file."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17374
- msgid "NetworkManager will update @code{resolv.conf} to reflect the nameservers provided by currently active connections."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17375
- #, no-wrap
- msgid "dnsmasq"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17379
- msgid "NetworkManager will run @code{dnsmasq} as a local caching nameserver, using a @dfn{conditional forwarding} configuration if you are connected to a VPN, and then update @code{resolv.conf} to point to the local nameserver."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17385
- msgid "With this setting, you can share your network connection. For example when you want to share your network connection to another laptop @i{via} an Ethernet cable, you can open @command{nm-connection-editor} and configure the Wired connection's method for IPv4 and IPv6 to be ``Shared to other computers'' and reestablish the connection (or reboot)."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17392
- msgid "You can also set up a @dfn{host-to-guest connection} to QEMU VMs (@pxref{Installing Guix in a VM}). With a host-to-guest connection, you can e.g.@: access a Web server running on the VM (@pxref{Web Services}) from a Web browser on your host system, or connect to the VM @i{via} SSH (@pxref{Networking Services, @code{openssh-service-type}}). To set up a host-to-guest connection, run this command once:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:17399
- #, no-wrap
- msgid ""
- "nmcli connection add type tun \\\n"
- " connection.interface-name tap0 \\\n"
- " tun.mode tap tun.owner $(id -u) \\\n"
- " ipv4.method shared \\\n"
- " ipv4.addresses 172.28.112.1/24\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17404
- msgid "Then each time you launch your QEMU VM (@pxref{Running Guix in a VM}), pass @option{-nic tap,ifname=tap0,script=no,downscript=no} to @command{qemu-system-...}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17407
- msgid "NetworkManager will not modify @code{resolv.conf}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17409
- #, no-wrap
- msgid "@code{vpn-plugins} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17413
- msgid "This is the list of available plugins for virtual private networks (VPNs). An example of this is the @code{network-manager-openvpn} package, which allows NetworkManager to manage VPNs @i{via} OpenVPN."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17417
- #, no-wrap
- msgid "Connman"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:17418
- #, no-wrap
- msgid "{Scheme Variable} connman-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:17421
- msgid "This is the service type to run @url{https://01.org/connman,Connman}, a network connection manager."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:17424
- msgid "Its value must be an @code{connman-configuration} record as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:17429
- #, no-wrap
- msgid ""
- "(service connman-service-type\n"
- " (connman-configuration\n"
- " (disable-vpn? #t)))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:17432
- msgid "See below for details about @code{connman-configuration}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17434
- #, no-wrap
- msgid "{Data Type} connman-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17436
- msgid "Data Type representing the configuration of connman."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17438
- #, no-wrap
- msgid "@code{connman} (default: @var{connman})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17440
- msgid "The connman package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17441
- #, no-wrap
- msgid "@code{disable-vpn?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17443
- msgid "When true, disable connman's vpn plugin."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17446
- #, no-wrap
- msgid "WPA Supplicant"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17447
- #, no-wrap
- msgid "{Scheme Variable} wpa-supplicant-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17451
- msgid "This is the service type to run @url{https://w1.fi/wpa_supplicant/,WPA supplicant}, an authentication daemon required to authenticate against encrypted WiFi or ethernet networks."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17453
- #, no-wrap
- msgid "{Data Type} wpa-supplicant-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17455
- msgid "Data type representing the configuration of WPA Supplicant."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17457 guix-git/doc/guix.texi:32945
- msgid "It takes the following parameters:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17459
- #, no-wrap
- msgid "@code{wpa-supplicant} (default: @code{wpa-supplicant})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17461
- msgid "The WPA Supplicant package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17462
- #, no-wrap
- msgid "@code{requirement} (default: @code{'(user-processes loopback syslogd)}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17464
- msgid "List of services that should be started before WPA Supplicant starts."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17465
- #, no-wrap
- msgid "@code{dbus?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17467
- msgid "Whether to listen for requests on D-Bus."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17468
- #, no-wrap
- msgid "@code{pid-file} (default: @code{\"/var/run/wpa_supplicant.pid\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17470
- msgid "Where to store the PID file."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17471 guix-git/doc/guix.texi:31246
- #: guix-git/doc/guix.texi:31388
- #, no-wrap
- msgid "@code{interface} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17474
- msgid "If this is set, it must specify the name of a network interface that WPA supplicant will control."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17475 guix-git/doc/guix.texi:17591
- #: guix-git/doc/guix.texi:22879
- #, no-wrap
- msgid "@code{config-file} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17477
- msgid "Optional configuration file to use."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17480
- msgid "List of additional command-line arguments to pass to the daemon."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17483
- #, no-wrap
- msgid "wicd"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17486
- #, no-wrap
- msgid "network management"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:17487
- #, no-wrap
- msgid "{Scheme Procedure} wicd-service [#:wicd @var{wicd}]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:17490
- msgid "Return a service that runs @url{https://launchpad.net/wicd,Wicd}, a network management daemon that aims to simplify wired and wireless networking."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:17495
- msgid "This service adds the @var{wicd} package to the global profile, providing several commands to interact with the daemon and configure networking: @command{wicd-client}, a graphical user interface, and the @command{wicd-cli} and @command{wicd-curses} user interfaces."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17497
- #, no-wrap
- msgid "ModemManager"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:17500
- msgid "Some networking devices such as modems require special care, and this is what the services below focus on."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17501
- #, no-wrap
- msgid "{Scheme Variable} modem-manager-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17506
- msgid "This is the service type for the @uref{https://wiki.gnome.org/Projects/ModemManager, ModemManager} service. The value for this service type is a @code{modem-manager-configuration} record."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17511
- #, no-wrap
- msgid "{Data Type} modem-manager-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17513
- msgid "Data type representing the configuration of ModemManager."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17515
- #, no-wrap
- msgid "@code{modem-manager} (default: @code{modem-manager})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17517
- msgid "The ModemManager package to use."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17521
- #, no-wrap
- msgid "USB_ModeSwitch"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17522
- #, no-wrap
- msgid "Modeswitching"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17524
- #, no-wrap
- msgid "{Scheme Variable} usb-modeswitch-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17529
- msgid "This is the service type for the @uref{https://www.draisberghof.de/usb_modeswitch/, USB_ModeSwitch} service. The value for this service type is a @code{usb-modeswitch-configuration} record."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17535
- msgid "When plugged in, some USB modems (and other USB devices) initially present themselves as a read-only storage medium and not as a modem. They need to be @dfn{modeswitched} before they are usable. The USB_ModeSwitch service type installs udev rules to automatically modeswitch these devices when they are plugged in."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17540
- #, no-wrap
- msgid "{Data Type} usb-modeswitch-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17542
- msgid "Data type representing the configuration of USB_ModeSwitch."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17544
- #, no-wrap
- msgid "@code{usb-modeswitch} (default: @code{usb-modeswitch})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17546
- msgid "The USB_ModeSwitch package providing the binaries for modeswitching."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17547
- #, no-wrap
- msgid "@code{usb-modeswitch-data} (default: @code{usb-modeswitch-data})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17550
- msgid "The package providing the device data and udev rules file used by USB_ModeSwitch."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17551
- #, no-wrap
- msgid "@code{config-file} (default: @code{#~(string-append #$usb-modeswitch:dispatcher \"/etc/usb_modeswitch.conf\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17556
- msgid "Which config file to use for the USB_ModeSwitch dispatcher. By default the config file shipped with USB_ModeSwitch is used which disables logging to @file{/var/log} among other default settings. If set to @code{#f}, no config file is used."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:17570
- msgid "The @code{(gnu services networking)} module discussed in the previous section provides services for more advanced setups: providing a DHCP service for others to use, filtering packets with iptables or nftables, running a WiFi access point with @command{hostapd}, running the @command{inetd} ``superdaemon'', and more. This section describes those."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:17571
- #, no-wrap
- msgid "{Scheme Procedure} dhcpd-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:17575
- msgid "This type defines a service that runs a DHCP daemon. To create a service of this type, you must supply a @code{<dhcpd-configuration>}. For example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:17581
- #, no-wrap
- msgid ""
- "(service dhcpd-service-type\n"
- " (dhcpd-configuration\n"
- " (config-file (local-file \"my-dhcpd.conf\"))\n"
- " (interfaces '(\"enp0s25\"))))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17584
- #, no-wrap
- msgid "{Data Type} dhcpd-configuration"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17586
- #, no-wrap
- msgid "@code{package} (default: @code{isc-dhcp})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17591
- msgid "The package that provides the DHCP daemon. This package is expected to provide the daemon at @file{sbin/dhcpd} relative to its output directory. The default package is the @uref{https://www.isc.org/products/DHCP, ISC's DHCP server}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17596
- msgid "The configuration file to use. This is required. It will be passed to @code{dhcpd} via its @code{-cf} option. This may be any ``file-like'' object (@pxref{G-Expressions, file-like objects}). See @code{man dhcpd.conf} for details on the configuration file syntax."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17596
- #, no-wrap
- msgid "@code{version} (default: @code{\"4\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17601
- msgid "The DHCP version to use. The ISC DHCP server supports the values ``4'', ``6'', and ``4o6''. These correspond to the @code{dhcpd} program options @code{-4}, @code{-6}, and @code{-4o6}. See @code{man dhcpd} for details."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17601
- #, no-wrap
- msgid "@code{run-directory} (default: @code{\"/run/dhcpd\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17604
- msgid "The run directory to use. At service activation time, this directory will be created if it does not exist."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17604
- #, no-wrap
- msgid "@code{pid-file} (default: @code{\"/run/dhcpd/dhcpd.pid\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17607
- msgid "The PID file to use. This corresponds to the @code{-pf} option of @code{dhcpd}. See @code{man dhcpd} for details."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17607
- #, no-wrap
- msgid "@code{interfaces} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17613
- msgid "The names of the network interfaces on which dhcpd should listen for broadcasts. If this list is not empty, then its elements (which must be strings) will be appended to the @code{dhcpd} invocation when starting the daemon. It may not be necessary to explicitly specify any interfaces here; see @code{man dhcpd} for details."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17616
- #, no-wrap
- msgid "hostapd service, for Wi-Fi access points"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17617
- #, no-wrap
- msgid "Wi-Fi access points, hostapd service"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17618
- #, no-wrap
- msgid "{Scheme Variable} hostapd-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17623
- msgid "This is the service type to run the @uref{https://w1.fi/hostapd/, hostapd} daemon to set up WiFi (IEEE 802.11) access points and authentication servers. Its associated value must be a @code{hostapd-configuration} as shown below:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:17631
- #, no-wrap
- msgid ""
- ";; Use wlan1 to run the access point for \"My Network\".\n"
- "(service hostapd-service-type\n"
- " (hostapd-configuration\n"
- " (interface \"wlan1\")\n"
- " (ssid \"My Network\")\n"
- " (channel 12)))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17634
- #, no-wrap
- msgid "{Data Type} hostapd-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17637
- msgid "This data type represents the configuration of the hostapd service, with the following fields:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17639
- #, no-wrap
- msgid "@code{package} (default: @code{hostapd})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17641
- msgid "The hostapd package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17642
- #, no-wrap
- msgid "@code{interface} (default: @code{\"wlan0\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17644
- msgid "The network interface to run the WiFi access point."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:17645
- #, no-wrap
- msgid "ssid"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17648
- msgid "The SSID (@dfn{service set identifier}), a string that identifies this network."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17649
- #, no-wrap
- msgid "@code{broadcast-ssid?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17651
- msgid "Whether to broadcast this SSID."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17652
- #, no-wrap
- msgid "@code{channel} (default: @code{1})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17654
- msgid "The WiFi channel to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17655
- #, no-wrap
- msgid "@code{driver} (default: @code{\"nl80211\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17659
- msgid "The driver interface type. @code{\"nl80211\"} is used with all Linux mac80211 drivers. Use @code{\"none\"} if building hostapd as a standalone RADIUS server that does # not control any wireless/wired driver."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17660 guix-git/doc/guix.texi:23728
- #: guix-git/doc/guix.texi:26807
- #, no-wrap
- msgid "@code{extra-settings} (default: @code{\"\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17664
- msgid "Extra settings to append as-is to the hostapd configuration file. See @uref{https://w1.fi/cgit/hostap/plain/hostapd/hostapd.conf} for the configuration file reference."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17667
- #, no-wrap
- msgid "{Scheme Variable} simulated-wifi-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17674
- msgid "This is the type of a service to simulate WiFi networking, which can be useful in virtual machines for testing purposes. The service loads the Linux kernel @uref{https://www.kernel.org/doc/html/latest/networking/mac80211_hwsim/mac80211_hwsim.html, @code{mac80211_hwsim} module} and starts hostapd to create a pseudo WiFi network that can be seen on @code{wlan0}, by default."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17676
- msgid "The service's value is a @code{hostapd-configuration} record."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17679
- #, no-wrap
- msgid "iptables"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17680
- #, no-wrap
- msgid "{Scheme Variable} iptables-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17686
- msgid "This is the service type to set up an iptables configuration. iptables is a packet filtering framework supported by the Linux kernel. This service supports configuring iptables for both IPv4 and IPv6. A simple example configuration rejecting all incoming connections except those to the ssh port 22 is shown below."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:17708
- #, no-wrap
- msgid ""
- "(service iptables-service-type\n"
- " (iptables-configuration\n"
- " (ipv4-rules (plain-file \"iptables.rules\" \"*filter\n"
- ":INPUT ACCEPT\n"
- ":FORWARD ACCEPT\n"
- ":OUTPUT ACCEPT\n"
- "-A INPUT -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT\n"
- "-A INPUT -p tcp --dport 22 -j ACCEPT\n"
- "-A INPUT -j REJECT --reject-with icmp-port-unreachable\n"
- "COMMIT\n"
- "\"))\n"
- " (ipv6-rules (plain-file \"ip6tables.rules\" \"*filter\n"
- ":INPUT ACCEPT\n"
- ":FORWARD ACCEPT\n"
- ":OUTPUT ACCEPT\n"
- "-A INPUT -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT\n"
- "-A INPUT -p tcp --dport 22 -j ACCEPT\n"
- "-A INPUT -j REJECT --reject-with icmp6-port-unreachable\n"
- "COMMIT\n"
- "\"))))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17711
- #, no-wrap
- msgid "{Data Type} iptables-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17713
- msgid "The data type representing the configuration of iptables."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17715
- #, no-wrap
- msgid "@code{iptables} (default: @code{iptables})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17718
- msgid "The iptables package that provides @code{iptables-restore} and @code{ip6tables-restore}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17718
- #, no-wrap
- msgid "@code{ipv4-rules} (default: @code{%iptables-accept-all-rules})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17722
- msgid "The iptables rules to use. It will be passed to @code{iptables-restore}. This may be any ``file-like'' object (@pxref{G-Expressions, file-like objects})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17722
- #, no-wrap
- msgid "@code{ipv6-rules} (default: @code{%iptables-accept-all-rules})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17726
- msgid "The ip6tables rules to use. It will be passed to @code{ip6tables-restore}. This may be any ``file-like'' object (@pxref{G-Expressions, file-like objects})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17729
- #, no-wrap
- msgid "nftables"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17730
- #, no-wrap
- msgid "{Scheme Variable} nftables-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17738
- msgid "This is the service type to set up a nftables configuration. nftables is a netfilter project that aims to replace the existing iptables, ip6tables, arptables and ebtables framework. It provides a new packet filtering framework, a new user-space utility @command{nft}, and a compatibility layer for iptables. This service comes with a default ruleset @code{%default-nftables-ruleset} that rejecting all incoming connections except those to the ssh port 22. To use it, simply write:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:17741
- #, no-wrap
- msgid "(service nftables-service-type)\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17744
- #, no-wrap
- msgid "{Data Type} nftables-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17746
- msgid "The data type representing the configuration of nftables."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17748
- #, no-wrap
- msgid "@code{package} (default: @code{nftables})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17750
- msgid "The nftables package that provides @command{nft}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17750
- #, no-wrap
- msgid "@code{ruleset} (default: @code{%default-nftables-ruleset})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17753
- msgid "The nftables ruleset to use. This may be any ``file-like'' object (@pxref{G-Expressions, file-like objects})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17756
- #, no-wrap
- msgid "NTP (Network Time Protocol), service"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17757
- #, no-wrap
- msgid "ntpd, service for the Network Time Protocol daemon"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17758
- #, no-wrap
- msgid "real time clock"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17759
- #, no-wrap
- msgid "{Scheme Variable} ntp-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17763
- msgid "This is the type of the service running the @uref{https://www.ntp.org, Network Time Protocol (NTP)} daemon, @command{ntpd}. The daemon will keep the system clock synchronized with that of the specified NTP servers."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17766
- msgid "The value of this service is an @code{ntpd-configuration} object, as described below."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17768
- #, no-wrap
- msgid "{Data Type} ntp-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17770
- msgid "This is the data type for the NTP service configuration."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17772
- #, no-wrap
- msgid "@code{servers} (default: @code{%ntp-servers})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17776
- msgid "This is the list of servers (@code{<ntp-server>} records) with which @command{ntpd} will be synchronized. See the @code{ntp-server} data type definition below."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17777
- #, no-wrap
- msgid "@code{allow-large-adjustment?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17780
- msgid "This determines whether @command{ntpd} is allowed to make an initial adjustment of more than 1,000 seconds."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17781
- #, no-wrap
- msgid "@code{ntp} (default: @code{ntp})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17783
- msgid "The NTP package to use."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17786
- #, no-wrap
- msgid "{Scheme Variable} %ntp-servers"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17789
- msgid "List of host names used as the default NTP servers. These are servers of the @uref{https://www.ntppool.org/en/, NTP Pool Project}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17791
- #, no-wrap
- msgid "{Data Type} ntp-server"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17793
- msgid "The data type representing the configuration of a NTP server."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17795
- #, no-wrap
- msgid "@code{type} (default: @code{'server})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17798
- msgid "The type of the NTP server, given as a symbol. One of @code{'pool}, @code{'server}, @code{'peer}, @code{'broadcast} or @code{'manycastclient}."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:17799
- #, no-wrap
- msgid "address"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17801
- msgid "The address of the server, as a string."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:17802 guix-git/doc/guix.texi:33774
- #: guix-git/doc/guix.texi:33794
- #, no-wrap
- msgid "options"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17807
- msgid "NTPD options to use with that specific server, given as a list of option names and/or of option names and values tuples. The following example define a server to use with the options @option{iburst} and @option{prefer}, as well as @option{version} 3 and a @option{maxpoll} time of 16 seconds."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:17813
- #, no-wrap
- msgid ""
- "(ntp-server\n"
- " (type 'server)\n"
- " (address \"some.ntp.server.org\")\n"
- " (options `(iburst (version 3) (maxpoll 16) prefer))))\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17817
- #, no-wrap
- msgid "OpenNTPD"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:17818
- #, no-wrap
- msgid "{Scheme Procedure} openntpd-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:17822
- msgid "Run the @command{ntpd}, the Network Time Protocol (NTP) daemon, as implemented by @uref{http://www.openntpd.org, OpenNTPD}. The daemon will keep the system clock synchronized with that of the given servers."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:17831
- #, no-wrap
- msgid ""
- "(service\n"
- " openntpd-service-type\n"
- " (openntpd-configuration\n"
- " (listen-on '(\"127.0.0.1\" \"::1\"))\n"
- " (sensor '(\"udcf0 correction 70000\"))\n"
- " (constraint-from '(\"www.gnu.org\"))\n"
- " (constraints-from '(\"https://www.google.com/\"))))\n"
- "\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17835
- #, no-wrap
- msgid "{Scheme Variable} %openntpd-servers"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17838
- msgid "This variable is a list of the server addresses defined in @code{%ntp-servers}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17840
- #, no-wrap
- msgid "{Data Type} openntpd-configuration"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17842
- #, no-wrap
- msgid "@code{openntpd} (default: @code{(file-append openntpd \"/sbin/ntpd\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17844
- msgid "The openntpd executable to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17844
- #, no-wrap
- msgid "@code{listen-on} (default: @code{'(\"127.0.0.1\" \"::1\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17846
- msgid "A list of local IP addresses or hostnames the ntpd daemon should listen on."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17846
- #, no-wrap
- msgid "@code{query-from} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17848
- msgid "A list of local IP address the ntpd daemon should use for outgoing queries."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17848
- #, no-wrap
- msgid "@code{sensor} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17853
- msgid "Specify a list of timedelta sensor devices ntpd should use. @code{ntpd} will listen to each sensor that actually exists and ignore non-existent ones. See @uref{https://man.openbsd.org/ntpd.conf, upstream documentation} for more information."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17853
- #, no-wrap
- msgid "@code{server} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17855
- msgid "Specify a list of IP addresses or hostnames of NTP servers to synchronize to."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17855
- #, no-wrap
- msgid "@code{servers} (default: @code{%openntp-servers})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17857
- msgid "Specify a list of IP addresses or hostnames of NTP pools to synchronize to."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17857
- #, no-wrap
- msgid "@code{constraint-from} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17864
- msgid "@code{ntpd} can be configured to query the ‘Date’ from trusted HTTPS servers via TLS. This time information is not used for precision but acts as an authenticated constraint, thereby reducing the impact of unauthenticated NTP man-in-the-middle attacks. Specify a list of URLs, IP addresses or hostnames of HTTPS servers to provide a constraint."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17864
- #, no-wrap
- msgid "@code{constraints-from} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17868
- msgid "As with constraint from, specify a list of URLs, IP addresses or hostnames of HTTPS servers to provide a constraint. Should the hostname resolve to multiple IP addresses, @code{ntpd} will calculate a median constraint from all of them."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17871
- #, no-wrap
- msgid "inetd"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:17872
- #, no-wrap
- msgid "{Scheme variable} inetd-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:17877
- msgid "This service runs the @command{inetd} (@pxref{inetd invocation,,, inetutils, GNU Inetutils}) daemon. @command{inetd} listens for connections on internet sockets, and lazily starts the specified server program when a connection is made on one of these sockets."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:17883
- msgid "The value of this service is an @code{inetd-configuration} object. The following example configures the @command{inetd} daemon to provide the built-in @command{echo} service, as well as an smtp service which forwards smtp traffic over ssh to a server @code{smtp-server} behind a gateway @code{hostname}:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:17906
- #, no-wrap
- msgid ""
- "(service\n"
- " inetd-service-type\n"
- " (inetd-configuration\n"
- " (entries (list\n"
- " (inetd-entry\n"
- " (name \"echo\")\n"
- " (socket-type 'stream)\n"
- " (protocol \"tcp\")\n"
- " (wait? #f)\n"
- " (user \"root\"))\n"
- " (inetd-entry\n"
- " (node \"127.0.0.1\")\n"
- " (name \"smtp\")\n"
- " (socket-type 'stream)\n"
- " (protocol \"tcp\")\n"
- " (wait? #f)\n"
- " (user \"root\")\n"
- " (program (file-append openssh \"/bin/ssh\"))\n"
- " (arguments\n"
- " '(\"ssh\" \"-qT\" \"-i\" \"/path/to/ssh_key\"\n"
- " \"-W\" \"smtp-server:25\" \"user@@hostname\")))))))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:17909
- msgid "See below for more details about @code{inetd-configuration}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17911
- #, no-wrap
- msgid "{Data Type} inetd-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17913
- msgid "Data type representing the configuration of @command{inetd}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17915
- #, no-wrap
- msgid "@code{program} (default: @code{(file-append inetutils \"/libexec/inetd\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17917
- msgid "The @command{inetd} executable to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17918 guix-git/doc/guix.texi:27655
- #, no-wrap
- msgid "@code{entries} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17921
- msgid "A list of @command{inetd} service entries. Each entry should be created by the @code{inetd-entry} constructor."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17924
- #, no-wrap
- msgid "{Data Type} inetd-entry"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17928
- msgid "Data type representing an entry in the @command{inetd} configuration. Each entry corresponds to a socket where @command{inetd} will listen for requests."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17930
- #, no-wrap
- msgid "@code{node} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17935
- msgid "Optional string, a comma-separated list of local addresses @command{inetd} should use when listening for this service. @xref{Configuration file,,, inetutils, GNU Inetutils} for a complete description of all options."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17937
- msgid "A string, the name must correspond to an entry in @code{/etc/services}."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:17937
- #, no-wrap
- msgid "socket-type"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17940
- msgid "One of @code{'stream}, @code{'dgram}, @code{'raw}, @code{'rdm} or @code{'seqpacket}."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:17940
- #, no-wrap
- msgid "protocol"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17942
- msgid "A string, must correspond to an entry in @code{/etc/protocols}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17942
- #, no-wrap
- msgid "@code{wait?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17945
- msgid "Whether @command{inetd} should wait for the server to exit before listening to new service requests."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17950
- msgid "A string containing the user (and, optionally, group) name of the user as whom the server should run. The group name can be specified in a suffix, separated by a colon or period, i.e.@: @code{\"user\"}, @code{\"user:group\"} or @code{\"user.group\"}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:17950
- #, no-wrap
- msgid "@code{program} (default: @code{\"internal\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17953
- msgid "The server program which will serve the requests, or @code{\"internal\"} if @command{inetd} should use a built-in service."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:17958
- msgid "A list strings or file-like objects, which are the server program's arguments, starting with the zeroth argument, i.e.@: the name of the program itself. For @command{inetd}'s internal services, this entry must be @code{'()} or @code{'(\"internal\")}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17962
- msgid "@xref{Configuration file,,, inetutils, GNU Inetutils} for a more detailed discussion of each configuration field."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17964
- #, no-wrap
- msgid "opendht, distributed hash table network service"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:17965
- #, no-wrap
- msgid "dhtproxy, for use with jami"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17966
- #, no-wrap
- msgid "{Scheme Variable} opendht-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17971
- msgid "This is the type of the service running a @uref{https://opendht.net, OpenDHT} node, @command{dhtnode}. The daemon can be used to host your own proxy service to the distributed hash table (DHT), for example to connect to with Jami, among other applications."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:17981
- msgid "When using the OpenDHT proxy server, the IP addresses it ``sees'' from the clients should be addresses reachable from other peers. In practice this means that a publicly reachable address is best suited for a proxy server, outside of your private network. For example, hosting the proxy server on a IPv4 private local network and exposing it via port forwarding could work for external peers, but peers local to the proxy would have their private addresses shared with the external peers, leading to connectivity problems."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:17985
- msgid "The value of this service is a @code{opendht-configuration} object, as described below."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17987
- #, no-wrap
- msgid "{Data Type} opendht-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17989
- msgid "This is the data type for the OpenDHT service configuration."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:17994
- msgid "Available @code{opendht-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:17995
- #, no-wrap
- msgid "{@code{opendht-configuration} parameter} package opendht"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:17997
- msgid "The @code{opendht} package to use."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:18000
- #, no-wrap
- msgid "{@code{opendht-configuration} parameter} boolean peer-discovery?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:18002
- msgid "Whether to enable the multicast local peer discovery mechanism."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:18004 guix-git/doc/guix.texi:18012
- #: guix-git/doc/guix.texi:18020 guix-git/doc/guix.texi:19712
- #: guix-git/doc/guix.texi:19788 guix-git/doc/guix.texi:19830
- #: guix-git/doc/guix.texi:19850 guix-git/doc/guix.texi:19856
- #: guix-git/doc/guix.texi:19872 guix-git/doc/guix.texi:19960
- #: guix-git/doc/guix.texi:20048 guix-git/doc/guix.texi:20361
- #: guix-git/doc/guix.texi:20374 guix-git/doc/guix.texi:21492
- #: guix-git/doc/guix.texi:22970 guix-git/doc/guix.texi:23076
- #: guix-git/doc/guix.texi:23141 guix-git/doc/guix.texi:23150
- #: guix-git/doc/guix.texi:24383 guix-git/doc/guix.texi:24427
- #: guix-git/doc/guix.texi:24444 guix-git/doc/guix.texi:24452
- #: guix-git/doc/guix.texi:24467 guix-git/doc/guix.texi:24485
- #: guix-git/doc/guix.texi:24509 guix-git/doc/guix.texi:24562
- #: guix-git/doc/guix.texi:24695 guix-git/doc/guix.texi:24729
- #: guix-git/doc/guix.texi:24765 guix-git/doc/guix.texi:24781
- #: guix-git/doc/guix.texi:24809 guix-git/doc/guix.texi:24870
- #: guix-git/doc/guix.texi:24953 guix-git/doc/guix.texi:28367
- #: guix-git/doc/guix.texi:28381 guix-git/doc/guix.texi:28403
- #: guix-git/doc/guix.texi:28522 guix-git/doc/guix.texi:28536
- #: guix-git/doc/guix.texi:28557 guix-git/doc/guix.texi:28578
- #: guix-git/doc/guix.texi:28585 guix-git/doc/guix.texi:28630
- #: guix-git/doc/guix.texi:28637 guix-git/doc/guix.texi:29426
- #: guix-git/doc/guix.texi:29440 guix-git/doc/guix.texi:29612
- #: guix-git/doc/guix.texi:29657 guix-git/doc/guix.texi:29744
- #: guix-git/doc/guix.texi:29946 guix-git/doc/guix.texi:29979
- #: guix-git/doc/guix.texi:30119 guix-git/doc/guix.texi:30130
- #: guix-git/doc/guix.texi:30381 guix-git/doc/guix.texi:31900
- #: guix-git/doc/guix.texi:31909 guix-git/doc/guix.texi:31917
- #: guix-git/doc/guix.texi:31925 guix-git/doc/guix.texi:31941
- #: guix-git/doc/guix.texi:31957 guix-git/doc/guix.texi:31965
- #: guix-git/doc/guix.texi:31973 guix-git/doc/guix.texi:31982
- #: guix-git/doc/guix.texi:31991 guix-git/doc/guix.texi:32007
- #: guix-git/doc/guix.texi:32071 guix-git/doc/guix.texi:32177
- #: guix-git/doc/guix.texi:32185 guix-git/doc/guix.texi:32193
- #: guix-git/doc/guix.texi:32218 guix-git/doc/guix.texi:32272
- #: guix-git/doc/guix.texi:32320 guix-git/doc/guix.texi:32521
- #: guix-git/doc/guix.texi:32528
- msgid "Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:18007
- #, no-wrap
- msgid "{@code{opendht-configuration} parameter} boolean enable-logging?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:18010
- msgid "Whether to enable logging messages to syslog. It is disabled by default as it is rather verbose."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:18015
- #, no-wrap
- msgid "{@code{opendht-configuration} parameter} boolean debug?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:18018
- msgid "Whether to enable debug-level logging messages. This has no effect if logging is disabled."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:18023
- #, no-wrap
- msgid "{@code{opendht-configuration} parameter} maybe-string bootstrap-host"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:18029
- msgid "The node host name that is used to make the first connection to the network. A specific port value can be provided by appending the @code{:PORT} suffix. By default, it uses the Jami bootstrap nodes, but any host can be specified here. It's also possible to disable bootsrapping by setting this to the @code{'disabled} symbol."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:18031
- msgid "Defaults to @samp{\"bootstrap.jami.net:4222\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:18034
- #, no-wrap
- msgid "{@code{opendht-configuration} parameter} maybe-number port"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:18037
- msgid "The UDP port to bind to. When set to @code{'disabled}, an available port is automatically selected."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:18039
- msgid "Defaults to @samp{4222}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:18042
- #, no-wrap
- msgid "{@code{opendht-configuration} parameter} maybe-number proxy-server-port"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:18044
- msgid "Spawn a proxy server listening on the specified port."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:18046 guix-git/doc/guix.texi:18053
- #: guix-git/doc/guix.texi:24391 guix-git/doc/guix.texi:24435
- #: guix-git/doc/guix.texi:24648 guix-git/doc/guix.texi:24704
- #: guix-git/doc/guix.texi:24878 guix-git/doc/guix.texi:24889
- #: guix-git/doc/guix.texi:24962 guix-git/doc/guix.texi:25687
- #: guix-git/doc/guix.texi:25730 guix-git/doc/guix.texi:25738
- #: guix-git/doc/guix.texi:25746 guix-git/doc/guix.texi:25754
- #: guix-git/doc/guix.texi:25763 guix-git/doc/guix.texi:25771
- #: guix-git/doc/guix.texi:25778 guix-git/doc/guix.texi:25786
- #: guix-git/doc/guix.texi:25794 guix-git/doc/guix.texi:25804
- #: guix-git/doc/guix.texi:25811 guix-git/doc/guix.texi:25835
- #: guix-git/doc/guix.texi:25843 guix-git/doc/guix.texi:25869
- #: guix-git/doc/guix.texi:25878 guix-git/doc/guix.texi:25887
- #: guix-git/doc/guix.texi:25896 guix-git/doc/guix.texi:25905
- #: guix-git/doc/guix.texi:25914 guix-git/doc/guix.texi:25922
- #: guix-git/doc/guix.texi:25930 guix-git/doc/guix.texi:25937
- #: guix-git/doc/guix.texi:25945 guix-git/doc/guix.texi:25952
- #: guix-git/doc/guix.texi:25960 guix-git/doc/guix.texi:25968
- #: guix-git/doc/guix.texi:25977 guix-git/doc/guix.texi:25986
- #: guix-git/doc/guix.texi:25994 guix-git/doc/guix.texi:26002
- #: guix-git/doc/guix.texi:26010 guix-git/doc/guix.texi:26021
- #: guix-git/doc/guix.texi:26031 guix-git/doc/guix.texi:26042
- #: guix-git/doc/guix.texi:26051 guix-git/doc/guix.texi:26061
- #: guix-git/doc/guix.texi:26069 guix-git/doc/guix.texi:26080
- #: guix-git/doc/guix.texi:26089 guix-git/doc/guix.texi:26099
- #: guix-git/doc/guix.texi:29339 guix-git/doc/guix.texi:29346
- #: guix-git/doc/guix.texi:29353 guix-git/doc/guix.texi:29360
- #: guix-git/doc/guix.texi:29367 guix-git/doc/guix.texi:29374
- #: guix-git/doc/guix.texi:29382 guix-git/doc/guix.texi:29390
- #: guix-git/doc/guix.texi:29397 guix-git/doc/guix.texi:29404
- #: guix-git/doc/guix.texi:29411 guix-git/doc/guix.texi:29418
- #: guix-git/doc/guix.texi:29448 guix-git/doc/guix.texi:29486
- #: guix-git/doc/guix.texi:29493 guix-git/doc/guix.texi:29502
- #: guix-git/doc/guix.texi:29524 guix-git/doc/guix.texi:29532
- #: guix-git/doc/guix.texi:29539 guix-git/doc/guix.texi:29694
- #: guix-git/doc/guix.texi:29714 guix-git/doc/guix.texi:29729
- #: guix-git/doc/guix.texi:29736 guix-git/doc/guix.texi:32473
- #: guix-git/doc/guix.texi:32481 guix-git/doc/guix.texi:32489
- #: guix-git/doc/guix.texi:32497 guix-git/doc/guix.texi:32505
- #: guix-git/doc/guix.texi:32513
- msgid "Defaults to @samp{disabled}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:18049
- #, no-wrap
- msgid "{@code{opendht-configuration} parameter} maybe-number proxy-server-port-tls"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:18051
- msgid "Spawn a proxy server listening to TLS connections on the specified port."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:18057
- #, no-wrap
- msgid "Tor"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:18058
- #, no-wrap
- msgid "{Scheme Variable} tor-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:18063
- msgid "This is the type for a service that runs the @uref{https://torproject.org, Tor} anonymous networking daemon. The service is configured using a @code{<tor-configuration>} record. By default, the Tor daemon runs as the @code{tor} unprivileged user, which is a member of the @code{tor} group."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:18066
- #, no-wrap
- msgid "{Data Type} tor-configuration"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18068
- #, no-wrap
- msgid "@code{tor} (default: @code{tor})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18073
- msgid "The package that provides the Tor daemon. This package is expected to provide the daemon at @file{bin/tor} relative to its output directory. The default package is the @uref{https://www.torproject.org, Tor Project's} implementation."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18074
- #, no-wrap
- msgid "@code{config-file} (default: @code{(plain-file \"empty\" \"\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18080
- msgid "The configuration file to use. It will be appended to a default configuration file, and the final configuration file will be passed to @code{tor} via its @code{-f} option. This may be any ``file-like'' object (@pxref{G-Expressions, file-like objects}). See @code{man tor} for details on the configuration file syntax."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18081
- #, no-wrap
- msgid "@code{hidden-services} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18087
- msgid "The list of @code{<hidden-service>} records to use. For any hidden service you include in this list, appropriate configuration to enable the hidden service will be automatically added to the default configuration file. You may conveniently create @code{<hidden-service>} records using the @code{tor-hidden-service} procedure described below."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18088
- #, no-wrap
- msgid "@code{socks-socket-type} (default: @code{'tcp})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18095
- msgid "The default socket type that Tor should use for its SOCKS socket. This must be either @code{'tcp} or @code{'unix}. If it is @code{'tcp}, then by default Tor will listen on TCP port 9050 on the loopback interface (i.e., localhost). If it is @code{'unix}, then Tor will listen on the UNIX domain socket @file{/var/run/tor/socks-sock}, which will be made writable by members of the @code{tor} group."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18100
- msgid "If you want to customize the SOCKS socket in more detail, leave @code{socks-socket-type} at its default value of @code{'tcp} and use @code{config-file} to override the default by providing your own @code{SocksPort} option."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18101
- #, no-wrap
- msgid "@code{control-socket?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18107
- msgid "Whether or not to provide a ``control socket'' by which Tor can be controlled to, for instance, dynamically instantiate tor onion services. If @code{#t}, Tor will listen for control commands on the UNIX domain socket @file{/var/run/tor/control-sock}, which will be made writable by members of the @code{tor} group."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:18111
- #, no-wrap
- msgid "hidden service"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18112
- #, no-wrap
- msgid "{Scheme Procedure} tor-hidden-service @var{name} @var{mapping}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18115
- msgid "Define a new Tor @dfn{hidden service} called @var{name} and implementing @var{mapping}. @var{mapping} is a list of port/host tuples, such as:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:18119
- #, no-wrap
- msgid ""
- " '((22 \"127.0.0.1:22\")\n"
- " (80 \"127.0.0.1:8080\"))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18123
- msgid "In this example, port 22 of the hidden service is mapped to local port 22, and port 80 is mapped to local port 8080."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18127
- msgid "This creates a @file{/var/lib/tor/hidden-services/@var{name}} directory, where the @file{hostname} file contains the @code{.onion} host name for the hidden service."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18130
- msgid "See @uref{https://www.torproject.org/docs/tor-hidden-service.html.en, the Tor project's documentation} for more information."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:18133
- msgid "The @code{(gnu services rsync)} module provides the following services:"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:18137
- msgid "You might want an rsync daemon if you have files that you want available so anyone (or just yourself) can download existing files or upload new files."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18138
- #, no-wrap
- msgid "{Scheme Variable} rsync-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18142
- msgid "This is the service type for the @uref{https://rsync.samba.org, rsync} daemon, The value for this service type is a @command{rsync-configuration} record as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:18155
- #, no-wrap
- msgid ""
- ";; Export two directories over rsync. By default rsync listens on\n"
- ";; all the network interfaces.\n"
- "(service rsync-service-type\n"
- " (rsync-configuration\n"
- " (modules (list (rsync-module\n"
- " (name \"music\")\n"
- " (file-name \"/srv/zik\")\n"
- " (read-only? #f))\n"
- " (rsync-module\n"
- " (name \"movies\")\n"
- " (file-name \"/home/charlie/movies\"))))))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18158
- msgid "See below for details about @code{rsync-configuration}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:18160
- #, no-wrap
- msgid "{Data Type} rsync-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:18162
- msgid "Data type representing the configuration for @code{rsync-service}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18164
- #, no-wrap
- msgid "@code{package} (default: @var{rsync})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18166
- msgid "@code{rsync} package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18167 guix-git/doc/guix.texi:31480
- #, no-wrap
- msgid "@code{address} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18170
- msgid "IP address on which @command{rsync} listens for incoming connections. If unspecified, it defaults to listening on all available addresses."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18171
- #, no-wrap
- msgid "@code{port-number} (default: @code{873})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18175
- msgid "TCP port on which @command{rsync} listens for incoming connections. If port is less than @code{1024} @command{rsync} needs to be started as the @code{root} user and group."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18176
- #, no-wrap
- msgid "@code{pid-file} (default: @code{\"/var/run/rsyncd/rsyncd.pid\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18178
- msgid "Name of the file where @command{rsync} writes its PID."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18179
- #, no-wrap
- msgid "@code{lock-file} (default: @code{\"/var/run/rsyncd/rsyncd.lock\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18181
- msgid "Name of the file where @command{rsync} writes its lock file."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18182
- #, no-wrap
- msgid "@code{log-file} (default: @code{\"/var/log/rsyncd.log\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18184
- msgid "Name of the file where @command{rsync} writes its log file."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18185 guix-git/doc/guix.texi:35582
- #, no-wrap
- msgid "@code{user} (default: @code{\"root\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18187
- msgid "Owner of the @code{rsync} process."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18188
- #, no-wrap
- msgid "@code{group} (default: @code{\"root\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18190
- msgid "Group of the @code{rsync} process."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18191
- #, no-wrap
- msgid "@code{uid} (default: @code{\"rsyncd\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18194
- msgid "User name or user ID that file transfers to and from that module should take place as when the daemon was run as @code{root}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18195
- #, no-wrap
- msgid "@code{gid} (default: @code{\"rsyncd\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18197 guix-git/doc/guix.texi:18676
- msgid "Group name or group ID that will be used when accessing the module."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18198 guix-git/doc/guix.texi:36378
- #, no-wrap
- msgid "@code{modules} (default: @code{%default-modules})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18201
- msgid "List of ``modules''---i.e., directories exported over rsync. Each element must be a @code{rsync-module} record, as described below."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:18204
- #, no-wrap
- msgid "{Data Type} rsync-module"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:18207
- msgid "This is the data type for rsync ``modules''. A module is a directory exported over the rsync protocol. The available fields are as follows:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18213
- msgid "The module name. This is the name that shows up in URLs. For example, if the module is called @code{music}, the corresponding URL will be @code{rsync://host.example.org/music}."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:18214
- #, fuzzy, no-wrap
- msgid "file-name"
- msgstr "نام بسته"
- #. type: table
- #: guix-git/doc/guix.texi:18216
- msgid "Name of the directory being exported."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18220
- msgid "Comment associated with the module. Client user interfaces may display it when they obtain the list of available modules."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18221
- #, no-wrap
- msgid "@code{read-only?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18225
- msgid "Whether or not client will be able to upload files. If this is false, the uploads will be authorized if permissions on the daemon side permit it."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18226
- #, no-wrap
- msgid "@code{chroot?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18230
- msgid "When this is true, the rsync daemon changes root to the module's directory before starting file transfers with the client. This improves security, but requires rsync to run as root."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18231
- #, no-wrap
- msgid "@code{timeout} (default: @code{300})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18234
- msgid "Idle time in seconds after which the daemon closes a connection with the client."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:18238
- msgid "The @code{(gnu services syncthing)} module provides the following services:"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:18238
- #, no-wrap
- msgid "syncthing"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:18243
- msgid "You might want a syncthing daemon if you have files between two or more computers and want to sync them in real time, safely protected from prying eyes."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18244
- #, no-wrap
- msgid "{Scheme Variable} syncthing-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18248
- msgid "This is the service type for the @uref{https://syncthing.net/, syncthing} daemon, The value for this service type is a @command{syncthing-configuration} record as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:18252
- #, no-wrap
- msgid ""
- "(service syncthing-service-type\n"
- " (syncthing-configuration (user \"alice\")))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18255
- msgid "See below for details about @code{syncthing-configuration}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:18256
- #, no-wrap
- msgid "{Data Type} syncthing-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:18258
- msgid "Data type representing the configuration for @code{syncthing-service-type}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18260
- #, no-wrap
- msgid "@code{syncthing} (default: @var{syncthing})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18262
- msgid "@code{syncthing} package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18263
- #, no-wrap
- msgid "@code{arguments} (default: @var{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18265
- msgid "List of command-line arguments passing to @code{syncthing} binary."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18266
- #, no-wrap
- msgid "@code{logflags} (default: @var{0})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18269
- msgid "Sum of logging flags, see @uref{https://docs.syncthing.net/users/syncthing.html#cmdoption-logflags, Syncthing documentation logflags}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18270
- #, no-wrap
- msgid "@code{user} (default: @var{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18273
- msgid "The user as which the Syncthing service is to be run. This assumes that the specified user exists."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18274
- #, no-wrap
- msgid "@code{group} (default: @var{\"users\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18277
- msgid "The group as which the Syncthing service is to be run. This assumes that the specified group exists."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18278
- #, no-wrap
- msgid "@code{home} (default: @var{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18281
- msgid "Common configuration and data directory. The default configuration directory is @file{$HOME} of the specified Syncthing @code{user}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:18287
- msgid "Furthermore, @code{(gnu services ssh)} provides the following services."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:18287 guix-git/doc/guix.texi:18326
- #: guix-git/doc/guix.texi:35715
- #, no-wrap
- msgid "SSH"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:18288 guix-git/doc/guix.texi:18327
- #: guix-git/doc/guix.texi:35716
- #, no-wrap
- msgid "SSH server"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18290
- #, no-wrap
- msgid "{Scheme Procedure} lsh-service [#:host-key \"/etc/lsh/host-key\"] @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18299
- msgid "[#:daemonic? #t] [#:interfaces '()] [#:port-number 22] @ [#:allow-empty-passwords? #f] [#:root-login? #f] @ [#:syslog-output? #t] [#:x11-forwarding? #t] @ [#:tcp/ip-forwarding? #t] [#:password-authentication? #t] @ [#:public-key-authentication? #t] [#:initialize? #t] Run the @command{lshd} program from @var{lsh} to listen on port @var{port-number}. @var{host-key} must designate a file containing the host key, and readable only by root."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18305
- msgid "When @var{daemonic?} is true, @command{lshd} will detach from the controlling terminal and log its output to syslogd, unless one sets @var{syslog-output?} to false. Obviously, it also makes lsh-service depend on existence of syslogd service. When @var{pid-file?} is true, @command{lshd} writes its PID to the file called @var{pid-file}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18309
- msgid "When @var{initialize?} is true, automatically create the seed and host key upon service activation if they do not exist yet. This may take long and require interaction."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18314
- msgid "When @var{initialize?} is false, it is up to the user to initialize the randomness generator (@pxref{lsh-make-seed,,, lsh, LSH Manual}), and to create a key pair with the private key stored in file @var{host-key} (@pxref{lshd basics,,, lsh, LSH Manual})."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18318
- msgid "When @var{interfaces} is empty, lshd listens for connections on all the network interfaces; otherwise, @var{interfaces} must be a list of host names or addresses."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18322
- msgid "@var{allow-empty-passwords?} specifies whether to accept log-ins with empty passwords, and @var{root-login?} specifies whether to accept log-ins as root."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18324
- msgid "The other options should be self-descriptive."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18328
- #, no-wrap
- msgid "{Scheme Variable} openssh-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18332
- msgid "This is the type for the @uref{http://www.openssh.org, OpenSSH} secure shell daemon, @command{sshd}. Its value must be an @code{openssh-configuration} record as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:18341
- #, no-wrap
- msgid ""
- "(service openssh-service-type\n"
- " (openssh-configuration\n"
- " (x11-forwarding? #t)\n"
- " (permit-root-login 'prohibit-password)\n"
- " (authorized-keys\n"
- " `((\"alice\" ,(local-file \"alice.pub\"))\n"
- " (\"bob\" ,(local-file \"bob.pub\"))))))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18344
- msgid "See below for details about @code{openssh-configuration}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18347
- msgid "This service can be extended with extra authorized keys, as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:18352
- #, no-wrap
- msgid ""
- "(service-extension openssh-service-type\n"
- " (const `((\"charlie\"\n"
- " ,(local-file \"charlie.pub\")))))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:18355
- #, no-wrap
- msgid "{Data Type} openssh-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:18357
- msgid "This is the configuration record for OpenSSH's @command{sshd}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18359
- #, no-wrap
- msgid "@code{openssh} (default @var{openssh})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18361
- msgid "The Openssh package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18362
- #, no-wrap
- msgid "@code{pid-file} (default: @code{\"/var/run/sshd.pid\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18364
- msgid "Name of the file where @command{sshd} writes its PID."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18365
- #, no-wrap
- msgid "@code{port-number} (default: @code{22})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18367
- msgid "TCP port on which @command{sshd} listens for incoming connections."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18368
- #, no-wrap
- msgid "@code{permit-root-login} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18373
- msgid "This field determines whether and when to allow logins as root. If @code{#f}, root logins are disallowed; if @code{#t}, they are allowed. If it's the symbol @code{'prohibit-password}, then root logins are permitted but not with password-based authentication."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18374 guix-git/doc/guix.texi:18535
- #, no-wrap
- msgid "@code{allow-empty-passwords?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18377
- msgid "When true, users with empty passwords may log in. When false, they may not."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18378 guix-git/doc/guix.texi:18538
- #, no-wrap
- msgid "@code{password-authentication?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18381
- msgid "When true, users may log in with their password. When false, they have other authentication methods."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18382
- #, no-wrap
- msgid "@code{public-key-authentication?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18385
- msgid "When true, users may log in using public key authentication. When false, users have to use other authentication method."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18388
- msgid "Authorized public keys are stored in @file{~/.ssh/authorized_keys}. This is used only by protocol version 2."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18389
- #, no-wrap
- msgid "@code{x11-forwarding?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18393
- msgid "When true, forwarding of X11 graphical client connections is enabled---in other words, @command{ssh} options @option{-X} and @option{-Y} will work."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18394
- #, no-wrap
- msgid "@code{allow-agent-forwarding?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18396
- msgid "Whether to allow agent forwarding."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18397
- #, no-wrap
- msgid "@code{allow-tcp-forwarding?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18399
- msgid "Whether to allow TCP forwarding."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18400
- #, no-wrap
- msgid "@code{gateway-ports?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18402
- msgid "Whether to allow gateway ports."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18403
- #, no-wrap
- msgid "@code{challenge-response-authentication?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18406
- msgid "Specifies whether challenge response authentication is allowed (e.g.@: via PAM)."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18407
- #, no-wrap
- msgid "@code{use-pam?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18413
- msgid "Enables the Pluggable Authentication Module interface. If set to @code{#t}, this will enable PAM authentication using @code{challenge-response-authentication?} and @code{password-authentication?}, in addition to PAM account and session module processing for all authentication types."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18418
- msgid "Because PAM challenge response authentication usually serves an equivalent role to password authentication, you should disable either @code{challenge-response-authentication?} or @code{password-authentication?}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18419
- #, no-wrap
- msgid "@code{print-last-log?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18422
- msgid "Specifies whether @command{sshd} should print the date and time of the last user login when a user logs in interactively."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18423
- #, no-wrap
- msgid "@code{subsystems} (default: @code{'((\"sftp\" \"internal-sftp\"))})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18425
- msgid "Configures external subsystems (e.g.@: file transfer daemon)."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18429
- msgid "This is a list of two-element lists, each of which containing the subsystem name and a command (with optional arguments) to execute upon subsystem request."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18432
- msgid "The command @command{internal-sftp} implements an in-process SFTP server. Alternatively, one can specify the @command{sftp-server} command:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:18437
- #, no-wrap
- msgid ""
- "(service openssh-service-type\n"
- " (openssh-configuration\n"
- " (subsystems\n"
- " `((\"sftp\" ,(file-append openssh \"/libexec/sftp-server\"))))))\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18439
- #, no-wrap
- msgid "@code{accepted-environment} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18441
- msgid "List of strings describing which environment variables may be exported."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18444
- msgid "Each string gets on its own line. See the @code{AcceptEnv} option in @code{man sshd_config}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18449
- msgid "This example allows ssh-clients to export the @env{COLORTERM} variable. It is set by terminal emulators, which support colors. You can use it in your shell's resource file to enable colors for the prompt and commands if this variable is set."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:18454
- #, no-wrap
- msgid ""
- "(service openssh-service-type\n"
- " (openssh-configuration\n"
- " (accepted-environment '(\"COLORTERM\"))))\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18456
- #, no-wrap
- msgid "@code{authorized-keys} (default: @code{'()})"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:18457
- #, no-wrap
- msgid "authorized keys, SSH"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:18458
- #, no-wrap
- msgid "SSH authorized keys"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18462
- msgid "This is the list of authorized keys. Each element of the list is a user name followed by one or more file-like objects that represent SSH public keys. For example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:18469
- #, no-wrap
- msgid ""
- "(openssh-configuration\n"
- " (authorized-keys\n"
- " `((\"rekado\" ,(local-file \"rekado.pub\"))\n"
- " (\"chris\" ,(local-file \"chris.pub\"))\n"
- " (\"root\" ,(local-file \"rekado.pub\") ,(local-file \"chris.pub\")))))\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18474
- msgid "registers the specified public keys for user accounts @code{rekado}, @code{chris}, and @code{root}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18477
- msgid "Additional authorized keys can be specified @i{via} @code{service-extension}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18480
- msgid "Note that this does @emph{not} interfere with the use of @file{~/.ssh/authorized_keys}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18481 guix-git/doc/guix.texi:18912
- #, no-wrap
- msgid "@code{log-level} (default: @code{'info})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18485
- msgid "This is a symbol specifying the logging level: @code{quiet}, @code{fatal}, @code{error}, @code{info}, @code{verbose}, @code{debug}, etc. See the man page for @file{sshd_config} for the full list of level names."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18486 guix-git/doc/guix.texi:21328
- #: guix-git/doc/guix.texi:26469
- #, no-wrap
- msgid "@code{extra-content} (default: @code{\"\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18491
- msgid "This field can be used to append arbitrary text to the configuration file. It is especially useful for elaborate configurations that cannot be expressed otherwise. This configuration, for example, would generally disable root logins, but permit them from one specific IP address:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:18497
- #, no-wrap
- msgid ""
- "(openssh-configuration\n"
- " (extra-content \"\\\n"
- "Match Address 192.168.0.1\n"
- " PermitRootLogin yes\"))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18502
- #, no-wrap
- msgid "{Scheme Procedure} dropbear-service [@var{config}]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18506
- msgid "Run the @uref{https://matt.ucc.asn.au/dropbear/dropbear.html,Dropbear SSH daemon} with the given @var{config}, a @code{<dropbear-configuration>} object."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18509
- msgid "For example, to specify a Dropbear service listening on port 1234, add this call to the operating system's @code{services} field:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:18513
- #, no-wrap
- msgid ""
- "(dropbear-service (dropbear-configuration\n"
- " (port-number 1234)))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:18516
- #, no-wrap
- msgid "{Data Type} dropbear-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:18518
- msgid "This data type represents the configuration of a Dropbear SSH daemon."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18520
- #, no-wrap
- msgid "@code{dropbear} (default: @var{dropbear})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18522
- msgid "The Dropbear package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18523
- #, no-wrap
- msgid "@code{port-number} (default: 22)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18525
- msgid "The TCP port where the daemon waits for incoming connections."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18526
- #, no-wrap
- msgid "@code{syslog-output?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18528
- msgid "Whether to enable syslog output."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18529
- #, no-wrap
- msgid "@code{pid-file} (default: @code{\"/var/run/dropbear.pid\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18531
- msgid "File name of the daemon's PID file."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18532
- #, no-wrap
- msgid "@code{root-login?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18534
- msgid "Whether to allow @code{root} logins."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18537
- msgid "Whether to allow empty passwords."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18540
- msgid "Whether to enable password-based authentication."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:18543
- #, no-wrap
- msgid "AutoSSH"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18544
- #, no-wrap
- msgid "{Scheme Variable} autossh-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18552
- msgid "This is the type for the @uref{https://www.harding.motd.ca/autossh, AutoSSH} program that runs a copy of @command{ssh} and monitors it, restarting it as necessary should it die or stop passing traffic. AutoSSH can be run manually from the command-line by passing arguments to the binary @command{autossh} from the package @code{autossh}, but it can also be run as a Guix service. This latter use case is documented here."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18556
- msgid "AutoSSH can be used to forward local traffic to a remote machine using an SSH tunnel, and it respects the @file{~/.ssh/config} of the user it is run as."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18561
- msgid "For example, to specify a service running autossh as the user @code{pino} and forwarding all local connections to port @code{8081} to @code{remote:8081} using an SSH tunnel, add this call to the operating system's @code{services} field:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:18567
- #, no-wrap
- msgid ""
- "(service autossh-service-type\n"
- " (autossh-configuration\n"
- " (user \"pino\")\n"
- " (ssh-options (list \"-T\" \"-N\" \"-L\" \"8081:localhost:8081\" \"remote.net\"))))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:18570
- #, no-wrap
- msgid "{Data Type} autossh-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:18572
- msgid "This data type represents the configuration of an AutoSSH service."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18575
- #, no-wrap
- msgid "@code{user} (default @code{\"autossh\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18578
- msgid "The user as which the AutoSSH service is to be run. This assumes that the specified user exists."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18579
- #, no-wrap
- msgid "@code{poll} (default @code{600})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18581
- msgid "Specifies the connection poll time in seconds."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18582
- #, no-wrap
- msgid "@code{first-poll} (default @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18588
- msgid "Specifies how many seconds AutoSSH waits before the first connection test. After this first test, polling is resumed at the pace defined in @code{poll}. When set to @code{#f}, the first poll is not treated specially and will also use the connection poll specified in @code{poll}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18589
- #, no-wrap
- msgid "@code{gate-time} (default @code{30})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18592
- msgid "Specifies how many seconds an SSH connection must be active before it is considered successful."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18593
- #, no-wrap
- msgid "@code{log-level} (default @code{1})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18596
- msgid "The log level, corresponding to the levels used by syslog---so @code{0} is the most silent while @code{7} is the chattiest."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18597
- #, no-wrap
- msgid "@code{max-start} (default @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18600
- msgid "The maximum number of times SSH may be (re)started before AutoSSH exits. When set to @code{#f}, no maximum is configured and AutoSSH may restart indefinitely."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18601
- #, no-wrap
- msgid "@code{message} (default @code{\"\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18603
- msgid "The message to append to the echo message sent when testing connections."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18604
- #, no-wrap
- msgid "@code{port} (default @code{\"0\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18614
- msgid "The ports used for monitoring the connection. When set to @code{\"0\"}, monitoring is disabled. When set to @code{\"@var{n}\"} where @var{n} is a positive integer, ports @var{n} and @var{n}+1 are used for monitoring the connection, such that port @var{n} is the base monitoring port and @code{n+1} is the echo port. When set to @code{\"@var{n}:@var{m}\"} where @var{n} and @var{m} are positive integers, the ports @var{n} and @var{m} are used for monitoring the connection, such that port @var{n} is the base monitoring port and @var{m} is the echo port."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18615
- #, no-wrap
- msgid "@code{ssh-options} (default @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18619
- msgid "The list of command-line arguments to pass to @command{ssh} when it is run. Options @option{-f} and @option{-M} are reserved for AutoSSH and may cause undefined behaviour."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:18623
- #, no-wrap
- msgid "WebSSH"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18624
- #, no-wrap
- msgid "{Scheme Variable} webssh-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18630
- msgid "This is the type for the @uref{https://webssh.huashengdun.org/, WebSSH} program that runs a web SSH client. WebSSH can be run manually from the command-line by passing arguments to the binary @command{wssh} from the package @code{webssh}, but it can also be run as a Guix service. This latter use case is documented here."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18636
- msgid "For example, to specify a service running WebSSH on loopback interface on port @code{8888} with reject policy with a list of allowed to connection hosts, and NGINX as a reverse-proxy to this service listening for HTTPS connection, add this call to the operating system's @code{services} field:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:18644
- #, no-wrap
- msgid ""
- "(service webssh-service-type\n"
- " (webssh-configuration (address \"127.0.0.1\")\n"
- " (port 8888)\n"
- " (policy 'reject)\n"
- " (known-hosts '(\"localhost ecdsa-sha2-nistp256 AAAA…\"\n"
- " \"127.0.0.1 ecdsa-sha2-nistp256 AAAA…\"))))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:18660
- #, no-wrap
- msgid ""
- "(service nginx-service-type\n"
- " (nginx-configuration\n"
- " (server-blocks\n"
- " (list\n"
- " (nginx-server-configuration\n"
- " (inherit %webssh-configuration-nginx)\n"
- " (server-name '(\"webssh.example.com\"))\n"
- " (listen '(\"443 ssl\"))\n"
- " (ssl-certificate (letsencrypt-certificate \"webssh.example.com\"))\n"
- " (ssl-certificate-key (letsencrypt-key \"webssh.example.com\"))\n"
- " (locations\n"
- " (cons (nginx-location-configuration\n"
- " (uri \"/.well-known\")\n"
- " (body '(\"root /var/www;\")))\n"
- " (nginx-server-configuration-locations %webssh-configuration-nginx))))))))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:18663
- #, no-wrap
- msgid "{Data Type} webssh-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:18665
- msgid "Data type representing the configuration for @code{webssh-service}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18667
- #, no-wrap
- msgid "@code{package} (default: @var{webssh})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18669
- msgid "@code{webssh} package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18670
- #, no-wrap
- msgid "@code{user-name} (default: @var{\"webssh\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18673
- msgid "User name or user ID that file transfers to and from that module should take place."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18674
- #, no-wrap
- msgid "@code{group-name} (default: @var{\"webssh\"})"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18677
- #, no-wrap
- msgid "@code{address} (default: @var{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18679
- msgid "IP address on which @command{webssh} listens for incoming connections."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18680
- #, no-wrap
- msgid "@code{port} (default: @var{8888})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18682
- msgid "TCP port on which @command{webssh} listens for incoming connections."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18683
- #, no-wrap
- msgid "@code{policy} (default: @var{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18685
- msgid "Connection policy. @var{reject} policy requires to specify @var{known-hosts}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18686
- #, no-wrap
- msgid "@code{known-hosts} (default: @var{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18688
- msgid "List of hosts which allowed for SSH connection from @command{webssh}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18689
- #, no-wrap
- msgid "@code{log-file} (default: @file{\"/var/log/webssh.log\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18691
- msgid "Name of the file where @command{webssh} writes its log file."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18692
- #, no-wrap
- msgid "@code{log-level} (default: @var{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18694
- msgid "Logging level."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:18698
- #, no-wrap
- msgid "{Scheme Variable} %facebook-host-aliases"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:18704
- msgid "This variable contains a string for use in @file{/etc/hosts} (@pxref{Host Names,,, libc, The GNU C Library Reference Manual}). Each line contains a entry that maps a known server name of the Facebook on-line service---e.g., @code{www.facebook.com}---to the local host---@code{127.0.0.1} or its IPv6 equivalent, @code{::1}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:18708
- msgid "This variable is typically used in the @code{hosts-file} field of an @code{operating-system} declaration (@pxref{operating-system Reference, @file{/etc/hosts}}):"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:18721
- #, no-wrap
- msgid ""
- "(operating-system\n"
- " (host-name \"mymachine\")\n"
- " ;; ...\n"
- " (hosts-file\n"
- " ;; Create a /etc/hosts file with aliases for \"localhost\"\n"
- " ;; and \"mymachine\", as well as for Facebook servers.\n"
- " (plain-file \"hosts\"\n"
- " (string-append (local-host-aliases host-name)\n"
- " %facebook-host-aliases))))\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:18725
- msgid "This mechanism can prevent programs running locally, such as Web browsers, from accessing Facebook."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:18728
- msgid "The @code{(gnu services avahi)} provides the following definition."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:18729
- #, no-wrap
- msgid "{Scheme Variable} avahi-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:18734
- msgid "This is the service that runs @command{avahi-daemon}, a system-wide mDNS/DNS-SD responder that allows for service discovery and ``zero-configuration'' host name lookups (see @uref{https://avahi.org/}). Its value must be an @code{avahi-configuration} record---see below."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:18739
- msgid "This service extends the name service cache daemon (nscd) so that it can resolve @code{.local} host names using @uref{https://0pointer.de/lennart/projects/nss-mdns/, nss-mdns}. @xref{Name Service Switch}, for information on host name resolution."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:18742
- msgid "Additionally, add the @var{avahi} package to the system profile so that commands such as @command{avahi-browse} are directly usable."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:18744
- #, no-wrap
- msgid "{Data Type} avahi-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:18746
- msgid "Data type representation the configuration for Avahi."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18749
- #, no-wrap
- msgid "@code{host-name} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18752
- msgid "If different from @code{#f}, use that as the host name to publish for this machine; otherwise, use the machine's actual host name."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18753 guix-git/doc/guix.texi:29132
- #, no-wrap
- msgid "@code{publish?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18756
- msgid "When true, allow host names and services to be published (broadcast) over the network."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18757
- #, no-wrap
- msgid "@code{publish-workstation?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18761
- msgid "When true, @command{avahi-daemon} publishes the machine's host name and IP address via mDNS on the local network. To view the host names published on your local network, you can run:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:18764
- #, no-wrap
- msgid "avahi-browse _workstation._tcp\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18766
- #, no-wrap
- msgid "@code{wide-area?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18768
- msgid "When true, DNS-SD over unicast DNS is enabled."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18769
- #, no-wrap
- msgid "@code{ipv4?} (default: @code{#t})"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:18770
- #, no-wrap
- msgid "@code{ipv6?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18772
- msgid "These fields determine whether to use IPv4/IPv6 sockets."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18773
- #, no-wrap
- msgid "@code{domains-to-browse} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18775
- msgid "This is a list of domains to browse."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18778
- #, no-wrap
- msgid "{Scheme Variable} openvswitch-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18782
- msgid "This is the type of the @uref{https://www.openvswitch.org, Open vSwitch} service, whose value should be an @code{openvswitch-configuration} object."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:18784
- #, no-wrap
- msgid "{Data Type} openvswitch-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:18788
- msgid "Data type representing the configuration of Open vSwitch, a multilayer virtual switch which is designed to enable massive network automation through programmatic extension."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18790
- #, no-wrap
- msgid "@code{package} (default: @var{openvswitch})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18792
- msgid "Package object of the Open vSwitch."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:18796
- #, no-wrap
- msgid "{Scheme Variable} pagekite-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:18801
- msgid "This is the service type for the @uref{https://pagekite.net, PageKite} service, a tunneling solution for making localhost servers publicly visible, even from behind restrictive firewalls or NAT without forwarded ports. The value for this service type is a @code{pagekite-configuration} record."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:18803
- msgid "Here's an example exposing the local HTTP and SSH daemons:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:18810
- #, no-wrap
- msgid ""
- "(service pagekite-service-type\n"
- " (pagekite-configuration\n"
- " (kites '(\"http:@@kitename:localhost:80:@@kitesecret\"\n"
- " \"raw/22:@@kitename:localhost:22:@@kitesecret\"))\n"
- " (extra-file \"/etc/pagekite.rc\")))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:18813
- #, no-wrap
- msgid "{Data Type} pagekite-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:18815
- msgid "Data type representing the configuration of PageKite."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18817
- #, no-wrap
- msgid "@code{package} (default: @var{pagekite})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18819
- msgid "Package object of PageKite."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18820
- #, no-wrap
- msgid "@code{kitename} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18822
- msgid "PageKite name for authenticating to the frontend server."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18823
- #, no-wrap
- msgid "@code{kitesecret} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18826
- msgid "Shared secret for authenticating to the frontend server. You should probably put this inside @code{extra-file} instead."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18827
- #, no-wrap
- msgid "@code{frontend} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18830
- msgid "Connect to the named PageKite frontend server instead of the @uref{https://pagekite.net,,pagekite.net} service."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18831
- #, no-wrap
- msgid "@code{kites} (default: @code{'(\"http:@@kitename:localhost:80:@@kitesecret\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18834
- msgid "List of service kites to use. Exposes HTTP on port 80 by default. The format is @code{proto:kitename:host:port:secret}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18835
- #, no-wrap
- msgid "@code{extra-file} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18838
- msgid "Extra configuration file to read, which you are expected to create manually. Use this to add additional options and manage shared secrets out-of-band."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:18842
- #, no-wrap
- msgid "{Scheme Variable} yggdrasil-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:18846
- msgid "The service type for connecting to the @uref{https://yggdrasil-network.github.io/, Yggdrasil network}, an early-stage implementation of a fully end-to-end encrypted IPv6 network."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:18853
- msgid "Yggdrasil provides name-independent routing with cryptographically generated addresses. Static addressing means you can keep the same address as long as you want, even if you move to a new location, or generate a new address (by generating new keys) whenever you want. @uref{https://yggdrasil-network.github.io/2018/07/28/addressing.html}"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:18857
- msgid "Pass it a value of @code{yggdrasil-configuration} to connect it to public peers and/or local peers."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:18861
- msgid "Here is an example using public peers and a static address. The static signing and encryption keys are defined in @file{/etc/yggdrasil-private.conf} (the default value for @code{config-file})."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:18873
- #, no-wrap
- msgid ""
- ";; part of the operating-system declaration\n"
- "(service yggdrasil-service-type\n"
- " (yggdrasil-configuration\n"
- " (autoconf? #f) ;; use only the public peers\n"
- " (json-config\n"
- " ;; choose one from\n"
- " ;; https://github.com/yggdrasil-network/public-peers\n"
- " '((peers . #(\"tcp://1.2.3.4:1337\"))))\n"
- " ;; /etc/yggdrasil-private.conf is the default value for config-file\n"
- " ))\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:18880
- #, no-wrap
- msgid ""
- "# sample content for /etc/yggdrasil-private.conf\n"
- "@{\n"
- " # Your public encryption key. Your peers may ask you for this to put\n"
- " # into their AllowedEncryptionPublicKeys configuration.\n"
- " EncryptionPublicKey: 378dc5...\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:18883
- #, no-wrap
- msgid ""
- " # Your private encryption key. DO NOT share this with anyone!\n"
- " EncryptionPrivateKey: 0777...\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:18887
- #, no-wrap
- msgid ""
- " # Your public signing key. You should not ordinarily need to share\n"
- " # this with anyone.\n"
- " SigningPublicKey: e1664...\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:18891
- #, no-wrap
- msgid ""
- " # Your private signing key. DO NOT share this with anyone!\n"
- " SigningPrivateKey: 0589d...\n"
- "@}\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:18894
- #, no-wrap
- msgid "{Data Type} yggdrasil-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:18896
- msgid "Data type representing the configuration of Yggdrasil."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18898
- #, no-wrap
- msgid "@code{package} (default: @code{yggdrasil})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18900
- msgid "Package object of Yggdrasil."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18901
- #, no-wrap
- msgid "@code{json-config} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18907
- msgid "Contents of @file{/etc/yggdrasil.conf}. Will be merged with @file{/etc/yggdrasil-private.conf}. Note that these settings are stored in the Guix store, which is readable to all users. @strong{Do not store your private keys in it}. See the output of @code{yggdrasil -genconf} for a quick overview of valid keys and their default values."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18908
- #, no-wrap
- msgid "@code{autoconf?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18911
- msgid "Whether to use automatic mode. Enabling it makes Yggdrasil use adynamic IP and peer with IPv6 neighbors."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18914
- msgid "How much detail to include in logs. Use @code{'debug} for more detail."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18915
- #, no-wrap
- msgid "@code{log-to} (default: @code{'stdout})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18919
- msgid "Where to send logs. By default, the service logs standard output to @file{/var/log/yggdrasil.log}. The alternative is @code{'syslog}, which sends output to the running syslog service."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18920
- #, no-wrap
- msgid "@code{config-file} (default: @code{\"/etc/yggdrasil-private.conf\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18927
- msgid "What HJSON file to load sensitive data from. This is where private keys should be stored, which are necessary to specify if you don't want a randomized address after each restart. Use @code{#f} to disable. Options defined in this file take precedence over @code{json-config}. Use the output of @code{yggdrasil -genconf} as a starting point. To configure a static address, delete everything except these options:"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:18929
- #, no-wrap
- msgid "EncryptionPublicKey"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:18930
- #, no-wrap
- msgid "EncryptionPrivateKey"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:18931
- #, no-wrap
- msgid "SigningPublicKey"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:18932
- #, no-wrap
- msgid "SigningPrivateKey"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:18937
- #, no-wrap
- msgid "IPFS"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:18938
- #, no-wrap
- msgid "{Scheme Variable} ipfs-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:18942
- msgid "The service type for connecting to the @uref{https://ipfs.io,IPFS network}, a global, versioned, peer-to-peer file system. Pass it a @code{ipfs-configuration} to change the ports used for the gateway and API."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:18944
- msgid "Here's an example configuration, using some non-standard ports:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:18950
- #, no-wrap
- msgid ""
- "(service ipfs-service-type\n"
- " (ipfs-configuration\n"
- " (gateway \"/ip4/127.0.0.1/tcp/8880\")\n"
- " (api \"/ip4/127.0.0.1/tcp/8881\")))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:18953
- #, no-wrap
- msgid "{Data Type} ipfs-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:18955
- msgid "Data type representing the configuration of IPFS."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18957
- #, no-wrap
- msgid "@code{package} (default: @code{go-ipfs})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18959
- msgid "Package object of IPFS."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18960
- #, no-wrap
- msgid "@code{gateway} (default: @code{\"/ip4/127.0.0.1/tcp/8082\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18962
- msgid "Address of the gateway, in ‘multiaddress’ format."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:18963
- #, no-wrap
- msgid "@code{api} (default: @code{\"/ip4/127.0.0.1/tcp/5001\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:18965
- msgid "Address of the API endpoint, in ‘multiaddress’ format."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:18968
- #, no-wrap
- msgid "keepalived"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18969
- #, no-wrap
- msgid "{Scheme Variable} keepalived-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18974
- msgid "This is the type for the @uref{https://www.keepalived.org/, Keepalived} routing software, @command{keepalived}. Its value must be an @code{keepalived-configuration} record as in this example for master machine:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:18979
- #, no-wrap
- msgid ""
- "(service keepalived-service-type\n"
- " (keepalived-configuration\n"
- " (config-file (local-file \"keepalived-master.conf\"))))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18982
- msgid "where @file{keepalived-master.conf}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:18994
- #, no-wrap
- msgid ""
- "vrrp_instance my-group @{\n"
- " state MASTER\n"
- " interface enp9s0\n"
- " virtual_router_id 100\n"
- " priority 100\n"
- " unicast_peer @{ 10.0.0.2 @}\n"
- " virtual_ipaddress @{\n"
- " 10.0.0.4/24\n"
- " @}\n"
- "@}\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:18997
- msgid "and for backup machine:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:19002
- #, no-wrap
- msgid ""
- "(service keepalived-service-type\n"
- " (keepalived-configuration\n"
- " (config-file (local-file \"keepalived-backup.conf\"))))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:19005
- msgid "where @file{keepalived-backup.conf}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:19017
- #, no-wrap
- msgid ""
- "vrrp_instance my-group @{\n"
- " state BACKUP\n"
- " interface enp9s0\n"
- " virtual_router_id 100\n"
- " priority 99\n"
- " unicast_peer @{ 10.0.0.3 @}\n"
- " virtual_ipaddress @{\n"
- " 10.0.0.4/24\n"
- " @}\n"
- "@}\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:19023
- #, no-wrap
- msgid "unattended upgrades"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:19024
- #, no-wrap
- msgid "upgrades, unattended"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:19029
- msgid "Guix provides a service to perform @emph{unattended upgrades}: periodically, the system automatically reconfigures itself from the latest Guix. Guix System has several properties that make unattended upgrades safe:"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:19034
- msgid "upgrades are transactional (either the upgrade succeeds or it fails, but you cannot end up with an ``in-between'' system state);"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:19038
- msgid "the upgrade log is kept---you can view it with @command{guix system list-generations}---and you can roll back to any previous generation, should the upgraded system fail to behave as intended;"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:19041
- msgid "channel code is authenticated so you know you can only run genuine code (@pxref{Channels});"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:19044
- msgid "@command{guix system reconfigure} prevents downgrades, which makes it immune to @dfn{downgrade attacks}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:19049
- msgid "To set up unattended upgrades, add an instance of @code{unattended-upgrade-service-type} like the one below to the list of your operating system services:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:19052
- #, no-wrap
- msgid "(service unattended-upgrade-service-type)\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:19059
- msgid "The defaults above set up weekly upgrades: every Sunday at midnight. You do not need to provide the operating system configuration file: it uses @file{/run/current-system/configuration.scm}, which ensures it always uses your latest configuration---@pxref{provenance-service-type}, for more information about this file."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:19065
- msgid "There are several things that can be configured, in particular the periodicity and services (daemons) to be restarted upon completion. When the upgrade is successful, the service takes care of deleting system generations older that some threshold, as per @command{guix system delete-generations}. See the reference below for details."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:19069
- msgid "To ensure that upgrades are actually happening, you can run @command{guix system describe}. To investigate upgrade failures, visit the unattended upgrade log file (see below)."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:19070
- #, no-wrap
- msgid "{Scheme Variable} unattended-upgrade-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:19074
- msgid "This is the service type for unattended upgrades. It sets up an mcron job (@pxref{Scheduled Job Execution}) that runs @command{guix system reconfigure} from the latest version of the specified channels."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:19077
- msgid "Its value must be a @code{unattended-upgrade-configuration} record (see below)."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:19079
- #, no-wrap
- msgid "{Data Type} unattended-upgrade-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:19082
- msgid "This data type represents the configuration of the unattended upgrade service. The following fields are available:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19084
- #, no-wrap
- msgid "@code{schedule} (default: @code{\"30 01 * * 0\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19088
- msgid "This is the schedule of upgrades, expressed as a gexp containing an mcron job schedule (@pxref{Guile Syntax, mcron job specifications,, mcron, GNU@tie{}mcron})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19089
- #, no-wrap
- msgid "@code{channels} (default: @code{#~%default-channels})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19093
- msgid "This gexp specifies the channels to use for the upgrade (@pxref{Channels}). By default, the tip of the official @code{guix} channel is used."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19094
- #, no-wrap
- msgid "@code{operating-system-file} (default: @code{\"/run/current-system/configuration.scm\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19097
- msgid "This field specifies the operating system configuration file to use. The default is to reuse the config file of the current configuration."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19103
- msgid "There are cases, though, where referring to @file{/run/current-system/configuration.scm} is not enough, for instance because that file refers to extra files (SSH public keys, extra configuration files, etc.) @i{via} @code{local-file} and similar constructs. For those cases, we recommend something along these lines:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:19109
- #, no-wrap
- msgid ""
- "(unattended-upgrade-configuration\n"
- " (operating-system-file\n"
- " (file-append (local-file \".\" \"config-dir\" #:recursive? #t)\n"
- " \"/config.scm\")))\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19116
- msgid "The effect here is to import all of the current directory into the store, and to refer to @file{config.scm} within that directory. Therefore, uses of @code{local-file} within @file{config.scm} will work as expected. @xref{G-Expressions}, for information about @code{local-file} and @code{file-append}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19117
- #, no-wrap
- msgid "@code{services-to-restart} (default: @code{'(mcron)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19120
- msgid "This field specifies the Shepherd services to restart when the upgrade completes."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19127
- msgid "Those services are restarted right away upon completion, as with @command{herd restart}, which ensures that the latest version is running---remember that by default @command{guix system reconfigure} only restarts services that are not currently running, which is conservative: it minimizes disruption but leaves outdated services running."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19131
- msgid "Use @command{herd status} to find out candidates for restarting. @xref{Services}, for general information about services. Common services to restart would include @code{ntpd} and @code{ssh-daemon}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19134
- msgid "By default, the @code{mcron} service is restarted. This ensures that the latest version of the unattended upgrade job will be used next time."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19135
- #, no-wrap
- msgid "@code{system-expiration} (default: @code{(* 3 30 24 3600)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19139
- msgid "This is the expiration time in seconds for system generations. System generations older that this amount of time are deleted with @command{guix system delete-generations} when an upgrade completes."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:19144
- msgid "The unattended upgrade service does not run the garbage collector. You will probably want to set up your own mcron job to run @command{guix gc} periodically."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19146
- #, no-wrap
- msgid "@code{maximum-duration} (default: @code{3600})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19149
- msgid "Maximum duration in seconds for the upgrade; past that time, the upgrade aborts."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19152
- msgid "This is primarily useful to ensure the upgrade does not end up rebuilding or re-downloading ``the world''."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19153
- #, no-wrap
- msgid "@code{log-file} (default: @code{\"/var/log/unattended-upgrade.log\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19155
- msgid "File where unattended upgrades are logged."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:19161
- #, no-wrap
- msgid "X11"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:19162
- #, no-wrap
- msgid "X Window System"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:19163 guix-git/doc/guix.texi:19436
- #, no-wrap
- msgid "login manager"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:19168
- msgid "Support for the X Window graphical display system---specifically Xorg---is provided by the @code{(gnu services xorg)} module. Note that there is no @code{xorg-service} procedure. Instead, the X server is started by the @dfn{login manager}, by default the GNOME Display Manager (GDM)."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:19169
- #, no-wrap
- msgid "GDM"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:19170
- #, no-wrap
- msgid "GNOME, login manager"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:19174
- msgid "GDM of course allows users to log in into window managers and desktop environments other than GNOME; for those using GNOME, GDM is required for features such as automatic screen locking."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:19175
- #, no-wrap
- msgid "window manager"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:19180
- msgid "To use X11, you must install at least one @dfn{window manager}---for example the @code{windowmaker} or @code{openbox} packages---preferably by adding it to the @code{packages} field of your operating system definition (@pxref{operating-system Reference, system-wide packages})."
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:19186
- msgid "wayland-gdm"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:19186
- msgid "GDM also supports Wayland: it can itself use Wayland instead of X11 for its user interface, and it can also start Wayland sessions. The former is required for the latter, to enable, set @code{wayland?} to @code{#t} in @code{gdm-configuration}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:19187
- #, no-wrap
- msgid "{Scheme Variable} gdm-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:19192
- msgid "This is the type for the @uref{https://wiki.gnome.org/Projects/GDM/, GNOME Desktop Manager} (GDM), a program that manages graphical display servers and handles graphical user logins. Its value must be a @code{gdm-configuration} (see below)."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:19193
- #, no-wrap
- msgid "session types"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:19201
- msgid "GDM looks for @dfn{session types} described by the @file{.desktop} files in @file{/run/current-system/profile/share/xsessions} (for X11 sessions) and @file{/run/current-system/profile/share/wayland-sessions} (for Wayland sessions) and allows users to choose a session from the log-in screen. Packages such as @code{gnome}, @code{xfce}, @code{i3} and @code{sway} provide @file{.desktop} files; adding them to the system-wide set of packages automatically makes them available at the log-in screen."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:19205
- msgid "In addition, @file{~/.xsession} files are honored. When available, @file{~/.xsession} must be an executable that starts a window manager and/or other X clients."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:19207
- #, no-wrap
- msgid "{Data Type} gdm-configuration"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19209 guix-git/doc/guix.texi:19291
- #, no-wrap
- msgid "@code{auto-login?} (default: @code{#f})"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:19210
- #, no-wrap
- msgid "@code{default-user} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19212
- msgid "When @code{auto-login?} is false, GDM presents a log-in screen."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19215
- msgid "When @code{auto-login?} is true, GDM logs in directly as @code{default-user}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19216 guix-git/doc/guix.texi:25077
- #: guix-git/doc/guix.texi:26786 guix-git/doc/guix.texi:31266
- #: guix-git/doc/guix.texi:31295 guix-git/doc/guix.texi:31324
- #: guix-git/doc/guix.texi:31351 guix-git/doc/guix.texi:31406
- #: guix-git/doc/guix.texi:31431 guix-git/doc/guix.texi:31458
- #: guix-git/doc/guix.texi:31484 guix-git/doc/guix.texi:31526
- #, no-wrap
- msgid "@code{debug?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19218
- msgid "When true, GDM writes debug messages to its log."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19219
- #, no-wrap
- msgid "@code{gnome-shell-assets} (default: ...)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19221
- msgid "List of GNOME Shell assets needed by GDM: icon theme, fonts, etc."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19222
- #, no-wrap
- msgid "@code{xorg-configuration} (default: @code{(xorg-configuration)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19224 guix-git/doc/guix.texi:19318
- #: guix-git/doc/guix.texi:19402
- msgid "Configuration of the Xorg graphical server."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19225
- #, no-wrap
- msgid "@code{xsession} (default: @code{(xinitrc)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19227 guix-git/doc/guix.texi:19417
- msgid "Script to run before starting a X session."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19228
- #, no-wrap
- msgid "@code{dbus-daemon} (default: @code{dbus-daemon-wrapper})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19230
- msgid "File name of the @code{dbus-daemon} executable."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19231
- #, no-wrap
- msgid "@code{gdm} (default: @code{gdm})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19233
- msgid "The GDM package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19234
- #, no-wrap
- msgid "@code{wayland?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19236
- msgid "When true, enables Wayland in GDM, necessary to use Wayland sessions."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19237
- #, no-wrap
- msgid "@code{wayland-session} (default: @code{gdm-wayland-session-wrapper})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19240
- msgid "The Wayland session wrapper to use, needed to setup the environment."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:19243
- #, no-wrap
- msgid "{Scheme Variable} slim-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:19245
- msgid "This is the type for the SLiM graphical login manager for X11."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:19249
- msgid "Like GDM, SLiM looks for session types described by @file{.desktop} files and allows users to choose a session from the log-in screen using @kbd{F1}. It also honors @file{~/.xsession} files."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:19256
- msgid "Unlike GDM, SLiM does not spawn the user session on a different VT after logging in, which means that you can only start one graphical session. If you want to be able to run multiple graphical sessions at the same time you have to add multiple SLiM services to your system services. The following example shows how to replace the default GDM service with two SLiM services on tty7 and tty8."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:19261
- #, no-wrap
- msgid ""
- "(use-modules (gnu services)\n"
- " (gnu services desktop)\n"
- " (gnu services xorg))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:19272
- #, no-wrap
- msgid ""
- "(operating-system\n"
- " ;; ...\n"
- " (services (cons* (service slim-service-type (slim-configuration\n"
- " (display \":0\")\n"
- " (vt \"vt7\")))\n"
- " (service slim-service-type (slim-configuration\n"
- " (display \":1\")\n"
- " (vt \"vt8\")))\n"
- " (modify-services %desktop-services\n"
- " (delete gdm-service-type)))))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:19276
- #, no-wrap
- msgid "{Data Type} slim-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:19278
- msgid "Data type representing the configuration of @code{slim-service-type}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19282
- msgid "Whether to allow logins with empty passwords."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19283
- #, no-wrap
- msgid "@code{gnupg?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19290
- msgid "If enabled, @code{pam-gnupg} will attempt to automatically unlock the user's GPG keys with the login password via @code{gpg-agent}. The keygrips of all keys to be unlocked should be written to @file{~/.pam-gnupg}, and can be queried with @code{gpg -K --with-keygrip}. Presetting passphrases must be enabled by adding @code{allow-preset-passphrase} in @file{~/.gnupg/gpg-agent.conf}."
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:19292
- #, no-wrap
- msgid "@code{default-user} (default: @code{\"\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19294
- msgid "When @code{auto-login?} is false, SLiM presents a log-in screen."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19297
- msgid "When @code{auto-login?} is true, SLiM logs in directly as @code{default-user}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19298
- #, no-wrap
- msgid "@code{theme} (default: @code{%default-slim-theme})"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:19299
- #, no-wrap
- msgid "@code{theme-name} (default: @code{%default-slim-theme-name})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19301
- msgid "The graphical theme to use and its name."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19302
- #, no-wrap
- msgid "@code{auto-login-session} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19305
- msgid "If true, this must be the name of the executable to start as the default session---e.g., @code{(file-append windowmaker \"/bin/windowmaker\")}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19309
- msgid "If false, a session described by one of the available @file{.desktop} files in @code{/run/current-system/profile} and @code{~/.guix-profile} will be used."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:19314
- msgid "You must install at least one window manager in the system profile or in your user profile. Failing to do that, if @code{auto-login-session} is false, you will be unable to log in."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19316 guix-git/doc/guix.texi:19400
- #, no-wrap
- msgid "@code{xorg-configuration} (default @code{(xorg-configuration)})"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19319
- #, no-wrap
- msgid "@code{display} (default @code{\":0\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19321
- msgid "The display on which to start the Xorg graphical server."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19322
- #, no-wrap
- msgid "@code{vt} (default @code{\"vt7\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19324
- msgid "The VT on which to start the Xorg graphical server."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19325
- #, no-wrap
- msgid "@code{xauth} (default: @code{xauth})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19327
- msgid "The XAuth package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19328
- #, no-wrap
- msgid "@code{shepherd} (default: @code{shepherd})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19331
- msgid "The Shepherd package used when invoking @command{halt} and @command{reboot}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19332
- #, no-wrap
- msgid "@code{sessreg} (default: @code{sessreg})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19334
- msgid "The sessreg package used in order to register the session."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19335
- #, no-wrap
- msgid "@code{slim} (default: @code{slim})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19337
- msgid "The SLiM package to use."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:19340
- #, no-wrap
- msgid "{Scheme Variable} %default-theme"
- msgstr ""
- #. type: defvrx
- #: guix-git/doc/guix.texi:19341
- #, no-wrap
- msgid "{Scheme Variable} %default-theme-name"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:19343
- msgid "The default SLiM theme and its name."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:19346 guix-git/doc/guix.texi:19453
- #, no-wrap
- msgid "{Data Type} sddm-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:19348
- msgid "This is the data type representing the SDDM service configuration."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19350
- #, no-wrap
- msgid "@code{display-server} (default: \"x11\")"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19353
- msgid "Select display server to use for the greeter. Valid values are @samp{\"x11\"} or @samp{\"wayland\"}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19354
- #, no-wrap
- msgid "@code{numlock} (default: \"on\")"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19356
- msgid "Valid values are @samp{\"on\"}, @samp{\"off\"} or @samp{\"none\"}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19357
- #, no-wrap
- msgid "@code{halt-command} (default @code{#~(string-apppend #$shepherd \"/sbin/halt\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19359
- msgid "Command to run when halting."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19360
- #, no-wrap
- msgid "@code{reboot-command} (default @code{#~(string-append #$shepherd \"/sbin/reboot\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19362
- msgid "Command to run when rebooting."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19363
- #, no-wrap
- msgid "@code{theme} (default \"maldives\")"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19366
- msgid "Theme to use. Default themes provided by SDDM are @samp{\"elarun\"}, @samp{\"maldives\"} or @samp{\"maya\"}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19367
- #, no-wrap
- msgid "@code{themes-directory} (default \"/run/current-system/profile/share/sddm/themes\")"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19369
- msgid "Directory to look for themes."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19370
- #, no-wrap
- msgid "@code{faces-directory} (default \"/run/current-system/profile/share/sddm/faces\")"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19372
- msgid "Directory to look for faces."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19373
- #, no-wrap
- msgid "@code{default-path} (default \"/run/current-system/profile/bin\")"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19375
- msgid "Default PATH to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19376
- #, no-wrap
- msgid "@code{minimum-uid} (default: 1000)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19378
- msgid "Minimum UID displayed in SDDM and allowed for log-in."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19379
- #, no-wrap
- msgid "@code{maximum-uid} (default: 2000)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19381
- msgid "Maximum UID to display in SDDM."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19382
- #, no-wrap
- msgid "@code{remember-last-user?} (default #t)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19384
- msgid "Remember last user."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19385
- #, no-wrap
- msgid "@code{remember-last-session?} (default #t)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19387
- msgid "Remember last session."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19388
- #, no-wrap
- msgid "@code{hide-users} (default \"\")"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19390
- msgid "Usernames to hide from SDDM greeter."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19391
- #, no-wrap
- msgid "@code{hide-shells} (default @code{#~(string-append #$shadow \"/sbin/nologin\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19393
- msgid "Users with shells listed will be hidden from the SDDM greeter."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19394
- #, no-wrap
- msgid "@code{session-command} (default @code{#~(string-append #$sddm \"/share/sddm/scripts/wayland-session\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19396
- msgid "Script to run before starting a wayland session."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19397
- #, no-wrap
- msgid "@code{sessions-directory} (default \"/run/current-system/profile/share/wayland-sessions\")"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19399
- msgid "Directory to look for desktop files starting wayland sessions."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19403
- #, no-wrap
- msgid "@code{xauth-path} (default @code{#~(string-append #$xauth \"/bin/xauth\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19405
- msgid "Path to xauth."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19406
- #, no-wrap
- msgid "@code{xephyr-path} (default @code{#~(string-append #$xorg-server \"/bin/Xephyr\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19408
- msgid "Path to Xephyr."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19409
- #, no-wrap
- msgid "@code{xdisplay-start} (default @code{#~(string-append #$sddm \"/share/sddm/scripts/Xsetup\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19411
- msgid "Script to run after starting xorg-server."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19412
- #, no-wrap
- msgid "@code{xdisplay-stop} (default @code{#~(string-append #$sddm \"/share/sddm/scripts/Xstop\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19414
- msgid "Script to run before stopping xorg-server."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19415
- #, no-wrap
- msgid "@code{xsession-command} (default: @code{xinitrc})"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19418
- #, no-wrap
- msgid "@code{xsessions-directory} (default: \"/run/current-system/profile/share/xsessions\")"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19420
- msgid "Directory to look for desktop files starting X sessions."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19421
- #, no-wrap
- msgid "@code{minimum-vt} (default: 7)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19423
- msgid "Minimum VT to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19424
- #, no-wrap
- msgid "@code{auto-login-user} (default \"\")"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19426
- msgid "User to use for auto-login."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19427
- #, no-wrap
- msgid "@code{auto-login-session} (default \"\")"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19429
- msgid "Desktop file to use for auto-login."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19430
- #, no-wrap
- msgid "@code{relogin?} (default #f)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19432
- msgid "Relogin after logout."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:19437
- #, no-wrap
- msgid "X11 login"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:19438
- #, no-wrap
- msgid "{Scheme Variable} sddm-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:19442
- msgid "This is the type of the service to run the @uref{https://github.com/sddm/sddm,SDDM display manager}. Its value must be a @code{sddm-configuration} record (see below)."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:19444
- msgid "Here's an example use:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:19450
- #, no-wrap
- msgid ""
- "(service sddm-service-type\n"
- " (sddm-configuration\n"
- " (auto-login-user \"alice\")\n"
- " (auto-login-session \"xfce.desktop\")))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:19456
- msgid "This data type represents the configuration of the SDDM login manager. The available fields are:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19458
- #, no-wrap
- msgid "@code{sddm} (default: @code{sddm})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19460
- msgid "The SDDM package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19461
- #, no-wrap
- msgid "@code{display-server} (default: @code{\"x11\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19463
- msgid "This must be either @code{\"x11\"} or @code{\"wayland\"}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19466
- #, no-wrap
- msgid "@code{auto-login-user} (default: @code{\"\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19469
- msgid "If non-empty, this is the user account under which to log in automatically."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19470
- #, no-wrap
- msgid "@code{auto-login-session} (default: @code{\"\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19473
- msgid "If non-empty, this is the @file{.desktop} file name to use as the auto-login session."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:19476
- #, no-wrap
- msgid "Xorg, configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:19477
- #, no-wrap
- msgid "{Data Type} xorg-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:19482
- msgid "This data type represents the configuration of the Xorg graphical display server. Note that there is no Xorg service; instead, the X server is started by a ``display manager'' such as GDM, SDDM, and SLiM@. Thus, the configuration of these display managers aggregates an @code{xorg-configuration} record."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19484
- #, no-wrap
- msgid "@code{modules} (default: @code{%default-xorg-modules})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19487
- msgid "This is a list of @dfn{module packages} loaded by the Xorg server---e.g., @code{xf86-video-vesa}, @code{xf86-input-keyboard}, and so on."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19488
- #, no-wrap
- msgid "@code{fonts} (default: @code{%default-xorg-fonts})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19490
- msgid "This is a list of font directories to add to the server's @dfn{font path}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19491
- #, no-wrap
- msgid "@code{drivers} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19495
- msgid "This must be either the empty list, in which case Xorg chooses a graphics driver automatically, or a list of driver names that will be tried in this order---e.g., @code{(\"modesetting\" \"vesa\")}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19496
- #, no-wrap
- msgid "@code{resolutions} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19500
- msgid "When @code{resolutions} is the empty list, Xorg chooses an appropriate screen resolution. Otherwise, it must be a list of resolutions---e.g., @code{((1024 768) (640 480))}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:19501
- #, no-wrap
- msgid "keyboard layout, for Xorg"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:19502
- #, no-wrap
- msgid "keymap, for Xorg"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19506
- msgid "If this is @code{#f}, Xorg uses the default keyboard layout---usually US English (``qwerty'') for a 105-key PC keyboard."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19510
- msgid "Otherwise this must be a @code{keyboard-layout} object specifying the keyboard layout in use when Xorg is running. @xref{Keyboard Layout}, for more information on how to specify the keyboard layout."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19511 guix-git/doc/guix.texi:21223
- #: guix-git/doc/guix.texi:34046
- #, no-wrap
- msgid "@code{extra-config} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19514 guix-git/doc/guix.texi:34050
- msgid "This is a list of strings or objects appended to the configuration file. It is used to pass extra text to be added verbatim to the configuration file."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19515
- #, no-wrap
- msgid "@code{server} (default: @code{xorg-server})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19517
- msgid "This is the package providing the Xorg server."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19518
- #, no-wrap
- msgid "@code{server-arguments} (default: @code{%default-xorg-server-arguments})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19521
- msgid "This is the list of command-line arguments to pass to the X server. The default is @code{-nolisten tcp}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:19524
- #, no-wrap
- msgid "{Scheme Procedure} set-xorg-configuration @var{config} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:19528
- msgid "[@var{login-manager-service-type}] Tell the log-in manager (of type @var{login-manager-service-type}) to use @var{config}, an @code{<xorg-configuration>} record."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:19532
- msgid "Since the Xorg configuration is embedded in the log-in manager's configuration---e.g., @code{gdm-configuration}---this procedure provides a shorthand to set the Xorg configuration."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:19534
- #, no-wrap
- msgid "{Scheme Procedure} xorg-start-command [@var{config}]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:19538
- msgid "Return a @code{startx} script in which the modules, fonts, etc. specified in @var{config}, are available. The result should be used in place of @code{startx}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:19540
- msgid "Usually the X server is started by a login manager."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:19543
- #, no-wrap
- msgid "{Scheme Procedure} screen-locker-service @var{package} [@var{program}]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:19547
- msgid "Add @var{package}, a package for a screen locker or screen saver whose command is @var{program}, to the set of setuid programs and add a PAM entry for it. For example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:19550
- #, no-wrap
- msgid "(screen-locker-service xlockmore \"xlock\")\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:19553
- msgid "makes the good ol' XlockMore usable."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:19559
- #, no-wrap
- msgid "printer support with CUPS"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:19563
- msgid "The @code{(gnu services cups)} module provides a Guix service definition for the CUPS printing service. To add printer support to a Guix system, add a @code{cups-service} to the operating system definition:"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:19564
- #, no-wrap
- msgid "{Scheme Variable} cups-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:19568
- msgid "The service type for the CUPS print server. Its value should be a valid CUPS configuration (see below). To use the default settings, simply write:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:19570
- #, no-wrap
- msgid "(service cups-service-type)\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:19580
- msgid "The CUPS configuration controls the basic things about your CUPS installation: what interfaces it listens on, what to do if a print job fails, how much logging to do, and so on. To actually add a printer, you have to visit the @url{http://localhost:631} URL, or use a tool such as GNOME's printer configuration services. By default, configuring a CUPS service will generate a self-signed certificate if needed, for secure connections to the print server."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:19586
- msgid "Suppose you want to enable the Web interface of CUPS and also add support for Epson printers @i{via} the @code{epson-inkjet-printer-escpr} package and for HP printers @i{via} the @code{hplip-minimal} package. You can do that directly, like this (you need to use the @code{(gnu packages cups)} module):"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:19593
- #, no-wrap
- msgid ""
- "(service cups-service-type\n"
- " (cups-configuration\n"
- " (web-interface? #t)\n"
- " (extensions\n"
- " (list cups-filters epson-inkjet-printer-escpr hplip-minimal))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:19598
- msgid "Note: If you wish to use the Qt5 based GUI which comes with the hplip package then it is suggested that you install the @code{hplip} package, either in your OS configuration file or as your user."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:19605
- msgid "The available configuration parameters follow. Each parameter definition is preceded by its type; for example, @samp{string-list foo} indicates that the @code{foo} parameter should be specified as a list of strings. There is also a way to specify the configuration as a string, if you have an old @code{cupsd.conf} file that you want to port over from some other system; see the end for more details."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:19616
- msgid "Available @code{cups-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19617
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} package cups"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19619 guix-git/doc/guix.texi:20387
- msgid "The CUPS package."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19621
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} package-list extensions (default: @code{(list brlaser cups-filters epson-inkjet-printer-escpr foomatic-filters hplip-minimal splix)})"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19623
- msgid "Drivers and other extensions to the CUPS package."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19625
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} files-configuration files-configuration"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19628
- msgid "Configuration of where to write logs, what directories to use for print spools, and related privileged configuration parameters."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19630
- msgid "Available @code{files-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19631
- #, no-wrap
- msgid "{@code{files-configuration} parameter} log-location access-log"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19639
- msgid "Defines the access log filename. Specifying a blank filename disables access log generation. The value @code{stderr} causes log entries to be sent to the standard error file when the scheduler is running in the foreground, or to the system log daemon when run in the background. The value @code{syslog} causes log entries to be sent to the system log daemon. The server name may be included in filenames using the string @code{%s}, as in @code{/var/log/cups/%s-access_log}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19641
- msgid "Defaults to @samp{\"/var/log/cups/access_log\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19643
- #, no-wrap
- msgid "{@code{files-configuration} parameter} file-name cache-dir"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19645
- msgid "Where CUPS should cache data."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19647
- msgid "Defaults to @samp{\"/var/cache/cups\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19649
- #, no-wrap
- msgid "{@code{files-configuration} parameter} string config-file-perm"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19652
- msgid "Specifies the permissions for all configuration files that the scheduler writes."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19658
- msgid "Note that the permissions for the printers.conf file are currently masked to only allow access from the scheduler user (typically root). This is done because printer device URIs sometimes contain sensitive authentication information that should not be generally known on the system. There is no way to disable this security feature."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19660
- msgid "Defaults to @samp{\"0640\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19662
- #, no-wrap
- msgid "{@code{files-configuration} parameter} log-location error-log"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19670
- msgid "Defines the error log filename. Specifying a blank filename disables error log generation. The value @code{stderr} causes log entries to be sent to the standard error file when the scheduler is running in the foreground, or to the system log daemon when run in the background. The value @code{syslog} causes log entries to be sent to the system log daemon. The server name may be included in filenames using the string @code{%s}, as in @code{/var/log/cups/%s-error_log}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19672
- msgid "Defaults to @samp{\"/var/log/cups/error_log\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19674
- #, no-wrap
- msgid "{@code{files-configuration} parameter} string fatal-errors"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19677
- msgid "Specifies which errors are fatal, causing the scheduler to exit. The kind strings are:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19681
- msgid "No errors are fatal."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19684
- msgid "All of the errors below are fatal."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19685
- #, no-wrap
- msgid "browse"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19688
- msgid "Browsing initialization errors are fatal, for example failed connections to the DNS-SD daemon."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19689
- #, no-wrap
- msgid "config"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19691
- msgid "Configuration file syntax errors are fatal."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19692
- #, no-wrap
- msgid "listen"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19695
- msgid "Listen or Port errors are fatal, except for IPv6 failures on the loopback or @code{any} addresses."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19696
- #, no-wrap
- msgid "log"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19698
- msgid "Log file creation or write errors are fatal."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:19699
- #, no-wrap
- msgid "permissions"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:19702
- msgid "Bad startup file permissions are fatal, for example shared TLS certificate and key files with world-read permissions."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19705
- msgid "Defaults to @samp{\"all -browse\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19707
- #, no-wrap
- msgid "{@code{files-configuration} parameter} boolean file-device?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19710
- msgid "Specifies whether the file pseudo-device can be used for new printer queues. The URI @uref{file:///dev/null} is always allowed."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19714
- #, no-wrap
- msgid "{@code{files-configuration} parameter} string group"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19717
- msgid "Specifies the group name or ID that will be used when executing external programs."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19719 guix-git/doc/guix.texi:19805
- msgid "Defaults to @samp{\"lp\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19721
- #, no-wrap
- msgid "{@code{files-configuration} parameter} string log-file-group"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19723
- msgid "Specifies the group name or ID that will be used for log files."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19725
- msgid "Defaults to @samp{\"lpadmin\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19727
- #, no-wrap
- msgid "{@code{files-configuration} parameter} string log-file-perm"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19729
- msgid "Specifies the permissions for all log files that the scheduler writes."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19731
- msgid "Defaults to @samp{\"0644\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19733
- #, no-wrap
- msgid "{@code{files-configuration} parameter} log-location page-log"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19741
- msgid "Defines the page log filename. Specifying a blank filename disables page log generation. The value @code{stderr} causes log entries to be sent to the standard error file when the scheduler is running in the foreground, or to the system log daemon when run in the background. The value @code{syslog} causes log entries to be sent to the system log daemon. The server name may be included in filenames using the string @code{%s}, as in @code{/var/log/cups/%s-page_log}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19743
- msgid "Defaults to @samp{\"/var/log/cups/page_log\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19745
- #, no-wrap
- msgid "{@code{files-configuration} parameter} string remote-root"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19748
- msgid "Specifies the username that is associated with unauthenticated accesses by clients claiming to be the root user. The default is @code{remroot}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19750
- msgid "Defaults to @samp{\"remroot\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19752
- #, no-wrap
- msgid "{@code{files-configuration} parameter} file-name request-root"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19755
- msgid "Specifies the directory that contains print jobs and other HTTP request data."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19757
- msgid "Defaults to @samp{\"/var/spool/cups\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19759
- #, no-wrap
- msgid "{@code{files-configuration} parameter} sandboxing sandboxing"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19764
- msgid "Specifies the level of security sandboxing that is applied to print filters, backends, and other child processes of the scheduler; either @code{relaxed} or @code{strict}. This directive is currently only used/supported on macOS."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19766
- msgid "Defaults to @samp{strict}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19768
- #, no-wrap
- msgid "{@code{files-configuration} parameter} file-name server-keychain"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19773
- msgid "Specifies the location of TLS certificates and private keys. CUPS will look for public and private keys in this directory: @file{.crt} files for PEM-encoded certificates and corresponding @file{.key} files for PEM-encoded private keys."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19775
- msgid "Defaults to @samp{\"/etc/cups/ssl\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19777
- #, no-wrap
- msgid "{@code{files-configuration} parameter} file-name server-root"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19779
- msgid "Specifies the directory containing the server configuration files."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19781
- msgid "Defaults to @samp{\"/etc/cups\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19783
- #, no-wrap
- msgid "{@code{files-configuration} parameter} boolean sync-on-close?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19786
- msgid "Specifies whether the scheduler calls fsync(2) after writing configuration or state files."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19790
- #, no-wrap
- msgid "{@code{files-configuration} parameter} space-separated-string-list system-group"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19792
- msgid "Specifies the group(s) to use for @code{@@SYSTEM} group authentication."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19794
- #, no-wrap
- msgid "{@code{files-configuration} parameter} file-name temp-dir"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19796
- msgid "Specifies the directory where temporary files are stored."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19798
- msgid "Defaults to @samp{\"/var/spool/cups/tmp\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19800
- #, no-wrap
- msgid "{@code{files-configuration} parameter} string user"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19803
- msgid "Specifies the user name or ID that is used when running external programs."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19807
- #, no-wrap
- msgid "{@code{files-configuration} parameter} string set-env"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19809
- msgid "Set the specified environment variable to be passed to child processes."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19811
- msgid "Defaults to @samp{\"variable value\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19814
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} access-log-level access-log-level"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19821
- msgid "Specifies the logging level for the AccessLog file. The @code{config} level logs when printers and classes are added, deleted, or modified and when configuration files are accessed or updated. The @code{actions} level logs when print jobs are submitted, held, released, modified, or canceled, and any of the conditions for @code{config}. The @code{all} level logs all requests."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19823
- msgid "Defaults to @samp{actions}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19825
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} boolean auto-purge-jobs?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19828
- msgid "Specifies whether to purge job history data automatically when it is no longer required for quotas."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19832
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} comma-separated-string-list browse-dns-sd-sub-types"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19836
- msgid "Specifies a list of DNS-SD sub-types to advertise for each shared printer. For example, @samp{\"_cups\" \"_print\"} will tell network clients that both CUPS sharing and IPP Everywhere are supported."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19838
- msgid "Defaults to @samp{\"_cups\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19840
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} browse-local-protocols browse-local-protocols"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19842
- msgid "Specifies which protocols to use for local printer sharing."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19844
- msgid "Defaults to @samp{dnssd}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19846
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} boolean browse-web-if?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19848
- msgid "Specifies whether the CUPS web interface is advertised."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19852
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} boolean browsing?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19854
- msgid "Specifies whether shared printers are advertised."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19858
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} string classification"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19863
- msgid "Specifies the security classification of the server. Any valid banner name can be used, including @samp{\"classified\"}, @samp{\"confidential\"}, @samp{\"secret\"}, @samp{\"topsecret\"}, and @samp{\"unclassified\"}, or the banner can be omitted to disable secure printing functions."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19865 guix-git/doc/guix.texi:20196
- #: guix-git/doc/guix.texi:22180 guix-git/doc/guix.texi:22192
- #: guix-git/doc/guix.texi:22220 guix-git/doc/guix.texi:22977
- #: guix-git/doc/guix.texi:22991 guix-git/doc/guix.texi:22998
- #: guix-git/doc/guix.texi:23005 guix-git/doc/guix.texi:23035
- #: guix-git/doc/guix.texi:23133 guix-git/doc/guix.texi:25252
- #: guix-git/doc/guix.texi:25278 guix-git/doc/guix.texi:25314
- #: guix-git/doc/guix.texi:25360 guix-git/doc/guix.texi:25379
- #: guix-git/doc/guix.texi:25418 guix-git/doc/guix.texi:25477
- #: guix-git/doc/guix.texi:25487 guix-git/doc/guix.texi:30085
- #: guix-git/doc/guix.texi:30093 guix-git/doc/guix.texi:30101
- #: guix-git/doc/guix.texi:30109 guix-git/doc/guix.texi:30388
- #: guix-git/doc/guix.texi:31743 guix-git/doc/guix.texi:31751
- #: guix-git/doc/guix.texi:31759 guix-git/doc/guix.texi:31867
- #: guix-git/doc/guix.texi:31892 guix-git/doc/guix.texi:32023
- #: guix-git/doc/guix.texi:32031 guix-git/doc/guix.texi:32039
- #: guix-git/doc/guix.texi:32047 guix-git/doc/guix.texi:32055
- #: guix-git/doc/guix.texi:32063 guix-git/doc/guix.texi:32086
- #: guix-git/doc/guix.texi:32094 guix-git/doc/guix.texi:32146
- #: guix-git/doc/guix.texi:32162 guix-git/doc/guix.texi:32170
- #: guix-git/doc/guix.texi:32209 guix-git/doc/guix.texi:32232
- #: guix-git/doc/guix.texi:32254 guix-git/doc/guix.texi:32261
- #: guix-git/doc/guix.texi:32296 guix-git/doc/guix.texi:32304
- #: guix-git/doc/guix.texi:32328 guix-git/doc/guix.texi:32360
- #: guix-git/doc/guix.texi:32389 guix-git/doc/guix.texi:32396
- #: guix-git/doc/guix.texi:32403 guix-git/doc/guix.texi:32411
- #: guix-git/doc/guix.texi:32425 guix-git/doc/guix.texi:32434
- #: guix-git/doc/guix.texi:32444 guix-git/doc/guix.texi:32451
- #: guix-git/doc/guix.texi:32458 guix-git/doc/guix.texi:32465
- #: guix-git/doc/guix.texi:32536 guix-git/doc/guix.texi:32543
- #: guix-git/doc/guix.texi:32550 guix-git/doc/guix.texi:32559
- #: guix-git/doc/guix.texi:32575 guix-git/doc/guix.texi:32582
- #: guix-git/doc/guix.texi:32589 guix-git/doc/guix.texi:32596
- #: guix-git/doc/guix.texi:32604 guix-git/doc/guix.texi:32612
- msgid "Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19867
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} boolean classify-override?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19870
- msgid "Specifies whether users may override the classification (cover page) of individual print jobs using the @code{job-sheets} option."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19874
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} default-auth-type default-auth-type"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19876
- msgid "Specifies the default type of authentication to use."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19878
- msgid "Defaults to @samp{Basic}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19880
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} default-encryption default-encryption"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19882
- msgid "Specifies whether encryption will be used for authenticated requests."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19884
- msgid "Defaults to @samp{Required}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19886
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} string default-language"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19888
- msgid "Specifies the default language to use for text and web content."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19890
- msgid "Defaults to @samp{\"en\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19892
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} string default-paper-size"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19897
- msgid "Specifies the default paper size for new print queues. @samp{\"Auto\"} uses a locale-specific default, while @samp{\"None\"} specifies there is no default paper size. Specific size names are typically @samp{\"Letter\"} or @samp{\"A4\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19899
- msgid "Defaults to @samp{\"Auto\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19901
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} string default-policy"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19903
- msgid "Specifies the default access policy to use."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19905
- msgid "Defaults to @samp{\"default\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19907
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} boolean default-shared?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19909
- msgid "Specifies whether local printers are shared by default."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19911 guix-git/doc/guix.texi:19991
- #: guix-git/doc/guix.texi:20281 guix-git/doc/guix.texi:23067
- #: guix-git/doc/guix.texi:23118 guix-git/doc/guix.texi:23125
- #: guix-git/doc/guix.texi:24407 guix-git/doc/guix.texi:24595
- #: guix-git/doc/guix.texi:24712 guix-git/doc/guix.texi:24748
- #: guix-git/doc/guix.texi:24799 guix-git/doc/guix.texi:24818
- #: guix-git/doc/guix.texi:24828 guix-git/doc/guix.texi:24838
- #: guix-git/doc/guix.texi:24897 guix-git/doc/guix.texi:24919
- #: guix-git/doc/guix.texi:24944 guix-git/doc/guix.texi:24970
- #: guix-git/doc/guix.texi:24988 guix-git/doc/guix.texi:28180
- #: guix-git/doc/guix.texi:28208 guix-git/doc/guix.texi:28344
- #: guix-git/doc/guix.texi:28351 guix-git/doc/guix.texi:28359
- #: guix-git/doc/guix.texi:28396 guix-git/doc/guix.texi:28410
- #: guix-git/doc/guix.texi:28499 guix-git/doc/guix.texi:28506
- #: guix-git/doc/guix.texi:28514 guix-git/doc/guix.texi:29293
- #: guix-git/doc/guix.texi:29433 guix-git/doc/guix.texi:29619
- #: guix-git/doc/guix.texi:29626 guix-git/doc/guix.texi:29648
- #: guix-git/doc/guix.texi:29687 guix-git/doc/guix.texi:29707
- #: guix-git/doc/guix.texi:29721 guix-git/doc/guix.texi:29934
- #: guix-git/doc/guix.texi:31845 guix-git/doc/guix.texi:31933
- #: guix-git/doc/guix.texi:31949 guix-git/doc/guix.texi:31999
- msgid "Defaults to @samp{#t}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19913
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} non-negative-integer dirty-clean-interval"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19917
- msgid "Specifies the delay for updating of configuration and state files, in seconds. A value of 0 causes the update to happen as soon as possible, typically within a few milliseconds."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19919 guix-git/doc/guix.texi:19967
- #: guix-git/doc/guix.texi:19976 guix-git/doc/guix.texi:20288
- #: guix-git/doc/guix.texi:24757 guix-git/doc/guix.texi:24790
- msgid "Defaults to @samp{30}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19921
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} error-policy error-policy"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19927
- msgid "Specifies what to do when an error occurs. Possible values are @code{abort-job}, which will discard the failed print job; @code{retry-job}, which will retry the job at a later time; @code{retry-current-job}, which retries the failed job immediately; and @code{stop-printer}, which stops the printer."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19929
- msgid "Defaults to @samp{stop-printer}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19931
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} non-negative-integer filter-limit"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19939
- msgid "Specifies the maximum cost of filters that are run concurrently, which can be used to minimize disk, memory, and CPU resource problems. A limit of 0 disables filter limiting. An average print to a non-PostScript printer needs a filter limit of about 200. A PostScript printer needs about half that (100). Setting the limit below these thresholds will effectively limit the scheduler to printing a single job at any time."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19941 guix-git/doc/guix.texi:19949
- #: guix-git/doc/guix.texi:19998 guix-git/doc/guix.texi:20114
- #: guix-git/doc/guix.texi:20128 guix-git/doc/guix.texi:20135
- #: guix-git/doc/guix.texi:21622 guix-git/doc/guix.texi:21638
- #: guix-git/doc/guix.texi:22295 guix-git/doc/guix.texi:22307
- #: guix-git/doc/guix.texi:23086 guix-git/doc/guix.texi:23095
- #: guix-git/doc/guix.texi:23103 guix-git/doc/guix.texi:23111
- #: guix-git/doc/guix.texi:29309 guix-git/doc/guix.texi:29634
- #: guix-git/doc/guix.texi:31838 guix-git/doc/guix.texi:32138
- #: guix-git/doc/guix.texi:32312
- msgid "Defaults to @samp{0}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19943
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} non-negative-integer filter-nice"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19947
- msgid "Specifies the scheduling priority of filters that are run to print a job. The nice value ranges from 0, the highest priority, to 19, the lowest priority."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19951
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} host-name-lookups host-name-lookups"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19958
- msgid "Specifies whether to do reverse lookups on connecting clients. The @code{double} setting causes @code{cupsd} to verify that the hostname resolved from the address matches one of the addresses returned for that hostname. Double lookups also prevent clients with unregistered addresses from connecting to your server. Only set this option to @code{#t} or @code{double} if absolutely required."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19962
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} non-negative-integer job-kill-delay"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19965
- msgid "Specifies the number of seconds to wait before killing the filters and backend associated with a canceled or held job."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19969
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} non-negative-integer job-retry-interval"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19974
- msgid "Specifies the interval between retries of jobs in seconds. This is typically used for fax queues but can also be used with normal print queues whose error policy is @code{retry-job} or @code{retry-current-job}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19978
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} non-negative-integer job-retry-limit"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19983
- msgid "Specifies the number of retries that are done for jobs. This is typically used for fax queues but can also be used with normal print queues whose error policy is @code{retry-job} or @code{retry-current-job}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19985 guix-git/doc/guix.texi:24721
- #: guix-git/doc/guix.texi:30186 guix-git/doc/guix.texi:30206
- #: guix-git/doc/guix.texi:30222 guix-git/doc/guix.texi:30236
- #: guix-git/doc/guix.texi:30243 guix-git/doc/guix.texi:30250
- #: guix-git/doc/guix.texi:30257 guix-git/doc/guix.texi:30417
- #: guix-git/doc/guix.texi:30433 guix-git/doc/guix.texi:30440
- #: guix-git/doc/guix.texi:30447 guix-git/doc/guix.texi:30458
- #: guix-git/doc/guix.texi:31790 guix-git/doc/guix.texi:31798
- #: guix-git/doc/guix.texi:31806 guix-git/doc/guix.texi:31830
- msgid "Defaults to @samp{5}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19987
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} boolean keep-alive?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19989
- msgid "Specifies whether to support HTTP keep-alive connections."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19993
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} non-negative-integer limit-request-body"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:19996
- msgid "Specifies the maximum size of print files, IPP requests, and HTML form data. A limit of 0 disables the limit check."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20000
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} multiline-string-list listen"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20007
- msgid "Listens on the specified interfaces for connections. Valid values are of the form @var{address}:@var{port}, where @var{address} is either an IPv6 address enclosed in brackets, an IPv4 address, or @code{*} to indicate all addresses. Values can also be file names of local UNIX domain sockets. The Listen directive is similar to the Port directive but allows you to restrict access to specific interfaces or networks."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20009
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} non-negative-integer listen-back-log"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20016
- msgid "Specifies the number of pending connections that will be allowed. This normally only affects very busy servers that have reached the MaxClients limit, but can also be triggered by large numbers of simultaneous connections. When the limit is reached, the operating system will refuse additional connections until the scheduler can accept the pending ones."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20018
- msgid "Defaults to @samp{128}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20020
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} location-access-control-list location-access-controls"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20022
- msgid "Specifies a set of additional access controls."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20024
- msgid "Available @code{location-access-controls} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20025
- #, no-wrap
- msgid "{@code{location-access-controls} parameter} file-name path"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20027
- msgid "Specifies the URI path to which the access control applies."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20029
- #, no-wrap
- msgid "{@code{location-access-controls} parameter} access-control-list access-controls"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20032
- msgid "Access controls for all access to this path, in the same format as the @code{access-controls} of @code{operation-access-control}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20034 guix-git/doc/guix.texi:20040
- #: guix-git/doc/guix.texi:20054 guix-git/doc/guix.texi:20061
- #: guix-git/doc/guix.texi:20203 guix-git/doc/guix.texi:20262
- #: guix-git/doc/guix.texi:20340 guix-git/doc/guix.texi:20354
- #: guix-git/doc/guix.texi:21502 guix-git/doc/guix.texi:21511
- #: guix-git/doc/guix.texi:22781 guix-git/doc/guix.texi:22984
- #: guix-git/doc/guix.texi:23012 guix-git/doc/guix.texi:23042
- #: guix-git/doc/guix.texi:23157 guix-git/doc/guix.texi:23170
- #: guix-git/doc/guix.texi:23177 guix-git/doc/guix.texi:24927
- #: guix-git/doc/guix.texi:25322 guix-git/doc/guix.texi:25426
- #: guix-git/doc/guix.texi:25853 guix-git/doc/guix.texi:25861
- #: guix-git/doc/guix.texi:26106 guix-git/doc/guix.texi:28239
- #: guix-git/doc/guix.texi:28417 guix-git/doc/guix.texi:28616
- #: guix-git/doc/guix.texi:30077 guix-git/doc/guix.texi:30137
- #: guix-git/doc/guix.texi:30145 guix-git/doc/guix.texi:31853
- #: guix-git/doc/guix.texi:31860 guix-git/doc/guix.texi:32202
- #: guix-git/doc/guix.texi:32280 guix-git/doc/guix.texi:32374
- #: guix-git/doc/guix.texi:32382 guix-git/doc/guix.texi:32418
- #: guix-git/doc/guix.texi:32568 guix-git/doc/guix.texi:32619
- #: guix-git/doc/guix.texi:32628
- msgid "Defaults to @samp{()}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20036
- #, no-wrap
- msgid "{@code{location-access-controls} parameter} method-access-control-list method-access-controls"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20038
- msgid "Access controls for method-specific access to this path."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20042
- msgid "Available @code{method-access-controls} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20043
- #, no-wrap
- msgid "{@code{method-access-controls} parameter} boolean reverse?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20046
- msgid "If @code{#t}, apply access controls to all methods except the listed methods. Otherwise apply to only the listed methods."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20050
- #, no-wrap
- msgid "{@code{method-access-controls} parameter} method-list methods"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20052
- msgid "Methods to which this access control applies."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20056
- #, no-wrap
- msgid "{@code{method-access-controls} parameter} access-control-list access-controls"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20059
- msgid "Access control directives, as a list of strings. Each string should be one directive, such as @samp{\"Order allow,deny\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20065
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} non-negative-integer log-debug-history"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20069
- msgid "Specifies the number of debugging messages that are retained for logging if an error occurs in a print job. Debug messages are logged regardless of the LogLevel setting."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20071 guix-git/doc/guix.texi:20092
- #: guix-git/doc/guix.texi:20099 guix-git/doc/guix.texi:22541
- #: guix-git/doc/guix.texi:24459 guix-git/doc/guix.texi:24474
- #: guix-git/doc/guix.texi:28601
- msgid "Defaults to @samp{100}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20073
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} log-level log-level"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20076
- msgid "Specifies the level of logging for the ErrorLog file. The value @code{none} stops all logging while @code{debug2} logs everything."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20078 guix-git/doc/guix.texi:24936
- msgid "Defaults to @samp{info}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20080
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} log-time-format log-time-format"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20083
- msgid "Specifies the format of the date and time in the log files. The value @code{standard} logs whole seconds while @code{usecs} logs microseconds."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20085
- msgid "Defaults to @samp{standard}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20087
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} non-negative-integer max-clients"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20090
- msgid "Specifies the maximum number of simultaneous clients that are allowed by the scheduler."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20094
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} non-negative-integer max-clients-per-host"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20097
- msgid "Specifies the maximum number of simultaneous clients that are allowed from a single address."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20101
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} non-negative-integer max-copies"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20104
- msgid "Specifies the maximum number of copies that a user can print of each job."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20106
- msgid "Defaults to @samp{9999}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20108
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} non-negative-integer max-hold-time"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20112
- msgid "Specifies the maximum time a job may remain in the @code{indefinite} hold state before it is canceled. A value of 0 disables cancellation of held jobs."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20116
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} non-negative-integer max-jobs"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20119
- msgid "Specifies the maximum number of simultaneous jobs that are allowed. Set to 0 to allow an unlimited number of jobs."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20121
- msgid "Defaults to @samp{500}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20123
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} non-negative-integer max-jobs-per-printer"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20126
- msgid "Specifies the maximum number of simultaneous jobs that are allowed per printer. A value of 0 allows up to MaxJobs jobs per printer."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20130
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} non-negative-integer max-jobs-per-user"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20133
- msgid "Specifies the maximum number of simultaneous jobs that are allowed per user. A value of 0 allows up to MaxJobs jobs per user."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20137
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} non-negative-integer max-job-time"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20140
- msgid "Specifies the maximum time a job may take to print before it is canceled, in seconds. Set to 0 to disable cancellation of ``stuck'' jobs."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20142
- msgid "Defaults to @samp{10800}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20144
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} non-negative-integer max-log-size"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20147
- msgid "Specifies the maximum size of the log files before they are rotated, in bytes. The value 0 disables log rotation."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20149
- msgid "Defaults to @samp{1048576}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20151
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} non-negative-integer multiple-operation-timeout"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20154
- msgid "Specifies the maximum amount of time to allow between files in a multiple file print job, in seconds."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20156 guix-git/doc/guix.texi:20367
- msgid "Defaults to @samp{900}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20158
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} string page-log-format"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20163
- msgid "Specifies the format of PageLog lines. Sequences beginning with percent (@samp{%}) characters are replaced with the corresponding information, while all other characters are copied literally. The following percent sequences are recognized:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20165
- #, no-wrap
- msgid "%%"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20167
- msgid "insert a single percent character"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20168
- #, no-wrap
- msgid "%@{name@}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20170
- msgid "insert the value of the specified IPP attribute"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20171
- #, no-wrap
- msgid "%C"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20173
- msgid "insert the number of copies for the current page"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20174
- #, no-wrap
- msgid "%P"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20176
- msgid "insert the current page number"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20177
- #, no-wrap
- msgid "%T"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20179
- msgid "insert the current date and time in common log format"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20180
- #, no-wrap
- msgid "%j"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20182
- msgid "insert the job ID"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20183 guix-git/doc/guix.texi:22140
- #, no-wrap
- msgid "%p"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20185
- msgid "insert the printer name"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20186 guix-git/doc/guix.texi:22163
- #, no-wrap
- msgid "%u"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20188
- msgid "insert the username"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20194
- msgid "A value of the empty string disables page logging. The string @code{%p %u %j %T %P %C %@{job-billing@} %@{job-originating-host-name@} %@{job-name@} %@{media@} %@{sides@}} creates a page log with the standard items."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20198
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} environment-variables environment-variables"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20201
- msgid "Passes the specified environment variable(s) to child processes; a list of strings."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20205
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} policy-configuration-list policies"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20207
- msgid "Specifies named access control policies."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20209
- msgid "Available @code{policy-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20210
- #, no-wrap
- msgid "{@code{policy-configuration} parameter} string name"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20212
- msgid "Name of the policy."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20214
- #, no-wrap
- msgid "{@code{policy-configuration} parameter} string job-private-access"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20224
- msgid "Specifies an access list for a job's private values. @code{@@ACL} maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values. @code{@@OWNER} maps to the job's owner. @code{@@SYSTEM} maps to the groups listed for the @code{system-group} field of the @code{files-configuration}, which is reified into the @code{cups-files.conf(5)} file. Other possible elements of the access list include specific user names, and @code{@@@var{group}} to indicate members of a specific group. The access list may also be simply @code{all} or @code{default}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20226 guix-git/doc/guix.texi:20248
- msgid "Defaults to @samp{\"@@OWNER @@SYSTEM\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20228
- #, no-wrap
- msgid "{@code{policy-configuration} parameter} string job-private-values"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20231 guix-git/doc/guix.texi:20253
- msgid "Specifies the list of job values to make private, or @code{all}, @code{default}, or @code{none}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20234
- msgid "Defaults to @samp{\"job-name job-originating-host-name job-originating-user-name phone\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20236
- #, no-wrap
- msgid "{@code{policy-configuration} parameter} string subscription-private-access"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20246
- msgid "Specifies an access list for a subscription's private values. @code{@@ACL} maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values. @code{@@OWNER} maps to the job's owner. @code{@@SYSTEM} maps to the groups listed for the @code{system-group} field of the @code{files-configuration}, which is reified into the @code{cups-files.conf(5)} file. Other possible elements of the access list include specific user names, and @code{@@@var{group}} to indicate members of a specific group. The access list may also be simply @code{all} or @code{default}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20250
- #, no-wrap
- msgid "{@code{policy-configuration} parameter} string subscription-private-values"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20256
- msgid "Defaults to @samp{\"notify-events notify-pull-method notify-recipient-uri notify-subscriber-user-name notify-user-data\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20258
- #, no-wrap
- msgid "{@code{policy-configuration} parameter} operation-access-control-list access-controls"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20260
- msgid "Access control by IPP operation."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20265
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} boolean-or-non-negative-integer preserve-job-files"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20270
- msgid "Specifies whether job files (documents) are preserved after a job is printed. If a numeric value is specified, job files are preserved for the indicated number of seconds after printing. Otherwise a boolean value applies indefinitely."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20272
- msgid "Defaults to @samp{86400}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20274
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} boolean-or-non-negative-integer preserve-job-history"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20279
- msgid "Specifies whether the job history is preserved after a job is printed. If a numeric value is specified, the job history is preserved for the indicated number of seconds after printing. If @code{#t}, the job history is preserved until the MaxJobs limit is reached."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20283
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} non-negative-integer reload-timeout"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20286
- msgid "Specifies the amount of time to wait for job completion before restarting the scheduler."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20290
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} string rip-cache"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20293
- msgid "Specifies the maximum amount of memory to use when converting documents into bitmaps for a printer."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20295
- msgid "Defaults to @samp{\"128m\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20297
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} string server-admin"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20299
- msgid "Specifies the email address of the server administrator."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20301
- msgid "Defaults to @samp{\"root@@localhost.localdomain\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20303
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} host-name-list-or-* server-alias"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20311
- msgid "The ServerAlias directive is used for HTTP Host header validation when clients connect to the scheduler from external interfaces. Using the special name @code{*} can expose your system to known browser-based DNS rebinding attacks, even when accessing sites through a firewall. If the auto-discovery of alternate names does not work, we recommend listing each alternate name with a ServerAlias directive instead of using @code{*}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20313
- msgid "Defaults to @samp{*}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20315
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} string server-name"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20317
- msgid "Specifies the fully-qualified host name of the server."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20319 guix-git/doc/guix.texi:25449
- #: guix-git/doc/guix.texi:25494
- msgid "Defaults to @samp{\"localhost\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20321
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} server-tokens server-tokens"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20329
- msgid "Specifies what information is included in the Server header of HTTP responses. @code{None} disables the Server header. @code{ProductOnly} reports @code{CUPS}. @code{Major} reports @code{CUPS 2}. @code{Minor} reports @code{CUPS 2.0}. @code{Minimal} reports @code{CUPS 2.0.0}. @code{OS} reports @code{CUPS 2.0.0 (@var{uname})} where @var{uname} is the output of the @code{uname} command. @code{Full} reports @code{CUPS 2.0.0 (@var{uname}) IPP/2.0}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20331
- msgid "Defaults to @samp{Minimal}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20333
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} multiline-string-list ssl-listen"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20338
- msgid "Listens on the specified interfaces for encrypted connections. Valid values are of the form @var{address}:@var{port}, where @var{address} is either an IPv6 address enclosed in brackets, an IPv4 address, or @code{*} to indicate all addresses."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20342
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} ssl-options ssl-options"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20352
- msgid "Sets encryption options. By default, CUPS only supports encryption using TLS v1.0 or higher using known secure cipher suites. Security is reduced when @code{Allow} options are used, and enhanced when @code{Deny} options are used. The @code{AllowRC4} option enables the 128-bit RC4 cipher suites, which are required for some older clients. The @code{AllowSSL3} option enables SSL v3.0, which is required for some older clients that do not support TLS v1.0. The @code{DenyCBC} option disables all CBC cipher suites. The @code{DenyTLS1.0} option disables TLS v1.0 support - this sets the minimum protocol version to TLS v1.1."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20356
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} boolean strict-conformance?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20359
- msgid "Specifies whether the scheduler requires clients to strictly adhere to the IPP specifications."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20363
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} non-negative-integer timeout"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20365
- msgid "Specifies the HTTP request timeout, in seconds."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20370
- #, no-wrap
- msgid "{@code{cups-configuration} parameter} boolean web-interface?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20372
- msgid "Specifies whether the web interface is enabled."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:20382
- msgid "At this point you're probably thinking ``oh dear, Guix manual, I like you but you can stop already with the configuration options''. Indeed. However, one more point: it could be that you have an existing @code{cupsd.conf} that you want to use. In that case, you can pass an @code{opaque-cups-configuration} as the configuration of a @code{cups-service-type}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:20384
- msgid "Available @code{opaque-cups-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20385
- #, no-wrap
- msgid "{@code{opaque-cups-configuration} parameter} package cups"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20389
- #, no-wrap
- msgid "{@code{opaque-cups-configuration} parameter} string cupsd.conf"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20391
- msgid "The contents of the @code{cupsd.conf}, as a string."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20393
- #, no-wrap
- msgid "{@code{opaque-cups-configuration} parameter} string cups-files.conf"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:20395
- msgid "The contents of the @code{cups-files.conf} file, as a string."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:20400
- msgid "For example, if your @code{cupsd.conf} and @code{cups-files.conf} are in strings of the same name, you could instantiate a CUPS service like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:20406
- #, no-wrap
- msgid ""
- "(service cups-service-type\n"
- " (opaque-cups-configuration\n"
- " (cupsd.conf cupsd.conf)\n"
- " (cups-files.conf cups-files.conf)))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:20417
- msgid "The @code{(gnu services desktop)} module provides services that are usually useful in the context of a ``desktop'' setup---that is, on a machine running a graphical display server, possibly with graphical user interfaces, etc. It also defines services that provide specific desktop environments like GNOME, Xfce or MATE."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:20421
- msgid "To simplify things, the module defines a variable containing the set of services that users typically expect on a machine with a graphical environment and networking:"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:20422
- #, no-wrap
- msgid "{Scheme Variable} %desktop-services"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:20425
- msgid "This is a list of services that builds upon @code{%base-services} and adds or adjusts services for a typical ``desktop'' setup."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:20436
- msgid "In particular, it adds a graphical login manager (@pxref{X Window, @code{gdm-service-type}}), screen lockers, a network management tool (@pxref{Networking Services, @code{network-manager-service-type}}) with modem support (@pxref{Networking Services, @code{modem-manager-service-type}}), energy and color management services, the @code{elogind} login and seat manager, the Polkit privilege service, the GeoClue location service, the AccountsService daemon that allows authorized users change system passwords, an NTP client (@pxref{Networking Services}), the Avahi daemon, and has the name service switch service configured to be able to use @code{nss-mdns} (@pxref{Name Service Switch, mDNS})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:20441
- msgid "The @code{%desktop-services} variable can be used as the @code{services} field of an @code{operating-system} declaration (@pxref{operating-system Reference, @code{services}})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:20464
- msgid "Additionally, the @code{gnome-desktop-service-type}, @code{xfce-desktop-service}, @code{mate-desktop-service-type}, @code{lxqt-desktop-service-type} and @code{enlightenment-desktop-service-type} procedures can add GNOME, Xfce, MATE and/or Enlightenment to a system. To ``add GNOME'' means that system-level services like the backlight adjustment helpers and the power management utilities are added to the system, extending @code{polkit} and @code{dbus} appropriately, allowing GNOME to operate with elevated privileges on a limited number of special-purpose system interfaces. Additionally, adding a service made by @code{gnome-desktop-service-type} adds the GNOME metapackage to the system profile. Likewise, adding the Xfce service not only adds the @code{xfce} metapackage to the system profile, but it also gives the Thunar file manager the ability to open a ``root-mode'' file management window, if the user authenticates using the administrator's password via the standard polkit graphical interface. To ``add MATE'' means that @code{polkit} and @code{dbus} are extended appropriately, allowing MATE to operate with elevated privileges on a limited number of special-purpose system interfaces. Additionally, adding a service of type @code{mate-desktop-service-type} adds the MATE metapackage to the system profile. ``Adding Enlightenment'' means that @code{dbus} is extended appropriately, and several of Enlightenment's binaries are set as setuid, allowing Enlightenment's screen locker and other functionality to work as expected."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:20474
- msgid "The desktop environments in Guix use the Xorg display server by default. If you'd like to use the newer display server protocol called Wayland, you need to enable Wayland support in GDM (@pxref{wayland-gdm}). Another solution is to use the @code{sddm-service} instead of GDM as the graphical login manager. You should then select the ``GNOME (Wayland)'' session in SDDM@. Alternatively you can also try starting GNOME on Wayland manually from a TTY with the command ``XDG_SESSION_TYPE=wayland exec dbus-run-session gnome-session``. Currently only GNOME has support for Wayland."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:20475
- #, no-wrap
- msgid "{Scheme Variable} gnome-desktop-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:20479
- msgid "This is the type of the service that adds the @uref{https://www.gnome.org, GNOME} desktop environment. Its value is a @code{gnome-desktop-configuration} object (see below)."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:20482
- msgid "This service adds the @code{gnome} package to the system profile, and extends polkit with the actions from @code{gnome-settings-daemon}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:20484
- #, no-wrap
- msgid "{Data Type} gnome-desktop-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:20486
- msgid "Configuration record for the GNOME desktop environment."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20488
- #, no-wrap
- msgid "@code{gnome} (default: @code{gnome})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20490
- msgid "The GNOME package to use."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:20493
- #, no-wrap
- msgid "{Scheme Variable} xfce-desktop-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:20497
- msgid "This is the type of a service to run the @uref{Xfce, https://xfce.org/} desktop environment. Its value is an @code{xfce-desktop-configuration} object (see below)."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:20502
- msgid "This service adds the @code{xfce} package to the system profile, and extends polkit with the ability for @code{thunar} to manipulate the file system as root from within a user session, after the user has authenticated with the administrator's password."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:20508
- msgid "Note that @code{xfce4-panel} and its plugin packages should be installed in the same profile to ensure compatibility. When using this service, you should add extra plugins (@code{xfce4-whiskermenu-plugin}, @code{xfce4-weather-plugin}, etc.) to the @code{packages} field of your @code{operating-system}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:20510
- #, no-wrap
- msgid "{Data Type} xfce-desktop-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:20512
- msgid "Configuration record for the Xfce desktop environment."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20514
- #, no-wrap
- msgid "@code{xfce} (default: @code{xfce})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20516
- msgid "The Xfce package to use."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20519
- #, no-wrap
- msgid "{Scheme Variable} mate-desktop-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20523
- msgid "This is the type of the service that runs the @uref{https://mate-desktop.org/, MATE desktop environment}. Its value is a @code{mate-desktop-configuration} object (see below)."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20527
- msgid "This service adds the @code{mate} package to the system profile, and extends polkit with the actions from @code{mate-settings-daemon}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:20529
- #, no-wrap
- msgid "{Data Type} mate-desktop-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:20531
- msgid "Configuration record for the MATE desktop environment."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20533
- #, no-wrap
- msgid "@code{mate} (default: @code{mate})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20535
- msgid "The MATE package to use."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20538
- #, no-wrap
- msgid "{Scheme Variable} lxqt-desktop-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20542
- msgid "This is the type of the service that runs the @uref{https://lxqt-project.org, LXQt desktop environment}. Its value is a @code{lxqt-desktop-configuration} object (see below)."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20545
- msgid "This service adds the @code{lxqt} package to the system profile."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:20547
- #, no-wrap
- msgid "{Data Type} lxqt-desktop-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:20549
- msgid "Configuration record for the LXQt desktop environment."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20551
- #, no-wrap
- msgid "@code{lxqt} (default: @code{lxqt})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20553
- msgid "The LXQT package to use."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20556
- #, no-wrap
- msgid "{Scheme Variable} enlightenment-desktop-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20559
- msgid "Return a service that adds the @code{enlightenment} package to the system profile, and extends dbus with actions from @code{efl}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:20561
- #, no-wrap
- msgid "{Data Type} enlightenment-desktop-service-configuration"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20563
- #, no-wrap
- msgid "@code{enlightenment} (default: @code{enlightenment})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20565
- msgid "The enlightenment package to use."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:20573
- msgid "Because the GNOME, Xfce and MATE desktop services pull in so many packages, the default @code{%desktop-services} variable doesn't include any of them by default. To add GNOME, Xfce or MATE, just @code{cons} them onto @code{%desktop-services} in the @code{services} field of your @code{operating-system}:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:20584
- #, no-wrap
- msgid ""
- "(use-modules (gnu))\n"
- "(use-service-modules desktop)\n"
- "(operating-system\n"
- " ...\n"
- " ;; cons* adds items to the list given as its last argument.\n"
- " (services (cons* (service gnome-desktop-service-type)\n"
- " (service xfce-desktop-service)\n"
- " %desktop-services))\n"
- " ...)\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:20588
- msgid "These desktop environments will then be available as options in the graphical login window."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:20592
- msgid "The actual service definitions included in @code{%desktop-services} and provided by @code{(gnu services dbus)} and @code{(gnu services desktop)} are described below."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20593
- #, no-wrap
- msgid "{Scheme Procedure} dbus-service [#:dbus @var{dbus}] [#:services '()]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20596
- msgid "Return a service that runs the ``system bus'', using @var{dbus}, with support for @var{services}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20600
- msgid "@uref{https://dbus.freedesktop.org/, D-Bus} is an inter-process communication facility. Its system bus is used to allow system services to communicate and to be notified of system-wide events."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20605
- msgid "@var{services} must be a list of packages that provide an @file{etc/dbus-1/system.d} directory containing additional D-Bus configuration and policy files. For example, to allow avahi-daemon to use the system bus, @var{services} must be equal to @code{(list avahi)}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20607
- #, no-wrap
- msgid "{Scheme Procedure} elogind-service [#:config @var{config}]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20613
- msgid "Return a service that runs the @code{elogind} login and seat management daemon. @uref{https://github.com/elogind/elogind, Elogind} exposes a D-Bus interface that can be used to know which users are logged in, know what kind of sessions they have open, suspend the system, inhibit system suspend, reboot the system, and other tasks."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20617
- msgid "Elogind handles most system-level power events for a computer, for example suspending the system when a lid is closed, or shutting it down when the power button is pressed."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20622
- msgid "The @var{config} keyword argument specifies the configuration for elogind, and should be the result of an @code{(elogind-configuration (@var{parameter} @var{value})...)} invocation. Available parameters and their default values are:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20624
- #, no-wrap
- msgid "kill-user-processes?"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:20626 guix-git/doc/guix.texi:20646
- #: guix-git/doc/guix.texi:20648 guix-git/doc/guix.texi:20650
- #: guix-git/doc/guix.texi:20662
- msgid "#f"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20626
- #, no-wrap
- msgid "kill-only-users"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:20628 guix-git/doc/guix.texi:20668
- msgid "()"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20628
- #, no-wrap
- msgid "kill-exclude-users"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:20630
- msgid "(\"root\")"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20630
- #, no-wrap
- msgid "inhibit-delay-max-seconds"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:20632
- msgid "5"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20632
- #, no-wrap
- msgid "handle-power-key"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:20634
- msgid "poweroff"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20634
- #, no-wrap
- msgid "handle-suspend-key"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:20636 guix-git/doc/guix.texi:20640
- msgid "suspend"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20636
- #, no-wrap
- msgid "handle-hibernate-key"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:20638
- msgid "hibernate"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20638
- #, no-wrap
- msgid "handle-lid-switch"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20640
- #, no-wrap
- msgid "handle-lid-switch-docked"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:20642 guix-git/doc/guix.texi:20644
- #: guix-git/doc/guix.texi:20656
- msgid "ignore"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20642
- #, no-wrap
- msgid "handle-lid-switch-external-power"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20644
- #, no-wrap
- msgid "power-key-ignore-inhibited?"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20646
- #, no-wrap
- msgid "suspend-key-ignore-inhibited?"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20648
- #, no-wrap
- msgid "hibernate-key-ignore-inhibited?"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20650
- #, no-wrap
- msgid "lid-switch-ignore-inhibited?"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:20652 guix-git/doc/guix.texi:20664
- msgid "#t"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20652
- #, no-wrap
- msgid "holdoff-timeout-seconds"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:20654
- msgid "30"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20654
- #, no-wrap
- msgid "idle-action"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20656
- #, no-wrap
- msgid "idle-action-seconds"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:20658
- msgid "(* 30 60)"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20658
- #, no-wrap
- msgid "runtime-directory-size-percent"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:20660
- msgid "10"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20660
- #, no-wrap
- msgid "runtime-directory-size"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20662
- #, no-wrap
- msgid "remove-ipc?"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20664
- #, no-wrap
- msgid "suspend-state"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:20666
- msgid "(\"mem\" \"standby\" \"freeze\")"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20666
- #, no-wrap
- msgid "suspend-mode"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20668
- #, no-wrap
- msgid "hibernate-state"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:20670 guix-git/doc/guix.texi:20674
- msgid "(\"disk\")"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20670
- #, no-wrap
- msgid "hibernate-mode"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:20672
- msgid "(\"platform\" \"shutdown\")"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20672
- #, no-wrap
- msgid "hybrid-sleep-state"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20674
- #, no-wrap
- msgid "hybrid-sleep-mode"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:20676
- msgid "(\"suspend\" \"platform\" \"shutdown\")"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20679
- #, no-wrap
- msgid "{Scheme Procedure} accountsservice-service @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20687
- msgid "[#:accountsservice @var{accountsservice}] Return a service that runs AccountsService, a system service that can list available accounts, change their passwords, and so on. AccountsService integrates with PolicyKit to enable unprivileged users to acquire the capability to modify their system configuration. @uref{https://www.freedesktop.org/wiki/Software/AccountsService/, the accountsservice web site} for more information."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20690
- msgid "The @var{accountsservice} keyword argument is the @code{accountsservice} package to expose as a service."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20692
- #, no-wrap
- msgid "{Scheme Procedure} polkit-service @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20701
- msgid "[#:polkit @var{polkit}] Return a service that runs the @uref{https://www.freedesktop.org/wiki/Software/polkit/, Polkit privilege management service}, which allows system administrators to grant access to privileged operations in a structured way. By querying the Polkit service, a privileged system component can know when it should grant additional capabilities to ordinary users. For example, an ordinary user can be granted the capability to suspend the system if the user is logged in locally."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:20703
- #, no-wrap
- msgid "{Scheme Variable} polkit-wheel-service"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:20708
- msgid "Service that adds the @code{wheel} group as admins to the Polkit service. This makes it so that users in the @code{wheel} group are queried for their own passwords when performing administrative actions instead of @code{root}'s, similar to the behaviour used by @code{sudo}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:20710
- #, no-wrap
- msgid "{Scheme Variable} upower-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:20714
- msgid "Service that runs @uref{https://upower.freedesktop.org/, @command{upowerd}}, a system-wide monitor for power consumption and battery levels, with the given configuration settings."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:20717
- msgid "It implements the @code{org.freedesktop.UPower} D-Bus interface, and is notably used by GNOME."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:20719
- #, no-wrap
- msgid "{Data Type} upower-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:20721
- msgid "Data type representation the configuration for UPower."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20724
- #, no-wrap
- msgid "@code{upower} (default: @var{upower})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20726
- msgid "Package to use for @code{upower}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20727
- #, no-wrap
- msgid "@code{watts-up-pro?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20729
- msgid "Enable the Watts Up Pro device."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20730
- #, no-wrap
- msgid "@code{poll-batteries?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20732
- msgid "Enable polling the kernel for battery level changes."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20733
- #, no-wrap
- msgid "@code{ignore-lid?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20735
- msgid "Ignore the lid state, this can be useful if it's incorrect on a device."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20736
- #, no-wrap
- msgid "@code{use-percentage-for-policy?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20739
- msgid "Whether battery percentage based policy should be used. The default is to use the time left, change to @code{#t} to use the percentage."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20740
- #, no-wrap
- msgid "@code{percentage-low} (default: @code{10})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20743
- msgid "When @code{use-percentage-for-policy?} is @code{#t}, this sets the percentage at which the battery is considered low."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20744
- #, no-wrap
- msgid "@code{percentage-critical} (default: @code{3})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20747
- msgid "When @code{use-percentage-for-policy?} is @code{#t}, this sets the percentage at which the battery is considered critical."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20748
- #, no-wrap
- msgid "@code{percentage-action} (default: @code{2})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20751
- msgid "When @code{use-percentage-for-policy?} is @code{#t}, this sets the percentage at which action will be taken."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20752
- #, no-wrap
- msgid "@code{time-low} (default: @code{1200})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20755
- msgid "When @code{use-time-for-policy?} is @code{#f}, this sets the time remaining in seconds at which the battery is considered low."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20756
- #, no-wrap
- msgid "@code{time-critical} (default: @code{300})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20759
- msgid "When @code{use-time-for-policy?} is @code{#f}, this sets the time remaining in seconds at which the battery is considered critical."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20760
- #, no-wrap
- msgid "@code{time-action} (default: @code{120})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20763
- msgid "When @code{use-time-for-policy?} is @code{#f}, this sets the time remaining in seconds at which action will be taken."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20764
- #, no-wrap
- msgid "@code{critical-power-action} (default: @code{'hybrid-sleep})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20767
- msgid "The action taken when @code{percentage-action} or @code{time-action} is reached (depending on the configuration of @code{use-percentage-for-policy?})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20769
- msgid "Possible values are:"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:20773
- msgid "'power-off"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:20776
- msgid "'hibernate"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:20779
- msgid "@code{'hybrid-sleep}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20784
- #, no-wrap
- msgid "{Scheme Procedure} udisks-service [#:udisks @var{udisks}]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20794
- msgid "Return a service for @uref{https://udisks.freedesktop.org/docs/latest/, UDisks}, a @dfn{disk management} daemon that provides user interfaces with notifications and ways to mount/unmount disks. Programs that talk to UDisks include the @command{udisksctl} command, part of UDisks, and GNOME Disks. Note that Udisks relies on the @command{mount} command, so it will only be able to use the file-system utilities installed in the system profile. For example if you want to be able to mount NTFS file-systems in read and write fashion, you'll need to have @code{ntfs-3g} installed system-wide."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20796
- #, no-wrap
- msgid "{Scheme Variable} colord-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20803
- msgid "This is the type of the service that runs @command{colord}, a system service with a D-Bus interface to manage the color profiles of input and output devices such as screens and scanners. It is notably used by the GNOME Color Manager graphical tool. See @uref{https://www.freedesktop.org/software/colord/, the colord web site} for more information."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:20805
- #, no-wrap
- msgid "scanner access"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:20806
- #, no-wrap
- msgid "{Scheme Variable} sane-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:20812
- msgid "This service provides access to scanners @i{via} @uref{http://www.sane-project.org, SANE} by installing the necessary udev rules. It is included in @code{%desktop-services} (@pxref{Desktop Services}) and relies by default on @code{sane-backends-minimal} package (see below) for hardware support."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:20814
- #, no-wrap
- msgid "{Scheme Variable} sane-backends-minimal"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:20817
- msgid "The default package which the @code{sane-service-type} installs. It supports many recent scanners."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:20819
- #, no-wrap
- msgid "{Scheme Variable} sane-backends"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:20826
- msgid "This package includes support for all scanners that @code{sane-backends-minimal} supports, plus older Hewlett-Packard scanners supported by @code{hplip} package. In order to use this on a system which relies on @code{%desktop-services}, you may use @code{modify-services} (@pxref{Service Reference, @code{modify-services}}) as illustrated below:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:20835
- #, no-wrap
- msgid ""
- "(use-modules (gnu))\n"
- "(use-service-modules\n"
- " @dots{}\n"
- " desktop)\n"
- "(use-package-modules\n"
- " @dots{}\n"
- " scanner)\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:20840
- #, no-wrap
- msgid ""
- "(define %my-desktop-services\n"
- " ;; List of desktop services that supports a broader range of scanners.\n"
- " (modify-services %desktop-services\n"
- " (sane-service-type _ => sane-backends)))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:20844
- #, no-wrap
- msgid ""
- "(operating-system\n"
- " @dots{}\n"
- " (services %my-desktop-services))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20847
- #, no-wrap
- msgid "{Scheme Procedure} geoclue-application name [#:allowed? #t] [#:system? #f] [#:users '()]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20856
- msgid "Return a configuration allowing an application to access GeoClue location data. @var{name} is the Desktop ID of the application, without the @code{.desktop} part. If @var{allowed?} is true, the application will have access to location information by default. The boolean @var{system?} value indicates whether an application is a system component or not. Finally @var{users} is a list of UIDs of all users for which this application is allowed location info access. An empty users list means that all users are allowed."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:20858
- #, no-wrap
- msgid "{Scheme Variable} %standard-geoclue-applications"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:20865
- msgid "The standard list of well-known GeoClue application configurations, granting authority to the GNOME date-and-time utility to ask for the current location in order to set the time zone, and allowing the IceCat and Epiphany web browsers to request location information. IceCat and Epiphany both query the user before allowing a web page to know the user's location."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20867
- #, no-wrap
- msgid "{Scheme Procedure} geoclue-service [#:colord @var{colord}] @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20880
- msgid "[#:whitelist '()] @ [#:wifi-geolocation-url \"https://location.services.mozilla.com/v1/geolocate?key=geoclue\"] @ [#:submit-data? #f] [#:wifi-submission-url \"https://location.services.mozilla.com/v1/submit?key=geoclue\"] @ [#:submission-nick \"geoclue\"] @ [#:applications %standard-geoclue-applications] Return a service that runs the GeoClue location service. This service provides a D-Bus interface to allow applications to request access to a user's physical location, and optionally to add information to online location databases. See @uref{https://wiki.freedesktop.org/www/Software/GeoClue/, the GeoClue web site} for more information."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20882
- #, no-wrap
- msgid "{Scheme Procedure} bluetooth-service [#:bluez @var{bluez}] @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20889
- msgid "[@w{#:auto-enable? #f}] Return a service that runs the @command{bluetoothd} daemon, which manages all the Bluetooth devices and provides a number of D-Bus interfaces. When AUTO-ENABLE? is true, the bluetooth controller is powered automatically at boot, which can be useful when using a bluetooth keyboard or mouse."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20891
- msgid "Users need to be in the @code{lp} group to access the D-Bus service."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:20893
- #, no-wrap
- msgid "{Scheme Variable} gnome-keyring-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:20897
- msgid "This is the type of the service that adds the @uref{https://wiki.gnome.org/Projects/GnomeKeyring, GNOME Keyring}. Its value is a @code{gnome-keyring-configuration} object (see below)."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:20901
- msgid "This service adds the @code{gnome-keyring} package to the system profile and extends PAM with entries using @code{pam_gnome_keyring.so}, unlocking a user's login keyring when they log in or setting its password with passwd."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:20903
- #, no-wrap
- msgid "{Data Type} gnome-keyring-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:20905
- msgid "Configuration record for the GNOME Keyring service."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20907
- #, no-wrap
- msgid "@code{keyring} (default: @code{gnome-keyring})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20909
- msgid "The GNOME keyring package to use."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:20910
- #, no-wrap
- msgid "pam-services"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20915
- msgid "A list of @code{(@var{service} . @var{kind})} pairs denoting PAM services to extend, where @var{service} is the name of an existing service to extend and @var{kind} is one of @code{login} or @code{passwd}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20921
- msgid "If @code{login} is given, it adds an optional @code{pam_gnome_keyring.so} to the auth block without arguments and to the session block with @code{auto_start}. If @code{passwd} is given, it adds an optional @code{pam_gnome_keyring.so} to the password block without arguments."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20924
- msgid "By default, this field contains ``gdm-password'' with the value @code{login} and ``passwd'' is with the value @code{passwd}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:20931
- #, no-wrap
- msgid "sound support"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:20932
- #, no-wrap
- msgid "ALSA"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:20933
- #, no-wrap
- msgid "PulseAudio, sound support"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:20938
- msgid "The @code{(gnu services sound)} module provides a service to configure the Advanced Linux Sound Architecture (ALSA) system, which makes PulseAudio the preferred ALSA output driver."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20939
- #, no-wrap
- msgid "{Scheme Variable} alsa-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20944
- msgid "This is the type for the @uref{https://alsa-project.org/, Advanced Linux Sound Architecture} (ALSA) system, which generates the @file{/etc/asound.conf} configuration file. The value for this type is a @command{alsa-configuration} record as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:20947
- #, no-wrap
- msgid "(service alsa-service-type)\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:20950
- msgid "See below for details about @code{alsa-configuration}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:20952
- #, no-wrap
- msgid "{Data Type} alsa-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:20954
- msgid "Data type representing the configuration for @code{alsa-service}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20956
- #, no-wrap
- msgid "@code{alsa-plugins} (default: @var{alsa-plugins})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20958
- msgid "@code{alsa-plugins} package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20959
- #, no-wrap
- msgid "@code{pulseaudio?} (default: @var{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20962
- msgid "Whether ALSA applications should transparently be made to use the @uref{https://www.pulseaudio.org/, PulseAudio} sound server."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20966
- msgid "Using PulseAudio allows you to run several sound-producing applications at the same time and to individual control them @i{via} @command{pavucontrol}, among other things."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:20967
- #, no-wrap
- msgid "@code{extra-options} (default: @var{\"\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:20969
- msgid "String to append to the @file{/etc/asound.conf} file."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:20975
- msgid "Individual users who want to override the system configuration of ALSA can do it with the @file{~/.asoundrc} file:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:20981
- #, no-wrap
- msgid ""
- "# In guix, we have to specify the absolute path for plugins.\n"
- "pcm_type.jack @{\n"
- " lib \"/home/alice/.guix-profile/lib/alsa-lib/libasound_module_pcm_jack.so\"\n"
- "@}\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:20990
- #, no-wrap
- msgid ""
- "# Routing ALSA to jack:\n"
- "# <http://jackaudio.org/faq/routing_alsa.html>.\n"
- "pcm.rawjack @{\n"
- " type jack\n"
- " playback_ports @{\n"
- " 0 system:playback_1\n"
- " 1 system:playback_2\n"
- " @}\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:20996
- #, no-wrap
- msgid ""
- " capture_ports @{\n"
- " 0 system:capture_1\n"
- " 1 system:capture_2\n"
- " @}\n"
- "@}\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:21003
- #, no-wrap
- msgid ""
- "pcm.!default @{\n"
- " type plug\n"
- " slave @{\n"
- " pcm \"rawjack\"\n"
- " @}\n"
- "@}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:21007
- msgid "See @uref{https://www.alsa-project.org/main/index.php/Asoundrc} for the details."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:21008
- #, no-wrap
- msgid "{Scheme Variable} pulseaudio-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:21012
- msgid "This is the type for the @uref{https://www.pulseaudio.org/, PulseAudio} sound server. It exists to allow system overrides of the default settings via @code{pulseaudio-configuration}, see below."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:21018
- msgid "This service overrides per-user configuration files. If you want PulseAudio to honor configuration files in @file{~/.config/pulse} you have to unset the environment variables @env{PULSE_CONFIG} and @env{PULSE_CLIENTCONFIG} in your @file{~/.bash_profile}."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:21026
- msgid "This service on its own does not ensure, that the @code{pulseaudio} package exists on your machine. It merely adds configuration files for it, as detailed below. In the (admittedly unlikely) case, that you find yourself without a @code{pulseaudio} package, consider enabling it through the @code{alsa-service-type} above."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:21029
- #, no-wrap
- msgid "{Data Type} pulseaudio-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:21031
- msgid "Data type representing the configuration for @code{pulseaudio-service}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21033
- #, no-wrap
- msgid "@code{client-conf} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21038
- msgid "List of settings to set in @file{client.conf}. Accepts a list of strings or a symbol-value pairs. A string will be inserted as-is with a newline added. A pair will be formatted as ``key = value'', again with a newline added."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21039
- #, no-wrap
- msgid "@code{daemon-conf} (default: @code{'((flat-volumes . no))})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21042
- msgid "List of settings to set in @file{daemon.conf}, formatted just like @var{client-conf}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21043
- #, no-wrap
- msgid "@code{script-file} (default: @code{(file-append pulseaudio \"/etc/pulse/default.pa\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21045
- msgid "Script file to use as @file{default.pa}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21046
- #, no-wrap
- msgid "@code{system-script-file} (default: @code{(file-append pulseaudio \"/etc/pulse/system.pa\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21048
- msgid "Script file to use as @file{system.pa}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:21051
- #, no-wrap
- msgid "{Scheme Variable} ladspa-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:21054
- msgid "This service sets the @var{LADSPA_PATH} variable, so that programs, which respect it, e.g. PulseAudio, can load LADSPA plugins."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:21057
- msgid "The following example will setup the service to enable modules from the @code{swh-plugins} package:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:21061
- #, no-wrap
- msgid ""
- "(service ladspa-service-type\n"
- " (ladspa-configuration (plugins (list swh-plugins))))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:21065
- msgid "See @uref{http://plugin.org.uk/ladspa-swh/docs/ladspa-swh.html} for the details."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:21072
- #, no-wrap
- msgid "SQL"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:21074
- msgid "The @code{(gnu services databases)} module provides the following services."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:21075
- #, no-wrap
- msgid "PostgreSQL"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:21079
- msgid "The following example describes a PostgreSQL service with the default configuration."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:21084
- #, no-wrap
- msgid ""
- "(service postgresql-service-type\n"
- " (postgresql-configuration\n"
- " (postgresql postgresql-10)))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:21090
- msgid "If the services fails to start, it may be due to an incompatible cluster already present in @var{data-directory}. Adjust it (or, if you don't need the cluster anymore, delete @var{data-directory}), then restart the service."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:21097
- msgid "Peer authentication is used by default and the @code{postgres} user account has no shell, which prevents the direct execution of @code{psql} commands as this user. To use @code{psql}, you can temporarily log in as @code{postgres} using a shell, create a PostgreSQL superuser with the same name as one of the system users and then create the associated database."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:21102
- #, no-wrap
- msgid ""
- "sudo -u postgres -s /bin/sh\n"
- "createuser --interactive\n"
- "createdb $MY_USER_LOGIN # Replace appropriately.\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:21104
- #, no-wrap
- msgid "{Data Type} postgresql-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:21107
- msgid "Data type representing the configuration for the @code{postgresql-service-type}."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:21109
- #, no-wrap
- msgid "postgresql"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21111
- msgid "PostgreSQL package to use for the service."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21112
- #, no-wrap
- msgid "@code{port} (default: @code{5432})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21114
- msgid "Port on which PostgreSQL should listen."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21117
- msgid "Locale to use as the default when creating the database cluster."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21118
- #, no-wrap
- msgid "@code{config-file} (default: @code{(postgresql-config-file)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21122
- msgid "The configuration file to use when running PostgreSQL@. The default behaviour uses the postgresql-config-file record with the default values for the fields."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21123
- #, no-wrap
- msgid "@code{log-directory} (default: @code{\"/var/log/postgresql\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21127
- msgid "The directory where @command{pg_ctl} output will be written in a file named @code{\"pg_ctl.log\"}. This file can be useful to debug PostgreSQL configuration errors for instance."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21128
- #, no-wrap
- msgid "@code{data-directory} (default: @code{\"/var/lib/postgresql/data\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21130
- msgid "Directory in which to store the data."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21131
- #, no-wrap
- msgid "@code{extension-packages} (default: @code{'()})"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:21132
- #, no-wrap
- msgid "postgresql extension-packages"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21137
- msgid "Additional extensions are loaded from packages listed in @var{extension-packages}. Extensions are available at runtime. For instance, to create a geographic database using the @code{postgis} extension, a user can configure the postgresql-service as in this example:"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:21138
- #, no-wrap
- msgid "postgis"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:21141
- #, no-wrap
- msgid ""
- "(use-package-modules databases geo)\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:21154
- #, no-wrap
- msgid ""
- "(operating-system\n"
- " ...\n"
- " ;; postgresql is required to run `psql' but postgis is not required for\n"
- " ;; proper operation.\n"
- " (packages (cons* postgresql %base-packages))\n"
- " (services\n"
- " (cons*\n"
- " (service postgresql-service-type\n"
- " (postgresql-configuration\n"
- " (postgresql postgresql-10)\n"
- " (extension-packages (list postgis))))\n"
- " %base-services)))\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21158
- msgid "Then the extension becomes visible and you can initialise an empty geographic database in this way:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:21165
- #, no-wrap
- msgid ""
- "psql -U postgres\n"
- "> create database postgistest;\n"
- "> \\connect postgistest;\n"
- "> create extension postgis;\n"
- "> create extension postgis_topology;\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21170
- msgid "There is no need to add this field for contrib extensions such as hstore or dblink as they are already loadable by postgresql. This field is only required to add extensions provided by other packages."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:21174
- #, no-wrap
- msgid "{Data Type} postgresql-config-file"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:21180
- msgid "Data type representing the PostgreSQL configuration file. As shown in the following example, this can be used to customize the configuration of PostgreSQL@. Note that you can use any G-expression or filename in place of this record, if you already have a configuration file you'd like to use for example."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:21200
- #, no-wrap
- msgid ""
- "(service postgresql-service-type\n"
- " (postgresql-configuration\n"
- " (config-file\n"
- " (postgresql-config-file\n"
- " (log-destination \"stderr\")\n"
- " (hba-file\n"
- " (plain-file \"pg_hba.conf\"\n"
- " \"\n"
- "local\tall\tall\t\t\ttrust\n"
- "host\tall\tall\t127.0.0.1/32 \tmd5\n"
- "host\tall\tall\t::1/128 \tmd5\"))\n"
- " (extra-config\n"
- " '((\"session_preload_libraries\" \"auto_explain\")\n"
- " (\"random_page_cost\" 2)\n"
- " (\"auto_explain.log_min_duration\" \"100 ms\")\n"
- " (\"work_mem\" \"500 MB\")\n"
- " (\"logging_collector\" #t)\n"
- " (\"log_directory\" \"/var/log/postgresql\")))))))\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21203
- #, no-wrap
- msgid "@code{log-destination} (default: @code{\"syslog\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21206
- msgid "The logging method to use for PostgreSQL@. Multiple values are accepted, separated by commas."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21207
- #, no-wrap
- msgid "@code{hba-file} (default: @code{%default-postgres-hba})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21210
- msgid "Filename or G-expression for the host-based authentication configuration."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21211
- #, no-wrap
- msgid "@code{ident-file} (default: @code{%default-postgres-ident})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21213
- msgid "Filename or G-expression for the user name mapping configuration."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21214
- #, no-wrap
- msgid "@code{socket-directory} (default: @code{\"/var/run/postgresql\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21219
- msgid "Specifies the directory of the Unix-domain socket(s) on which PostgreSQL is to listen for connections from client applications. If set to @code{\"\"} PostgreSQL does not listen on any Unix-domain sockets, in which case only TCP/IP sockets can be used to connect to the server."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21222
- msgid "By default, the @code{#false} value means the PostgreSQL default value will be used, which is currently @samp{/tmp}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21227
- msgid "List of additional keys and values to include in the PostgreSQL config file. Each entry in the list should be a list where the first element is the key, and the remaining elements are the values."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21233
- msgid "The values can be numbers, booleans or strings and will be mapped to PostgreSQL parameters types @code{Boolean}, @code{String}, @code{Numeric}, @code{Numeric with Unit} and @code{Enumerated} described @uref{https://www.postgresql.org/docs/current/config-setting.html, here}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:21237
- #, no-wrap
- msgid "{Scheme Variable} postgresql-role-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:21240
- msgid "This service allows to create PostgreSQL roles and databases after PostgreSQL service start. Here is an example of its use."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:21248
- #, no-wrap
- msgid ""
- "(service postgresql-role-service-type\n"
- " (postgresql-role-configuration\n"
- " (roles\n"
- " (list (postgresql-role\n"
- " (name \"test\")\n"
- " (create-database? #t))))))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:21252
- msgid "This service can be extended with extra roles, as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:21258
- #, no-wrap
- msgid ""
- "(service-extension postgresql-role-service-type\n"
- " (const (postgresql-role\n"
- " (name \"alice\")\n"
- " (create-database? #t))))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:21261
- #, no-wrap
- msgid "{Data Type} postgresql-role"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:21267
- msgid "PostgreSQL manages database access permissions using the concept of roles. A role can be thought of as either a database user, or a group of database users, depending on how the role is set up. Roles can own database objects (for example, tables) and can assign privileges on those objects to other roles to control who has access to which objects."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21271
- msgid "The role name."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21272
- #, no-wrap
- msgid "@code{permissions} (default: @code{'(createdb login)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21276
- msgid "The role permissions list. Supported permissions are @code{bypassrls}, @code{createdb}, @code{createrole}, @code{login}, @code{replication} and @code{superuser}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21277
- #, no-wrap
- msgid "@code{create-database?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21279
- msgid "Whether to create a database with the same name as the role."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:21283
- #, no-wrap
- msgid "{Data Type} postgresql-role-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:21286
- msgid "Data type representing the configuration of @var{postgresql-role-service-type}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21288
- #, no-wrap
- msgid "@code{host} (default: @code{\"/var/run/postgresql\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21290
- msgid "The PostgreSQL host to connect to."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21291
- #, no-wrap
- msgid "@code{log} (default: @code{\"/var/log/postgresql_roles.log\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21293
- msgid "File name of the log file."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21294
- #, no-wrap
- msgid "@code{roles} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21296
- msgid "The initial PostgreSQL roles to create."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:21299
- #, no-wrap
- msgid "MariaDB/MySQL"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:21301
- #, no-wrap
- msgid "{Scheme Variable} mysql-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:21305
- msgid "This is the service type for a MySQL or MariaDB database server. Its value is a @code{mysql-configuration} object that specifies which package to use, as well as various settings for the @command{mysqld} daemon."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:21307
- #, no-wrap
- msgid "{Data Type} mysql-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:21309
- msgid "Data type representing the configuration of @var{mysql-service-type}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21311
- #, no-wrap
- msgid "@code{mysql} (default: @var{mariadb})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21314
- msgid "Package object of the MySQL database server, can be either @var{mariadb} or @var{mysql}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21317
- msgid "For MySQL, a temporary root password will be displayed at activation time. For MariaDB, the root password is empty."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21318 guix-git/doc/guix.texi:25138
- #, no-wrap
- msgid "@code{bind-address} (default: @code{\"127.0.0.1\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21321
- msgid "The IP on which to listen for network connections. Use @code{\"0.0.0.0\"} to bind to all available network interfaces."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21322
- #, no-wrap
- msgid "@code{port} (default: @code{3306})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21324
- msgid "TCP port on which the database server listens for incoming connections."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21325
- #, no-wrap
- msgid "@code{socket} (default: @code{\"/run/mysqld/mysqld.sock\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21327
- msgid "Socket file to use for local (non-network) connections."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21330
- msgid "Additional settings for the @file{my.cnf} configuration file."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21331
- #, no-wrap
- msgid "@code{extra-environment} (default: @code{#~'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21333
- msgid "List of environment variables passed to the @command{mysqld} process."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21334
- #, no-wrap
- msgid "@code{auto-upgrade?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21339
- msgid "Whether to automatically run @command{mysql_upgrade} after starting the service. This is necessary to upgrade the @dfn{system schema} after ``major'' updates (such as switching from MariaDB 10.4 to 10.5), but can be disabled if you would rather do that manually."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:21343
- #, no-wrap
- msgid "Memcached"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:21345
- #, no-wrap
- msgid "{Scheme Variable} memcached-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:21349
- msgid "This is the service type for the @uref{https://memcached.org/, Memcached} service, which provides a distributed in memory cache. The value for the service type is a @code{memcached-configuration} object."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:21353
- #, no-wrap
- msgid "(service memcached-service-type)\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:21355
- #, no-wrap
- msgid "{Data Type} memcached-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:21357
- msgid "Data type representing the configuration of memcached."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21359
- #, no-wrap
- msgid "@code{memcached} (default: @code{memcached})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21361
- msgid "The Memcached package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21362
- #, no-wrap
- msgid "@code{interfaces} (default: @code{'(\"0.0.0.0\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21364
- msgid "Network interfaces on which to listen."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21365
- #, no-wrap
- msgid "@code{tcp-port} (default: @code{11211})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21367
- msgid "Port on which to accept connections."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21368
- #, no-wrap
- msgid "@code{udp-port} (default: @code{11211})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21371
- msgid "Port on which to accept UDP connections on, a value of 0 will disable listening on a UDP socket."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21372
- #, no-wrap
- msgid "@code{additional-options} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21374
- msgid "Additional command line options to pass to @code{memcached}."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:21377
- #, no-wrap
- msgid "Redis"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:21379
- #, no-wrap
- msgid "{Scheme Variable} redis-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:21382
- msgid "This is the service type for the @uref{https://redis.io/, Redis} key/value store, whose value is a @code{redis-configuration} object."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:21384
- #, no-wrap
- msgid "{Data Type} redis-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:21386
- msgid "Data type representing the configuration of redis."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21388
- #, no-wrap
- msgid "@code{redis} (default: @code{redis})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21390
- msgid "The Redis package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21391
- #, no-wrap
- msgid "@code{bind} (default: @code{\"127.0.0.1\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21393
- msgid "Network interface on which to listen."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21394
- #, no-wrap
- msgid "@code{port} (default: @code{6379})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21397
- msgid "Port on which to accept connections on, a value of 0 will disable listening on a TCP socket."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:21398
- #, no-wrap
- msgid "@code{working-directory} (default: @code{\"/var/lib/redis\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:21400
- msgid "Directory in which to store the database and related files."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:21406
- #, no-wrap
- msgid "mail"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:21407
- #, no-wrap
- msgid "email"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:21412
- msgid "The @code{(gnu services mail)} module provides Guix service definitions for email services: IMAP, POP3, and LMTP servers, as well as mail transport agents (MTAs). Lots of acronyms! These services are detailed in the subsections below."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:21413
- #, no-wrap
- msgid "Dovecot Service"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:21415
- #, no-wrap
- msgid "{Scheme Procedure} dovecot-service [#:config (dovecot-configuration)]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:21417
- msgid "Return a service that runs the Dovecot IMAP/POP3/LMTP mail server."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:21427
- msgid "By default, Dovecot does not need much configuration; the default configuration object created by @code{(dovecot-configuration)} will suffice if your mail is delivered to @code{~/Maildir}. A self-signed certificate will be generated for TLS-protected connections, though Dovecot will also listen on cleartext ports by default. There are a number of options, though, which mail administrators might need to change, and as is the case with other services, Guix allows the system administrator to specify these parameters via a uniform Scheme interface."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:21430
- msgid "For example, to specify that mail is located at @code{maildir~/.mail}, one would instantiate the Dovecot service like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:21435
- #, no-wrap
- msgid ""
- "(dovecot-service #:config\n"
- " (dovecot-configuration\n"
- " (mail-location \"maildir:~/.mail\")))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:21443
- msgid "The available configuration parameters follow. Each parameter definition is preceded by its type; for example, @samp{string-list foo} indicates that the @code{foo} parameter should be specified as a list of strings. There is also a way to specify the configuration as a string, if you have an old @code{dovecot.conf} file that you want to port over from some other system; see the end for more details."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:21453
- msgid "Available @code{dovecot-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21454
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} package dovecot"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21456 guix-git/doc/guix.texi:22805
- msgid "The dovecot package."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21458
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} comma-separated-string-list listen"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21464
- msgid "A list of IPs or hosts where to listen for connections. @samp{*} listens on all IPv4 interfaces, @samp{::} listens on all IPv6 interfaces. If you want to specify non-default ports or anything more complex, customize the address and port fields of the @samp{inet-listener} of the specific services you are interested in."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21466
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} protocol-configuration-list protocols"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21469
- msgid "List of protocols we want to serve. Available protocols include @samp{imap}, @samp{pop3}, and @samp{lmtp}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21471
- msgid "Available @code{protocol-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21472
- #, no-wrap
- msgid "{@code{protocol-configuration} parameter} string name"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21474
- msgid "The name of the protocol."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21476
- #, no-wrap
- msgid "{@code{protocol-configuration} parameter} string auth-socket-path"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21480
- msgid "UNIX socket path to the master authentication server to find users. This is used by imap (for shared users) and lda. It defaults to @samp{\"/var/run/dovecot/auth-userdb\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21482
- #, no-wrap
- msgid "{@code{protocol-configuration} parameter} boolean imap-metadata?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21487
- msgid "Whether to enable the @code{IMAP METADATA} extension as defined in @uref{https://tools.ietf.org/html/rfc5464,RFC@tie{}5464}, which provides a means for clients to set and retrieve per-mailbox, per-user metadata and annotations over IMAP."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21490
- msgid "If this is @samp{#t}, you must also specify a dictionary @i{via} the @code{mail-attribute-dict} setting."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21495
- #, no-wrap
- msgid "{@code{protocol-configuration} parameter} space-separated-string-list managesieve-notify-capabilities"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21500
- msgid "Which NOTIFY capabilities to report to clients that first connect to the ManageSieve service, before authentication. These may differ from the capabilities offered to authenticated users. If this field is left empty, report what the Sieve interpreter supports by default."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21504
- #, no-wrap
- msgid "{@code{protocol-configuration} parameter} space-separated-string-list managesieve-sieve-capability"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21509
- msgid "Which SIEVE capabilities to report to clients that first connect to the ManageSieve service, before authentication. These may differ from the capabilities offered to authenticated users. If this field is left empty, report what the Sieve interpreter supports by default."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21514
- #, no-wrap
- msgid "{@code{protocol-configuration} parameter} space-separated-string-list mail-plugins"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21516
- msgid "Space separated list of plugins to load."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21518
- #, no-wrap
- msgid "{@code{protocol-configuration} parameter} non-negative-integer mail-max-userip-connections"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21522
- msgid "Maximum number of IMAP connections allowed for a user from each IP address. NOTE: The username is compared case-sensitively. Defaults to @samp{10}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21526
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} service-configuration-list services"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21530
- msgid "List of services to enable. Available services include @samp{imap}, @samp{imap-login}, @samp{pop3}, @samp{pop3-login}, @samp{auth}, and @samp{lmtp}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21532
- msgid "Available @code{service-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21533
- #, no-wrap
- msgid "{@code{service-configuration} parameter} string kind"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21538
- msgid "The service kind. Valid values include @code{director}, @code{imap-login}, @code{pop3-login}, @code{lmtp}, @code{imap}, @code{pop3}, @code{auth}, @code{auth-worker}, @code{dict}, @code{tcpwrap}, @code{quota-warning}, or anything else."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21540
- #, no-wrap
- msgid "{@code{service-configuration} parameter} listener-configuration-list listeners"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21545
- msgid "Listeners for the service. A listener is either a @code{unix-listener-configuration}, a @code{fifo-listener-configuration}, or an @code{inet-listener-configuration}. Defaults to @samp{()}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21547
- msgid "Available @code{unix-listener-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21548
- #, no-wrap
- msgid "{@code{unix-listener-configuration} parameter} string path"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21551 guix-git/doc/guix.texi:21574
- msgid "Path to the file, relative to @code{base-dir} field. This is also used as the section name."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21553
- #, no-wrap
- msgid "{@code{unix-listener-configuration} parameter} string mode"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21556 guix-git/doc/guix.texi:21579
- msgid "The access mode for the socket. Defaults to @samp{\"0600\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21558
- #, no-wrap
- msgid "{@code{unix-listener-configuration} parameter} string user"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21561 guix-git/doc/guix.texi:21584
- msgid "The user to own the socket. Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21563
- #, no-wrap
- msgid "{@code{unix-listener-configuration} parameter} string group"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21566 guix-git/doc/guix.texi:21589
- msgid "The group to own the socket. Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21570
- msgid "Available @code{fifo-listener-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21571
- #, no-wrap
- msgid "{@code{fifo-listener-configuration} parameter} string path"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21576
- #, no-wrap
- msgid "{@code{fifo-listener-configuration} parameter} string mode"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21581
- #, no-wrap
- msgid "{@code{fifo-listener-configuration} parameter} string user"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21586
- #, no-wrap
- msgid "{@code{fifo-listener-configuration} parameter} string group"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21593
- msgid "Available @code{inet-listener-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21594
- #, no-wrap
- msgid "{@code{inet-listener-configuration} parameter} string protocol"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21596
- msgid "The protocol to listen for."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21598
- #, no-wrap
- msgid "{@code{inet-listener-configuration} parameter} string address"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21601
- msgid "The address on which to listen, or empty for all addresses. Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21603
- #, no-wrap
- msgid "{@code{inet-listener-configuration} parameter} non-negative-integer port"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21605
- msgid "The port on which to listen."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21607
- #, no-wrap
- msgid "{@code{inet-listener-configuration} parameter} boolean ssl?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21611
- msgid "Whether to use SSL for this service; @samp{yes}, @samp{no}, or @samp{required}. Defaults to @samp{#t}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21615
- #, no-wrap
- msgid "{@code{service-configuration} parameter} non-negative-integer client-limit"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21620
- msgid "Maximum number of simultaneous client connections per process. Once this number of connections is received, the next incoming connection will prompt Dovecot to spawn another process. If set to 0, @code{default-client-limit} is used instead."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21625
- #, no-wrap
- msgid "{@code{service-configuration} parameter} non-negative-integer service-count"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21630
- msgid "Number of connections to handle before starting a new process. Typically the only useful values are 0 (unlimited) or 1. 1 is more secure, but 0 is faster. <doc/wiki/LoginProcess.txt>. Defaults to @samp{1}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21633
- #, no-wrap
- msgid "{@code{service-configuration} parameter} non-negative-integer process-limit"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21636
- msgid "Maximum number of processes that can exist for this service. If set to 0, @code{default-process-limit} is used instead."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21641
- #, no-wrap
- msgid "{@code{service-configuration} parameter} non-negative-integer process-min-avail"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21644
- msgid "Number of processes to always keep waiting for more connections. Defaults to @samp{0}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21646
- #, no-wrap
- msgid "{@code{service-configuration} parameter} non-negative-integer vsz-limit"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21650
- msgid "If you set @samp{service-count 0}, you probably need to grow this. Defaults to @samp{256000000}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21654
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} dict-configuration dict"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21657
- msgid "Dict configuration, as created by the @code{dict-configuration} constructor."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21659
- msgid "Available @code{dict-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21660
- #, no-wrap
- msgid "{@code{dict-configuration} parameter} free-form-fields entries"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21663
- msgid "A list of key-value pairs that this dict should hold. Defaults to @samp{()}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21667
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} passdb-configuration-list passdbs"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21670
- msgid "A list of passdb configurations, each one created by the @code{passdb-configuration} constructor."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21672
- msgid "Available @code{passdb-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21673
- #, no-wrap
- msgid "{@code{passdb-configuration} parameter} string driver"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21678
- msgid "The driver that the passdb should use. Valid values include @samp{pam}, @samp{passwd}, @samp{shadow}, @samp{bsdauth}, and @samp{static}. Defaults to @samp{\"pam\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21680
- #, no-wrap
- msgid "{@code{passdb-configuration} parameter} space-separated-string-list args"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21683
- msgid "Space separated list of arguments to the passdb driver. Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21687
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} userdb-configuration-list userdbs"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21690
- msgid "List of userdb configurations, each one created by the @code{userdb-configuration} constructor."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21692
- msgid "Available @code{userdb-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21693
- #, no-wrap
- msgid "{@code{userdb-configuration} parameter} string driver"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21697
- msgid "The driver that the userdb should use. Valid values include @samp{passwd} and @samp{static}. Defaults to @samp{\"passwd\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21699
- #, no-wrap
- msgid "{@code{userdb-configuration} parameter} space-separated-string-list args"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21702
- msgid "Space separated list of arguments to the userdb driver. Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21704
- #, no-wrap
- msgid "{@code{userdb-configuration} parameter} free-form-args override-fields"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21707
- msgid "Override fields from passwd. Defaults to @samp{()}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21711
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} plugin-configuration plugin-configuration"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21714
- msgid "Plug-in configuration, created by the @code{plugin-configuration} constructor."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21716
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} list-of-namespace-configuration namespaces"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21719
- msgid "List of namespaces. Each item in the list is created by the @code{namespace-configuration} constructor."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21721
- msgid "Available @code{namespace-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21722
- #, no-wrap
- msgid "{@code{namespace-configuration} parameter} string name"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21724
- msgid "Name for this namespace."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21726
- #, no-wrap
- msgid "{@code{namespace-configuration} parameter} string type"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21729
- msgid "Namespace type: @samp{private}, @samp{shared} or @samp{public}. Defaults to @samp{\"private\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21731
- #, no-wrap
- msgid "{@code{namespace-configuration} parameter} string separator"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21737
- msgid "Hierarchy separator to use. You should use the same separator for all namespaces or some clients get confused. @samp{/} is usually a good one. The default however depends on the underlying mail storage format. Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21739
- #, no-wrap
- msgid "{@code{namespace-configuration} parameter} string prefix"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21743
- msgid "Prefix required to access this namespace. This needs to be different for all namespaces. For example @samp{Public/}. Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21745
- #, no-wrap
- msgid "{@code{namespace-configuration} parameter} string location"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21749
- msgid "Physical location of the mailbox. This is in the same format as mail_location, which is also the default for it. Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21751
- #, no-wrap
- msgid "{@code{namespace-configuration} parameter} boolean inbox?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21755
- msgid "There can be only one INBOX, and this setting defines which namespace has it. Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21757
- #, no-wrap
- msgid "{@code{namespace-configuration} parameter} boolean hidden?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21765
- msgid "If namespace is hidden, it's not advertised to clients via NAMESPACE extension. You'll most likely also want to set @samp{list? #f}. This is mostly useful when converting from another server with different namespaces which you want to deprecate but still keep working. For example you can create hidden namespaces with prefixes @samp{~/mail/}, @samp{~%u/mail/} and @samp{mail/}. Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21767
- #, no-wrap
- msgid "{@code{namespace-configuration} parameter} boolean list?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21773
- msgid "Show the mailboxes under this namespace with the LIST command. This makes the namespace visible for clients that do not support the NAMESPACE extension. The special @code{children} value lists child mailboxes, but hides the namespace prefix. Defaults to @samp{#t}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21775
- #, no-wrap
- msgid "{@code{namespace-configuration} parameter} boolean subscriptions?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21780
- msgid "Namespace handles its own subscriptions. If set to @code{#f}, the parent namespace handles them. The empty prefix should always have this as @code{#t}). Defaults to @samp{#t}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21782
- #, no-wrap
- msgid "{@code{namespace-configuration} parameter} mailbox-configuration-list mailboxes"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21785
- msgid "List of predefined mailboxes in this namespace. Defaults to @samp{()}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21787
- msgid "Available @code{mailbox-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21788
- #, no-wrap
- msgid "{@code{mailbox-configuration} parameter} string name"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21790
- msgid "Name for this mailbox."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21792
- #, no-wrap
- msgid "{@code{mailbox-configuration} parameter} string auto"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21796
- msgid "@samp{create} will automatically create this mailbox. @samp{subscribe} will both create and subscribe to the mailbox. Defaults to @samp{\"no\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21798
- #, no-wrap
- msgid "{@code{mailbox-configuration} parameter} space-separated-string-list special-use"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21803
- msgid "List of IMAP @code{SPECIAL-USE} attributes as specified by RFC 6154. Valid values are @code{\\All}, @code{\\Archive}, @code{\\Drafts}, @code{\\Flagged}, @code{\\Junk}, @code{\\Sent}, and @code{\\Trash}. Defaults to @samp{()}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21809
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} file-name base-dir"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21812
- msgid "Base directory where to store runtime data. Defaults to @samp{\"/var/run/dovecot/\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21814
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string login-greeting"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21817
- msgid "Greeting message for clients. Defaults to @samp{\"Dovecot ready.\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21819
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} space-separated-string-list login-trusted-networks"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21826
- msgid "List of trusted network ranges. Connections from these IPs are allowed to override their IP addresses and ports (for logging and for authentication checks). @samp{disable-plaintext-auth} is also ignored for these networks. Typically you would specify your IMAP proxy servers here. Defaults to @samp{()}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21828
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} space-separated-string-list login-access-sockets"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21831
- msgid "List of login access check sockets (e.g.@: tcpwrap). Defaults to @samp{()}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21833
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean verbose-proctitle?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21839
- msgid "Show more verbose process titles (in ps). Currently shows user name and IP address. Useful for seeing who is actually using the IMAP processes (e.g.@: shared mailboxes or if the same uid is used for multiple accounts). Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21841
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean shutdown-clients?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21847
- msgid "Should all processes be killed when Dovecot master process shuts down. Setting this to @code{#f} means that Dovecot can be upgraded without forcing existing client connections to close (although that could also be a problem if the upgrade is e.g.@: due to a security fix). Defaults to @samp{#t}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21849
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} non-negative-integer doveadm-worker-count"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21853
- msgid "If non-zero, run mail commands via this many connections to doveadm server, instead of running them directly in the same process. Defaults to @samp{0}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21855
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string doveadm-socket-path"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21858
- msgid "UNIX socket or host:port used for connecting to doveadm server. Defaults to @samp{\"doveadm-server\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21860
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} space-separated-string-list import-environment"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21864
- msgid "List of environment variables that are preserved on Dovecot startup and passed down to all of its child processes. You can also give key=value pairs to always set specific settings."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21866
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean disable-plaintext-auth?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21873
- msgid "Disable LOGIN command and all other plaintext authentications unless SSL/TLS is used (LOGINDISABLED capability). Note that if the remote IP matches the local IP (i.e.@: you're connecting from the same computer), the connection is considered secure and plaintext authentication is allowed. See also ssl=required setting. Defaults to @samp{#t}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21875
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} non-negative-integer auth-cache-size"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21880
- msgid "Authentication cache size (e.g.@: @samp{#e10e6}). 0 means it's disabled. Note that bsdauth, PAM and vpopmail require @samp{cache-key} to be set for caching to be used. Defaults to @samp{0}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21882
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string auth-cache-ttl"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21890
- msgid "Time to live for cached data. After TTL expires the cached record is no longer used, *except* if the main database lookup returns internal failure. We also try to handle password changes automatically: If user's previous authentication was successful, but this one wasn't, the cache isn't used. For now this works only with plaintext authentication. Defaults to @samp{\"1 hour\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21892
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string auth-cache-negative-ttl"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21896
- msgid "TTL for negative hits (user not found, password mismatch). 0 disables caching them completely. Defaults to @samp{\"1 hour\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21898
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} space-separated-string-list auth-realms"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21904
- msgid "List of realms for SASL authentication mechanisms that need them. You can leave it empty if you don't want to support multiple realms. Many clients simply use the first one listed here, so keep the default realm first. Defaults to @samp{()}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21906
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string auth-default-realm"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21911
- msgid "Default realm/domain to use if none was specified. This is used for both SASL realms and appending @@domain to username in plaintext logins. Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21913
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string auth-username-chars"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21920
- msgid "List of allowed characters in username. If the user-given username contains a character not listed in here, the login automatically fails. This is just an extra check to make sure user can't exploit any potential quote escaping vulnerabilities with SQL/LDAP databases. If you want to allow all characters, set this value to empty. Defaults to @samp{\"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234567890.-_@@\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21922
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string auth-username-translation"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21928
- msgid "Username character translations before it's looked up from databases. The value contains series of from -> to characters. For example @samp{#@@/@@} means that @samp{#} and @samp{/} characters are translated to @samp{@@}. Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21930
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string auth-username-format"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21937
- msgid "Username formatting before it's looked up from databases. You can use the standard variables here, e.g.@: %Lu would lowercase the username, %n would drop away the domain if it was given, or @samp{%n-AT-%d} would change the @samp{@@} into @samp{-AT-}. This translation is done after @samp{auth-username-translation} changes. Defaults to @samp{\"%Lu\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21939
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string auth-master-user-separator"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21947
- msgid "If you want to allow master users to log in by specifying the master username within the normal username string (i.e.@: not using SASL mechanism's support for it), you can specify the separator character here. The format is then <username><separator><master username>. UW-IMAP uses @samp{*} as the separator, so that could be a good choice. Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21949
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string auth-anonymous-username"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21953
- msgid "Username to use for users logging in with ANONYMOUS SASL mechanism. Defaults to @samp{\"anonymous\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21955
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} non-negative-integer auth-worker-max-count"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21960
- msgid "Maximum number of dovecot-auth worker processes. They're used to execute blocking passdb and userdb queries (e.g.@: MySQL and PAM). They're automatically created and destroyed as needed. Defaults to @samp{30}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21962
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string auth-gssapi-hostname"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21967
- msgid "Host name to use in GSSAPI principal names. The default is to use the name returned by gethostname(). Use @samp{$ALL} (with quotes) to allow all keytab entries. Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21969
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string auth-krb5-keytab"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21975
- msgid "Kerberos keytab to use for the GSSAPI mechanism. Will use the system default (usually @file{/etc/krb5.keytab}) if not specified. You may need to change the auth service to run as root to be able to read this file. Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21977
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean auth-use-winbind?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21982
- msgid "Do NTLM and GSS-SPNEGO authentication using Samba's winbind daemon and @samp{ntlm-auth} helper. <doc/wiki/Authentication/Mechanisms/Winbind.txt>. Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21984
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} file-name auth-winbind-helper-path"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21987
- msgid "Path for Samba's @samp{ntlm-auth} helper binary. Defaults to @samp{\"/usr/bin/ntlm_auth\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21989
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string auth-failure-delay"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21992
- msgid "Time to delay before replying to failed authentications. Defaults to @samp{\"2 secs\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21994
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean auth-ssl-require-client-cert?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:21998
- msgid "Require a valid SSL client certificate or the authentication fails. Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22000
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean auth-ssl-username-from-cert?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22005
- msgid "Take the username from client's SSL certificate, using @code{X509_NAME_get_text_by_NID()} which returns the subject's DN's CommonName. Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22007
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} space-separated-string-list auth-mechanisms"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22013
- msgid "List of wanted authentication mechanisms. Supported mechanisms are: @samp{plain}, @samp{login}, @samp{digest-md5}, @samp{cram-md5}, @samp{ntlm}, @samp{rpa}, @samp{apop}, @samp{anonymous}, @samp{gssapi}, @samp{otp}, @samp{skey}, and @samp{gss-spnego}. NOTE: See also @samp{disable-plaintext-auth} setting."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22015
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} space-separated-string-list director-servers"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22020
- msgid "List of IPs or hostnames to all director servers, including ourself. Ports can be specified as ip:port. The default port is the same as what director service's @samp{inet-listener} is using. Defaults to @samp{()}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22022
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} space-separated-string-list director-mail-servers"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22026
- msgid "List of IPs or hostnames to all backend mail servers. Ranges are allowed too, like 10.0.0.10-10.0.0.30. Defaults to @samp{()}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22028
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string director-user-expire"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22032
- msgid "How long to redirect users to a specific server after it no longer has any connections. Defaults to @samp{\"15 min\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22034
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string director-username-hash"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22039
- msgid "How the username is translated before being hashed. Useful values include %Ln if user can log in with or without @@domain, %Ld if mailboxes are shared within domain. Defaults to @samp{\"%Lu\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22041
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string log-path"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22045
- msgid "Log file to use for error messages. @samp{syslog} logs to syslog, @samp{/dev/stderr} logs to stderr. Defaults to @samp{\"syslog\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22047
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string info-log-path"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22051
- msgid "Log file to use for informational messages. Defaults to @samp{log-path}. Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22053
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string debug-log-path"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22057
- msgid "Log file to use for debug messages. Defaults to @samp{info-log-path}. Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22059
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string syslog-facility"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22064
- msgid "Syslog facility to use if you're logging to syslog. Usually if you don't want to use @samp{mail}, you'll use local0..local7. Also other standard facilities are supported. Defaults to @samp{\"mail\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22066
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean auth-verbose?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22070
- msgid "Log unsuccessful authentication attempts and the reasons why they failed. Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22072
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string auth-verbose-passwords"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22079
- msgid "In case of password mismatches, log the attempted password. Valid values are no, plain and sha1. sha1 can be useful for detecting brute force password attempts vs. user simply trying the same password over and over again. You can also truncate the value to n chars by appending \":n\" (e.g.@: sha1:6). Defaults to @samp{\"no\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22081
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean auth-debug?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22085
- msgid "Even more verbose logging for debugging purposes. Shows for example SQL queries. Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22087
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean auth-debug-passwords?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22092
- msgid "In case of password mismatches, log the passwords and used scheme so the problem can be debugged. Enabling this also enables @samp{auth-debug}. Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22094
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean mail-debug?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22098
- msgid "Enable mail process debugging. This can help you figure out why Dovecot isn't finding your mails. Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22100
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean verbose-ssl?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22103
- msgid "Show protocol level SSL errors. Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22105
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string log-timestamp"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22109
- msgid "Prefix for each line written to log file. % codes are in strftime(3) format. Defaults to @samp{\"\\\"%b %d %H:%M:%S \\\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22111
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} space-separated-string-list login-log-format-elements"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22115
- msgid "List of elements we want to log. The elements which have a non-empty variable value are joined together to form a comma-separated string."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22117
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string login-log-format"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22121
- msgid "Login log format. %s contains @samp{login-log-format-elements} string, %$ contains the data we want to log. Defaults to @samp{\"%$: %s\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22123
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string mail-log-prefix"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22127
- msgid "Log prefix for mail processes. See doc/wiki/Variables.txt for list of possible variables you can use. Defaults to @samp{\"\\\"%s(%u)<%@{pid@}><%@{session@}>: \\\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22129
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string deliver-log-format"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22131
- msgid "Format to use for logging mail deliveries. You can use variables:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22132
- #, no-wrap
- msgid "%$"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22134
- msgid "Delivery status message (e.g.@: @samp{saved to INBOX})"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22134
- #, no-wrap
- msgid "%m"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22136
- msgid "Message-ID"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22136 guix-git/doc/guix.texi:22679
- #, no-wrap
- msgid "%s"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22138
- msgid "Subject"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22138
- #, no-wrap
- msgid "%f"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22140
- msgid "From address"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22142
- msgid "Physical size"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22142
- #, no-wrap
- msgid "%w"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22144
- msgid "Virtual size."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22146
- msgid "Defaults to @samp{\"msgid=%m: %$\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22148
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string mail-location"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22153
- msgid "Location for users' mailboxes. The default is empty, which means that Dovecot tries to find the mailboxes automatically. This won't work if the user doesn't yet have any mail, so you should explicitly tell Dovecot the full location."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22159
- msgid "If you're using mbox, giving a path to the INBOX file (e.g.@: @file{/var/mail/%u}) isn't enough. You'll also need to tell Dovecot where the other mailboxes are kept. This is called the @emph{root mail directory}, and it must be the first path given in the @samp{mail-location} setting."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22161
- msgid "There are a few special variables you can use, e.g.:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22165
- msgid "username"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22165 guix-git/doc/guix.texi:22675
- #, no-wrap
- msgid "%n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22167
- msgid "user part in user@@domain, same as %u if there's no domain"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22167
- #, no-wrap
- msgid "%d"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22169
- msgid "domain part in user@@domain, empty if there's no domain"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22169
- #, no-wrap
- msgid "%h"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22171
- msgid "home director"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22174
- msgid "See doc/wiki/Variables.txt for full list. Some examples:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22175
- #, no-wrap
- msgid "maildir:~/Maildir"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22176
- #, no-wrap
- msgid "mbox:~/mail:INBOX=/var/mail/%u"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22177
- #, no-wrap
- msgid "mbox:/var/mail/%d/%1n/%n:INDEX=/var/indexes/%d/%1n/%"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22182
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string mail-uid"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22187
- msgid "System user and group used to access mails. If you use multiple, userdb can override these by returning uid or gid fields. You can use either numbers or names. <doc/wiki/UserIds.txt>. Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22189
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string mail-gid"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22194
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string mail-privileged-group"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22200
- msgid "Group to enable temporarily for privileged operations. Currently this is used only with INBOX when either its initial creation or dotlocking fails. Typically this is set to @samp{\"mail\"} to give access to @file{/var/mail}. Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22202
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string mail-access-groups"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22210
- msgid "Grant access to these supplementary groups for mail processes. Typically these are used to set up access to shared mailboxes. Note that it may be dangerous to set these if users can create symlinks (e.g.@: if @samp{mail} group is set here, @code{ln -s /var/mail ~/mail/var} could allow a user to delete others' mailboxes, or @code{ln -s /secret/shared/box ~/mail/mybox} would allow reading it). Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22212
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string mail-attribute-dict"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22215
- msgid "The location of a dictionary used to store @code{IMAP METADATA} as defined by @uref{https://tools.ietf.org/html/rfc5464, RFC@tie{}5464}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22218
- msgid "The IMAP METADATA commands are available only if the ``imap'' protocol configuration's @code{imap-metadata?} field is @samp{#t}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22223
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean mail-full-filesystem-access?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22229
- msgid "Allow full file system access to clients. There's no access checks other than what the operating system does for the active UID/GID@. It works with both maildir and mboxes, allowing you to prefix mailboxes names with e.g.@: @file{/path/} or @file{~user/}. Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22231
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean mmap-disable?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22235
- msgid "Don't use @code{mmap()} at all. This is required if you store indexes to shared file systems (NFS or clustered file system). Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22237
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean dotlock-use-excl?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22242
- msgid "Rely on @samp{O_EXCL} to work when creating dotlock files. NFS supports @samp{O_EXCL} since version 3, so this should be safe to use nowadays by default. Defaults to @samp{#t}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22244
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string mail-fsync"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22246
- msgid "When to use fsync() or fdatasync() calls:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22247
- #, no-wrap
- msgid "optimized"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22249
- msgid "Whenever necessary to avoid losing important data"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22251
- msgid "Useful with e.g.@: NFS when @code{write()}s are delayed"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22253
- msgid "Never use it (best performance, but crashes can lose data)."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22255
- msgid "Defaults to @samp{\"optimized\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22257
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean mail-nfs-storage?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22262
- msgid "Mail storage exists in NFS@. Set this to yes to make Dovecot flush NFS caches whenever needed. If you're using only a single mail server this isn't needed. Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22264
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean mail-nfs-index?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22268
- msgid "Mail index files also exist in NFS@. Setting this to yes requires @samp{mmap-disable? #t} and @samp{fsync-disable? #f}. Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22270
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string lock-method"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22276
- msgid "Locking method for index files. Alternatives are fcntl, flock and dotlock. Dotlocking uses some tricks which may create more disk I/O than other locking methods. NFS users: flock doesn't work, remember to change @samp{mmap-disable}. Defaults to @samp{\"fcntl\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22278
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} file-name mail-temp-dir"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22282
- msgid "Directory in which LDA/LMTP temporarily stores incoming mails >128 kB. Defaults to @samp{\"/tmp\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22284
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} non-negative-integer first-valid-uid"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22290
- msgid "Valid UID range for users. This is mostly to make sure that users can't log in as daemons or other system users. Note that denying root logins is hardcoded to dovecot binary and can't be done even if @samp{first-valid-uid} is set to 0. Defaults to @samp{500}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22292
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} non-negative-integer last-valid-uid"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22297
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} non-negative-integer first-valid-gid"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22302
- msgid "Valid GID range for users. Users having non-valid GID as primary group ID aren't allowed to log in. If user belongs to supplementary groups with non-valid GIDs, those groups are not set. Defaults to @samp{1}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22304
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} non-negative-integer last-valid-gid"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22309
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} non-negative-integer mail-max-keyword-length"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22313
- msgid "Maximum allowed length for mail keyword name. It's only forced when trying to create new keywords. Defaults to @samp{50}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22315
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} colon-separated-file-name-list valid-chroot-dirs"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22325
- msgid "List of directories under which chrooting is allowed for mail processes (i.e.@: @file{/var/mail} will allow chrooting to @file{/var/mail/foo/bar} too). This setting doesn't affect @samp{login-chroot} @samp{mail-chroot} or auth chroot settings. If this setting is empty, @samp{/./} in home dirs are ignored. WARNING: Never add directories here which local users can modify, that may lead to root exploit. Usually this should be done only if you don't allow shell access for users. <doc/wiki/Chrooting.txt>. Defaults to @samp{()}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22327
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string mail-chroot"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22336
- msgid "Default chroot directory for mail processes. This can be overridden for specific users in user database by giving @samp{/./} in user's home directory (e.g.@: @samp{/home/./user} chroots into @file{/home}). Note that usually there is no real need to do chrooting, Dovecot doesn't allow users to access files outside their mail directory anyway. If your home directories are prefixed with the chroot directory, append @samp{/.} to @samp{mail-chroot}. <doc/wiki/Chrooting.txt>. Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22338
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} file-name auth-socket-path"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22342
- msgid "UNIX socket path to master authentication server to find users. This is used by imap (for shared users) and lda. Defaults to @samp{\"/var/run/dovecot/auth-userdb\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22344
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} file-name mail-plugin-dir"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22347
- msgid "Directory where to look up mail plugins. Defaults to @samp{\"/usr/lib/dovecot\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22349
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} space-separated-string-list mail-plugins"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22353
- msgid "List of plugins to load for all services. Plugins specific to IMAP, LDA, etc.@: are added to this list in their own .conf files. Defaults to @samp{()}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22355
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} non-negative-integer mail-cache-min-mail-count"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22360
- msgid "The minimum number of mails in a mailbox before updates are done to cache file. This allows optimizing Dovecot's behavior to do less disk writes at the cost of more disk reads. Defaults to @samp{0}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22362
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string mailbox-idle-check-interval"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22369
- msgid "When IDLE command is running, mailbox is checked once in a while to see if there are any new mails or other changes. This setting defines the minimum time to wait between those checks. Dovecot can also use dnotify, inotify and kqueue to find out immediately when changes occur. Defaults to @samp{\"30 secs\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22371
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean mail-save-crlf?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22378
- msgid "Save mails with CR+LF instead of plain LF@. This makes sending those mails take less CPU, especially with sendfile() syscall with Linux and FreeBSD@. But it also creates a bit more disk I/O which may just make it slower. Also note that if other software reads the mboxes/maildirs, they may handle the extra CRs wrong and cause problems. Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22380
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean maildir-stat-dirs?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22388
- msgid "By default LIST command returns all entries in maildir beginning with a dot. Enabling this option makes Dovecot return only entries which are directories. This is done by stat()ing each entry, so it causes more disk I/O. (For systems setting struct @samp{dirent->d_type} this check is free and it's done always regardless of this setting). Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22390
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean maildir-copy-with-hardlinks?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22395
- msgid "When copying a message, do it with hard links whenever possible. This makes the performance much better, and it's unlikely to have any side effects. Defaults to @samp{#t}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22397
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean maildir-very-dirty-syncs?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22402
- msgid "Assume Dovecot is the only MUA accessing Maildir: Scan cur/ directory only when its mtime changes unexpectedly or when we can't find the mail otherwise. Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22404
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} space-separated-string-list mbox-read-locks"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22407
- msgid "Which locking methods to use for locking mbox. There are four available:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22409
- #, no-wrap
- msgid "dotlock"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22413
- msgid "Create <mailbox>.lock file. This is the oldest and most NFS-safe solution. If you want to use /var/mail/ like directory, the users will need write access to that directory."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22413
- #, no-wrap
- msgid "dotlock-try"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22416
- msgid "Same as dotlock, but if it fails because of permissions or because there isn't enough disk space, just skip it."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22416
- #, no-wrap
- msgid "fcntl"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22418
- msgid "Use this if possible. Works with NFS too if lockd is used."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22418
- #, no-wrap
- msgid "flock"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22420 guix-git/doc/guix.texi:22422
- msgid "May not exist in all systems. Doesn't work with NFS."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22420
- #, no-wrap
- msgid "lockf"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22428
- msgid "You can use multiple locking methods; if you do the order they're declared in is important to avoid deadlocks if other MTAs/MUAs are using multiple locking methods as well. Some operating systems don't allow using some of them simultaneously."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22430
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} space-separated-string-list mbox-write-locks"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22434
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string mbox-lock-timeout"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22437
- msgid "Maximum time to wait for lock (all of them) before aborting. Defaults to @samp{\"5 mins\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22439
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string mbox-dotlock-change-timeout"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22443
- msgid "If dotlock exists but the mailbox isn't modified in any way, override the lock file after this much time. Defaults to @samp{\"2 mins\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22445
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean mbox-dirty-syncs?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22456
- msgid "When mbox changes unexpectedly we have to fully read it to find out what changed. If the mbox is large this can take a long time. Since the change is usually just a newly appended mail, it'd be faster to simply read the new mails. If this setting is enabled, Dovecot does this but still safely fallbacks to re-reading the whole mbox file whenever something in mbox isn't how it's expected to be. The only real downside to this setting is that if some other MUA changes message flags, Dovecot doesn't notice it immediately. Note that a full sync is done with SELECT, EXAMINE, EXPUNGE and CHECK commands. Defaults to @samp{#t}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22458
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean mbox-very-dirty-syncs?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22463
- msgid "Like @samp{mbox-dirty-syncs}, but don't do full syncs even with SELECT, EXAMINE, EXPUNGE or CHECK commands. If this is set, @samp{mbox-dirty-syncs} is ignored. Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22465
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean mbox-lazy-writes?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22471
- msgid "Delay writing mbox headers until doing a full write sync (EXPUNGE and CHECK commands and when closing the mailbox). This is especially useful for POP3 where clients often delete all mails. The downside is that our changes aren't immediately visible to other MUAs. Defaults to @samp{#t}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22473
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} non-negative-integer mbox-min-index-size"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22478
- msgid "If mbox size is smaller than this (e.g.@: 100k), don't write index files. If an index file already exists it's still read, just not updated. Defaults to @samp{0}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22480
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} non-negative-integer mdbox-rotate-size"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22483
- msgid "Maximum dbox file size until it's rotated. Defaults to @samp{10000000}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22485
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string mdbox-rotate-interval"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22490
- msgid "Maximum dbox file age until it's rotated. Typically in days. Day begins from midnight, so 1d = today, 2d = yesterday, etc. 0 = check disabled. Defaults to @samp{\"1d\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22492
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean mdbox-preallocate-space?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22497
- msgid "When creating new mdbox files, immediately preallocate their size to @samp{mdbox-rotate-size}. This setting currently works only in Linux with some file systems (ext4, xfs). Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22499
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string mail-attachment-dir"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22503
- msgid "sdbox and mdbox support saving mail attachments to external files, which also allows single instance storage for them. Other backends don't support this for now."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22505
- msgid "WARNING: This feature hasn't been tested much yet. Use at your own risk."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22508
- msgid "Directory root where to store mail attachments. Disabled, if empty. Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22510
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} non-negative-integer mail-attachment-min-size"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22515
- msgid "Attachments smaller than this aren't saved externally. It's also possible to write a plugin to disable saving specific attachments externally. Defaults to @samp{128000}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22517
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string mail-attachment-fs"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22519
- msgid "File system backend to use for saving attachments:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22520
- #, no-wrap
- msgid "posix"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22522
- msgid "No SiS done by Dovecot (but this might help FS's own deduplication)"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22522
- #, no-wrap
- msgid "sis posix"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22524
- msgid "SiS with immediate byte-by-byte comparison during saving"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22524
- #, no-wrap
- msgid "sis-queue posix"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22526
- msgid "SiS with delayed comparison and deduplication."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22528
- msgid "Defaults to @samp{\"sis posix\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22530
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string mail-attachment-hash"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22536
- msgid "Hash format to use in attachment filenames. You can add any text and variables: @code{%@{md4@}}, @code{%@{md5@}}, @code{%@{sha1@}}, @code{%@{sha256@}}, @code{%@{sha512@}}, @code{%@{size@}}. Variables can be truncated, e.g.@: @code{%@{sha256:80@}} returns only first 80 bits. Defaults to @samp{\"%@{sha1@}\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22538
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} non-negative-integer default-process-limit"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22543
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} non-negative-integer default-client-limit"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22546 guix-git/doc/guix.texi:30171
- msgid "Defaults to @samp{1000}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22548
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} non-negative-integer default-vsz-limit"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22553
- msgid "Default VSZ (virtual memory size) limit for service processes. This is mainly intended to catch and kill processes that leak memory before they eat up everything. Defaults to @samp{256000000}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22555
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string default-login-user"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22560
- msgid "Login user is internally used by login processes. This is the most untrusted user in Dovecot system. It shouldn't have access to anything at all. Defaults to @samp{\"dovenull\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22562
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string default-internal-user"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22567
- msgid "Internal user is used by unprivileged processes. It should be separate from login user, so that login processes can't disturb other processes. Defaults to @samp{\"dovecot\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22569
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string ssl?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22572
- msgid "SSL/TLS support: yes, no, required. <doc/wiki/SSL.txt>. Defaults to @samp{\"required\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22574
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string ssl-cert"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22577
- msgid "PEM encoded X.509 SSL/TLS certificate (public key). Defaults to @samp{\"</etc/dovecot/default.pem\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22579
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string ssl-key"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22584
- msgid "PEM encoded SSL/TLS private key. The key is opened before dropping root privileges, so keep the key file unreadable by anyone but root. Defaults to @samp{\"</etc/dovecot/private/default.pem\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22586
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string ssl-key-password"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22592
- msgid "If key file is password protected, give the password here. Alternatively give it when starting dovecot with -p parameter. Since this file is often world-readable, you may want to place this setting instead to a different. Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22594
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string ssl-ca"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22600
- msgid "PEM encoded trusted certificate authority. Set this only if you intend to use @samp{ssl-verify-client-cert? #t}. The file should contain the CA certificate(s) followed by the matching CRL(s). (e.g.@: @samp{ssl-ca </etc/ssl/certs/ca.pem}). Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22602
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean ssl-require-crl?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22605
- msgid "Require that CRL check succeeds for client certificates. Defaults to @samp{#t}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22607
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean ssl-verify-client-cert?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22611
- msgid "Request client to send a certificate. If you also want to require it, set @samp{auth-ssl-require-client-cert? #t} in auth section. Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22613
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string ssl-cert-username-field"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22618
- msgid "Which field from certificate to use for username. commonName and x500UniqueIdentifier are the usual choices. You'll also need to set @samp{auth-ssl-username-from-cert? #t}. Defaults to @samp{\"commonName\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22620
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string ssl-min-protocol"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22623
- msgid "Minimum SSL protocol version to accept. Defaults to @samp{\"TLSv1\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22625
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string ssl-cipher-list"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22628
- msgid "SSL ciphers to use. Defaults to @samp{\"ALL:!kRSA:!SRP:!kDHd:!DSS:!aNULL:!eNULL:!EXPORT:!DES:!3DES:!MD5:!PSK:!RC4:!ADH:!LOW@@STRENGTH\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22630
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string ssl-crypto-device"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22633
- msgid "SSL crypto device to use, for valid values run \"openssl engine\". Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22635
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string postmaster-address"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22639
- msgid "Address to use when sending rejection mails. %d expands to recipient domain. Defaults to @samp{\"postmaster@@%d\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22641
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string hostname"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22645
- msgid "Hostname to use in various parts of sent mails (e.g.@: in Message-Id) and in LMTP replies. Default is the system's real hostname@@domain. Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22647
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean quota-full-tempfail?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22651
- msgid "If user is over quota, return with temporary failure instead of bouncing the mail. Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22653
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} file-name sendmail-path"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22656
- msgid "Binary to use for sending mails. Defaults to @samp{\"/usr/sbin/sendmail\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22658
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string submission-host"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22662
- msgid "If non-empty, send mails via this SMTP host[:port] instead of sendmail. Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22664
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string rejection-subject"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22668
- msgid "Subject: header to use for rejection mails. You can use the same variables as for @samp{rejection-reason} below. Defaults to @samp{\"Rejected: %s\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22670
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string rejection-reason"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22673
- msgid "Human readable error message for rejection mails. You can use variables:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22677
- msgid "CRLF"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22677
- #, no-wrap
- msgid "%r"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22679
- msgid "reason"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22681
- msgid "original subject"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22681
- #, no-wrap
- msgid "%t"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22683
- msgid "recipient"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22685
- msgid "Defaults to @samp{\"Your message to <%t> was automatically rejected:%n%r\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22687
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string recipient-delimiter"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22691
- msgid "Delimiter character between local-part and detail in email address. Defaults to @samp{\"+\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22693
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string lda-original-recipient-header"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22699
- msgid "Header where the original recipient address (SMTP's RCPT TO: address) is taken from if not available elsewhere. With dovecot-lda -a parameter overrides this. A commonly used header for this is X-Original-To. Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22701
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean lda-mailbox-autocreate?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22705
- msgid "Should saving a mail to a nonexistent mailbox automatically create it?. Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22707
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} boolean lda-mailbox-autosubscribe?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22711
- msgid "Should automatically created mailboxes be also automatically subscribed?. Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22713
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} non-negative-integer imap-max-line-length"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22719
- msgid "Maximum IMAP command line length. Some clients generate very long command lines with huge mailboxes, so you may need to raise this if you get \"Too long argument\" or \"IMAP command line too large\" errors often. Defaults to @samp{64000}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22721
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string imap-logout-format"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22723
- msgid "IMAP logout format string:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22724
- #, no-wrap
- msgid "%i"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22726
- msgid "total number of bytes read from client"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22726
- #, no-wrap
- msgid "%o"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22728
- msgid "total number of bytes sent to client."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22731
- msgid "See @file{doc/wiki/Variables.txt} for a list of all the variables you can use. Defaults to @samp{\"in=%i out=%o deleted=%@{deleted@} expunged=%@{expunged@} trashed=%@{trashed@} hdr_count=%@{fetch_hdr_count@} hdr_bytes=%@{fetch_hdr_bytes@} body_count=%@{fetch_body_count@} body_bytes=%@{fetch_body_bytes@}\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22733
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string imap-capability"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22737
- msgid "Override the IMAP CAPABILITY response. If the value begins with '+', add the given capabilities on top of the defaults (e.g.@: +XFOO XBAR). Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22739
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string imap-idle-notify-interval"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22743
- msgid "How long to wait between \"OK Still here\" notifications when client is IDLEing. Defaults to @samp{\"2 mins\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22745
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string imap-id-send"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22751
- msgid "ID field names and values to send to clients. Using * as the value makes Dovecot use the default value. The following fields have default values currently: name, version, os, os-version, support-url, support-email. Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22753
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string imap-id-log"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22756
- msgid "ID fields sent by client to log. * means everything. Defaults to @samp{\"\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22758
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} space-separated-string-list imap-client-workarounds"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22760
- msgid "Workarounds for various client bugs:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22762
- #, no-wrap
- msgid "delay-newmail"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22769
- msgid "Send EXISTS/RECENT new mail notifications only when replying to NOOP and CHECK commands. Some clients ignore them otherwise, for example OSX Mail (<v2.1). Outlook Express breaks more badly though, without this it may show user \"Message no longer in server\" errors. Note that OE6 still breaks even with this workaround if synchronization is set to \"Headers Only\"."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22770
- #, no-wrap
- msgid "tb-extra-mailbox-sep"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22774
- msgid "Thunderbird gets somehow confused with LAYOUT=fs (mbox and dbox) and adds extra @samp{/} suffixes to mailbox names. This option causes Dovecot to ignore the extra @samp{/} instead of treating it as invalid mailbox name."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22775
- #, no-wrap
- msgid "tb-lsub-flags"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22779
- msgid "Show \\Noselect flags for LSUB replies with LAYOUT=fs (e.g.@: mbox). This makes Thunderbird realize they aren't selectable and show them greyed out, instead of only later giving \"not selectable\" popup error."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22783
- #, no-wrap
- msgid "{@code{dovecot-configuration} parameter} string imap-urlauth-host"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22786
- msgid "Host allowed in URLAUTH URLs sent by client. \"*\" allows all. Defaults to @samp{\"\"}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:22794
- msgid "Whew! Lots of configuration options. The nice thing about it though is that Guix has a complete interface to Dovecot's configuration language. This allows not only a nice way to declare configurations, but also offers reflective capabilities as well: users can write code to inspect and transform configurations from within Scheme."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:22800
- msgid "However, it could be that you just want to get a @code{dovecot.conf} up and running. In that case, you can pass an @code{opaque-dovecot-configuration} as the @code{#:config} parameter to @code{dovecot-service}. As its name indicates, an opaque configuration does not have easy reflective capabilities."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:22802
- msgid "Available @code{opaque-dovecot-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22803
- #, no-wrap
- msgid "{@code{opaque-dovecot-configuration} parameter} package dovecot"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22807
- #, no-wrap
- msgid "{@code{opaque-dovecot-configuration} parameter} string string"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22809
- msgid "The contents of the @code{dovecot.conf}, as a string."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:22813
- msgid "For example, if your @code{dovecot.conf} is just the empty string, you could instantiate a dovecot service like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:22818
- #, no-wrap
- msgid ""
- "(dovecot-service #:config\n"
- " (opaque-dovecot-configuration\n"
- " (string \"\")))\n"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:22820
- #, no-wrap
- msgid "OpenSMTPD Service"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:22822
- #, no-wrap
- msgid "{Scheme Variable} opensmtpd-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:22826
- msgid "This is the type of the @uref{https://www.opensmtpd.org, OpenSMTPD} service, whose value should be an @code{opensmtpd-configuration} object as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:22831
- #, no-wrap
- msgid ""
- "(service opensmtpd-service-type\n"
- " (opensmtpd-configuration\n"
- " (config-file (local-file \"./my-smtpd.conf\"))))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:22834
- #, no-wrap
- msgid "{Data Type} opensmtpd-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:22836
- msgid "Data type representing the configuration of opensmtpd."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22838
- #, no-wrap
- msgid "@code{package} (default: @var{opensmtpd})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22840
- msgid "Package object of the OpenSMTPD SMTP server."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22841
- #, no-wrap
- msgid "@code{config-file} (default: @code{%default-opensmtpd-file})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22846
- msgid "File-like object of the OpenSMTPD configuration file to use. By default it listens on the loopback network interface, and allows for mail from users and daemons on the local machine, as well as permitting email to remote servers. Run @command{man smtpd.conf} for more information."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:22850
- #, no-wrap
- msgid "Exim Service"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:22852
- #, no-wrap
- msgid "mail transfer agent (MTA)"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:22853
- #, no-wrap
- msgid "MTA (mail transfer agent)"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:22854
- #, no-wrap
- msgid "SMTP"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:22856
- #, no-wrap
- msgid "{Scheme Variable} exim-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:22860
- msgid "This is the type of the @uref{https://exim.org, Exim} mail transfer agent (MTA), whose value should be an @code{exim-configuration} object as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:22865
- #, no-wrap
- msgid ""
- "(service exim-service-type\n"
- " (exim-configuration\n"
- " (config-file (local-file \"./my-exim.conf\"))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:22871
- msgid "In order to use an @code{exim-service-type} service you must also have a @code{mail-aliases-service-type} service present in your @code{operating-system} (even if it has no aliases)."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:22872
- #, no-wrap
- msgid "{Data Type} exim-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:22874
- msgid "Data type representing the configuration of exim."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:22876
- #, no-wrap
- msgid "@code{package} (default: @var{exim})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22878
- msgid "Package object of the Exim server."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:22885
- msgid "File-like object of the Exim configuration file to use. If its value is @code{#f} then use the default configuration file from the package provided in @code{package}. The resulting configuration file is loaded after setting the @code{exim_user} and @code{exim_group} configuration variables."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:22889
- #, no-wrap
- msgid "Getmail service"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:22891
- #, no-wrap
- msgid "IMAP"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:22892
- #, no-wrap
- msgid "POP"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:22894
- #, no-wrap
- msgid "{Scheme Variable} getmail-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:22897
- msgid "This is the type of the @uref{http://pyropus.ca/software/getmail/, Getmail} mail retriever, whose value should be an @code{getmail-configuration}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:22900
- msgid "Available @code{getmail-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22901
- #, no-wrap
- msgid "{@code{getmail-configuration} parameter} symbol name"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22903
- msgid "A symbol to identify the getmail service."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22905
- msgid "Defaults to @samp{\"unset\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22908
- #, no-wrap
- msgid "{@code{getmail-configuration} parameter} package package"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22910
- msgid "The getmail package to use."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22913
- #, no-wrap
- msgid "{@code{getmail-configuration} parameter} string user"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22915
- msgid "The user to run getmail as."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22917 guix-git/doc/guix.texi:22924
- msgid "Defaults to @samp{\"getmail\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22920
- #, no-wrap
- msgid "{@code{getmail-configuration} parameter} string group"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22922
- msgid "The group to run getmail as."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22927
- #, no-wrap
- msgid "{@code{getmail-configuration} parameter} string directory"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22929
- msgid "The getmail directory to use."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22931
- msgid "Defaults to @samp{\"/var/lib/getmail/default\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22934
- #, no-wrap
- msgid "{@code{getmail-configuration} parameter} getmail-configuration-file rcfile"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22936
- msgid "The getmail configuration file to use."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22938
- msgid "Available @code{getmail-configuration-file} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22939
- #, no-wrap
- msgid "{@code{getmail-configuration-file} parameter} getmail-retriever-configuration retriever"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22941
- msgid "What mail account to retrieve mail from, and how to access that account."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22943
- msgid "Available @code{getmail-retriever-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22944
- #, no-wrap
- msgid "{@code{getmail-retriever-configuration} parameter} string type"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22947
- msgid "The type of mail retriever to use. Valid values include @samp{passwd} and @samp{static}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22949
- msgid "Defaults to @samp{\"SimpleIMAPSSLRetriever\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22952
- #, no-wrap
- msgid "{@code{getmail-retriever-configuration} parameter} string server"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22954 guix-git/doc/guix.texi:22961
- msgid "Username to login to the mail server with."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22956 guix-git/doc/guix.texi:22963
- #: guix-git/doc/guix.texi:23027
- msgid "Defaults to @samp{unset}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22959
- #, no-wrap
- msgid "{@code{getmail-retriever-configuration} parameter} string username"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22966
- #, no-wrap
- msgid "{@code{getmail-retriever-configuration} parameter} non-negative-integer port"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22968
- msgid "Port number to connect to."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22973
- #, no-wrap
- msgid "{@code{getmail-retriever-configuration} parameter} string password"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22975 guix-git/doc/guix.texi:22982
- msgid "Override fields from passwd."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22980
- #, no-wrap
- msgid "{@code{getmail-retriever-configuration} parameter} list password-command"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22987
- #, no-wrap
- msgid "{@code{getmail-retriever-configuration} parameter} string keyfile"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22989
- msgid "PEM-formatted key file to use for the TLS negotiation."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22994
- #, no-wrap
- msgid "{@code{getmail-retriever-configuration} parameter} string certfile"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:22996
- msgid "PEM-formatted certificate file to use for the TLS negotiation."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23001
- #, no-wrap
- msgid "{@code{getmail-retriever-configuration} parameter} string ca-certs"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23003
- msgid "CA certificates to use."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23008
- #, no-wrap
- msgid "{@code{getmail-retriever-configuration} parameter} parameter-alist extra-parameters"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23010
- msgid "Extra retriever parameters."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23017
- #, no-wrap
- msgid "{@code{getmail-configuration-file} parameter} getmail-destination-configuration destination"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23019
- msgid "What to do with retrieved messages."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23021
- msgid "Available @code{getmail-destination-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23022
- #, no-wrap
- msgid "{@code{getmail-destination-configuration} parameter} string type"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23025
- msgid "The type of mail destination. Valid values include @samp{Maildir}, @samp{Mboxrd} and @samp{MDA_external}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23030
- #, no-wrap
- msgid "{@code{getmail-destination-configuration} parameter} string-or-filelike path"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23033
- msgid "The path option for the mail destination. The behaviour depends on the chosen type."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23038
- #, no-wrap
- msgid "{@code{getmail-destination-configuration} parameter} parameter-alist extra-parameters"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23040
- msgid "Extra destination parameters"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23047
- #, no-wrap
- msgid "{@code{getmail-configuration-file} parameter} getmail-options-configuration options"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23049
- msgid "Configure getmail."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23051
- msgid "Available @code{getmail-options-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23052
- #, no-wrap
- msgid "{@code{getmail-options-configuration} parameter} non-negative-integer verbose"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23057
- msgid "If set to @samp{0}, getmail will only print warnings and errors. A value of @samp{1} means that messages will be printed about retrieving and deleting messages. If set to @samp{2}, getmail will print messages about each of its actions."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23059 guix-git/doc/guix.texi:29641
- #: guix-git/doc/guix.texi:30229 guix-git/doc/guix.texi:30374
- msgid "Defaults to @samp{1}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23062
- #, no-wrap
- msgid "{@code{getmail-options-configuration} parameter} boolean read-all"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23065
- msgid "If true, getmail will retrieve all available messages. Otherwise it will only retrieve messages it hasn't seen previously."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23070
- #, no-wrap
- msgid "{@code{getmail-options-configuration} parameter} boolean delete"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23074
- msgid "If set to true, messages will be deleted from the server after retrieving and successfully delivering them. Otherwise, messages will be left on the server."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23079
- #, no-wrap
- msgid "{@code{getmail-options-configuration} parameter} non-negative-integer delete-after"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23084
- msgid "Getmail will delete messages this number of days after seeing them, if they have been delivered. This means messages will be left on the server this number of days after delivering them. A value of @samp{0} disabled this feature."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23089
- #, no-wrap
- msgid "{@code{getmail-options-configuration} parameter} non-negative-integer delete-bigger-than"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23093
- msgid "Delete messages larger than this of bytes after retrieving them, even if the delete and delete-after options are disabled. A value of @samp{0} disables this feature."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23098
- #, no-wrap
- msgid "{@code{getmail-options-configuration} parameter} non-negative-integer max-bytes-per-session"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23101
- msgid "Retrieve messages totalling up to this number of bytes before closing the session with the server. A value of @samp{0} disables this feature."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23106
- #, no-wrap
- msgid "{@code{getmail-options-configuration} parameter} non-negative-integer max-message-size"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23109
- msgid "Don't retrieve messages larger than this number of bytes. A value of @samp{0} disables this feature."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23114
- #, no-wrap
- msgid "{@code{getmail-options-configuration} parameter} boolean delivered-to"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23116
- msgid "If true, getmail will add a Delivered-To header to messages."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23121
- #, no-wrap
- msgid "{@code{getmail-options-configuration} parameter} boolean received"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23123
- msgid "If set, getmail adds a Received header to the messages."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23128
- #, no-wrap
- msgid "{@code{getmail-options-configuration} parameter} string message-log"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23131
- msgid "Getmail will record a log of its actions to the named file. A value of @samp{\"\"} disables this feature."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23136
- #, no-wrap
- msgid "{@code{getmail-options-configuration} parameter} boolean message-log-syslog"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23139
- msgid "If true, getmail will record a log of its actions using the system logger."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23144
- #, no-wrap
- msgid "{@code{getmail-options-configuration} parameter} boolean message-log-verbose"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23148
- msgid "If true, getmail will log information about messages not retrieved and the reason for not retrieving them, as well as starting and ending information lines."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23153
- #, no-wrap
- msgid "{@code{getmail-options-configuration} parameter} parameter-alist extra-parameters"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23155
- msgid "Extra options to include."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23164
- #, no-wrap
- msgid "{@code{getmail-configuration} parameter} list idle"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23168
- msgid "A list of mailboxes that getmail should wait on the server for new mail notifications. This depends on the server supporting the IDLE extension."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23173
- #, no-wrap
- msgid "{@code{getmail-configuration} parameter} list environment-variables"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23175
- msgid "Environment variables to set for getmail."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:23180
- #, no-wrap
- msgid "Mail Aliases Service"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:23182
- #, no-wrap
- msgid "email aliases"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:23183
- #, no-wrap
- msgid "aliases, for email addresses"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:23185
- #, no-wrap
- msgid "{Scheme Variable} mail-aliases-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:23188
- msgid "This is the type of the service which provides @code{/etc/aliases}, specifying how to deliver mail to users on this system."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:23193
- #, no-wrap
- msgid ""
- "(service mail-aliases-service-type\n"
- " '((\"postmaster\" \"bob\")\n"
- " (\"bob\" \"bob@@example.com\" \"bob@@example2.com\")))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23201
- msgid "The configuration for a @code{mail-aliases-service-type} service is an association list denoting how to deliver mail that comes to this system. Each entry is of the form @code{(alias addresses ...)}, with @code{alias} specifying the local alias and @code{addresses} specifying where to deliver this user's mail."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23207
- msgid "The aliases aren't required to exist as users on the local system. In the above example, there doesn't need to be a @code{postmaster} entry in the @code{operating-system}'s @code{user-accounts} in order to deliver the @code{postmaster} mail to @code{bob} (which subsequently would deliver mail to @code{bob@@example.com} and @code{bob@@example2.com})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:23208 guix-git/doc/guix.texi:23209
- #, no-wrap
- msgid "GNU Mailutils IMAP4 Daemon"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:23211
- #, no-wrap
- msgid "{Scheme Variable} imap4d-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:23215
- msgid "This is the type of the GNU Mailutils IMAP4 Daemon (@pxref{imap4d,,, mailutils, GNU Mailutils Manual}), whose value should be an @code{imap4d-configuration} object as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:23220
- #, no-wrap
- msgid ""
- "(service imap4d-service-type\n"
- " (imap4d-configuration\n"
- " (config-file (local-file \"imap4d.conf\"))))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:23223
- #, no-wrap
- msgid "{Data Type} imap4d-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:23225
- msgid "Data type representing the configuration of @command{imap4d}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:23227
- #, no-wrap
- msgid "@code{package} (default: @code{mailutils})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:23229
- msgid "The package that provides @command{imap4d}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:23230
- #, no-wrap
- msgid "@code{config-file} (default: @code{%default-imap4d-config-file})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:23234
- msgid "File-like object of the configuration file to use, by default it will listen on TCP port 143 of @code{localhost}. @xref{Conf-imap4d,,, mailutils, GNU Mailutils Manual}, for details."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:23238
- #, no-wrap
- msgid "Radicale Service"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:23239
- #, no-wrap
- msgid "CalDAV"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:23240
- #, no-wrap
- msgid "CardDAV"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:23242
- #, no-wrap
- msgid "{Scheme Variable} radicale-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:23245
- msgid "This is the type of the @uref{https://radicale.org, Radicale} CalDAV/CardDAV server whose value should be a @code{radicale-configuration}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:23247
- #, no-wrap
- msgid "{Data Type} radicale-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:23249
- msgid "Data type representing the configuration of @command{radicale}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:23251
- #, no-wrap
- msgid "@code{package} (default: @code{radicale})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:23253
- msgid "The package that provides @command{radicale}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:23254
- #, no-wrap
- msgid "@code{config-file} (default: @code{%default-radicale-config-file})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:23258
- msgid "File-like object of the configuration file to use, by default it will listen on TCP port 5232 of @code{localhost} and use the @code{htpasswd} file at @file{/var/lib/radicale/users} with no (@code{plain}) encryption."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:23265
- #, no-wrap
- msgid "messaging"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:23266
- #, no-wrap
- msgid "jabber"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:23267
- #, no-wrap
- msgid "XMPP"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23271
- msgid "The @code{(gnu services messaging)} module provides Guix service definitions for messaging services. Currently it provides the following services:"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:23272
- #, no-wrap
- msgid "Prosody Service"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:23274
- #, no-wrap
- msgid "{Scheme Variable} prosody-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:23278
- msgid "This is the type for the @uref{https://prosody.im, Prosody XMPP communication server}. Its value must be a @code{prosody-configuration} record as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:23293
- #, no-wrap
- msgid ""
- "(service prosody-service-type\n"
- " (prosody-configuration\n"
- " (modules-enabled (cons* \"groups\" \"mam\" %default-modules-enabled))\n"
- " (int-components\n"
- " (list\n"
- " (int-component-configuration\n"
- " (hostname \"conference.example.net\")\n"
- " (plugin \"muc\")\n"
- " (mod-muc (mod-muc-configuration)))))\n"
- " (virtualhosts\n"
- " (list\n"
- " (virtualhost-configuration\n"
- " (domain \"example.net\"))))))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:23296
- msgid "See below for details about @code{prosody-configuration}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23302
- msgid "By default, Prosody does not need much configuration. Only one @code{virtualhosts} field is needed: it specifies the domain you wish Prosody to serve."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23305
- msgid "You can perform various sanity checks on the generated configuration with the @code{prosodyctl check} command."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23309
- msgid "Prosodyctl will also help you to import certificates from the @code{letsencrypt} directory so that the @code{prosody} user can access them. See @url{https://prosody.im/doc/letsencrypt}."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:23312
- #, no-wrap
- msgid "prosodyctl --root cert import /etc/letsencrypt/live\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23319
- msgid "The available configuration parameters follow. Each parameter definition is preceded by its type; for example, @samp{string-list foo} indicates that the @code{foo} parameter should be specified as a list of strings. Types starting with @code{maybe-} denote parameters that won't show up in @code{prosody.cfg.lua} when their value is @code{'disabled}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23323
- msgid "There is also a way to specify the configuration as a string, if you have an old @code{prosody.cfg.lua} file that you want to port over from some other system; see the end for more details."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23326
- msgid "The @code{file-object} type designates either a file-like object (@pxref{G-Expressions, file-like objects}) or a file name."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23336
- msgid "Available @code{prosody-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23337
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} package prosody"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23339
- msgid "The Prosody package."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23341
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} file-name data-path"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23345
- msgid "Location of the Prosody data storage directory. See @url{https://prosody.im/doc/configure}. Defaults to @samp{\"/var/lib/prosody\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23347
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} file-object-list plugin-paths"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23351
- msgid "Additional plugin directories. They are searched in all the specified paths in order. See @url{https://prosody.im/doc/plugins_directory}. Defaults to @samp{()}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23353
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} file-name certificates"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23358
- msgid "Every virtual host and component needs a certificate so that clients and servers can securely verify its identity. Prosody will automatically load certificates/keys from the directory specified here. Defaults to @samp{\"/etc/prosody/certs\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23360
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} string-list admins"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23366
- msgid "This is a list of accounts that are admins for the server. Note that you must create the accounts separately. See @url{https://prosody.im/doc/admins} and @url{https://prosody.im/doc/creating_accounts}. Example: @code{(admins '(\"user1@@example.com\" \"user2@@example.net\"))} Defaults to @samp{()}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23368
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} boolean use-libevent?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23372
- msgid "Enable use of libevent for better performance under high load. See @url{https://prosody.im/doc/libevent}. Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23374
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} module-list modules-enabled"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23380
- msgid "This is the list of modules Prosody will load on startup. It looks for @code{mod_modulename.lua} in the plugins folder, so make sure that exists too. Documentation on modules can be found at: @url{https://prosody.im/doc/modules}. Defaults to @samp{(\"roster\" \"saslauth\" \"tls\" \"dialback\" \"disco\" \"carbons\" \"private\" \"blocklist\" \"vcard\" \"version\" \"uptime\" \"time\" \"ping\" \"pep\" \"register\" \"admin_adhoc\")}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23382
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} string-list modules-disabled"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23386
- msgid "@samp{\"offline\"}, @samp{\"c2s\"} and @samp{\"s2s\"} are auto-loaded, but should you want to disable them then add them to this list. Defaults to @samp{()}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23388
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} file-object groups-file"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23393
- msgid "Path to a text file where the shared groups are defined. If this path is empty then @samp{mod_groups} does nothing. See @url{https://prosody.im/doc/modules/mod_groups}. Defaults to @samp{\"/var/lib/prosody/sharedgroups.txt\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23395
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} boolean allow-registration?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23399
- msgid "Disable account creation by default, for security. See @url{https://prosody.im/doc/creating_accounts}. Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23401
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} maybe-ssl-configuration ssl"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23406
- msgid "These are the SSL/TLS-related settings. Most of them are disabled so to use Prosody's defaults. If you do not completely understand these options, do not add them to your config, it is easy to lower the security of your server using them. See @url{https://prosody.im/doc/advanced_ssl_config}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23408
- msgid "Available @code{ssl-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23409
- #, no-wrap
- msgid "{@code{ssl-configuration} parameter} maybe-string protocol"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23411
- msgid "This determines what handshake to use."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23413
- #, no-wrap
- msgid "{@code{ssl-configuration} parameter} maybe-file-name key"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23415
- msgid "Path to your private key file."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23417
- #, no-wrap
- msgid "{@code{ssl-configuration} parameter} maybe-file-name certificate"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23419
- msgid "Path to your certificate file."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23421
- #, no-wrap
- msgid "{@code{ssl-configuration} parameter} file-object capath"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23425
- msgid "Path to directory containing root certificates that you wish Prosody to trust when verifying the certificates of remote servers. Defaults to @samp{\"/etc/ssl/certs\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23427
- #, no-wrap
- msgid "{@code{ssl-configuration} parameter} maybe-file-object cafile"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23430
- msgid "Path to a file containing root certificates that you wish Prosody to trust. Similar to @code{capath} but with all certificates concatenated together."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23432
- #, no-wrap
- msgid "{@code{ssl-configuration} parameter} maybe-string-list verify"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23435
- msgid "A list of verification options (these mostly map to OpenSSL's @code{set_verify()} flags)."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23437
- #, no-wrap
- msgid "{@code{ssl-configuration} parameter} maybe-string-list options"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23441
- msgid "A list of general options relating to SSL/TLS@. These map to OpenSSL's @code{set_options()}. For a full list of options available in LuaSec, see the LuaSec source."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23443
- #, no-wrap
- msgid "{@code{ssl-configuration} parameter} maybe-non-negative-integer depth"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23446
- msgid "How long a chain of certificate authorities to check when looking for a trusted root certificate."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23448
- #, no-wrap
- msgid "{@code{ssl-configuration} parameter} maybe-string ciphers"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23451
- msgid "An OpenSSL cipher string. This selects what ciphers Prosody will offer to clients, and in what order."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23453
- #, no-wrap
- msgid "{@code{ssl-configuration} parameter} maybe-file-name dhparam"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23457
- msgid "A path to a file containing parameters for Diffie-Hellman key exchange. You can create such a file with: @code{openssl dhparam -out /etc/prosody/certs/dh-2048.pem 2048}"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23459
- #, no-wrap
- msgid "{@code{ssl-configuration} parameter} maybe-string curve"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23462
- msgid "Curve for Elliptic curve Diffie-Hellman. Prosody's default is @samp{\"secp384r1\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23464
- #, no-wrap
- msgid "{@code{ssl-configuration} parameter} maybe-string-list verifyext"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23466
- msgid "A list of ``extra'' verification options."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23468
- #, no-wrap
- msgid "{@code{ssl-configuration} parameter} maybe-string password"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23470
- msgid "Password for encrypted private keys."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23474
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} boolean c2s-require-encryption?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23478
- msgid "Whether to force all client-to-server connections to be encrypted or not. See @url{https://prosody.im/doc/modules/mod_tls}. Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23480
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} string-list disable-sasl-mechanisms"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23484
- msgid "Set of mechanisms that will never be offered. See @url{https://prosody.im/doc/modules/mod_saslauth}. Defaults to @samp{(\"DIGEST-MD5\")}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23486
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} boolean s2s-require-encryption?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23490
- msgid "Whether to force all server-to-server connections to be encrypted or not. See @url{https://prosody.im/doc/modules/mod_tls}. Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23492
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} boolean s2s-secure-auth?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23498
- msgid "Whether to require encryption and certificate authentication. This provides ideal security, but requires servers you communicate with to support encryption AND present valid, trusted certificates. See @url{https://prosody.im/doc/s2s#security}. Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23500
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} string-list s2s-insecure-domains"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23506
- msgid "Many servers don't support encryption or have invalid or self-signed certificates. You can list domains here that will not be required to authenticate using certificates. They will be authenticated using DNS@. See @url{https://prosody.im/doc/s2s#security}. Defaults to @samp{()}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23508
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} string-list s2s-secure-domains"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23513
- msgid "Even if you leave @code{s2s-secure-auth?} disabled, you can still require valid certificates for some domains by specifying a list here. See @url{https://prosody.im/doc/s2s#security}. Defaults to @samp{()}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23515
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} string authentication"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23523
- msgid "Select the authentication backend to use. The default provider stores passwords in plaintext and uses Prosody's configured data storage to store the authentication data. If you do not trust your server please see @url{https://prosody.im/doc/modules/mod_auth_internal_hashed} for information about using the hashed backend. See also @url{https://prosody.im/doc/authentication} Defaults to @samp{\"internal_plain\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23525
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} maybe-string log"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23529
- msgid "Set logging options. Advanced logging configuration is not yet supported by the Prosody service. See @url{https://prosody.im/doc/logging}. Defaults to @samp{\"*syslog\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23531
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} file-name pidfile"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23534
- msgid "File to write pid in. See @url{https://prosody.im/doc/modules/mod_posix}. Defaults to @samp{\"/var/run/prosody/prosody.pid\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23536
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} maybe-non-negative-integer http-max-content-size"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23538
- msgid "Maximum allowed size of the HTTP body (in bytes)."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23540
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} maybe-string http-external-url"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23545
- msgid "Some modules expose their own URL in various ways. This URL is built from the protocol, host and port used. If Prosody sits behind a proxy, the public URL will be @code{http-external-url} instead. See @url{https://prosody.im/doc/http#external_url}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23547
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} virtualhost-configuration-list virtualhosts"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23552
- msgid "A host in Prosody is a domain on which user accounts can be created. For example if you want your users to have addresses like @samp{\"john.smith@@example.com\"} then you need to add a host @samp{\"example.com\"}. All options in this list will apply only to this host."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23558
- msgid "Note: the name @emph{virtual} host is used in configuration to avoid confusion with the actual physical host that Prosody is installed on. A single Prosody instance can serve many domains, each one defined as a VirtualHost entry in Prosody's configuration. Conversely a server that hosts a single domain would have just one VirtualHost entry."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23560
- msgid "See @url{https://prosody.im/doc/configure#virtual_host_settings}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23562
- msgid "Available @code{virtualhost-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23564 guix-git/doc/guix.texi:23586
- #: guix-git/doc/guix.texi:23639
- msgid "all these @code{prosody-configuration} fields: @code{admins}, @code{use-libevent?}, @code{modules-enabled}, @code{modules-disabled}, @code{groups-file}, @code{allow-registration?}, @code{ssl}, @code{c2s-require-encryption?}, @code{disable-sasl-mechanisms}, @code{s2s-require-encryption?}, @code{s2s-secure-auth?}, @code{s2s-insecure-domains}, @code{s2s-secure-domains}, @code{authentication}, @code{log}, @code{http-max-content-size}, @code{http-external-url}, @code{raw-content}, plus:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23564
- #, no-wrap
- msgid "{@code{virtualhost-configuration} parameter} string domain"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23566
- msgid "Domain you wish Prosody to serve."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23570
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} int-component-configuration-list int-components"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23575
- msgid "Components are extra services on a server which are available to clients, usually on a subdomain of the main server (such as @samp{\"mycomponent.example.com\"}). Example components might be chatroom servers, user directories, or gateways to other protocols."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23579
- msgid "Internal components are implemented with Prosody-specific plugins. To add an internal component, you simply fill the hostname field, and the plugin you wish to use for the component."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23582
- msgid "See @url{https://prosody.im/doc/components}. Defaults to @samp{()}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23584
- msgid "Available @code{int-component-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23586
- #, no-wrap
- msgid "{@code{int-component-configuration} parameter} string hostname"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23588 guix-git/doc/guix.texi:23645
- msgid "Hostname of the component."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23590
- #, no-wrap
- msgid "{@code{int-component-configuration} parameter} string plugin"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23592
- msgid "Plugin you wish to use for the component."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23594
- #, no-wrap
- msgid "{@code{int-component-configuration} parameter} maybe-mod-muc-configuration mod-muc"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23597
- msgid "Multi-user chat (MUC) is Prosody's module for allowing you to create hosted chatrooms/conferences for XMPP users."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23601
- msgid "General information on setting up and using multi-user chatrooms can be found in the ``Chatrooms'' documentation (@url{https://prosody.im/doc/chatrooms}), which you should read if you are new to XMPP chatrooms."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23603
- msgid "See also @url{https://prosody.im/doc/modules/mod_muc}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23605
- msgid "Available @code{mod-muc-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23606
- #, no-wrap
- msgid "{@code{mod-muc-configuration} parameter} string name"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23609
- msgid "The name to return in service discovery responses. Defaults to @samp{\"Prosody Chatrooms\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23611
- #, no-wrap
- msgid "{@code{mod-muc-configuration} parameter} string-or-boolean restrict-room-creation"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23618
- msgid "If @samp{#t}, this will only allow admins to create new chatrooms. Otherwise anyone can create a room. The value @samp{\"local\"} restricts room creation to users on the service's parent domain. E.g.@: @samp{user@@example.com} can create rooms on @samp{rooms.example.com}. The value @samp{\"admin\"} restricts to service administrators only. Defaults to @samp{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23620
- #, no-wrap
- msgid "{@code{mod-muc-configuration} parameter} non-negative-integer max-history-messages"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23624
- msgid "Maximum number of history messages that will be sent to the member that has just joined the room. Defaults to @samp{20}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23630
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} ext-component-configuration-list ext-components"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23635
- msgid "External components use XEP-0114, which most standalone components support. To add an external component, you simply fill the hostname field. See @url{https://prosody.im/doc/components}. Defaults to @samp{()}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23637
- msgid "Available @code{ext-component-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23639
- #, no-wrap
- msgid "{@code{ext-component-configuration} parameter} string component-secret"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23641
- msgid "Password which the component will use to log in."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23643
- #, no-wrap
- msgid "{@code{ext-component-configuration} parameter} string hostname"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23649
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} non-negative-integer-list component-ports"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23652
- msgid "Port(s) Prosody listens on for component connections. Defaults to @samp{(5347)}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23654
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} string component-interface"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23657
- msgid "Interface Prosody listens on for component connections. Defaults to @samp{\"127.0.0.1\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23659
- #, no-wrap
- msgid "{@code{prosody-configuration} parameter} maybe-raw-content raw-content"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23661
- msgid "Raw content that will be added to the configuration file."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23669
- msgid "It could be that you just want to get a @code{prosody.cfg.lua} up and running. In that case, you can pass an @code{opaque-prosody-configuration} record as the value of @code{prosody-service-type}. As its name indicates, an opaque configuration does not have easy reflective capabilities. Available @code{opaque-prosody-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23670
- #, no-wrap
- msgid "{@code{opaque-prosody-configuration} parameter} package prosody"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23672
- msgid "The prosody package."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23674
- #, no-wrap
- msgid "{@code{opaque-prosody-configuration} parameter} string prosody.cfg.lua"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:23676
- msgid "The contents of the @code{prosody.cfg.lua} to use."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23680
- msgid "For example, if your @code{prosody.cfg.lua} is just the empty string, you could instantiate a prosody service like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:23685
- #, no-wrap
- msgid ""
- "(service prosody-service-type\n"
- " (opaque-prosody-configuration\n"
- " (prosody.cfg.lua \"\")))\n"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:23689
- #, no-wrap
- msgid "BitlBee Service"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:23691 guix-git/doc/guix.texi:23735
- #, no-wrap
- msgid "IRC (Internet Relay Chat)"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:23692
- #, no-wrap
- msgid "IRC gateway"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23695
- msgid "@url{https://bitlbee.org,BitlBee} is a gateway that provides an IRC interface to a variety of messaging protocols such as XMPP."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:23696
- #, no-wrap
- msgid "{Scheme Variable} bitlbee-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:23700
- msgid "This is the service type for the @url{https://bitlbee.org,BitlBee} IRC gateway daemon. Its value is a @code{bitlbee-configuration} (see below)."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:23703
- msgid "To have BitlBee listen on port 6667 on localhost, add this line to your services:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:23706
- #, no-wrap
- msgid "(service bitlbee-service-type)\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:23709
- #, no-wrap
- msgid "{Data Type} bitlbee-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:23711
- msgid "This is the configuration for BitlBee, with the following fields:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:23713
- #, no-wrap
- msgid "@code{interface} (default: @code{\"127.0.0.1\"})"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:23714
- #, no-wrap
- msgid "@code{port} (default: @code{6667})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:23717
- msgid "Listen on the network interface corresponding to the IP address specified in @var{interface}, on @var{port}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:23721
- msgid "When @var{interface} is @code{127.0.0.1}, only local clients can connect; when it is @code{0.0.0.0}, connections can come from any networking interface."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:23722
- #, no-wrap
- msgid "@code{bitlbee} (default: @code{bitlbee})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:23724
- msgid "The BitlBee package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:23725
- #, no-wrap
- msgid "@code{plugins} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:23727
- msgid "List of plugin packages to use---e.g., @code{bitlbee-discord}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:23730
- msgid "Configuration snippet added as-is to the BitlBee configuration file."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:23733
- #, no-wrap
- msgid "Quassel Service"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23739
- msgid "@url{https://quassel-irc.org/,Quassel} is a distributed IRC client, meaning that one or more clients can attach to and detach from the central core."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:23740
- #, no-wrap
- msgid "{Scheme Variable} quassel-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:23744
- msgid "This is the service type for the @url{https://quassel-irc.org/,Quassel} IRC backend daemon. Its value is a @code{quassel-configuration} (see below)."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:23746
- #, no-wrap
- msgid "{Data Type} quassel-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:23748
- msgid "This is the configuration for Quassel, with the following fields:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:23750
- #, no-wrap
- msgid "@code{quassel} (default: @code{quassel})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:23752
- msgid "The Quassel package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:23753
- #, no-wrap
- msgid "@code{interface} (default: @code{\"::,0.0.0.0\"})"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:23754
- #, no-wrap
- msgid "@code{port} (default: @code{4242})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:23758
- msgid "Listen on the network interface(s) corresponding to the IPv4 or IPv6 interfaces specified in the comma delimited @var{interface}, on @var{port}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:23759
- #, no-wrap
- msgid "@code{loglevel} (default: @code{\"Info\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:23762
- msgid "The level of logging desired. Accepted values are Debug, Info, Warning and Error."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:23768
- #, no-wrap
- msgid "telephony, services"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23772
- msgid "The @code{(gnu services telephony)} module contains Guix service definitions for telephony services. Currently it provides the following services:"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:23773
- #, no-wrap
- msgid "Jami"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:23775
- #, no-wrap
- msgid "jami, service"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23781
- msgid "This section describes how to configure a Jami server that can be used to host video (or audio) conferences, among other uses. The following example demonstrates how to specify Jami account archives (backups) to be provisioned automatically:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:23790
- #, no-wrap
- msgid ""
- "(service jami-service-type\n"
- " (jami-configuration\n"
- " (accounts\n"
- " (list (jami-account\n"
- " (archive \"/etc/jami/unencrypted-account-1.gz\"))\n"
- " (jami-account\n"
- " (archive \"/etc/jami/unencrypted-account-2.gz\"))))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23795
- msgid "When the accounts field is specified, the Jami account files of the service found under @file{/var/lib/jami} are recreated every time the service starts."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23800
- msgid "Jami accounts and their corresponding backup archives can be generated using either the @code{jami-qt} or @code{jami-gnome} Jami clients. The accounts should not be password-protected, but it is wise to ensure their files are only readable by @samp{root}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23803
- msgid "The next example shows how to declare that only some contacts should be allowed to communicate with a given account:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:23815
- #, no-wrap
- msgid ""
- "(service jami-service-type\n"
- " (jami-configuration\n"
- " (accounts\n"
- " (list (jami-account\n"
- " (archive \"/etc/jami/unencrypted-account-1.gz\")\n"
- " (peer-discovery? #t)\n"
- " (rendezvous-point? #t)\n"
- " (allowed-contacts\n"
- " '(\"1dbcb0f5f37324228235564b79f2b9737e9a008f\"\n"
- " \"2dbcb0f5f37324228235564b79f2b9737e9a008f\")))))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23821
- msgid "In this mode, only the declared @code{allowed-contacts} can initiate communication with the Jami account. This can be used, for example, with rendezvous point accounts to create a private video conferencing space."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23824
- msgid "To put the system administrator in full control of the conferences hosted on their system, the Jami service supports the following actions:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:23836
- #, no-wrap
- msgid ""
- "# herd doc jami list-actions\n"
- "(list-accounts\n"
- " list-account-details\n"
- " list-banned-contacts\n"
- " list-contacts\n"
- " list-moderators\n"
- " add-moderator\n"
- " ban-contact\n"
- " enable-account\n"
- " disable-account)\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23843
- msgid "The above actions aim to provide the most valuable actions for moderation purposes, not to cover the whole Jami API. Users wanting to interact with the Jami daemon from Guile may be interested in experimenting with the @code{(gnu build jami-service)} module, which powers the above Shepherd actions."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23849
- msgid "The @code{add-moderator} and @code{ban-contact} actions accept a contact @emph{fingerprint} (40 characters long hash) as first argument and an account fingerprint or username as second argument:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:23853
- #, no-wrap
- msgid ""
- "# herd add-moderator jami 1dbcb0f5f37324228235564b79f2b9737e9a008f \\\n"
- " f3345f2775ddfe07a4b0d95daea111d15fbc1199\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:23857
- #, no-wrap
- msgid ""
- "# herd list-moderators jami\n"
- "Moderators for account f3345f2775ddfe07a4b0d95daea111d15fbc1199:\n"
- " - 1dbcb0f5f37324228235564b79f2b9737e9a008f\n"
- "\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23862
- msgid "In the case of @code{ban-contact}, the second username argument is optional; when omitted, the account is banned from all Jami accounts:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:23865
- #, no-wrap
- msgid ""
- "# herd ban-contact jami 1dbcb0f5f37324228235564b79f2b9737e9a008f\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:23869
- #, no-wrap
- msgid ""
- "# herd list-banned-contacts jami\n"
- "Banned contacts for account f3345f2775ddfe07a4b0d95daea111d15fbc1199:\n"
- " - 1dbcb0f5f37324228235564b79f2b9737e9a008f\n"
- "\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23873
- msgid "Banned contacts are also stripped from their moderation privileges."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23878
- msgid "The @code{disable-account} action allows to completely disconnect an account from the network, making it unreachable, while @code{enable-account} does the inverse. They accept a single account username or fingerprint as first argument:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:23881
- #, no-wrap
- msgid ""
- "# herd disable-account jami f3345f2775ddfe07a4b0d95daea111d15fbc1199\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:23885
- #, no-wrap
- msgid ""
- "# herd list-accounts jami\n"
- "The following Jami accounts are available:\n"
- " - f3345f2775ddfe07a4b0d95daea111d15fbc1199 (dummy) [disabled]\n"
- "\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23896
- msgid "The @code{list-account-details} action prints the detailed parameters of each accounts in the Recutils format, which means the @command{recsel} command can be used to select accounts of interest (@pxref{Selection Expressions,,,recutils, GNU recutils manual}). Note that period characters (@samp{.}) found in the account parameter keys are mapped to underscores (@samp{_}) in the output, to meet the requirements of the Recutils format. The following example shows how to print the account fingerprints for all accounts operating in the rendezvous point mode:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:23901
- #, no-wrap
- msgid ""
- "# herd list-account-details jami | \\\n"
- " recsel -p Account.username -e 'Account.rendezVous ~ \"true\"'\n"
- "Account_username: f3345f2775ddfe07a4b0d95daea111d15fbc1199\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23904
- msgid "The remaining actions should be self-explanatory."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:23906
- msgid "The complete set of available configuration options is detailed below."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:23910
- #, no-wrap
- msgid "{Data Type} jami-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:23912
- msgid "Available @code{jami-configuration} fields are:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:23914
- #, no-wrap
- msgid "@code{jamid} (default: @code{libring}) (type: package)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:23916
- msgid "The Jami daemon package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:23917
- #, no-wrap
- msgid "@code{dbus} (default: @code{dbus}) (type: package)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:23919
- msgid "The D-Bus package to use to start the required D-Bus session."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:23920
- #, no-wrap
- msgid "@code{nss-certs} (default: @code{nss-certs}) (type: package)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:23922
- msgid "The nss-certs package to use to provide TLS certificates."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:23923
- #, no-wrap
- msgid "@code{enable-logging?} (default: @code{#t}) (type: boolean)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:23925
- msgid "Whether to enable logging to syslog."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:23926
- #, no-wrap
- msgid "@code{debug?} (default: @code{#f}) (type: boolean)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:23928
- msgid "Whether to enable debug level messages."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:23929
- #, no-wrap
- msgid "@code{auto-answer?} (default: @code{#f}) (type: boolean)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:23931
- msgid "Whether to force automatic answer to incoming calls."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:23932
- #, no-wrap
- msgid "@code{accounts} (default: @code{disabled}) (type: maybe-jami-account-list)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:23937
- msgid "A list of Jami accounts to be (re-)provisioned every time the Jami daemon service starts. When providing this field, the account directories under @file{/var/lib/jami/} are recreated every time the service starts, ensuring a consistent state."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:23943
- #, no-wrap
- msgid "{Data Type} jami-account"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:23945
- msgid "Available @code{jami-account} fields are:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:23947
- #, no-wrap
- msgid "@code{archive} (type: string-or-computed-file)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:23953
- msgid "The account archive (backup) file name of the account. This is used to provision the account when the service starts. The account archive should @emph{not} be encrypted. It is highly recommended to make it readable only to the @samp{root} user (i.e., not in the store), to guard against leaking the secret key material of the Jami account it contains."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:23954
- #, no-wrap
- msgid "@code{allowed-contacts} (default: @code{disabled}) (type: maybe-account-fingerprint-list)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:23961
- msgid "The list of allowed contacts for the account, entered as their 40 characters long fingerprint. Messages or calls from accounts not in that list will be rejected. When unspecified, the configuration of the account archive is used as-is with respect to contacts and public inbound calls/messaging allowance, which typically defaults to allow any contact to communicate with the account."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:23962
- #, no-wrap
- msgid "@code{moderators} (default: @code{disabled}) (type: maybe-account-fingerprint-list)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:23968
- msgid "The list of contacts that should have moderation privileges (to ban, mute, etc. other users) in rendezvous conferences, entered as their 40 characters long fingerprint. When unspecified, the configuration of the account archive is used as-is with respect to moderation, which typically defaults to allow anyone to moderate."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:23969
- #, no-wrap
- msgid "@code{rendezvous-point?} (default: @code{disabled}) (type: maybe-boolean)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:23973
- msgid "Whether the account should operate in the rendezvous mode. In this mode, all the incoming audio/video calls are mixed into a conference. When left unspecified, the value from the account archive prevails."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:23974
- #, no-wrap
- msgid "@code{peer-discovery?} (default: @code{disabled}) (type: maybe-boolean)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:23980
- msgid "Whether peer discovery should be enabled. Peer discovery is used to discover other OpenDHT nodes on the local network, which can be useful to maintain communication between devices on such network even when the connection to the the Internet has been lost. When left unspecified, the value from the account archive prevails."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:23981
- #, no-wrap
- msgid "@code{bootstrap-hostnames} (default: @code{disabled}) (type: maybe-string-list)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:23985
- msgid "A list of hostnames or IPs pointing to OpenDHT nodes, that should be used to initially join the OpenDHT network. When left unspecified, the value from the account archive prevails."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:23986
- #, no-wrap
- msgid "@code{name-server-uri} (default: @code{disabled}) (type: maybe-string)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:23989
- msgid "The URI of the name server to use, that can be used to retrieve the account fingerprint for a registered username."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:23994 guix-git/doc/guix.texi:23996
- #, no-wrap
- msgid "Murmur (VoIP server)"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:23997
- #, no-wrap
- msgid "VoIP server"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:24001
- msgid "This section describes how to set up and run a Murmur server. Murmur is the server of the @uref{https://mumble.info, Mumble} voice-over-IP (VoIP) suite."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:24002
- #, no-wrap
- msgid "{Data Type} murmur-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:24005
- msgid "The service type for the Murmur server. An example configuration can look like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:24014
- #, no-wrap
- msgid ""
- "(service murmur-service-type\n"
- " (murmur-configuration\n"
- " (welcome-text\n"
- " \"Welcome to this Mumble server running on Guix!\")\n"
- " (cert-required? #t) ;disallow text password logins\n"
- " (ssl-cert \"/etc/letsencrypt/live/mumble.example.com/fullchain.pem\")\n"
- " (ssl-key \"/etc/letsencrypt/live/mumble.example.com/privkey.pem\")))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:24018
- msgid "After reconfiguring your system, you can manually set the murmur @code{SuperUser} password with the command that is printed during the activation phase."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:24027
- msgid "It is recommended to register a normal Mumble user account and grant it admin or moderator rights. You can use the @code{mumble} client to login as new normal user, register yourself, and log out. For the next step login with the name @code{SuperUser} use the @code{SuperUser} password that you set previously, and grant your newly registered mumble user administrator or moderator rights and create some channels."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:24029
- msgid "Available @code{murmur-configuration} fields are:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24031
- #, no-wrap
- msgid "@code{package} (default: @code{mumble})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24033
- msgid "Package that contains @code{bin/murmurd}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24034
- #, no-wrap
- msgid "@code{user} (default: @code{\"murmur\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24036
- msgid "User who will run the Murmur server."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24037
- #, no-wrap
- msgid "@code{group} (default: @code{\"murmur\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24039
- msgid "Group of the user who will run the murmur server."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24040
- #, no-wrap
- msgid "@code{port} (default: @code{64738})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24042
- msgid "Port on which the server will listen."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24043
- #, no-wrap
- msgid "@code{welcome-text} (default: @code{\"\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24045
- msgid "Welcome text sent to clients when they connect."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24046
- #, no-wrap
- msgid "@code{server-password} (default: @code{\"\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24048
- msgid "Password the clients have to enter in order to connect."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24049
- #, no-wrap
- msgid "@code{max-users} (default: @code{100})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24051
- msgid "Maximum of users that can be connected to the server at once."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24052
- #, no-wrap
- msgid "@code{max-user-bandwidth} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24054
- msgid "Maximum voice traffic a user can send per second."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24055
- #, no-wrap
- msgid "@code{database-file} (default: @code{\"/var/lib/murmur/db.sqlite\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24058
- msgid "File name of the sqlite database. The service's user will become the owner of the directory."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24059
- #, no-wrap
- msgid "@code{log-file} (default: @code{\"/var/log/murmur/murmur.log\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24062
- msgid "File name of the log file. The service's user will become the owner of the directory."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24063
- #, no-wrap
- msgid "@code{autoban-attempts} (default: @code{10})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24066
- msgid "Maximum number of logins a user can make in @code{autoban-timeframe} without getting auto banned for @code{autoban-time}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24067
- #, no-wrap
- msgid "@code{autoban-timeframe} (default: @code{120})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24069
- msgid "Timeframe for autoban in seconds."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24070
- #, no-wrap
- msgid "@code{autoban-time} (default: @code{300})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24073
- msgid "Amount of time in seconds for which a client gets banned when violating the autoban limits."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24074
- #, no-wrap
- msgid "@code{opus-threshold} (default: @code{100})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24077
- msgid "Percentage of clients that need to support opus before switching over to opus audio codec."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24078
- #, no-wrap
- msgid "@code{channel-nesting-limit} (default: @code{10})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24080
- msgid "How deep channels can be nested at maximum."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24081
- #, no-wrap
- msgid "@code{channelname-regex} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24083
- msgid "A string in form of a Qt regular expression that channel names must conform to."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24084
- #, no-wrap
- msgid "@code{username-regex} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24086
- msgid "A string in form of a Qt regular expression that user names must conform to."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24087
- #, no-wrap
- msgid "@code{text-message-length} (default: @code{5000})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24089
- msgid "Maximum size in bytes that a user can send in one text chat message."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24090
- #, no-wrap
- msgid "@code{image-message-length} (default: @code{(* 128 1024)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24092
- msgid "Maximum size in bytes that a user can send in one image message."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24093
- #, no-wrap
- msgid "@code{cert-required?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24096
- msgid "If it is set to @code{#t} clients that use weak password authentication will not be accepted. Users must have completed the certificate wizard to join."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24097
- #, no-wrap
- msgid "@code{remember-channel?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24100
- msgid "Should murmur remember the last channel each user was in when they disconnected and put them into the remembered channel when they rejoin."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24101
- #, no-wrap
- msgid "@code{allow-html?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24103
- msgid "Should html be allowed in text messages, user comments, and channel descriptions."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24104
- #, no-wrap
- msgid "@code{allow-ping?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24108
- msgid "Setting to true exposes the current user count, the maximum user count, and the server's maximum bandwidth per client to unauthenticated users. In the Mumble client, this information is shown in the Connect dialog."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24110
- msgid "Disabling this setting will prevent public listing of the server."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24111
- #, no-wrap
- msgid "@code{bonjour?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24113
- msgid "Should the server advertise itself in the local network through the bonjour protocol."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24114
- #, no-wrap
- msgid "@code{send-version?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24116
- msgid "Should the murmur server version be exposed in ping requests."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24117
- #, no-wrap
- msgid "@code{log-days} (default: @code{31})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24121
- msgid "Murmur also stores logs in the database, which are accessible via RPC. The default is 31 days of months, but you can set this setting to 0 to keep logs forever, or -1 to disable logging to the database."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24122
- #, no-wrap
- msgid "@code{obfuscate-ips?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24124
- msgid "Should logged ips be obfuscated to protect the privacy of users."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24125
- #, no-wrap
- msgid "@code{ssl-cert} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24127
- msgid "File name of the SSL/TLS certificate used for encrypted connections."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:24130
- #, no-wrap
- msgid "(ssl-cert \"/etc/letsencrypt/live/example.com/fullchain.pem\")\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24131
- #, no-wrap
- msgid "@code{ssl-key} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24133
- msgid "Filepath to the ssl private key used for encrypted connections."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:24135
- #, no-wrap
- msgid "(ssl-key \"/etc/letsencrypt/live/example.com/privkey.pem\")\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24137
- #, no-wrap
- msgid "@code{ssl-dh-params} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24142
- msgid "File name of a PEM-encoded file with Diffie-Hellman parameters for the SSL/TLS encryption. Alternatively you set it to @code{\"@@ffdhe2048\"}, @code{\"@@ffdhe3072\"}, @code{\"@@ffdhe4096\"}, @code{\"@@ffdhe6144\"} or @code{\"@@ffdhe8192\"} to use bundled parameters from RFC 7919."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24143
- #, no-wrap
- msgid "@code{ssl-ciphers} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24146
- msgid "The @code{ssl-ciphers} option chooses the cipher suites to make available for use in SSL/TLS."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24150
- msgid "This option is specified using @uref{https://www.openssl.org/docs/apps/ciphers.html#CIPHER-LIST-FORMAT, OpenSSL cipher list notation}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24155
- msgid "It is recommended that you try your cipher string using 'openssl ciphers <string>' before setting it here, to get a feel for which cipher suites you will get. After setting this option, it is recommend that you inspect your Murmur log to ensure that Murmur is using the cipher suites that you expected it to."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24159
- msgid "Note: Changing this option may impact the backwards compatibility of your Murmur server, and can remove the ability for older Mumble clients to be able to connect to it."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24160
- #, no-wrap
- msgid "@code{public-registration} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24162
- msgid "Must be a @code{<murmur-public-registration-configuration>} record or @code{#f}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24167
- msgid "You can optionally register your server in the public server list that the @code{mumble} client shows on startup. You cannot register your server if you have set a @code{server-password}, or set @code{allow-ping} to @code{#f}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24169
- msgid "It might take a few hours until it shows up in the public list."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24170 guix-git/doc/guix.texi:26407
- #, no-wrap
- msgid "@code{file} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24172
- msgid "Optional alternative override for this configuration."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:24175
- #, no-wrap
- msgid "{Data Type} murmur-public-registration-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:24177
- msgid "Configuration for public registration of a murmur service."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24181
- msgid "This is a display name for your server. Not to be confused with the hostname."
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:24182 guix-git/doc/guix.texi:33135
- #: guix-git/doc/guix.texi:34304
- #, no-wrap
- msgid "password"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24185
- msgid "A password to identify your registration. Subsequent updates will need the same password. Don't lose your password."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24189
- msgid "This should be a @code{http://} or @code{https://} link to your web site."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:24190 guix-git/doc/guix.texi:27292
- #, no-wrap
- msgid "@code{hostname} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:24193
- msgid "By default your server will be listed by its IP address. If it is set your server will be linked by this host name instead."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:24203
- msgid "The @code{(gnu services file-sharing)} module provides services that assist with transferring files over peer-to-peer file-sharing networks."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:24204
- #, no-wrap
- msgid "Transmission Daemon Service"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:24212
- msgid "@uref{https://transmissionbt.com/, Transmission} is a flexible BitTorrent client that offers a variety of graphical and command-line interfaces. A @code{transmission-daemon-service-type} service provides Transmission's headless variant, @command{transmission-daemon}, as a system service, allowing users to share files via BitTorrent even when they are not logged in."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:24213
- #, no-wrap
- msgid "{Scheme Variable} transmission-daemon-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:24217
- msgid "The service type for the Transmission Daemon BitTorrent client. Its value must be a @code{transmission-daemon-configuration} object as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:24228
- #, no-wrap
- msgid ""
- "(service transmission-daemon-service-type\n"
- " (transmission-daemon-configuration\n"
- " ;; Restrict access to the RPC (\"control\") interface\n"
- " (rpc-authentication-required? #t)\n"
- " (rpc-username \"transmission\")\n"
- " (rpc-password\n"
- " (transmission-password-hash\n"
- " \"transmission\" ; desired password\n"
- " \"uKd1uMs9\")) ; arbitrary salt value\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:24233
- #, no-wrap
- msgid ""
- " ;; Accept requests from this and other hosts on the\n"
- " ;; local network\n"
- " (rpc-whitelist-enabled? #t)\n"
- " (rpc-whitelist '(\"::1\" \"127.0.0.1\" \"192.168.0.*\"))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:24237
- #, no-wrap
- msgid ""
- " ;; Limit bandwidth use during work hours\n"
- " (alt-speed-down (* 1024 2)) ; 2 MB/s\n"
- " (alt-speed-up 512) ; 512 kB/s\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:24244
- #, no-wrap
- msgid ""
- " (alt-speed-time-enabled? #t)\n"
- " (alt-speed-time-day 'weekdays)\n"
- " (alt-speed-time-begin\n"
- " (+ (* 60 8) 30)) ; 8:30 am\n"
- " (alt-speed-time-end\n"
- " (+ (* 60 (+ 12 5)) 30)))) ; 5:30 pm\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:24257
- msgid "Once the service is started, users can interact with the daemon through its Web interface (at @code{http://localhost:9091/}) or by using the @command{transmission-remote} command-line tool, available in the @code{transmission} package. (Emacs users may want to also consider the @code{emacs-transmission} package.) Both communicate with the daemon through its remote procedure call (RPC) interface, which by default is available to all users on the system; you may wish to change this by assigning values to the @code{rpc-authentication-required?}, @code{rpc-username} and @code{rpc-password} settings, as shown in the example above and documented further below."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:24265
- msgid "The value for @code{rpc-password} must be a password hash of the type generated and used by Transmission clients. This can be copied verbatim from an existing @file{settings.json} file, if another Transmission client is already being used. Otherwise, the @code{transmission-password-hash} and @code{transmission-random-salt} procedures provided by this module can be used to obtain a suitable hash value."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:24266
- #, no-wrap
- msgid "{Scheme Procedure} transmission-password-hash @var{password} @var{salt}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:24270
- msgid "Returns a string containing the result of hashing @var{password} together with @var{salt}, in the format recognized by Transmission clients for their @code{rpc-password} configuration setting."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:24274
- msgid "@var{salt} must be an eight-character string. The @code{transmission-random-salt} procedure can be used to generate a suitable salt value at random."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:24276
- #, no-wrap
- msgid "{Scheme Procedure} transmission-random-salt"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:24280
- msgid "Returns a string containing a random, eight-character salt value of the type generated and used by Transmission clients, suitable for passing to the @code{transmission-password-hash} procedure."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:24286
- msgid "These procedures are accessible from within a Guile REPL started with the @command{guix repl} command (@pxref{Invoking guix repl}). This is useful for obtaining a random salt value to provide as the second parameter to `transmission-password-hash`, as in this example session:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:24292
- #, no-wrap
- msgid ""
- "$ guix repl\n"
- "scheme@@(guix-user)> ,use (gnu services file-sharing)\n"
- "scheme@@(guix-user)> (transmission-random-salt)\n"
- "$1 = \"uKd1uMs9\"\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:24295
- msgid "Alternatively, a complete password hash can generated in a single step:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:24300
- #, no-wrap
- msgid ""
- "scheme@@(guix-user)> (transmission-password-hash \"transmission\"\n"
- "(transmission-random-salt))\n"
- "$2 = \"@{c8bbc6d1740cd8dc819a6e25563b67812c1c19c9VtFPfdsX\"\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:24305
- msgid "The resulting string can be used as-is for the value of @code{rpc-password}, allowing the password to be kept hidden even in the operating-system configuration."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:24314
- msgid "Torrent files downloaded by the daemon are directly accessible only to users in the ``transmission'' user group, who receive read-only access to the directory specified by the @code{download-dir} configuration setting (and also the directory specified by @code{incomplete-dir}, if @code{incomplete-dir-enabled?} is @code{#t}). Downloaded files can be moved to another directory or deleted altogether using @command{transmission-remote} with its @code{--move} and @code{--remove-and-delete} options."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:24321
- msgid "If the @code{watch-dir-enabled?} setting is set to @code{#t}, users in the ``transmission'' group are able also to place @file{.torrent} files in the directory specified by @code{watch-dir} to have the corresponding torrents added by the daemon. (The @code{trash-original-torrent-files?} setting controls whether the daemon deletes these files after processing them.)"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:24326
- msgid "Some of the daemon's configuration settings can be changed temporarily by @command{transmission-remote} and similar tools. To undo these changes, use the service's @code{reload} action to have the daemon reload its settings from disk:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:24329
- #, no-wrap
- msgid "# herd reload transmission-daemon\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:24333
- msgid "The full set of available configuration settings is defined by the @code{transmission-daemon-configuration} data type."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:24334
- #, no-wrap
- msgid "{Data Type} transmission-daemon-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:24338
- msgid "The data type representing configuration settings for Transmission Daemon. These correspond directly to the settings recognized by Transmission clients in their @file{settings.json} file."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:24352
- msgid "Available @code{transmission-daemon-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24353
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} package transmission"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24355
- msgid "The Transmission package to use."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24358
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer stop-wait-period"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24364
- msgid "The period, in seconds, to wait when stopping the service for @command{transmission-daemon} to exit before killing its process. This allows the daemon time to complete its housekeeping and send a final update to trackers as it shuts down. On slow hosts, or hosts with a slow network connection, this value may need to be increased."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24366 guix-git/doc/guix.texi:24738
- #: guix-git/doc/guix.texi:32101 guix-git/doc/guix.texi:32336
- #: guix-git/doc/guix.texi:32344 guix-git/doc/guix.texi:32352
- msgid "Defaults to @samp{10}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24369
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} string download-dir"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24371
- msgid "The directory to which torrent files are downloaded."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24373
- msgid "Defaults to @samp{\"/var/lib/transmission-daemon/downloads\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24376
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean incomplete-dir-enabled?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24381
- msgid "If @code{#t}, files will be held in @code{incomplete-dir} while their torrent is being downloaded, then moved to @code{download-dir} once the torrent is complete. Otherwise, files for all torrents (including those still being downloaded) will be placed in @code{download-dir}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24386
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} maybe-string incomplete-dir"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24389
- msgid "The directory in which files from incompletely downloaded torrents will be held when @code{incomplete-dir-enabled?} is @code{#t}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24394
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} umask umask"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24397
- msgid "The file mode creation mask used for downloaded files. (See the @command{umask} man page for more information.)"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24399
- msgid "Defaults to @samp{18}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24402
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean rename-partial-files?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24405
- msgid "When @code{#t}, ``.part'' is appended to the name of partially downloaded files."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24410
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} preallocation-mode preallocation"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24415
- msgid "The mode by which space should be preallocated for downloaded files, one of @code{none}, @code{fast} (or @code{sparse}) and @code{full}. Specifying @code{full} will minimize disk fragmentation at a cost to file-creation speed."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24417
- msgid "Defaults to @samp{fast}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24420
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean watch-dir-enabled?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24425
- msgid "If @code{#t}, the directory specified by @code{watch-dir} will be watched for new @file{.torrent} files and the torrents they describe added automatically (and the original files removed, if @code{trash-original-torrent-files?} is @code{#t})."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24430
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} maybe-string watch-dir"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24433
- msgid "The directory to be watched for @file{.torrent} files indicating new torrents to be added, when @code{watch-dir-enabled} is @code{#t}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24438
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean trash-original-torrent-files?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24442
- msgid "When @code{#t}, @file{.torrent} files will be deleted from the watch directory once their torrent has been added (see @code{watch-directory-enabled?})."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24447
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean speed-limit-down-enabled?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24450
- msgid "When @code{#t}, the daemon's download speed will be limited to the rate specified by @code{speed-limit-down}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24455
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer speed-limit-down"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24457
- msgid "The default global-maximum download speed, in kilobytes per second."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24462
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean speed-limit-up-enabled?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24465
- msgid "When @code{#t}, the daemon's upload speed will be limited to the rate specified by @code{speed-limit-up}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24470
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer speed-limit-up"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24472
- msgid "The default global-maximum upload speed, in kilobytes per second."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24477
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean alt-speed-enabled?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24483
- msgid "When @code{#t}, the alternate speed limits @code{alt-speed-down} and @code{alt-speed-up} are used (in place of @code{speed-limit-down} and @code{speed-limit-up}, if they are enabled) to constrain the daemon's bandwidth usage. This can be scheduled to occur automatically at certain times during the week; see @code{alt-speed-time-enabled?}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24488
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer alt-speed-down"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24490
- msgid "The alternate global-maximum download speed, in kilobytes per second."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24492 guix-git/doc/guix.texi:24499
- #: guix-git/doc/guix.texi:24671 guix-git/doc/guix.texi:32108
- #: guix-git/doc/guix.texi:32123
- msgid "Defaults to @samp{50}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24495
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer alt-speed-up"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24497
- msgid "The alternate global-maximum upload speed, in kilobytes per second."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24502
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean alt-speed-time-enabled?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24507
- msgid "When @code{#t}, the alternate speed limits @code{alt-speed-down} and @code{alt-speed-up} will be enabled automatically during the periods specified by @code{alt-speed-time-day}, @code{alt-speed-time-begin} and @code{alt-time-speed-end}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24512
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} day-list alt-speed-time-day"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24517
- msgid "The days of the week on which the alternate-speed schedule should be used, specified either as a list of days (@code{sunday}, @code{monday}, and so on) or using one of the symbols @code{weekdays}, @code{weekends} or @code{all}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24519
- msgid "Defaults to @samp{all}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24522
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer alt-speed-time-begin"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24525
- msgid "The time of day at which to enable the alternate speed limits, expressed as a number of minutes since midnight."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24527
- msgid "Defaults to @samp{540}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24530
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer alt-speed-time-end"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24533
- msgid "The time of day at which to disable the alternate speed limits, expressed as a number of minutes since midnight."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24535
- msgid "Defaults to @samp{1020}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24538
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} string bind-address-ipv4"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24541
- msgid "The IP address at which to listen for peer connections, or ``0.0.0.0'' to listen at all available IP addresses."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24543 guix-git/doc/guix.texi:24846
- #: guix-git/doc/guix.texi:29969
- msgid "Defaults to @samp{\"0.0.0.0\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24546
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} string bind-address-ipv6"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24549
- msgid "The IPv6 address at which to listen for peer connections, or ``::'' to listen at all available IPv6 addresses."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24551
- msgid "Defaults to @samp{\"::\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24554
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean peer-port-random-on-start?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24560
- msgid "If @code{#t}, when the daemon starts it will select a port at random on which to listen for peer connections, from the range specified (inclusively) by @code{peer-port-random-low} and @code{peer-port-random-high}. Otherwise, it listens on the port specified by @code{peer-port}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24565
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} port-number peer-port-random-low"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24568
- msgid "The lowest selectable port number when @code{peer-port-random-on-start?} is @code{#t}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24570
- msgid "Defaults to @samp{49152}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24573
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} port-number peer-port-random-high"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24576
- msgid "The highest selectable port number when @code{peer-port-random-on-start} is @code{#t}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24578
- msgid "Defaults to @samp{65535}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24581
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} port-number peer-port"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24584
- msgid "The port on which to listen for peer connections when @code{peer-port-random-on-start?} is @code{#f}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24586
- msgid "Defaults to @samp{51413}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24589
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean port-forwarding-enabled?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24593
- msgid "If @code{#t}, the daemon will attempt to configure port-forwarding on an upstream gateway automatically using @acronym{UPnP} and @acronym{NAT-PMP}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24598
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} encryption-mode encryption"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24603
- msgid "The encryption preference for peer connections, one of @code{prefer-unencrypted-connections}, @code{prefer-encrypted-connections} or @code{require-encrypted-connections}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24605
- msgid "Defaults to @samp{prefer-encrypted-connections}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24608
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} maybe-string peer-congestion-algorithm"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24613
- msgid "The TCP congestion-control algorithm to use for peer connections, specified using a string recognized by the operating system in calls to @code{setsockopt} (or set to @code{disabled}, in which case the operating-system default is used)."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24622
- msgid "Note that on GNU/Linux systems, the kernel must be configured to allow processes to use a congestion-control algorithm not in the default set; otherwise, it will deny these requests with ``Operation not permitted''. To see which algorithms are available on your system and which are currently permitted for use, look at the contents of the files @file{tcp_available_congestion_control} and @file{tcp_allowed_congestion_control} in the @file{/proc/sys/net/ipv4} directory."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24630
- msgid "As an example, to have Transmission Daemon use @uref{http://www-ece.rice.edu/networks/TCP-LP/,the TCP Low Priority congestion-control algorithm}, you'll need to modify your kernel configuration to build in support for the algorithm, then update your operating-system configuration to allow its use by adding a @code{sysctl-service-type} service (or updating the existing one's configuration) with lines like the following:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:24637
- #, no-wrap
- msgid ""
- "(service sysctl-service-type\n"
- " (sysctl-configuration\n"
- " (settings\n"
- " (\"net.ipv4.tcp_allowed_congestion_control\" .\n"
- " \"reno cubic lp\"))))\n"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24640
- msgid "The Transmission Daemon configuration can then be updated with"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:24643
- #, no-wrap
- msgid "(peer-congestion-algorithm \"lp\")\n"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24646
- msgid "and the system reconfigured to have the changes take effect."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24651
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} tcp-type-of-service peer-socket-tos"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24655
- msgid "The type of service to request in outgoing @acronym{TCP} packets, one of @code{default}, @code{low-cost}, @code{throughput}, @code{low-delay} and @code{reliability}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24657
- msgid "Defaults to @samp{default}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24660
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer peer-limit-global"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24662
- msgid "The global limit on the number of connected peers."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24664
- msgid "Defaults to @samp{200}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24667
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer peer-limit-per-torrent"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24669
- msgid "The per-torrent limit on the number of connected peers."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24674
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer upload-slots-per-torrent"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24677
- msgid "The maximum number of peers to which the daemon will upload data simultaneously for each torrent."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24679
- msgid "Defaults to @samp{14}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24682
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer peer-id-ttl-hours"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24685
- msgid "The maximum lifespan, in hours, of the peer ID associated with each public torrent before it is regenerated."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24687
- msgid "Defaults to @samp{6}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24690
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean blocklist-enabled?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24693
- msgid "When @code{#t}, the daemon will ignore peers mentioned in the blocklist it has most recently downloaded from @code{blocklist-url}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24698
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} maybe-string blocklist-url"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24702
- msgid "The URL of a peer blocklist (in @acronym{P2P}-plaintext or eMule @file{.dat} format) to be periodically downloaded and applied when @code{blocklist-enabled?} is @code{#t}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24707
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean download-queue-enabled?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24710
- msgid "If @code{#t}, the daemon will be limited to downloading at most @code{download-queue-size} non-stalled torrents simultaneously."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24715
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer download-queue-size"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24719
- msgid "The size of the daemon's download queue, which limits the number of non-stalled torrents it will download at any one time when @code{download-queue-enabled?} is @code{#t}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24724
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean seed-queue-enabled?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24727
- msgid "If @code{#t}, the daemon will be limited to seeding at most @code{seed-queue-size} non-stalled torrents simultaneously."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24732
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer seed-queue-size"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24736
- msgid "The size of the daemon's seed queue, which limits the number of non-stalled torrents it will seed at any one time when @code{seed-queue-enabled?} is @code{#t}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24741
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean queue-stalled-enabled?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24746
- msgid "When @code{#t}, the daemon will consider torrents for which it has not shared data in the past @code{queue-stalled-minutes} minutes to be stalled and not count them against its @code{download-queue-size} and @code{seed-queue-size} limits."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24751
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer queue-stalled-minutes"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24755
- msgid "The maximum period, in minutes, a torrent may be idle before it is considered to be stalled, when @code{queue-stalled-enabled?} is @code{#t}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24760
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean ratio-limit-enabled?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24763
- msgid "When @code{#t}, a torrent being seeded will automatically be paused once it reaches the ratio specified by @code{ratio-limit}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24768
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} non-negative-rational ratio-limit"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24771
- msgid "The ratio at which a torrent being seeded will be paused, when @code{ratio-limit-enabled?} is @code{#t}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24773
- msgid "Defaults to @samp{2.0}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24776
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean idle-seeding-limit-enabled?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24779
- msgid "When @code{#t}, a torrent being seeded will automatically be paused once it has been idle for @code{idle-seeding-limit} minutes."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24784
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer idle-seeding-limit"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24788
- msgid "The maximum period, in minutes, a torrent being seeded may be idle before it is paused, when @code{idle-seeding-limit-enabled?} is @code{#t}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24793
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean dht-enabled?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24797
- msgid "Enable @uref{http://bittorrent.org/beps/bep_0005.html,the distributed hash table (@acronym{DHT}) protocol}, which supports the use of trackerless torrents."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24802
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean lpd-enabled?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24807
- msgid "Enable @uref{https://en.wikipedia.org/wiki/Local_Peer_Discovery,local peer discovery} (@acronym{LPD}), which allows the discovery of peers on the local network and may reduce the amount of data sent over the public Internet."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24812
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean pex-enabled?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24816
- msgid "Enable @uref{https://en.wikipedia.org/wiki/Peer_exchange,peer exchange} (@acronym{PEX}), which reduces the daemon's reliance on external trackers and may improve its performance."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24821
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean utp-enabled?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24826
- msgid "Enable @uref{http://bittorrent.org/beps/bep_0029.html,the micro transport protocol} (@acronym{uTP}), which aims to reduce the impact of BitTorrent traffic on other users of the local network while maintaining full utilization of the available bandwidth."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24831
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean rpc-enabled?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24836
- msgid "If @code{#t}, enable the remote procedure call (@acronym{RPC}) interface, which allows remote control of the daemon via its Web interface, the @command{transmission-remote} command-line client, and similar tools."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24841
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} string rpc-bind-address"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24844
- msgid "The IP address at which to listen for @acronym{RPC} connections, or ``0.0.0.0'' to listen at all available IP addresses."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24849
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} port-number rpc-port"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24851
- msgid "The port on which to listen for @acronym{RPC} connections."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24853
- msgid "Defaults to @samp{9091}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24856
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} string rpc-url"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24858
- msgid "The path prefix to use in the @acronym{RPC}-endpoint @acronym{URL}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24860
- msgid "Defaults to @samp{\"/transmission/\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24863
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean rpc-authentication-required?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24868
- msgid "When @code{#t}, clients must authenticate (see @code{rpc-username} and @code{rpc-password}) when using the @acronym{RPC} interface. Note this has the side effect of disabling host-name whitelisting (see @code{rpc-host-whitelist-enabled?}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24873
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} maybe-string rpc-username"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24876
- msgid "The username required by clients to access the @acronym{RPC} interface when @code{rpc-authentication-required?} is @code{#t}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24881
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} maybe-transmission-password-hash rpc-password"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24887
- msgid "The password required by clients to access the @acronym{RPC} interface when @code{rpc-authentication-required?} is @code{#t}. This must be specified using a password hash in the format recognized by Transmission clients, either copied from an existing @file{settings.json} file or generated using the @code{transmission-password-hash} procedure."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24892
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean rpc-whitelist-enabled?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24895
- msgid "When @code{#t}, @acronym{RPC} requests will be accepted only when they originate from an address specified in @code{rpc-whitelist}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24900
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} string-list rpc-whitelist"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24904
- msgid "The list of IP and IPv6 addresses from which @acronym{RPC} requests will be accepted when @code{rpc-whitelist-enabled?} is @code{#t}. Wildcards may be specified using @samp{*}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24906
- msgid "Defaults to @samp{(\"127.0.0.1\" \"::1\")}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24909
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean rpc-host-whitelist-enabled?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24914
- msgid "When @code{#t}, @acronym{RPC} requests will be accepted only when they are addressed to a host named in @code{rpc-host-whitelist}. Note that requests to ``localhost'' or ``localhost.'', or to a numeric address, are always accepted regardless of these settings."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24917
- msgid "Note also this functionality is disabled when @code{rpc-authentication-required?} is @code{#t}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24922
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} string-list rpc-host-whitelist"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24925
- msgid "The list of host names recognized by the @acronym{RPC} server when @code{rpc-host-whitelist-enabled?} is @code{#t}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24930
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} message-level message-level"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24934
- msgid "The minimum severity level of messages to be logged (to @file{/var/log/transmission.log}) by the daemon, one of @code{none} (no logging), @code{error}, @code{info} and @code{debug}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24939
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean start-added-torrents?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24942
- msgid "When @code{#t}, torrents are started as soon as they are added; otherwise, they are added in ``paused'' state."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24947
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean script-torrent-done-enabled?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24951
- msgid "When @code{#t}, the script specified by @code{script-torrent-done-filename} will be invoked each time a torrent completes."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24956
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} maybe-file-object script-torrent-done-filename"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24960
- msgid "A file name or file-like object specifying a script to run each time a torrent completes, when @code{script-torrent-done-enabled?} is @code{#t}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24965
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean scrape-paused-torrents-enabled?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24968
- msgid "When @code{#t}, the daemon will scrape trackers for a torrent even when the torrent is paused."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24973
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer cache-size-mb"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24977
- msgid "The amount of memory, in megabytes, to allocate for the daemon's in-memory cache. A larger value may increase performance by reducing the frequency of disk I/O."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24979
- msgid "Defaults to @samp{4}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24982
- #, no-wrap
- msgid "{@code{transmission-daemon-configuration} parameter} boolean prefetch-enabled?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:24986
- msgid "When @code{#t}, the daemon will try to improve I/O performance by hinting to the operating system which data is likely to be read next from disk to satisfy requests from peers."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:24999
- #, no-wrap
- msgid "Tailon Service"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:25003
- msgid "@uref{https://tailon.readthedocs.io/, Tailon} is a web application for viewing and searching log files."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:25006
- msgid "The following example will configure the service with default values. By default, Tailon can be accessed on port 8080 (@code{http://localhost:8080})."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:25009
- #, no-wrap
- msgid "(service tailon-service-type)\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:25013
- msgid "The following example customises more of the Tailon configuration, adding @command{sed} to the list of allowed commands."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:25020
- #, no-wrap
- msgid ""
- "(service tailon-service-type\n"
- " (tailon-configuration\n"
- " (config-file\n"
- " (tailon-configuration-file\n"
- " (allowed-commands '(\"tail\" \"grep\" \"awk\" \"sed\"))))))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:25023
- #, no-wrap
- msgid "{Data Type} tailon-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:25026
- msgid "Data type representing the configuration of Tailon. This type has the following parameters:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25028
- #, no-wrap
- msgid "@code{config-file} (default: @code{(tailon-configuration-file)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25032
- msgid "The configuration file to use for Tailon. This can be set to a @dfn{tailon-configuration-file} record value, or any gexp (@pxref{G-Expressions})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25035
- msgid "For example, to instead use a local file, the @code{local-file} function can be used:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:25040
- #, no-wrap
- msgid ""
- "(service tailon-service-type\n"
- " (tailon-configuration\n"
- " (config-file (local-file \"./my-tailon.conf\"))))\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25042
- #, no-wrap
- msgid "@code{package} (default: @code{tailon})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25044
- msgid "The tailon package to use."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:25048
- #, no-wrap
- msgid "{Data Type} tailon-configuration-file"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:25051
- msgid "Data type representing the configuration options for Tailon. This type has the following parameters:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25053
- #, no-wrap
- msgid "@code{files} (default: @code{(list \"/var/log\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25058
- msgid "List of files to display. The list can include strings for a single file or directory, or a list, where the first item is the name of a subsection, and the remaining items are the files or directories in that subsection."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25059
- #, no-wrap
- msgid "@code{bind} (default: @code{\"localhost:8080\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25061
- msgid "Address and port to which Tailon should bind on."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25062
- #, no-wrap
- msgid "@code{relative-root} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25064
- msgid "URL path to use for Tailon, set to @code{#f} to not use a path."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25065
- #, no-wrap
- msgid "@code{allow-transfers?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25067
- msgid "Allow downloading the log files in the web interface."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25068
- #, no-wrap
- msgid "@code{follow-names?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25070
- msgid "Allow tailing of not-yet existent files."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25071
- #, no-wrap
- msgid "@code{tail-lines} (default: @code{200})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25073
- msgid "Number of lines to read initially from each file."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25074
- #, no-wrap
- msgid "@code{allowed-commands} (default: @code{(list \"tail\" \"grep\" \"awk\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25076
- msgid "Commands to allow running. By default, @code{sed} is disabled."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25079
- msgid "Set @code{debug?} to @code{#t} to show debug messages."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25080
- #, no-wrap
- msgid "@code{wrap-lines} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25084
- msgid "Initial line wrapping state in the web interface. Set to @code{#t} to initially wrap lines (the default), or to @code{#f} to initially not wrap lines."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25085
- #, no-wrap
- msgid "@code{http-auth} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25089
- msgid "HTTP authentication type to use. Set to @code{#f} to disable authentication (the default). Supported values are @code{\"digest\"} or @code{\"basic\"}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25090
- #, no-wrap
- msgid "@code{users} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25095
- msgid "If HTTP authentication is enabled (see @code{http-auth}), access will be restricted to the credentials provided here. To configure users, use a list of pairs, where the first element of the pair is the username, and the 2nd element of the pair is the password."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:25101
- #, no-wrap
- msgid ""
- "(tailon-configuration-file\n"
- " (http-auth \"basic\")\n"
- " (users '((\"user1\" . \"password1\")\n"
- " (\"user2\" . \"password2\"))))\n"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:25107
- #, no-wrap
- msgid "Darkstat Service"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:25108
- #, no-wrap
- msgid "darkstat"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:25111
- msgid "Darkstat is a packet sniffer that captures network traffic, calculates statistics about usage, and serves reports over HTTP."
- msgstr ""
- #. type: defvar
- #: guix-git/doc/guix.texi:25112
- #, no-wrap
- msgid "{Scheme Variable} darkstat-service-type"
- msgstr ""
- #. type: defvar
- #: guix-git/doc/guix.texi:25117
- msgid "This is the service type for the @uref{https://unix4lyfe.org/darkstat/, darkstat} service, its value must be a @code{darkstat-configuration} record as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:25122
- #, no-wrap
- msgid ""
- "(service darkstat-service-type\n"
- " (darkstat-configuration\n"
- " (interface \"eno1\")))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:25125
- #, no-wrap
- msgid "{Data Type} darkstat-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:25127
- msgid "Data type representing the configuration of @command{darkstat}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25129
- #, no-wrap
- msgid "@code{package} (default: @code{darkstat})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25131
- msgid "The darkstat package to use."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:25132
- #, no-wrap
- msgid "interface"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25134
- msgid "Capture traffic on the specified network interface."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25135
- #, no-wrap
- msgid "@code{port} (default: @code{\"667\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25137
- msgid "Bind the web interface to the specified port."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25140 guix-git/doc/guix.texi:25175
- msgid "Bind the web interface to the specified address."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25141
- #, no-wrap
- msgid "@code{base} (default: @code{\"/\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25144
- msgid "Specify the path of the base URL@. This can be useful if @command{darkstat} is accessed via a reverse proxy."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:25148
- #, no-wrap
- msgid "Prometheus Node Exporter Service"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:25150
- #, no-wrap
- msgid "prometheus-node-exporter"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:25155
- msgid "The Prometheus ``node exporter'' makes hardware and operating system statistics provided by the Linux kernel available for the Prometheus monitoring system. This service should be deployed on all physical nodes and virtual machines, where monitoring these statistics is desirable."
- msgstr ""
- #. type: defvar
- #: guix-git/doc/guix.texi:25156
- #, no-wrap
- msgid "{Scheme variable} prometheus-node-exporter-service-type"
- msgstr ""
- #. type: defvar
- #: guix-git/doc/guix.texi:25160
- msgid "This is the service type for the @uref{https://github.com/prometheus/node_exporter/, prometheus-node-exporter} service, its value must be a @code{prometheus-node-exporter-configuration}."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:25163
- #, no-wrap
- msgid "(service prometheus-node-exporter-service-type)\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:25166
- #, no-wrap
- msgid "{Data Type} prometheus-node-exporter-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:25168
- msgid "Data type representing the configuration of @command{node_exporter}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25170
- #, no-wrap
- msgid "@code{package} (default: @code{go-github-com-prometheus-node-exporter})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25172
- msgid "The prometheus-node-exporter package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25173
- #, no-wrap
- msgid "@code{web-listen-address} (default: @code{\":9100\"})"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25176
- #, no-wrap
- msgid "@code{textfile-directory} (default: @code{\"/var/lib/prometheus/node-exporter\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25180
- msgid "This directory can be used to export metrics specific to this machine. Files containing metrics in the text format, with the filename ending in @code{.prom} should be placed in this directory."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25183
- msgid "Extra options to pass to the Prometheus node exporter."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:25187
- #, no-wrap
- msgid "Zabbix server"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:25188
- #, no-wrap
- msgid "zabbix zabbix-server"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:25191
- msgid "Zabbix provides monitoring metrics, among others network utilization, CPU load and disk space consumption:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25193
- #, no-wrap
- msgid "High performance, high capacity (able to monitor hundreds of thousands of devices)."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25194
- #, no-wrap
- msgid "Auto-discovery of servers and network devices and interfaces."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25195
- #, no-wrap
- msgid "Low-level discovery, allows to automatically start monitoring new items, file systems or network interfaces among others."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25196
- #, no-wrap
- msgid "Distributed monitoring with centralized web administration."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25197
- #, no-wrap
- msgid "Native high performance agents."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25198
- #, no-wrap
- msgid "SLA, and ITIL KPI metrics on reporting."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25199
- #, no-wrap
- msgid "High-level (business) view of monitored resources through user-defined visual console screens and dashboards."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25200
- #, no-wrap
- msgid "Remote command execution through Zabbix proxies."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:25206
- msgid "Available @code{zabbix-server-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25207
- #, no-wrap
- msgid "{@code{zabbix-server-configuration} parameter} package zabbix-server"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25209
- msgid "The zabbix-server package."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25212
- #, no-wrap
- msgid "{@code{zabbix-server-configuration} parameter} string user"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25214
- msgid "User who will run the Zabbix server."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25216 guix-git/doc/guix.texi:25223
- #: guix-git/doc/guix.texi:25237 guix-git/doc/guix.texi:25244
- #: guix-git/doc/guix.texi:25345 guix-git/doc/guix.texi:25352
- #: guix-git/doc/guix.texi:25463 guix-git/doc/guix.texi:25470
- msgid "Defaults to @samp{\"zabbix\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25219
- #, no-wrap
- msgid "{@code{zabbix-server-configuration} parameter} group group"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25221
- msgid "Group who will run the Zabbix server."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25226
- #, no-wrap
- msgid "{@code{zabbix-server-configuration} parameter} string db-host"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25228 guix-git/doc/guix.texi:25447
- msgid "Database host name."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25230
- msgid "Defaults to @samp{\"127.0.0.1\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25233
- #, no-wrap
- msgid "{@code{zabbix-server-configuration} parameter} string db-name"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25235 guix-git/doc/guix.texi:25461
- msgid "Database name."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25240
- #, no-wrap
- msgid "{@code{zabbix-server-configuration} parameter} string db-user"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25242 guix-git/doc/guix.texi:25468
- msgid "Database user."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25247
- #, no-wrap
- msgid "{@code{zabbix-server-configuration} parameter} string db-password"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25250
- msgid "Database password. Please, use @code{include-files} with @code{DBPassword=SECRET} inside a specified file instead."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25255
- #, no-wrap
- msgid "{@code{zabbix-server-configuration} parameter} number db-port"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25257 guix-git/doc/guix.texi:25454
- msgid "Database port."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25259 guix-git/doc/guix.texi:25456
- msgid "Defaults to @samp{5432}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25262
- #, no-wrap
- msgid "{@code{zabbix-server-configuration} parameter} string log-type"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25264 guix-git/doc/guix.texi:25365
- msgid "Specifies where log messages are written to:"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:25268 guix-git/doc/guix.texi:25369
- msgid "@code{system} - syslog."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:25271 guix-git/doc/guix.texi:25372
- msgid "@code{file} - file specified with @code{log-file} parameter."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:25274 guix-git/doc/guix.texi:25375
- msgid "@code{console} - standard output."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25281
- #, no-wrap
- msgid "{@code{zabbix-server-configuration} parameter} string log-file"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25283 guix-git/doc/guix.texi:25384
- msgid "Log file name for @code{log-type} @code{file} parameter."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25285
- msgid "Defaults to @samp{\"/var/log/zabbix/server.log\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25288
- #, no-wrap
- msgid "{@code{zabbix-server-configuration} parameter} string pid-file"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25290 guix-git/doc/guix.texi:25391
- msgid "Name of PID file."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25292
- msgid "Defaults to @samp{\"/var/run/zabbix/zabbix_server.pid\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25295
- #, no-wrap
- msgid "{@code{zabbix-server-configuration} parameter} string ssl-ca-location"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25298
- msgid "The location of certificate authority (CA) files for SSL server certificate verification."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25300
- msgid "Defaults to @samp{\"/etc/ssl/certs/ca-certificates.crt\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25303
- #, no-wrap
- msgid "{@code{zabbix-server-configuration} parameter} string ssl-cert-location"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25305
- msgid "Location of SSL client certificates."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25307
- msgid "Defaults to @samp{\"/etc/ssl/certs\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25310
- #, no-wrap
- msgid "{@code{zabbix-server-configuration} parameter} string extra-options"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25312 guix-git/doc/guix.texi:25416
- msgid "Extra options will be appended to Zabbix server configuration file."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25317
- #, no-wrap
- msgid "{@code{zabbix-server-configuration} parameter} include-files include-files"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25320 guix-git/doc/guix.texi:25424
- msgid "You may include individual files or all files in a directory in the configuration file."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:25327
- #, no-wrap
- msgid "Zabbix agent"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:25328
- #, no-wrap
- msgid "zabbix zabbix-agent"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:25331
- msgid "Zabbix agent gathers information for Zabbix server."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:25335
- msgid "Available @code{zabbix-agent-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25336
- #, no-wrap
- msgid "{@code{zabbix-agent-configuration} parameter} package zabbix-agent"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25338
- msgid "The zabbix-agent package."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25341
- #, no-wrap
- msgid "{@code{zabbix-agent-configuration} parameter} string user"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25343
- msgid "User who will run the Zabbix agent."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25348
- #, no-wrap
- msgid "{@code{zabbix-agent-configuration} parameter} group group"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25350
- msgid "Group who will run the Zabbix agent."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25355
- #, no-wrap
- msgid "{@code{zabbix-agent-configuration} parameter} string hostname"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25358
- msgid "Unique, case sensitive hostname which is required for active checks and must match hostname as configured on the server."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25363
- #, no-wrap
- msgid "{@code{zabbix-agent-configuration} parameter} string log-type"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25382
- #, no-wrap
- msgid "{@code{zabbix-agent-configuration} parameter} string log-file"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25386
- msgid "Defaults to @samp{\"/var/log/zabbix/agent.log\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25389
- #, no-wrap
- msgid "{@code{zabbix-agent-configuration} parameter} string pid-file"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25393
- msgid "Defaults to @samp{\"/var/run/zabbix/zabbix_agent.pid\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25396
- #, no-wrap
- msgid "{@code{zabbix-agent-configuration} parameter} list server"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25400
- msgid "List of IP addresses, optionally in CIDR notation, or hostnames of Zabbix servers and Zabbix proxies. Incoming connections will be accepted only from the hosts listed here."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25402 guix-git/doc/guix.texi:25411
- msgid "Defaults to @samp{(\"127.0.0.1\")}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25405
- #, no-wrap
- msgid "{@code{zabbix-agent-configuration} parameter} list server-active"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25409
- msgid "List of IP:port (or hostname:port) pairs of Zabbix servers and Zabbix proxies for active checks. If port is not specified, default port is used. If this parameter is not specified, active checks are disabled."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25414
- #, no-wrap
- msgid "{@code{zabbix-agent-configuration} parameter} string extra-options"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25421
- #, no-wrap
- msgid "{@code{zabbix-agent-configuration} parameter} include-files include-files"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:25431
- #, no-wrap
- msgid "Zabbix front-end"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:25432
- #, no-wrap
- msgid "zabbix zabbix-front-end"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:25435
- msgid "This service provides a WEB interface to Zabbix server."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:25439
- msgid "Available @code{zabbix-front-end-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25440
- #, no-wrap
- msgid "{@code{zabbix-front-end-configuration} parameter} nginx-server-configuration-list nginx"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25442 guix-git/doc/guix.texi:31735
- msgid "NGINX configuration."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25445
- #, no-wrap
- msgid "{@code{zabbix-front-end-configuration} parameter} string db-host"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25452
- #, no-wrap
- msgid "{@code{zabbix-front-end-configuration} parameter} number db-port"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25459
- #, no-wrap
- msgid "{@code{zabbix-front-end-configuration} parameter} string db-name"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25466
- #, no-wrap
- msgid "{@code{zabbix-front-end-configuration} parameter} string db-user"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25473
- #, no-wrap
- msgid "{@code{zabbix-front-end-configuration} parameter} string db-password"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25475
- msgid "Database password. Please, use @code{db-secret-file} instead."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25480
- #, no-wrap
- msgid "{@code{zabbix-front-end-configuration} parameter} string db-secret-file"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25485
- msgid "Secret file containing the credentials for the Zabbix front-end. The value must be a local file name, not a G-expression. You are expected to create this file manually. Its contents will be copied into @file{zabbix.conf.php} as the value of @code{$DB['PASSWORD']}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25490
- #, no-wrap
- msgid "{@code{zabbix-front-end-configuration} parameter} string zabbix-host"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25492
- msgid "Zabbix server hostname."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25497
- #, no-wrap
- msgid "{@code{zabbix-front-end-configuration} parameter} number zabbix-port"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25499
- msgid "Zabbix server port."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25501
- msgid "Defaults to @samp{10051}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:25509
- #, no-wrap
- msgid "Kerberos"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:25513
- msgid "The @code{(gnu services kerberos)} module provides services relating to the authentication protocol @dfn{Kerberos}."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:25514
- #, no-wrap
- msgid "Krb5 Service"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:25521
- msgid "Programs using a Kerberos client library normally expect a configuration file in @file{/etc/krb5.conf}. This service generates such a file from a definition provided in the operating system declaration. It does not cause any daemon to be started."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:25525
- msgid "No ``keytab'' files are provided by this service---you must explicitly create them. This service is known to work with the MIT client library, @code{mit-krb5}. Other implementations have not been tested."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:25526
- #, no-wrap
- msgid "{Scheme Variable} krb5-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:25528
- msgid "A service type for Kerberos 5 clients."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:25532
- msgid "Here is an example of its use:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:25546
- #, no-wrap
- msgid ""
- "(service krb5-service-type\n"
- " (krb5-configuration\n"
- " (default-realm \"EXAMPLE.COM\")\n"
- " (allow-weak-crypto? #t)\n"
- " (realms (list\n"
- " (krb5-realm\n"
- " (name \"EXAMPLE.COM\")\n"
- " (admin-server \"groucho.example.com\")\n"
- " (kdc \"karl.example.com\"))\n"
- " (krb5-realm\n"
- " (name \"ARGRX.EDU\")\n"
- " (admin-server \"kerb-admin.argrx.edu\")\n"
- " (kdc \"keys.argrx.edu\"))))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:25550
- msgid "This example provides a Kerberos@tie{}5 client configuration which:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25551
- #, no-wrap
- msgid "Recognizes two realms, @i{viz:} ``EXAMPLE.COM'' and ``ARGRX.EDU'', both"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:25553
- msgid "of which have distinct administration servers and key distribution centers;"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25553
- #, no-wrap
- msgid "Will default to the realm ``EXAMPLE.COM'' if the realm is not explicitly"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:25555
- msgid "specified by clients;"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25555
- #, no-wrap
- msgid "Accepts services which only support encryption types known to be weak."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:25563
- msgid "The @code{krb5-realm} and @code{krb5-configuration} types have many fields. Only the most commonly used ones are described here. For a full list, and more detailed explanation of each, see the MIT @uref{https://web.mit.edu/kerberos/krb5-devel/doc/admin/conf_files/krb5_conf.html,,krb5.conf} documentation."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:25565
- #, no-wrap
- msgid "{Data Type} krb5-realm"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:25566
- #, no-wrap
- msgid "realm, kerberos"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25572
- msgid "This field is a string identifying the name of the realm. A common convention is to use the fully qualified DNS name of your organization, converted to upper case."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:25573
- #, no-wrap
- msgid "admin-server"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25576
- msgid "This field is a string identifying the host where the administration server is running."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:25577
- #, no-wrap
- msgid "kdc"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25580
- msgid "This field is a string identifying the key distribution center for the realm."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:25583
- #, no-wrap
- msgid "{Data Type} krb5-configuration"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25586
- #, no-wrap
- msgid "@code{allow-weak-crypto?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25589
- msgid "If this flag is @code{#t} then services which only offer encryption algorithms known to be weak will be accepted."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25590
- #, no-wrap
- msgid "@code{default-realm} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25597
- msgid "This field should be a string identifying the default Kerberos realm for the client. You should set this field to the name of your Kerberos realm. If this value is @code{#f} then a realm must be specified with every Kerberos principal when invoking programs such as @command{kinit}."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:25598
- #, no-wrap
- msgid "realms"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25603
- msgid "This should be a non-empty list of @code{krb5-realm} objects, which clients may access. Normally, one of them will have a @code{name} field matching the @code{default-realm} field."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:25607
- #, no-wrap
- msgid "PAM krb5 Service"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:25608
- #, no-wrap
- msgid "pam-krb5"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:25614
- msgid "The @code{pam-krb5} service allows for login authentication and password management via Kerberos. You will need this service if you want PAM enabled applications to authenticate users using Kerberos."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:25615
- #, no-wrap
- msgid "{Scheme Variable} pam-krb5-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:25617
- msgid "A service type for the Kerberos 5 PAM module."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:25619
- #, no-wrap
- msgid "{Data Type} pam-krb5-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:25622
- msgid "Data type representing the configuration of the Kerberos 5 PAM module. This type has the following parameters:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25623
- #, no-wrap
- msgid "@code{pam-krb5} (default: @code{pam-krb5})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25625
- msgid "The pam-krb5 package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:25626
- #, no-wrap
- msgid "@code{minimum-uid} (default: @code{1000})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:25629
- msgid "The smallest user ID for which Kerberos authentications should be attempted. Local accounts with lower values will silently fail to authenticate."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:25635
- #, no-wrap
- msgid "LDAP"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:25636
- #, no-wrap
- msgid "nslcd, LDAP service"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:25643
- msgid "The @code{(gnu services authentication)} module provides the @code{nslcd-service-type}, which can be used to authenticate against an LDAP server. In addition to configuring the service itself, you may want to add @code{ldap} as a name service to the Name Service Switch. @xref{Name Service Switch} for detailed information."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:25647
- msgid "Here is a simple operating system declaration with a default configuration of the @code{nslcd-service-type} and a Name Service Switch configuration that consults the @code{ldap} name service last:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:25670
- #, no-wrap
- msgid ""
- "(use-service-modules authentication)\n"
- "(use-modules (gnu system nss))\n"
- "...\n"
- "(operating-system\n"
- " ...\n"
- " (services\n"
- " (cons*\n"
- " (service nslcd-service-type)\n"
- " (service dhcp-client-service-type)\n"
- " %base-services))\n"
- " (name-service-switch\n"
- " (let ((services (list (name-service (name \"db\"))\n"
- " (name-service (name \"files\"))\n"
- " (name-service (name \"ldap\")))))\n"
- " (name-service-switch\n"
- " (inherit %mdns-host-lookup-nss)\n"
- " (password services)\n"
- " (shadow services)\n"
- " (group services)\n"
- " (netgroup services)\n"
- " (gshadow services)))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:25675
- msgid "Available @code{nslcd-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25676
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} package nss-pam-ldapd"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25678
- msgid "The @code{nss-pam-ldapd} package to use."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25681
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-number threads"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25685
- msgid "The number of threads to start that can handle requests and perform LDAP queries. Each thread opens a separate connection to the LDAP server. The default is to start 5 threads."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25690
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} string uid"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25692
- msgid "This specifies the user id with which the daemon should be run."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25694 guix-git/doc/guix.texi:25701
- msgid "Defaults to @samp{\"nslcd\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25697
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} string gid"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25699
- msgid "This specifies the group id with which the daemon should be run."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25704
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} log-option log"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25712
- msgid "This option controls the way logging is done via a list containing SCHEME and LEVEL@. The SCHEME argument may either be the symbols @samp{none} or @samp{syslog}, or an absolute file name. The LEVEL argument is optional and specifies the log level. The log level may be one of the following symbols: @samp{crit}, @samp{error}, @samp{warning}, @samp{notice}, @samp{info} or @samp{debug}. All messages with the specified log level or higher are logged."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25714
- msgid "Defaults to @samp{(\"/var/log/nslcd\" info)}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25717
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} list uri"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25720
- msgid "The list of LDAP server URIs. Normally, only the first server will be used with the following servers as fall-back."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25722
- msgid "Defaults to @samp{(\"ldap://localhost:389/\")}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25725
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-string ldap-version"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25728
- msgid "The version of the LDAP protocol to use. The default is to use the maximum version supported by the LDAP library."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25733
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-string binddn"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25736
- msgid "Specifies the distinguished name with which to bind to the directory server for lookups. The default is to bind anonymously."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25741
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-string bindpw"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25744
- msgid "Specifies the credentials with which to bind. This option is only applicable when used with binddn."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25749
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-string rootpwmoddn"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25752
- msgid "Specifies the distinguished name to use when the root user tries to modify a user's password using the PAM module."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25757
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-string rootpwmodpw"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25761
- msgid "Specifies the credentials with which to bind if the root user tries to change a user's password. This option is only applicable when used with rootpwmoddn"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25766
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-string sasl-mech"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25769
- msgid "Specifies the SASL mechanism to be used when performing SASL authentication."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25774
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-string sasl-realm"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25776
- msgid "Specifies the SASL realm to be used when performing SASL authentication."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25781
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-string sasl-authcid"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25784
- msgid "Specifies the authentication identity to be used when performing SASL authentication."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25789
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-string sasl-authzid"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25792
- msgid "Specifies the authorization identity to be used when performing SASL authentication."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25797
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-boolean sasl-canonicalize?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25802
- msgid "Determines whether the LDAP server host name should be canonicalised. If this is enabled the LDAP library will do a reverse host name lookup. By default, it is left up to the LDAP library whether this check is performed or not."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25807
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-string krb5-ccname"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25809
- msgid "Set the name for the GSS-API Kerberos credentials cache."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25814
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} string base"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25816
- msgid "The directory search base."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25818
- msgid "Defaults to @samp{\"dc=example,dc=com\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25821
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} scope-option scope"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25825
- msgid "Specifies the search scope (subtree, onelevel, base or children). The default scope is subtree; base scope is almost never useful for name service lookups; children scope is not supported on all servers."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25827
- msgid "Defaults to @samp{(subtree)}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25830
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-deref-option deref"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25833
- msgid "Specifies the policy for dereferencing aliases. The default policy is to never dereference aliases."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25838
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-boolean referrals"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25841
- msgid "Specifies whether automatic referral chasing should be enabled. The default behaviour is to chase referrals."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25846
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} list-of-map-entries maps"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25851
- msgid "This option allows for custom attributes to be looked up instead of the default RFC 2307 attributes. It is a list of maps, each consisting of the name of a map, the RFC 2307 attribute to match and the query expression for the attribute as it is available in the directory."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25856
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} list-of-filter-entries filters"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25859
- msgid "A list of filters consisting of the name of a map to which the filter applies and an LDAP search filter expression."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25864
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-number bind-timelimit"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25867
- msgid "Specifies the time limit in seconds to use when connecting to the directory server. The default value is 10 seconds."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25872
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-number timelimit"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25876
- msgid "Specifies the time limit (in seconds) to wait for a response from the LDAP server. A value of zero, which is the default, is to wait indefinitely for searches to be completed."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25881
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-number idle-timelimit"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25885
- msgid "Specifies the period if inactivity (in seconds) after which the con‐ nection to the LDAP server will be closed. The default is not to time out connections."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25890
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-number reconnect-sleeptime"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25894
- msgid "Specifies the number of seconds to sleep when connecting to all LDAP servers fails. By default one second is waited between the first failure and the first retry."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25899
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-number reconnect-retrytime"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25903
- msgid "Specifies the time after which the LDAP server is considered to be permanently unavailable. Once this time is reached retries will be done only once per this time period. The default value is 10 seconds."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25908
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-ssl-option ssl"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25912
- msgid "Specifies whether to use SSL/TLS or not (the default is not to). If 'start-tls is specified then StartTLS is used rather than raw LDAP over SSL."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25917
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-tls-reqcert-option tls-reqcert"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25920
- msgid "Specifies what checks to perform on a server-supplied certificate. The meaning of the values is described in the ldap.conf(5) manual page."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25925
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-string tls-cacertdir"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25928
- msgid "Specifies the directory containing X.509 certificates for peer authen‐ tication. This parameter is ignored when using GnuTLS."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25933
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-string tls-cacertfile"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25935
- msgid "Specifies the path to the X.509 certificate for peer authentication."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25940
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-string tls-randfile"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25943
- msgid "Specifies the path to an entropy source. This parameter is ignored when using GnuTLS."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25948
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-string tls-ciphers"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25950
- msgid "Specifies the ciphers to use for TLS as a string."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25955
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-string tls-cert"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25958
- msgid "Specifies the path to the file containing the local certificate for client TLS authentication."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25963
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-string tls-key"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25966
- msgid "Specifies the path to the file containing the private key for client TLS authentication."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25971
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-number pagesize"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25975
- msgid "Set this to a number greater than 0 to request paged results from the LDAP server in accordance with RFC2696. The default (0) is to not request paged results."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25980
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-ignore-users-option nss-initgroups-ignoreusers"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25984
- msgid "This option prevents group membership lookups through LDAP for the specified users. Alternatively, the value 'all-local may be used. With that value nslcd builds a full list of non-LDAP users on startup."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25989
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-number nss-min-uid"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25992
- msgid "This option ensures that LDAP users with a numeric user id lower than the specified value are ignored."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:25997
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-number nss-uid-offset"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:26000
- msgid "This option specifies an offset that is added to all LDAP numeric user ids. This can be used to avoid user id collisions with local users."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:26005
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-number nss-gid-offset"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:26008
- msgid "This option specifies an offset that is added to all LDAP numeric group ids. This can be used to avoid user id collisions with local groups."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:26013
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-boolean nss-nested-groups"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:26019
- msgid "If this option is set, the member attribute of a group may point to another group. Members of nested groups are also returned in the higher level group and parent groups are returned when finding groups for a specific user. The default is not to perform extra searches for nested groups."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:26024
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-boolean nss-getgrent-skipmembers"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:26029
- msgid "If this option is set, the group member list is not retrieved when looking up groups. Lookups for finding which groups a user belongs to will remain functional so the user will likely still get the correct groups assigned on login."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:26034
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-boolean nss-disable-enumeration"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:26040
- msgid "If this option is set, functions which cause all user/group entries to be loaded from the directory will not succeed in doing so. This can dramatically reduce LDAP server load in situations where there are a great number of users and/or groups. This option is not recommended for most configurations."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:26045
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-string validnames"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:26049
- msgid "This option can be used to specify how user and group names are verified within the system. This pattern is used to check all user and group names that are requested and returned from LDAP."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:26054
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-boolean ignorecase"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:26059
- msgid "This specifies whether or not to perform searches using case-insensitive matching. Enabling this could open up the system to authorization bypass vulnerabilities and introduce nscd cache poisoning vulnerabilities which allow denial of service."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:26064
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-boolean pam-authc-ppolicy"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:26067
- msgid "This option specifies whether password policy controls are requested and handled from the LDAP server when performing user authentication."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:26072
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-string pam-authc-search"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:26078
- msgid "By default nslcd performs an LDAP search with the user's credentials after BIND (authentication) to ensure that the BIND operation was successful. The default search is a simple check to see if the user's DN exists. A search filter can be specified that will be used instead. It should return at least one entry."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:26083
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-string pam-authz-search"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:26087
- msgid "This option allows flexible fine tuning of the authorisation check that should be performed. The search filter specified is executed and if any entries match, access is granted, otherwise access is denied."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:26092
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} maybe-string pam-password-prohibit-message"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:26097
- msgid "If this option is set password modification using pam_ldap will be denied and the specified message will be presented to the user instead. The message can be used to direct the user to an alternative means of changing their password."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:26102
- #, no-wrap
- msgid "{@code{nslcd-configuration} parameter} list pam-services"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:26104
- msgid "List of pam service names for which LDAP authentication should suffice."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:26115
- #, no-wrap
- msgid "web"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:26116
- #, no-wrap
- msgid "www"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:26117
- #, no-wrap
- msgid "HTTP"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:26120
- msgid "The @code{(gnu services web)} module provides the Apache HTTP Server, the nginx web server, and also a fastcgi wrapper daemon."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:26121
- #, no-wrap
- msgid "Apache HTTP Server"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:26123
- #, no-wrap
- msgid "{Scheme Variable} httpd-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:26127
- msgid "Service type for the @uref{https://httpd.apache.org/,Apache HTTP} server (@dfn{httpd}). The value for this service type is a @code{httpd-configuration} record."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:26129 guix-git/doc/guix.texi:26311
- msgid "A simple example configuration is given below."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:26137
- #, no-wrap
- msgid ""
- "(service httpd-service-type\n"
- " (httpd-configuration\n"
- " (config\n"
- " (httpd-config-file\n"
- " (server-name \"www.example.com\")\n"
- " (document-root \"/srv/http/www.example.com\")))))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:26141
- msgid "Other services can also extend the @code{httpd-service-type} to add to the configuration."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:26150 guix-git/doc/guix.texi:26290
- #, no-wrap
- msgid ""
- "(simple-service 'www.example.com-server httpd-service-type\n"
- " (list\n"
- " (httpd-virtualhost\n"
- " \"*:80\"\n"
- " (list (string-join '(\"ServerName www.example.com\"\n"
- " \"DocumentRoot /srv/http/www.example.com\")\n"
- " \"\\n\")))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:26156
- msgid "The details for the @code{httpd-configuration}, @code{httpd-module}, @code{httpd-config-file} and @code{httpd-virtualhost} record types are given below."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:26157
- #, no-wrap
- msgid "{Data Type} httpd-configuration"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:26159
- msgid "This data type represents the configuration for the httpd service."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26161
- #, no-wrap
- msgid "@code{package} (default: @code{httpd})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26163
- msgid "The httpd package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26164 guix-git/doc/guix.texi:26253
- #, no-wrap
- msgid "@code{pid-file} (default: @code{\"/var/run/httpd\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26166
- msgid "The pid file used by the shepherd-service."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26167
- #, no-wrap
- msgid "@code{config} (default: @code{(httpd-config-file)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26172
- msgid "The configuration file to use with the httpd service. The default value is a @code{httpd-config-file} record, but this can also be a different G-expression that generates a file, for example a @code{plain-file}. A file outside of the store can also be specified through a string."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:26176
- #, no-wrap
- msgid "{Data Type} httpd-module"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:26178
- msgid "This data type represents a module for the httpd service."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26182
- msgid "The name of the module."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26188
- msgid "The file for the module. This can be relative to the httpd package being used, the absolute location of a file, or a G-expression for a file within the store, for example @code{(file-append mod-wsgi \"/modules/mod_wsgi.so\")}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:26192
- #, no-wrap
- msgid "{Scheme Variable} %default-httpd-modules"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:26194
- msgid "A default list of @code{httpd-module} objects."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:26196
- #, no-wrap
- msgid "{Data Type} httpd-config-file"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:26198
- msgid "This data type represents a configuration file for the httpd service."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26200
- #, no-wrap
- msgid "@code{modules} (default: @code{%default-httpd-modules})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26203
- msgid "The modules to load. Additional modules can be added here, or loaded by additional configuration."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26206
- msgid "For example, in order to handle requests for PHP files, you can use Apache’s @code{mod_proxy_fcgi} module along with @code{php-fpm-service-type}:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:26228
- #, no-wrap
- msgid ""
- "(service httpd-service-type\n"
- " (httpd-configuration\n"
- " (config\n"
- " (httpd-config-file\n"
- " (modules (cons*\n"
- " (httpd-module\n"
- " (name \"proxy_module\")\n"
- " (file \"modules/mod_proxy.so\"))\n"
- " (httpd-module\n"
- " (name \"proxy_fcgi_module\")\n"
- " (file \"modules/mod_proxy_fcgi.so\"))\n"
- " %default-httpd-modules))\n"
- " (extra-config (list \"\\\n"
- "<FilesMatch \\\\.php$>\n"
- " SetHandler \\\"proxy:unix:/var/run/php-fpm.sock|fcgi://localhost/\\\"\n"
- "</FilesMatch>\"))))))\n"
- "(service php-fpm-service-type\n"
- " (php-fpm-configuration\n"
- " (socket \"/var/run/php-fpm.sock\")\n"
- " (socket-group \"httpd\")))\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26230
- #, no-wrap
- msgid "@code{server-root} (default: @code{httpd})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26234
- msgid "The @code{ServerRoot} in the configuration file, defaults to the httpd package. Directives including @code{Include} and @code{LoadModule} are taken as relative to the server root."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26235
- #, no-wrap
- msgid "@code{server-name} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26239
- msgid "The @code{ServerName} in the configuration file, used to specify the request scheme, hostname and port that the server uses to identify itself."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26243
- msgid "This doesn't need to be set in the server config, and can be specified in virtual hosts. The default is @code{#f} to not specify a @code{ServerName}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26244
- #, no-wrap
- msgid "@code{document-root} (default: @code{\"/srv/http\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26246
- msgid "The @code{DocumentRoot} from which files will be served."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26247
- #, no-wrap
- msgid "@code{listen} (default: @code{'(\"80\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26252
- msgid "The list of values for the @code{Listen} directives in the config file. The value should be a list of strings, when each string can specify the port number to listen on, and optionally the IP address and protocol to use."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26257
- msgid "The @code{PidFile} to use. This should match the @code{pid-file} set in the @code{httpd-configuration} so that the Shepherd service is configured correctly."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26258
- #, no-wrap
- msgid "@code{error-log} (default: @code{\"/var/log/httpd/error_log\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26260
- msgid "The @code{ErrorLog} to which the server will log errors."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26261 guix-git/doc/guix.texi:26823
- #, no-wrap
- msgid "@code{user} (default: @code{\"httpd\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26263
- msgid "The @code{User} which the server will answer requests as."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26264
- #, no-wrap
- msgid "@code{group} (default: @code{\"httpd\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26266
- msgid "The @code{Group} which the server will answer requests as."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26267
- #, no-wrap
- msgid "@code{extra-config} (default: @code{(list \"TypesConfig etc/httpd/mime.types\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26270
- msgid "A flat list of strings and G-expressions which will be added to the end of the configuration file."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26273
- msgid "Any values which the service is extended with will be appended to this list."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:26277
- #, no-wrap
- msgid "{Data Type} httpd-virtualhost"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:26279
- msgid "This data type represents a virtualhost configuration block for the httpd service."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:26281
- msgid "These should be added to the extra-config for the httpd-service."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:26293
- #, no-wrap
- msgid "addresses-and-ports"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26295
- msgid "The addresses and ports for the @code{VirtualHost} directive."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:26296
- #, no-wrap
- msgid "contents"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26299
- msgid "The contents of the @code{VirtualHost} directive, this should be a list of strings and G-expressions."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:26304
- #, no-wrap
- msgid "NGINX"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:26306
- #, no-wrap
- msgid "{Scheme Variable} nginx-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:26309
- msgid "Service type for the @uref{https://nginx.org/,NGinx} web server. The value for this service type is a @code{<nginx-configuration>} record."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:26319 guix-git/doc/guix.texi:26373
- #, no-wrap
- msgid ""
- "(service nginx-service-type\n"
- " (nginx-configuration\n"
- " (server-blocks\n"
- " (list (nginx-server-configuration\n"
- " (server-name '(\"www.example.com\"))\n"
- " (root \"/srv/http/www.example.com\"))))))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:26324
- msgid "In addition to adding server blocks to the service configuration directly, this service can be extended by other services to add server blocks, as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:26330
- #, no-wrap
- msgid ""
- "(simple-service 'my-extra-server nginx-service-type\n"
- " (list (nginx-server-configuration\n"
- " (root \"/srv/http/extra-website\")\n"
- " (try-files (list \"$uri\" \"$uri/index.html\")))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:26341
- msgid "At startup, @command{nginx} has not yet read its configuration file, so it uses a default file to log error messages. If it fails to load its configuration file, that is where error messages are logged. After the configuration file is loaded, the default error log file changes as per configuration. In our case, startup error messages can be found in @file{/var/run/nginx/logs/error.log}, and after configuration in @file{/var/log/nginx/error.log}. The second location can be changed with the @var{log-directory} configuration option."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:26342
- #, no-wrap
- msgid "{Data Type} nginx-configuration"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:26346
- msgid "This data type represents the configuration for NGinx. Some configuration can be done through this and the other provided record types, or alternatively, a config file can be provided."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26348
- #, no-wrap
- msgid "@code{nginx} (default: @code{nginx})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26350
- msgid "The nginx package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26351
- #, no-wrap
- msgid "@code{log-directory} (default: @code{\"/var/log/nginx\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26353
- msgid "The directory to which NGinx will write log files."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26354
- #, no-wrap
- msgid "@code{run-directory} (default: @code{\"/var/run/nginx\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26357
- msgid "The directory in which NGinx will create a pid file, and write temporary files."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26358
- #, no-wrap
- msgid "@code{server-blocks} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26362
- msgid "A list of @dfn{server blocks} to create in the generated configuration file, the elements should be of type @code{<nginx-server-configuration>}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26366
- msgid "The following example would setup NGinx to serve @code{www.example.com} from the @code{/srv/http/www.example.com} directory, without using HTTPS."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26375
- #, no-wrap
- msgid "@code{upstream-blocks} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26379
- msgid "A list of @dfn{upstream blocks} to create in the generated configuration file, the elements should be of type @code{<nginx-upstream-configuration>}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26386
- msgid "Configuring upstreams through the @code{upstream-blocks} can be useful when combined with @code{locations} in the @code{<nginx-server-configuration>} records. The following example creates a server configuration with one location configuration, that will proxy requests to a upstream configuration, which will handle requests with two servers."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:26405
- #, no-wrap
- msgid ""
- "(service\n"
- " nginx-service-type\n"
- " (nginx-configuration\n"
- " (server-blocks\n"
- " (list (nginx-server-configuration\n"
- " (server-name '(\"www.example.com\"))\n"
- " (root \"/srv/http/www.example.com\")\n"
- " (locations\n"
- " (list\n"
- " (nginx-location-configuration\n"
- " (uri \"/path1\")\n"
- " (body '(\"proxy_pass http://server-proxy;\"))))))))\n"
- " (upstream-blocks\n"
- " (list (nginx-upstream-configuration\n"
- " (name \"server-proxy\")\n"
- " (servers (list \"server1.example.com\"\n"
- " \"server2.example.com\")))))))\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26413
- msgid "If a configuration @var{file} is provided, this will be used, rather than generating a configuration file from the provided @code{log-directory}, @code{run-directory}, @code{server-blocks} and @code{upstream-blocks}. For proper operation, these arguments should match what is in @var{file} to ensure that the directories are created when the service is activated."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26417
- msgid "This can be useful if you have an existing configuration file, or it's not possible to do what is required through the other parts of the nginx-configuration record."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26418
- #, no-wrap
- msgid "@code{server-names-hash-bucket-size} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26421
- msgid "Bucket size for the server names hash tables, defaults to @code{#f} to use the size of the processors cache line."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26422
- #, no-wrap
- msgid "@code{server-names-hash-bucket-max-size} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26424
- msgid "Maximum bucket size for the server names hash tables."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26428
- msgid "List of nginx dynamic modules to load. This should be a list of file names of loadable modules, as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:26436
- #, no-wrap
- msgid ""
- "(modules\n"
- " (list\n"
- " (file-append nginx-accept-language-module \"\\\n"
- "/etc/nginx/modules/ngx_http_accept_language_module.so\")\n"
- " (file-append nginx-lua-module \"\\\n"
- "/etc/nginx/modules/ngx_http_lua_module.so\")))\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26438
- #, no-wrap
- msgid "@code{lua-package-path} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26441
- msgid "List of nginx lua packages to load. This should be a list of package names of loadable lua modules, as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:26448
- #, no-wrap
- msgid ""
- "(lua-package-path (list lua-resty-core\n"
- " lua-resty-lrucache\n"
- " lua-resty-signal\n"
- " lua-tablepool\n"
- " lua-resty-shell))\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26450
- #, no-wrap
- msgid "@code{lua-package-cpath} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26453
- msgid "List of nginx lua C packages to load. This should be a list of package names of loadable lua C modules, as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:26456
- #, no-wrap
- msgid "(lua-package-cpath (list lua-resty-signal))\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26458
- #, no-wrap
- msgid "@code{global-directives} (default: @code{'((events . ()))})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26461
- msgid "Association list of global directives for the top level of the nginx configuration. Values may themselves be association lists."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:26467
- #, no-wrap
- msgid ""
- "(global-directives\n"
- " `((worker_processes . 16)\n"
- " (pcre_jit . on)\n"
- " (events . ((worker_connections . 1024)))))\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26472
- msgid "Extra content for the @code{http} block. Should be string or a string valued G-expression."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:26476
- #, no-wrap
- msgid "{Data Type} nginx-server-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:26479
- msgid "Data type representing the configuration of an nginx server block. This type has the following parameters:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26481
- #, no-wrap
- msgid "@code{listen} (default: @code{'(\"80\" \"443 ssl\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26486
- msgid "Each @code{listen} directive sets the address and port for IP, or the path for a UNIX-domain socket on which the server will accept requests. Both address and port, or only address or only port can be specified. An address may also be a hostname, for example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:26489
- #, no-wrap
- msgid "'(\"127.0.0.1:8000\" \"127.0.0.1\" \"8000\" \"*:8000\" \"localhost:8000\")\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26491
- #, no-wrap
- msgid "@code{server-name} (default: @code{(list 'default)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26494
- msgid "A list of server names this server represents. @code{'default} represents the default server for connections matching no other server."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26495
- #, no-wrap
- msgid "@code{root} (default: @code{\"/srv/http\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26497
- msgid "Root of the website nginx will serve."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26498
- #, no-wrap
- msgid "@code{locations} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26502
- msgid "A list of @dfn{nginx-location-configuration} or @dfn{nginx-named-location-configuration} records to use within this server block."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26503
- #, no-wrap
- msgid "@code{index} (default: @code{(list \"index.html\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26506
- msgid "Index files to look for when clients ask for a directory. If it cannot be found, Nginx will send the list of files in the directory."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26507
- #, no-wrap
- msgid "@code{try-files} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26510
- msgid "A list of files whose existence is checked in the specified order. @code{nginx} will use the first file it finds to process the request."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26511
- #, no-wrap
- msgid "@code{ssl-certificate} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26514
- msgid "Where to find the certificate for secure connections. Set it to @code{#f} if you don't have a certificate or you don't want to use HTTPS."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26515
- #, no-wrap
- msgid "@code{ssl-certificate-key} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26518
- msgid "Where to find the private key for secure connections. Set it to @code{#f} if you don't have a key or you don't want to use HTTPS."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26519
- #, no-wrap
- msgid "@code{server-tokens?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26521
- msgid "Whether the server should add its configuration to response."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26522
- #, no-wrap
- msgid "@code{raw-content} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26524
- msgid "A list of raw lines added to the server block."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:26528
- #, no-wrap
- msgid "{Data Type} nginx-upstream-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:26531
- msgid "Data type representing the configuration of an nginx @code{upstream} block. This type has the following parameters:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26535
- msgid "Name for this group of servers."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:26536
- #, no-wrap
- msgid "servers"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26543
- msgid "Specify the addresses of the servers in the group. The address can be specified as a IP address (e.g.@: @samp{127.0.0.1}), domain name (e.g.@: @samp{backend1.example.com}) or a path to a UNIX socket using the prefix @samp{unix:}. For addresses using an IP address or domain name, the default port is 80, and a different port can be specified explicitly."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:26547
- #, no-wrap
- msgid "{Data Type} nginx-location-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:26550
- msgid "Data type representing the configuration of an nginx @code{location} block. This type has the following parameters:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26554
- msgid "URI which this location block matches."
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:26556
- msgid "nginx-location-configuration body"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:26556 guix-git/doc/guix.texi:26577
- #, no-wrap
- msgid "body"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26563
- msgid "Body of the location block, specified as a list of strings. This can contain many configuration directives. For example, to pass requests to a upstream server group defined using an @code{nginx-upstream-configuration} block, the following directive would be specified in the body @samp{(list \"proxy_pass http://upstream-name;\")}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:26567
- #, no-wrap
- msgid "{Data Type} nginx-named-location-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:26572
- msgid "Data type representing the configuration of an nginx named location block. Named location blocks are used for request redirection, and not used for regular request processing. This type has the following parameters:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26576
- msgid "Name to identify this location block."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26582
- msgid "@xref{nginx-location-configuration body}, as the body for named location blocks can be used in a similar way to the @code{nginx-location-configuration body}. One restriction is that the body of a named location block cannot contain location blocks."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:26586
- #, no-wrap
- msgid "Varnish Cache"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:26587
- #, no-wrap
- msgid "Varnish"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:26592
- msgid "Varnish is a fast cache server that sits in between web applications and end users. It proxies requests from clients and caches the accessed URLs such that multiple requests for the same resource only creates one request to the back-end."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:26593
- #, no-wrap
- msgid "{Scheme Variable} varnish-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:26595
- msgid "Service type for the Varnish daemon."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:26597
- #, no-wrap
- msgid "{Data Type} varnish-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:26600
- msgid "Data type representing the @code{varnish} service configuration. This type has the following parameters:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26602
- #, no-wrap
- msgid "@code{package} (default: @code{varnish})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26604
- msgid "The Varnish package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26605
- #, no-wrap
- msgid "@code{name} (default: @code{\"default\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26610
- msgid "A name for this Varnish instance. Varnish will create a directory in @file{/var/varnish/} with this name and keep temporary files there. If the name starts with a forward slash, it is interpreted as an absolute directory name."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26613
- msgid "Pass the @code{-n} argument to other Varnish programs to connect to the named instance, e.g.@: @command{varnishncsa -n default}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26614
- #, no-wrap
- msgid "@code{backend} (default: @code{\"localhost:8080\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26616
- msgid "The backend to use. This option has no effect if @code{vcl} is set."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26617
- #, no-wrap
- msgid "@code{vcl} (default: #f)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26622
- msgid "The @dfn{VCL} (Varnish Configuration Language) program to run. If this is @code{#f}, Varnish will proxy @code{backend} using the default configuration. Otherwise this must be a file-like object with valid VCL syntax."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26626
- msgid "For example, to mirror @url{https://www.gnu.org,www.gnu.org} with VCL you can do something along these lines:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:26632
- #, no-wrap
- msgid ""
- "(define %gnu-mirror\n"
- " (plain-file \"gnu.vcl\"\n"
- " \"vcl 4.1;\n"
- "backend gnu @{ .host = \\\"www.gnu.org\\\"; @}\"))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:26640
- #, no-wrap
- msgid ""
- "(operating-system\n"
- " ;; @dots{}\n"
- " (services (cons (service varnish-service-type\n"
- " (varnish-configuration\n"
- " (listen '(\":80\"))\n"
- " (vcl %gnu-mirror)))\n"
- " %base-services)))\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26644
- msgid "The configuration of an already running Varnish instance can be inspected and changed using the @command{varnishadm} program."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26648
- msgid "Consult the @url{https://varnish-cache.org/docs/,Varnish User Guide} and @url{https://book.varnish-software.com/4.0/,Varnish Book} for comprehensive documentation on Varnish and its configuration language."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26649
- #, no-wrap
- msgid "@code{listen} (default: @code{'(\"localhost:80\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26651
- msgid "List of addresses Varnish will listen on."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26652
- #, no-wrap
- msgid "@code{storage} (default: @code{'(\"malloc,128m\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26654
- msgid "List of storage backends that will be available in VCL."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26655
- #, no-wrap
- msgid "@code{parameters} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26657
- msgid "List of run-time parameters in the form @code{'((\"parameter\" . \"value\"))}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26660
- msgid "Additional arguments to pass to the @command{varnishd} process."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:26664 guix-git/doc/guix.texi:26665
- #, no-wrap
- msgid "Patchwork"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:26668
- msgid "Patchwork is a patch tracking system. It can collect patches sent to a mailing list, and display them in a web interface."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:26669
- #, no-wrap
- msgid "{Scheme Variable} patchwork-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:26671
- msgid "Service type for Patchwork."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:26675
- msgid "The following example is an example of a minimal service for Patchwork, for the @code{patchwork.example.com} domain."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:26695
- #, no-wrap
- msgid ""
- "(service patchwork-service-type\n"
- " (patchwork-configuration\n"
- " (domain \"patchwork.example.com\")\n"
- " (settings-module\n"
- " (patchwork-settings-module\n"
- " (allowed-hosts (list domain))\n"
- " (default-from-email \"patchwork@@patchwork.example.com\")))\n"
- " (getmail-retriever-config\n"
- " (getmail-retriever-configuration\n"
- " (type \"SimpleIMAPSSLRetriever\")\n"
- " (server \"imap.example.com\")\n"
- " (port 993)\n"
- " (username \"patchwork\")\n"
- " (password-command\n"
- " (list (file-append coreutils \"/bin/cat\")\n"
- " \"/etc/getmail-patchwork-imap-password\"))\n"
- " (extra-parameters\n"
- " '((mailboxes . (\"Patches\"))))))))\n"
- "\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:26701
- msgid "There are three records for configuring the Patchwork service. The @code{<patchwork-configuration>} relates to the configuration for Patchwork within the HTTPD service."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:26705
- msgid "The @code{settings-module} field within the @code{<patchwork-configuration>} record can be populated with the @code{<patchwork-settings-module>} record, which describes a settings module that is generated within the Guix store."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:26709
- msgid "For the @code{database-configuration} field within the @code{<patchwork-settings-module>}, the @code{<patchwork-database-configuration>} must be used."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:26710
- #, no-wrap
- msgid "{Data Type} patchwork-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:26713
- msgid "Data type representing the Patchwork service configuration. This type has the following parameters:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26715
- #, no-wrap
- msgid "@code{patchwork} (default: @code{patchwork})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26717
- msgid "The Patchwork package to use."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:26718
- #, no-wrap
- msgid "domain"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26721
- msgid "The domain to use for Patchwork, this is used in the HTTPD service virtual host."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:26722
- #, no-wrap
- msgid "settings-module"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26728
- msgid "The settings module to use for Patchwork. As a Django application, Patchwork is configured with a Python module containing the settings. This can either be an instance of the @code{<patchwork-settings-module>} record, any other record that represents the settings in the store, or a directory outside of the store."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26729
- #, no-wrap
- msgid "@code{static-path} (default: @code{\"/static/\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26731
- msgid "The path under which the HTTPD service should serve the static files."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:26732
- #, no-wrap
- msgid "getmail-retriever-config"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26736
- msgid "The getmail-retriever-configuration record value to use with Patchwork. Getmail will be configured with this value, the messages will be delivered to Patchwork."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:26740
- #, no-wrap
- msgid "{Data Type} patchwork-settings-module"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:26745
- msgid "Data type representing a settings module for Patchwork. Some of these settings relate directly to Patchwork, but others relate to Django, the web framework used by Patchwork, or the Django Rest Framework library. This type has the following parameters:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26747
- #, no-wrap
- msgid "@code{database-configuration} (default: @code{(patchwork-database-configuration)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26750
- msgid "The database connection settings used for Patchwork. See the @code{<patchwork-database-configuration>} record type for more information."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26751
- #, no-wrap
- msgid "@code{secret-key-file} (default: @code{\"/etc/patchwork/django-secret-key\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26754
- msgid "Patchwork, as a Django web application uses a secret key for cryptographically signing values. This file should contain a unique unpredictable value."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26757
- msgid "If this file does not exist, it will be created and populated with a random value by the patchwork-setup shepherd service."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26759
- msgid "This setting relates to Django."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:26760
- #, no-wrap
- msgid "allowed-hosts"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26763
- msgid "A list of valid hosts for this Patchwork service. This should at least include the domain specified in the @code{<patchwork-configuration>} record."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26765 guix-git/doc/guix.texi:26779
- #: guix-git/doc/guix.texi:26785 guix-git/doc/guix.texi:26791
- msgid "This is a Django setting."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:26766
- #, no-wrap
- msgid "default-from-email"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26768
- msgid "The email address from which Patchwork should send email by default."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26770 guix-git/doc/guix.texi:26796
- #: guix-git/doc/guix.texi:26801 guix-git/doc/guix.texi:26806
- msgid "This is a Patchwork setting."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26771
- #, no-wrap
- msgid "@code{static-url} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26774
- msgid "The URL to use when serving static assets. It can be part of a URL, or a full URL, but must end in a @code{/}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26777
- msgid "If the default value is used, the @code{static-path} value from the @code{<patchwork-configuration>} record will be used."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26780
- #, no-wrap
- msgid "@code{admins} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26783
- msgid "Email addresses to send the details of errors that occur. Each value should be a list containing two elements, the name and then the email address."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26789
- msgid "Whether to run Patchwork in debug mode. If set to @code{#t}, detailed error messages will be shown."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26792
- #, no-wrap
- msgid "@code{enable-rest-api?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26794
- msgid "Whether to enable the Patchwork REST API."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26797
- #, no-wrap
- msgid "@code{enable-xmlrpc?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26799
- msgid "Whether to enable the XML RPC API."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26802
- #, no-wrap
- msgid "@code{force-https-links?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26804
- msgid "Whether to use HTTPS links on Patchwork pages."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26809
- msgid "Extra code to place at the end of the Patchwork settings module."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:26813
- #, no-wrap
- msgid "{Data Type} patchwork-database-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:26815
- msgid "Data type representing the database configuration for Patchwork."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26817
- #, no-wrap
- msgid "@code{engine} (default: @code{\"django.db.backends.postgresql_psycopg2\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26819
- msgid "The database engine to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26820
- #, no-wrap
- msgid "@code{name} (default: @code{\"patchwork\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26822
- msgid "The name of the database to use."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26825
- msgid "The user to connect to the database as."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26826
- #, no-wrap
- msgid "@code{password} (default: @code{\"\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26828
- msgid "The password to use when connecting to the database."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26829
- #, no-wrap
- msgid "@code{host} (default: @code{\"\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26831
- msgid "The host to make the database connection to."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26832
- #, no-wrap
- msgid "@code{port} (default: @code{\"\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26834
- msgid "The port on which to connect to the database."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:26838
- #, no-wrap
- msgid "Mumi"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:26840
- #, no-wrap
- msgid "Mumi, Debbugs Web interface"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:26841
- #, no-wrap
- msgid "Debbugs, Mumi Web interface"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:26846
- msgid "@uref{https://git.elephly.net/gitweb.cgi?p=software/mumi.git, Mumi} is a Web interface to the Debbugs bug tracker, by default for @uref{https://bugs.gnu.org, the GNU instance}. Mumi is a Web server, but it also fetches and indexes mail retrieved from Debbugs."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:26847
- #, no-wrap
- msgid "{Scheme Variable} mumi-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:26849
- msgid "This is the service type for Mumi."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:26851
- #, no-wrap
- msgid "{Data Type} mumi-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:26854
- msgid "Data type representing the Mumi service configuration. This type has the following fields:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26856
- #, no-wrap
- msgid "@code{mumi} (default: @code{mumi})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26858
- msgid "The Mumi package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26859
- #, no-wrap
- msgid "@code{mailer?} (default: @code{#true})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26861
- msgid "Whether to enable or disable the mailer component."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:26862
- #, no-wrap
- msgid "mumi-configuration-sender"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26864
- msgid "The email address used as the sender for comments."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:26865
- #, no-wrap
- msgid "mumi-configuration-smtp"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26870
- msgid "A URI to configure the SMTP settings for Mailutils. This could be something like @code{sendmail:///path/to/bin/msmtp} or any other URI supported by Mailutils. @xref{SMTP Mailboxes, SMTP Mailboxes,, mailutils, GNU@tie{}Mailutils}."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:26875
- #, no-wrap
- msgid "FastCGI"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:26876
- #, no-wrap
- msgid "fastcgi"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:26877
- #, no-wrap
- msgid "fcgiwrap"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:26884
- msgid "FastCGI is an interface between the front-end and the back-end of a web service. It is a somewhat legacy facility; new web services should generally just talk HTTP between the front-end and the back-end. However there are a number of back-end services such as PHP or the optimized HTTP Git repository access that use FastCGI, so we have support for it in Guix."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:26891
- msgid "To use FastCGI, you configure the front-end web server (e.g., nginx) to dispatch some subset of its requests to the fastcgi backend, which listens on a local TCP or UNIX socket. There is an intermediary @code{fcgiwrap} program that sits between the actual backend process and the web server. The front-end indicates which backend program to run, passing that information to the @code{fcgiwrap} process."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:26892
- #, no-wrap
- msgid "{Scheme Variable} fcgiwrap-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:26894
- msgid "A service type for the @code{fcgiwrap} FastCGI proxy."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:26896
- #, no-wrap
- msgid "{Data Type} fcgiwrap-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:26899
- msgid "Data type representing the configuration of the @code{fcgiwrap} service. This type has the following parameters:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26900
- #, no-wrap
- msgid "@code{package} (default: @code{fcgiwrap})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26902
- msgid "The fcgiwrap package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26903
- #, no-wrap
- msgid "@code{socket} (default: @code{tcp:127.0.0.1:9000})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26909
- msgid "The socket on which the @code{fcgiwrap} process should listen, as a string. Valid @var{socket} values include @code{unix:@var{/path/to/unix/socket}}, @code{tcp:@var{dot.ted.qu.ad}:@var{port}} and @code{tcp6:[@var{ipv6_addr}]:port}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26910
- #, no-wrap
- msgid "@code{user} (default: @code{fcgiwrap})"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:26911
- #, no-wrap
- msgid "@code{group} (default: @code{fcgiwrap})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26916
- msgid "The user and group names, as strings, under which to run the @code{fcgiwrap} process. The @code{fastcgi} service will ensure that if the user asks for the specific user or group names @code{fcgiwrap} that the corresponding user and/or group is present on the system."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26923
- msgid "It is possible to configure a FastCGI-backed web service to pass HTTP authentication information from the front-end to the back-end, and to allow @code{fcgiwrap} to run the back-end process as a corresponding local user. To enable this capability on the back-end, run @code{fcgiwrap} as the @code{root} user and group. Note that this capability also has to be configured on the front-end as well."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:26926
- #, no-wrap
- msgid "php-fpm"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:26929
- msgid "PHP-FPM (FastCGI Process Manager) is an alternative PHP FastCGI implementation with some additional features useful for sites of any size."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:26931
- msgid "These features include:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26932
- #, no-wrap
- msgid "Adaptive process spawning"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26933
- #, no-wrap
- msgid "Basic statistics (similar to Apache's mod_status)"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26934
- #, no-wrap
- msgid "Advanced process management with graceful stop/start"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26935
- #, no-wrap
- msgid "Ability to start workers with different uid/gid/chroot/environment"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:26937
- msgid "and different php.ini (replaces safe_mode)"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26937
- #, no-wrap
- msgid "Stdout & stderr logging"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26938
- #, no-wrap
- msgid "Emergency restart in case of accidental opcode cache destruction"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26939
- #, no-wrap
- msgid "Accelerated upload support"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26940
- #, no-wrap
- msgid "Support for a \"slowlog\""
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26941
- #, no-wrap
- msgid "Enhancements to FastCGI, such as fastcgi_finish_request() -"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:26944
- msgid "a special function to finish request & flush all data while continuing to do something time-consuming (video converting, stats processing, etc.)"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:26946
- msgid "...@: and much more."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:26947
- #, no-wrap
- msgid "{Scheme Variable} php-fpm-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:26949
- msgid "A Service type for @code{php-fpm}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:26951
- #, no-wrap
- msgid "{Data Type} php-fpm-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:26953
- msgid "Data Type for php-fpm service configuration."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26954
- #, no-wrap
- msgid "@code{php} (default: @code{php})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26956
- msgid "The php package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26956
- #, no-wrap
- msgid "@code{socket} (default: @code{(string-append \"/var/run/php\" (version-major (package-version php)) \"-fpm.sock\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26958
- msgid "The address on which to accept FastCGI requests. Valid syntaxes are:"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:26959
- #, no-wrap
- msgid "\"ip.add.re.ss:port\""
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26961
- msgid "Listen on a TCP socket to a specific address on a specific port."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:26961
- #, no-wrap
- msgid "\"port\""
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26963
- msgid "Listen on a TCP socket to all addresses on a specific port."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:26963
- #, no-wrap
- msgid "\"/path/to/unix/socket\""
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26965
- msgid "Listen on a unix socket."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26967
- #, no-wrap
- msgid "@code{user} (default: @code{php-fpm})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26969
- msgid "User who will own the php worker processes."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26969
- #, no-wrap
- msgid "@code{group} (default: @code{php-fpm})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26971
- msgid "Group of the worker processes."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26971
- #, no-wrap
- msgid "@code{socket-user} (default: @code{php-fpm})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26973
- msgid "User who can speak to the php-fpm socket."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26973
- #, no-wrap
- msgid "@code{socket-group} (default: @code{nginx})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26975
- msgid "Group that can speak to the php-fpm socket."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26975
- #, no-wrap
- msgid "@code{pid-file} (default: @code{(string-append \"/var/run/php\" (version-major (package-version php)) \"-fpm.pid\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26978
- msgid "The process id of the php-fpm process is written to this file once the service has started."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26978
- #, no-wrap
- msgid "@code{log-file} (default: @code{(string-append \"/var/log/php\" (version-major (package-version php)) \"-fpm.log\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26980
- msgid "Log for the php-fpm master process."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26980
- #, no-wrap
- msgid "@code{process-manager} (default: @code{(php-fpm-dynamic-process-manager-configuration)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26983
- msgid "Detailed settings for the php-fpm process manager. Must be one of:"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:26984
- #, no-wrap
- msgid "<php-fpm-dynamic-process-manager-configuration>"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:26985
- #, no-wrap
- msgid "<php-fpm-static-process-manager-configuration>"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:26986
- #, no-wrap
- msgid "<php-fpm-on-demand-process-manager-configuration>"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26988
- #, no-wrap
- msgid "@code{display-errors} (default @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26993
- msgid "Determines whether php errors and warning should be sent to clients and displayed in their browsers. This is useful for local php development, but a security risk for public sites, as error messages can reveal passwords and personal data."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26993
- #, no-wrap
- msgid "@code{timezone} (default @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26995
- msgid "Specifies @code{php_admin_value[date.timezone]} parameter."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26995
- #, no-wrap
- msgid "@code{workers-logfile} (default @code{(string-append \"/var/log/php\" (version-major (package-version php)) \"-fpm.www.log\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:26998
- msgid "This file will log the @code{stderr} outputs of php worker processes. Can be set to @code{#f} to disable logging."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:26998
- #, no-wrap
- msgid "@code{file} (default @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27001
- msgid "An optional override of the whole configuration. You can use the @code{mixed-text-file} function or an absolute filepath for it."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27001
- #, no-wrap
- msgid "@code{php-ini-file} (default @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27005
- msgid "An optional override of the default php settings. It may be any ``file-like'' object (@pxref{G-Expressions, file-like objects}). You can use the @code{mixed-text-file} function or an absolute filepath for it."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27009
- msgid "For local development it is useful to set a higher timeout and memory limit for spawned php processes. This be accomplished with the following operating system configuration snippet:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:27014
- #, no-wrap
- msgid ""
- "(define %local-php-ini\n"
- " (plain-file \"php.ini\"\n"
- " \"memory_limit = 2G\n"
- "max_execution_time = 1800\"))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:27021
- #, no-wrap
- msgid ""
- "(operating-system\n"
- " ;; @dots{}\n"
- " (services (cons (service php-fpm-service-type\n"
- " (php-fpm-configuration\n"
- " (php-ini-file %local-php-ini)))\n"
- " %base-services)))\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27026
- msgid "Consult the @url{https://www.php.net/manual/en/ini.core.php,core php.ini directives} for comprehensive documentation on the acceptable @file{php.ini} directives."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27029
- #, no-wrap
- msgid "{Data type} php-fpm-dynamic-process-manager-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27033
- msgid "Data Type for the @code{dynamic} php-fpm process manager. With the @code{dynamic} process manager, spare worker processes are kept around based on its configured limits."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27034 guix-git/doc/guix.texi:27050
- #: guix-git/doc/guix.texi:27060
- #, no-wrap
- msgid "@code{max-children} (default: @code{5})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27036 guix-git/doc/guix.texi:27052
- #: guix-git/doc/guix.texi:27062
- msgid "Maximum of worker processes."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27036
- #, no-wrap
- msgid "@code{start-servers} (default: @code{2})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27038
- msgid "How many worker processes should be started on start-up."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27038
- #, no-wrap
- msgid "@code{min-spare-servers} (default: @code{1})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27040
- msgid "How many spare worker processes should be kept around at minimum."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27040
- #, no-wrap
- msgid "@code{max-spare-servers} (default: @code{3})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27042
- msgid "How many spare worker processes should be kept around at maximum."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27045
- #, no-wrap
- msgid "{Data type} php-fpm-static-process-manager-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27049
- msgid "Data Type for the @code{static} php-fpm process manager. With the @code{static} process manager, an unchanging number of worker processes are created."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27055
- #, no-wrap
- msgid "{Data type} php-fpm-on-demand-process-manager-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27059
- msgid "Data Type for the @code{on-demand} php-fpm process manager. With the @code{on-demand} process manager, worker processes are only created as requests arrive."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27062
- #, no-wrap
- msgid "@code{process-idle-timeout} (default: @code{10})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27064
- msgid "The time in seconds after which a process with no requests is killed."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:27068
- #, no-wrap
- msgid "{Scheme Procedure} nginx-php-location @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:27074
- msgid "[#:nginx-package nginx] @ [socket (string-append \"/var/run/php\" @ (version-major (package-version php)) @ \"-fpm.sock\")] A helper function to quickly add php to an @code{nginx-server-configuration}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:27077
- msgid "A simple services setup for nginx with php can look like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:27090
- #, no-wrap
- msgid ""
- "(services (cons* (service dhcp-client-service-type)\n"
- " (service php-fpm-service-type)\n"
- " (service nginx-service-type\n"
- " (nginx-server-configuration\n"
- " (server-name '(\"example.com\"))\n"
- " (root \"/srv/http/\")\n"
- " (locations\n"
- " (list (nginx-php-location)))\n"
- " (listen '(\"80\"))\n"
- " (ssl-certificate #f)\n"
- " (ssl-certificate-key #f)))\n"
- " %base-services))\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:27092
- #, no-wrap
- msgid "cat-avatar-generator"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:27096
- msgid "The cat avatar generator is a simple service to demonstrate the use of php-fpm in @code{Nginx}. It is used to generate cat avatar from a seed, for instance the hash of a user's email address."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:27097
- #, no-wrap
- msgid "{Scheme Procedure} cat-avatar-generator-service @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:27105
- msgid "[#:cache-dir \"/var/cache/cat-avatar-generator\"] @ [#:package cat-avatar-generator] @ [#:configuration (nginx-server-configuration)] Returns an nginx-server-configuration that inherits @code{configuration}. It extends the nginx configuration to add a server block that serves @code{package}, a version of cat-avatar-generator. During execution, cat-avatar-generator will be able to use @code{cache-dir} as its cache directory."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:27108
- msgid "A simple setup for cat-avatar-generator can look like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:27115
- #, no-wrap
- msgid ""
- "(services (cons* (cat-avatar-generator-service\n"
- " #:configuration\n"
- " (nginx-server-configuration\n"
- " (server-name '(\"example.com\"))))\n"
- " ...\n"
- " %base-services))\n"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:27117
- #, no-wrap
- msgid "Hpcguix-web"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:27119
- #, no-wrap
- msgid "hpcguix-web"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:27124
- msgid "The @uref{https://github.com/UMCUGenetics/hpcguix-web/, hpcguix-web} program is a customizable web interface to browse Guix packages, initially designed for users of high-performance computing (HPC) clusters."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:27125
- #, no-wrap
- msgid "{Scheme Variable} hpcguix-web-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:27127
- msgid "The service type for @code{hpcguix-web}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27129
- #, no-wrap
- msgid "{Data Type} hpcguix-web-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27131
- msgid "Data type for the hpcguix-web service configuration."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:27133
- #, no-wrap
- msgid "specs"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27136
- msgid "A gexp (@pxref{G-Expressions}) specifying the hpcguix-web service configuration. The main items available in this spec are:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27138
- #, no-wrap
- msgid "@code{title-prefix} (default: @code{\"hpcguix | \"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27140
- msgid "The page title prefix."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27141
- #, no-wrap
- msgid "@code{guix-command} (default: @code{\"guix\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27143
- msgid "The @command{guix} command."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27144
- #, no-wrap
- msgid "@code{package-filter-proc} (default: @code{(const #t)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27146
- msgid "A procedure specifying how to filter packages that are displayed."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27147
- #, no-wrap
- msgid "@code{package-page-extension-proc} (default: @code{(const '())})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27149
- msgid "Extension package for @code{hpcguix-web}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27150
- #, no-wrap
- msgid "@code{menu} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27152
- msgid "Additional entry in page @code{menu}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27153
- #, no-wrap
- msgid "@code{channels} (default: @code{%default-channels})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27155
- msgid "List of channels from which the package list is built (@pxref{Channels})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27156
- #, no-wrap
- msgid "@code{package-list-expiration} (default: @code{(* 12 3600)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27159
- msgid "The expiration time, in seconds, after which the package list is rebuilt from the latest instances of the given channels."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27164
- msgid "See the hpcguix-web repository for a @uref{https://github.com/UMCUGenetics/hpcguix-web/blob/master/hpcweb-configuration.scm, complete example}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27165
- #, no-wrap
- msgid "@code{package} (default: @code{hpcguix-web})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27167
- msgid "The hpcguix-web package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27168
- #, no-wrap
- msgid "@code{address} (default: @code{\"127.0.0.1\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27170
- msgid "The IP address to listen to."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27171
- #, no-wrap
- msgid "@code{port} (default: @code{5000})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27173
- msgid "The port number to listen to."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:27177
- msgid "A typical hpcguix-web service declaration looks like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:27186
- #, no-wrap
- msgid ""
- "(service hpcguix-web-service-type\n"
- " (hpcguix-web-configuration\n"
- " (specs\n"
- " #~(define site-config\n"
- " (hpcweb-configuration\n"
- " (title-prefix \"Guix-HPC - \")\n"
- " (menu '((\"/about\" \"ABOUT\"))))))))\n"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:27193
- msgid "The hpcguix-web service periodically updates the package list it publishes by pulling channels from Git. To that end, it needs to access X.509 certificates so that it can authenticate Git servers when communicating over HTTPS, and it assumes that @file{/etc/ssl/certs} contains those certificates."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:27197
- msgid "Thus, make sure to add @code{nss-certs} or another certificate package to the @code{packages} field of your configuration. @ref{X.509 Certificates}, for more information on X.509 certificates."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:27199 guix-git/doc/guix.texi:27201
- #, no-wrap
- msgid "gmnisrv"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:27204
- msgid "The @uref{https://git.sr.ht/~sircmpwn/gmnisrv, gmnisrv} program is a simple @uref{https://gemini.circumlunar.space/, Gemini} protocol server."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:27205
- #, no-wrap
- msgid "{Scheme Variable} gmnisrv-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:27208
- msgid "This is the type of the gmnisrv service, whose value should be a @code{gmnisrv-configuration} object, as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:27213
- #, no-wrap
- msgid ""
- "(service gmnisrv-service-type\n"
- " (gmnisrv-configuration\n"
- " (config-file (local-file \"./my-gmnisrv.ini\"))))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27216
- #, no-wrap
- msgid "{Data Type} gmnisrv-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27218
- msgid "Data type representing the configuration of gmnisrv."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27220
- #, no-wrap
- msgid "@code{package} (default: @var{gmnisrv})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27222
- msgid "Package object of the gmnisrv server."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27223
- #, no-wrap
- msgid "@code{config-file} (default: @code{%default-gmnisrv-config-file})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27229
- msgid "File-like object of the gmnisrv configuration file to use. The default configuration listens on port 1965 and serves files from @file{/srv/gemini}. Certificates are stored in @file{/var/lib/gemini/certs}. For more information, run @command{man gmnisrv} and @command{man gmnisrv.ini}."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:27233
- #, no-wrap
- msgid "Agate"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:27235
- #, no-wrap
- msgid "agate"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:27240
- msgid "The @uref{gemini://qwertqwefsday.eu/agate.gmi, Agate} (@uref{https://github.com/mbrubeck/agate, GitHub page over HTTPS}) program is a simple @uref{https://gemini.circumlunar.space/, Gemini} protocol server written in Rust."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:27241
- #, no-wrap
- msgid "{Scheme Variable} agate-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:27244
- msgid "This is the type of the agate service, whose value should be an @code{agate-service-type} object, as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:27251
- #, no-wrap
- msgid ""
- "(service agate-service-type\n"
- "\t (agate-configuration\n"
- "\t (content \"/srv/gemini\")\n"
- "\t (cert \"/srv/cert.pem\")\n"
- "\t (key \"/srv/key.rsa\")))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:27256
- msgid "The example above represents the minimal tweaking necessary to get Agate up and running. Specifying the path to the certificate and key is always necessary, as the Gemini protocol requires TLS by default."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:27259
- msgid "To obtain a certificate and a key, you could, for example, use OpenSSL, running a command similar to the following example:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:27263
- #, no-wrap
- msgid ""
- "openssl req -x509 -newkey rsa:4096 -keyout key.rsa -out cert.pem \\\n"
- " -days 3650 -nodes -subj \"/CN=example.com\"\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:27268
- msgid "Of course, you'll have to replace @i{example.com} with your own domain name, and then point the Agate configuration towards the path of the generated key and certificate."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27271
- #, no-wrap
- msgid "{Data Type} agate-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27273
- msgid "Data type representing the configuration of Agate."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27275
- #, no-wrap
- msgid "@code{package} (default: @code{agate})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27277
- msgid "The package object of the Agate server."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27278
- #, no-wrap
- msgid "@code{content} (default: @file{\"/srv/gemini\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27280
- msgid "The directory from which Agate will serve files."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27281
- #, no-wrap
- msgid "@code{cert} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27284
- msgid "The path to the TLS certificate PEM file to be used for encrypted connections. Must be filled in with a value from the user."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27285 guix-git/doc/guix.texi:27721
- #, no-wrap
- msgid "@code{key} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27288
- msgid "The path to the PKCS8 private key file to be used for encrypted connections. Must be filled in with a value from the user."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27289
- #, no-wrap
- msgid "@code{addr} (default: @code{'(\"0.0.0.0:1965\" \"[::]:1965\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27291
- msgid "A list of the addresses to listen on."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27294
- msgid "The domain name of this Gemini server. Optional."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27295
- #, no-wrap
- msgid "@code{lang} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27297
- msgid "RFC 4646 language code(s) for text/gemini documents. Optional."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27298
- #, no-wrap
- msgid "@code{silent?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27300
- msgid "Set to @code{#t} to disable logging output."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27301
- #, no-wrap
- msgid "@code{serve-secret?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27304
- msgid "Set to @code{#t} to serve secret files (files/directories starting with a dot)."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27305
- #, no-wrap
- msgid "@code{log-ip?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27307
- msgid "Whether or not to output IP addresses when logging."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27308
- #, no-wrap
- msgid "@code{user} (default: @code{\"agate\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27310
- msgid "Owner of the @code{agate} process."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27311
- #, no-wrap
- msgid "@code{group} (default: @code{\"agate\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27313
- msgid "Owner's group of the @code{agate} process."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27314
- #, no-wrap
- msgid "@code{log-file} (default: @file{\"/var/log/agate.log\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27316
- msgid "The file which should store the logging output of Agate."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:27323
- #, no-wrap
- msgid "Web"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:27324
- #, no-wrap
- msgid "HTTP, HTTPS"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:27325
- #, no-wrap
- msgid "Let's Encrypt"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:27326
- #, no-wrap
- msgid "TLS certificates"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:27333
- msgid "The @code{(gnu services certbot)} module provides a service to automatically obtain a valid TLS certificate from the Let's Encrypt certificate authority. These certificates can then be used to serve content securely over HTTPS or other TLS-based protocols, with the knowledge that the client will be able to verify the server's authenticity."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:27345
- msgid "@url{https://letsencrypt.org/, Let's Encrypt} provides the @code{certbot} tool to automate the certification process. This tool first securely generates a key on the server. It then makes a request to the Let's Encrypt certificate authority (CA) to sign the key. The CA checks that the request originates from the host in question by using a challenge-response protocol, requiring the server to provide its response over HTTP@. If that protocol completes successfully, the CA signs the key, resulting in a certificate. That certificate is valid for a limited period of time, and therefore to continue to provide TLS services, the server needs to periodically ask the CA to renew its signature."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:27352
- msgid "The certbot service automates this process: the initial key generation, the initial certification request to the Let's Encrypt service, the web server challenge/response integration, writing the certificate to disk, the automated periodic renewals, and the deployment tasks associated with the renewal (e.g.@: reloading services, copying keys with different permissions)."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:27358
- msgid "Certbot is run twice a day, at a random minute within the hour. It won't do anything until your certificates are due for renewal or revoked, but running it regularly would give your service a chance of staying online in case a Let's Encrypt-initiated revocation happened for some reason."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:27362
- msgid "By using this service, you agree to the ACME Subscriber Agreement, which can be found there: @url{https://acme-v01.api.letsencrypt.org/directory}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:27363
- #, no-wrap
- msgid "{Scheme Variable} certbot-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:27366
- msgid "A service type for the @code{certbot} Let's Encrypt client. Its value must be a @code{certbot-configuration} record as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:27373
- #, no-wrap
- msgid ""
- "(define %nginx-deploy-hook\n"
- " (program-file\n"
- " \"nginx-deploy-hook\"\n"
- " #~(let ((pid (call-with-input-file \"/var/run/nginx/pid\" read)))\n"
- " (kill pid SIGHUP))))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:27384
- #, no-wrap
- msgid ""
- "(service certbot-service-type\n"
- " (certbot-configuration\n"
- " (email \"foo@@example.net\")\n"
- " (certificates\n"
- " (list\n"
- " (certificate-configuration\n"
- " (domains '(\"example.net\" \"www.example.net\"))\n"
- " (deploy-hook %nginx-deploy-hook))\n"
- " (certificate-configuration\n"
- " (domains '(\"bar.example.net\")))))))\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:27387
- msgid "See below for details about @code{certbot-configuration}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27389
- #, no-wrap
- msgid "{Data Type} certbot-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27392
- msgid "Data type representing the configuration of the @code{certbot} service. This type has the following parameters:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27394
- #, no-wrap
- msgid "@code{package} (default: @code{certbot})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27396
- msgid "The certbot package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27397
- #, no-wrap
- msgid "@code{webroot} (default: @code{/var/www})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27400
- msgid "The directory from which to serve the Let's Encrypt challenge/response files."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27401
- #, no-wrap
- msgid "@code{certificates} (default: @code{()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27405
- msgid "A list of @code{certificates-configuration}s for which to generate certificates and request signatures. Each certificate has a @code{name} and several @code{domains}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27406
- #, no-wrap
- msgid "@code{email} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27410
- msgid "Optional email address used for registration and recovery contact. Setting this is encouraged as it allows you to receive important notifications about the account and issued certificates."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27411 guix-git/doc/guix.texi:29158
- #, no-wrap
- msgid "@code{server} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27414
- msgid "Optional URL of ACME server. Setting this overrides certbot's default, which is the Let's Encrypt server."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27415
- #, no-wrap
- msgid "@code{rsa-key-size} (default: @code{2048})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27417
- msgid "Size of the RSA key."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27418
- #, no-wrap
- msgid "@code{default-location} (default: @i{see below})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27427
- msgid "The default @code{nginx-location-configuration}. Because @code{certbot} needs to be able to serve challenges and responses, it needs to be able to run a web server. It does so by extending the @code{nginx} web service with an @code{nginx-server-configuration} listening on the @var{domains} on port 80, and which has a @code{nginx-location-configuration} for the @code{/.well-known/} URI path subspace used by Let's Encrypt. @xref{Web Services}, for more on these nginx configuration data types."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27431
- msgid "Requests to other URL paths will be matched by the @code{default-location}, which if present is added to all @code{nginx-server-configuration}s."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27435
- msgid "By default, the @code{default-location} will issue a redirect from @code{http://@var{domain}/...} to @code{https://@var{domain}/...}, leaving you to define what to serve on your site via @code{https}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27437
- msgid "Pass @code{#f} to not issue a default location."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27440
- #, no-wrap
- msgid "{Data Type} certificate-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27443
- msgid "Data type representing the configuration of a certificate. This type has the following parameters:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27445
- #, no-wrap
- msgid "@code{name} (default: @i{see below})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27449
- msgid "This name is used by Certbot for housekeeping and in file paths; it doesn't affect the content of the certificate itself. To see certificate names, run @code{certbot certificates}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27451
- msgid "Its default is the first provided domain."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27452
- #, no-wrap
- msgid "@code{domains} (default: @code{()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27455
- msgid "The first domain provided will be the subject CN of the certificate, and all domains will be Subject Alternative Names on the certificate."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27456
- #, no-wrap
- msgid "@code{challenge} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27463
- msgid "The challenge type that has to be run by certbot. If @code{#f} is specified, default to the HTTP challenge. If a value is specified, defaults to the manual plugin (see @code{authentication-hook}, @code{cleanup-hook} and the documentation at @url{https://certbot.eff.org/docs/using.html#hooks}), and gives Let's Encrypt permission to log the public IP address of the requesting machine."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27464
- #, no-wrap
- msgid "@code{csr} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27471
- msgid "File name of Certificate Signing Request (CSR) in DER or PEM format. If @code{#f} is specified, this argument will not be passed to certbot. If a value is specified, certbot will use it to obtain a certificate, instead of using a self-generated CSR. The domain-name(s) mentioned in @code{domains}, must be consistent with the domain-name(s) mentioned in CSR file."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27472
- #, no-wrap
- msgid "@code{authentication-hook} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27478
- msgid "Command to be run in a shell once for each certificate challenge to be answered. For this command, the shell variable @code{$CERTBOT_DOMAIN} will contain the domain being authenticated, @code{$CERTBOT_VALIDATION} contains the validation string and @code{$CERTBOT_TOKEN} contains the file name of the resource requested when performing an HTTP-01 challenge."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27479
- #, no-wrap
- msgid "@code{cleanup-hook} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27485
- msgid "Command to be run in a shell once for each certificate challenge that have been answered by the @code{auth-hook}. For this command, the shell variables available in the @code{auth-hook} script are still available, and additionally @code{$CERTBOT_AUTH_OUTPUT} will contain the standard output of the @code{auth-hook} script."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27486
- #, no-wrap
- msgid "@code{deploy-hook} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27494
- msgid "Command to be run in a shell once for each successfully issued certificate. For this command, the shell variable @code{$RENEWED_LINEAGE} will point to the config live subdirectory (for example, @samp{\"/etc/letsencrypt/live/example.com\"}) containing the new certificates and keys; the shell variable @code{$RENEWED_DOMAINS} will contain a space-delimited list of renewed certificate domains (for example, @samp{\"example.com www.example.com\"}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:27501
- msgid "For each @code{certificate-configuration}, the certificate is saved to @code{/etc/letsencrypt/live/@var{name}/fullchain.pem} and the key is saved to @code{/etc/letsencrypt/live/@var{name}/privkey.pem}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:27503
- #, no-wrap
- msgid "DNS (domain name system)"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:27504
- #, no-wrap
- msgid "domain name system (DNS)"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:27512
- msgid "The @code{(gnu services dns)} module provides services related to the @dfn{domain name system} (DNS). It provides a server service for hosting an @emph{authoritative} DNS server for multiple zones, slave or master. This service uses @uref{https://www.knot-dns.cz/, Knot DNS}. And also a caching and forwarding DNS server for the LAN, which uses @uref{http://www.thekelleys.org.uk/dnsmasq/doc.html, dnsmasq}."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:27513
- #, no-wrap
- msgid "Knot Service"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:27517
- msgid "An example configuration of an authoritative server for two zones, one master and one slave, is:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:27524
- #, no-wrap
- msgid ""
- "(define-zone-entries example.org.zone\n"
- ";; Name TTL Class Type Data\n"
- " (\"@@\" \"\" \"IN\" \"A\" \"127.0.0.1\")\n"
- " (\"@@\" \"\" \"IN\" \"NS\" \"ns\")\n"
- " (\"ns\" \"\" \"IN\" \"A\" \"127.0.0.1\"))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:27531
- #, no-wrap
- msgid ""
- "(define master-zone\n"
- " (knot-zone-configuration\n"
- " (domain \"example.org\")\n"
- " (zone (zone-file\n"
- " (origin \"example.org\")\n"
- " (entries example.org.zone)))))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:27537
- #, no-wrap
- msgid ""
- "(define slave-zone\n"
- " (knot-zone-configuration\n"
- " (domain \"plop.org\")\n"
- " (dnssec-policy \"default\")\n"
- " (master (list \"plop-master\"))))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:27542
- #, no-wrap
- msgid ""
- "(define plop-master\n"
- " (knot-remote-configuration\n"
- " (id \"plop-master\")\n"
- " (address (list \"208.76.58.171\"))))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:27551
- #, no-wrap
- msgid ""
- "(operating-system\n"
- " ;; ...\n"
- " (services (cons* (service knot-service-type\n"
- " (knot-configuration\n"
- " (remotes (list plop-master))\n"
- " (zones (list master-zone slave-zone))))\n"
- " ;; ...\n"
- " %base-services)))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:27553
- #, no-wrap
- msgid "{Scheme Variable} knot-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:27555
- msgid "This is the type for the Knot DNS server."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:27563
- msgid "Knot DNS is an authoritative DNS server, meaning that it can serve multiple zones, that is to say domain names you would buy from a registrar. This server is not a resolver, meaning that it can only resolve names for which it is authoritative. This server can be configured to serve zones as a master server or a slave server as a per-zone basis. Slave zones will get their data from masters, and will serve it as an authoritative server. From the point of view of a resolver, there is no difference between master and slave."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:27565
- msgid "The following data types are used to configure the Knot DNS server:"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27567
- #, no-wrap
- msgid "{Data Type} knot-key-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27570
- msgid "Data type representing a key. This type has the following parameters:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27572 guix-git/doc/guix.texi:27592
- #: guix-git/doc/guix.texi:27707 guix-git/doc/guix.texi:27733
- #: guix-git/doc/guix.texi:27768
- #, no-wrap
- msgid "@code{id} (default: @code{\"\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27575 guix-git/doc/guix.texi:27595
- msgid "An identifier for other configuration fields to refer to this key. IDs must be unique and must not be empty."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27576
- #, no-wrap
- msgid "@code{algorithm} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27580
- msgid "The algorithm to use. Choose between @code{#f}, @code{'hmac-md5}, @code{'hmac-sha1}, @code{'hmac-sha224}, @code{'hmac-sha256}, @code{'hmac-sha384} and @code{'hmac-sha512}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27581
- #, no-wrap
- msgid "@code{secret} (default: @code{\"\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27583
- msgid "The secret key itself."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27587
- #, no-wrap
- msgid "{Data Type} knot-acl-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27590
- msgid "Data type representing an Access Control List (ACL) configuration. This type has the following parameters:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27596 guix-git/doc/guix.texi:27711
- #, no-wrap
- msgid "@code{address} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27600
- msgid "An ordered list of IP addresses, network subnets, or network ranges represented with strings. The query must match one of them. Empty value means that address match is not required."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27601
- #, no-wrap
- msgid "@code{key} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27605
- msgid "An ordered list of references to keys represented with strings. The string must match a key ID defined in a @code{knot-key-configuration}. No key means that a key is not require to match that ACL."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27606
- #, no-wrap
- msgid "@code{action} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27610
- msgid "An ordered list of actions that are permitted or forbidden by this ACL@. Possible values are lists of zero or more elements from @code{'transfer}, @code{'notify} and @code{'update}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27611
- #, no-wrap
- msgid "@code{deny?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27614
- msgid "When true, the ACL defines restrictions. Listed actions are forbidden. When false, listed actions are allowed."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27618
- #, no-wrap
- msgid "{Data Type} zone-entry"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27621
- msgid "Data type representing a record entry in a zone file. This type has the following parameters:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27623
- #, no-wrap
- msgid "@code{name} (default: @code{\"@@\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27629
- msgid "The name of the record. @code{\"@@\"} refers to the origin of the zone. Names are relative to the origin of the zone. For example, in the @code{example.org} zone, @code{\"ns.example.org\"} actually refers to @code{ns.example.org.example.org}. Names ending with a dot are absolute, which means that @code{\"ns.example.org.\"} refers to @code{ns.example.org}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27630
- #, no-wrap
- msgid "@code{ttl} (default: @code{\"\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27632
- msgid "The Time-To-Live (TTL) of this record. If not set, the default TTL is used."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27633
- #, no-wrap
- msgid "@code{class} (default: @code{\"IN\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27636
- msgid "The class of the record. Knot currently supports only @code{\"IN\"} and partially @code{\"CH\"}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27637
- #, no-wrap
- msgid "@code{type} (default: @code{\"A\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27641
- msgid "The type of the record. Common types include A (IPv4 address), AAAA (IPv6 address), NS (Name Server) and MX (Mail eXchange). Many other types are defined."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27642
- #, no-wrap
- msgid "@code{data} (default: @code{\"\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27646
- msgid "The data contained in the record. For instance an IP address associated with an A record, or a domain name associated with an NS record. Remember that domain names are relative to the origin unless they end with a dot."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27650
- #, no-wrap
- msgid "{Data Type} zone-file"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27653
- msgid "Data type representing the content of a zone file. This type has the following parameters:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27662
- msgid "The list of entries. The SOA record is taken care of, so you don't need to put it in the list of entries. This list should probably contain an entry for your primary authoritative DNS server. Other than using a list of entries directly, you can use @code{define-zone-entries} to define a object containing the list of entries more easily, that you can later pass to the @code{entries} field of the @code{zone-file}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27663
- #, no-wrap
- msgid "@code{origin} (default: @code{\"\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27665
- msgid "The name of your zone. This parameter cannot be empty."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27666
- #, no-wrap
- msgid "@code{ns} (default: @code{\"ns\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27671
- msgid "The domain of your primary authoritative DNS server. The name is relative to the origin, unless it ends with a dot. It is mandatory that this primary DNS server corresponds to an NS record in the zone and that it is associated to an IP address in the list of entries."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27672
- #, no-wrap
- msgid "@code{mail} (default: @code{\"hostmaster\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27675
- msgid "An email address people can contact you at, as the owner of the zone. This is translated as @code{<mail>@@<origin>}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27676
- #, no-wrap
- msgid "@code{serial} (default: @code{1})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27680
- msgid "The serial number of the zone. As this is used to keep track of changes by both slaves and resolvers, it is mandatory that it @emph{never} decreases. Always increment it when you make a change in your zone."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27681
- #, no-wrap
- msgid "@code{refresh} (default: @code{(* 2 24 3600)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27685
- msgid "The frequency at which slaves will do a zone transfer. This value is a number of seconds. It can be computed by multiplications or with @code{(string->duration)}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27686
- #, no-wrap
- msgid "@code{retry} (default: @code{(* 15 60)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27689
- msgid "The period after which a slave will retry to contact its master when it fails to do so a first time."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27690
- #, no-wrap
- msgid "@code{expiry} (default: @code{(* 14 24 3600)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27694
- msgid "Default TTL of records. Existing records are considered correct for at most this amount of time. After this period, resolvers will invalidate their cache and check again that it still exists."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27695
- #, no-wrap
- msgid "@code{nx} (default: @code{3600})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27698
- msgid "Default TTL of inexistent records. This delay is usually short because you want your new domains to reach everyone quickly."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27702
- #, no-wrap
- msgid "{Data Type} knot-remote-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27705
- msgid "Data type representing a remote configuration. This type has the following parameters:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27710
- msgid "An identifier for other configuration fields to refer to this remote. IDs must be unique and must not be empty."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27715
- msgid "An ordered list of destination IP addresses. Addresses are tried in sequence. An optional port can be given with the @@ separator. For instance: @code{(list \"1.2.3.4\" \"2.3.4.5@@53\")}. Default port is 53."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27716
- #, no-wrap
- msgid "@code{via} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27720
- msgid "An ordered list of source IP addresses. An empty list will have Knot choose an appropriate source IP@. An optional port can be given with the @@ separator. The default is to choose at random."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27724
- msgid "A reference to a key, that is a string containing the identifier of a key defined in a @code{knot-key-configuration} field."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27728
- #, no-wrap
- msgid "{Data Type} knot-keystore-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27731
- msgid "Data type representing a keystore to hold dnssec keys. This type has the following parameters:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27735
- msgid "The id of the keystore. It must not be empty."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27736
- #, no-wrap
- msgid "@code{backend} (default: @code{'pem})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27738
- msgid "The backend to store the keys in. Can be @code{'pem} or @code{'pkcs11}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27739
- #, no-wrap
- msgid "@code{config} (default: @code{\"/var/lib/knot/keys/keys\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27743
- msgid "The configuration string of the backend. An example for the PKCS#11 is: @code{\"pkcs11:token=knot;pin-value=1234 /gnu/store/.../lib/pkcs11/libsofthsm2.so\"}. For the pem backend, the string represents a path in the file system."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27747
- #, no-wrap
- msgid "{Data Type} knot-policy-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27751
- msgid "Data type representing a dnssec policy. Knot DNS is able to automatically sign your zones. It can either generate and manage your keys automatically or use keys that you generate."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27758
- msgid "Dnssec is usually implemented using two keys: a Key Signing Key (KSK) that is used to sign the second, and a Zone Signing Key (ZSK) that is used to sign the zone. In order to be trusted, the KSK needs to be present in the parent zone (usually a top-level domain). If your registrar supports dnssec, you will have to send them your KSK's hash so they can add a DS record in their zone. This is not automated and need to be done each time you change your KSK."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27764
- msgid "The policy also defines the lifetime of keys. Usually, ZSK can be changed easily and use weaker cryptographic functions (they use lower parameters) in order to sign records quickly, so they are changed often. The KSK however requires manual interaction with the registrar, so they are changed less often and use stronger parameters because they sign only one record."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27766
- msgid "This type has the following parameters:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27770
- msgid "The id of the policy. It must not be empty."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27771
- #, no-wrap
- msgid "@code{keystore} (default: @code{\"default\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27776
- msgid "A reference to a keystore, that is a string containing the identifier of a keystore defined in a @code{knot-keystore-configuration} field. The @code{\"default\"} identifier means the default keystore (a kasp database that was setup by this service)."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27777
- #, no-wrap
- msgid "@code{manual?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27779
- msgid "Whether the key management is manual or automatic."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27780
- #, no-wrap
- msgid "@code{single-type-signing?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27782
- msgid "When @code{#t}, use the Single-Type Signing Scheme."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27783
- #, no-wrap
- msgid "@code{algorithm} (default: @code{\"ecdsap256sha256\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27785
- msgid "An algorithm of signing keys and issued signatures."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27786
- #, no-wrap
- msgid "@code{ksk-size} (default: @code{256})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27789
- msgid "The length of the KSK@. Note that this value is correct for the default algorithm, but would be unsecure for other algorithms."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27790
- #, no-wrap
- msgid "@code{zsk-size} (default: @code{256})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27793
- msgid "The length of the ZSK@. Note that this value is correct for the default algorithm, but would be unsecure for other algorithms."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27794
- #, no-wrap
- msgid "@code{dnskey-ttl} (default: @code{'default})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27797
- msgid "The TTL value for DNSKEY records added into zone apex. The special @code{'default} value means same as the zone SOA TTL."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27798
- #, no-wrap
- msgid "@code{zsk-lifetime} (default: @code{(* 30 24 3600)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27800
- msgid "The period between ZSK publication and the next rollover initiation."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27801
- #, no-wrap
- msgid "@code{propagation-delay} (default: @code{(* 24 3600)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27804
- msgid "An extra delay added for each key rollover step. This value should be high enough to cover propagation of data from the master server to all slaves."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27805
- #, no-wrap
- msgid "@code{rrsig-lifetime} (default: @code{(* 14 24 3600)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27807
- msgid "A validity period of newly issued signatures."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27808
- #, no-wrap
- msgid "@code{rrsig-refresh} (default: @code{(* 7 24 3600)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27810
- msgid "A period how long before a signature expiration the signature will be refreshed."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27811
- #, no-wrap
- msgid "@code{nsec3?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27813
- msgid "When @code{#t}, NSEC3 will be used instead of NSEC."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27814
- #, no-wrap
- msgid "@code{nsec3-iterations} (default: @code{5})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27816
- msgid "The number of additional times the hashing is performed."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27817
- #, no-wrap
- msgid "@code{nsec3-salt-length} (default: @code{8})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27820
- msgid "The length of a salt field in octets, which is appended to the original owner name before hashing."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27821
- #, no-wrap
- msgid "@code{nsec3-salt-lifetime} (default: @code{(* 30 24 3600)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27823
- msgid "The validity period of newly issued salt field."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27827
- #, no-wrap
- msgid "{Data Type} knot-zone-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27830
- msgid "Data type representing a zone served by Knot. This type has the following parameters:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27832
- #, no-wrap
- msgid "@code{domain} (default: @code{\"\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27834
- msgid "The domain served by this configuration. It must not be empty."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27835
- #, no-wrap
- msgid "@code{file} (default: @code{\"\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27838
- msgid "The file where this zone is saved. This parameter is ignored by master zones. Empty means default location that depends on the domain name."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27839
- #, no-wrap
- msgid "@code{zone} (default: @code{(zone-file)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27842
- msgid "The content of the zone file. This parameter is ignored by slave zones. It must contain a zone-file record."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27843
- #, no-wrap
- msgid "@code{master} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27846
- msgid "A list of master remotes. When empty, this zone is a master. When set, this zone is a slave. This is a list of remotes identifiers."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27847
- #, no-wrap
- msgid "@code{ddns-master} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27850
- msgid "The main master. When empty, it defaults to the first master in the list of masters."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27851
- #, no-wrap
- msgid "@code{notify} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27853
- msgid "A list of slave remote identifiers."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27854
- #, no-wrap
- msgid "@code{acl} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27856
- msgid "A list of acl identifiers."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27857
- #, no-wrap
- msgid "@code{semantic-checks?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27859
- msgid "When set, this adds more semantic checks to the zone."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27860
- #, no-wrap
- msgid "@code{zonefile-sync} (default: @code{0})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27863
- msgid "The delay between a modification in memory and on disk. 0 means immediate synchronization."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27864
- #, no-wrap
- msgid "@code{zonefile-load} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27867
- msgid "The way the zone file contents are applied during zone load. Possible values are:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27869
- #, no-wrap
- msgid "@code{#f} for using the default value from Knot,"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27870
- #, no-wrap
- msgid "@code{'none} for not using the zone file at all,"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27871
- #, no-wrap
- msgid "@code{'difference} for computing the difference between already available"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:27873
- msgid "contents and zone contents and applying it to the current zone contents,"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27873
- #, no-wrap
- msgid "@code{'difference-no-serial} for the same as @code{'difference}, but"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:27876
- msgid "ignoring the SOA serial in the zone file, while the server takes care of it automatically."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27876
- #, no-wrap
- msgid "@code{'whole} for loading zone contents from the zone file."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27879
- #, no-wrap
- msgid "@code{journal-content} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27884
- msgid "The way the journal is used to store zone and its changes. Possible values are @code{'none} to not use it at all, @code{'changes} to store changes and @code{'all} to store contents. @code{#f} does not set this option, so the default value from Knot is used."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27885
- #, no-wrap
- msgid "@code{max-journal-usage} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27888
- msgid "The maximum size for the journal on disk. @code{#f} does not set this option, so the default value from Knot is used."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27889
- #, no-wrap
- msgid "@code{max-journal-depth} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27892
- msgid "The maximum size of the history. @code{#f} does not set this option, so the default value from Knot is used."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27893
- #, no-wrap
- msgid "@code{max-zone-size} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27897
- msgid "The maximum size of the zone file. This limit is enforced for incoming transfer and updates. @code{#f} does not set this option, so the default value from Knot is used."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27898
- #, no-wrap
- msgid "@code{dnssec-policy} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27902
- msgid "A reference to a @code{knot-policy-configuration} record, or the special name @code{\"default\"}. If the value is @code{#f}, there is no dnssec signing on this zone."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27903
- #, no-wrap
- msgid "@code{serial-policy} (default: @code{'increment})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27905
- msgid "A policy between @code{'increment} and @code{'unixtime}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27909
- #, no-wrap
- msgid "{Data Type} knot-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27912
- msgid "Data type representing the Knot configuration. This type has the following parameters:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27914
- #, no-wrap
- msgid "@code{knot} (default: @code{knot})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27916
- msgid "The Knot package."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27917
- #, no-wrap
- msgid "@code{run-directory} (default: @code{\"/var/run/knot\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27919
- msgid "The run directory. This directory will be used for pid file and sockets."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27920
- #, no-wrap
- msgid "@code{includes} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27923
- msgid "A list of strings or file-like objects denoting other files that must be included at the top of the configuration file."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:27924
- #, no-wrap
- msgid "secrets, Knot service"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27930
- msgid "This can be used to manage secrets out-of-band. For example, secret keys may be stored in an out-of-band file not managed by Guix, and thus not visible in @file{/gnu/store}---e.g., you could store secret key configuration in @file{/etc/knot/secrets.conf} and add this file to the @code{includes} list."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27935
- msgid "One can generate a secret tsig key (for nsupdate and zone transfers with the keymgr command from the knot package. Note that the package is not automatically installed by the service. The following example shows how to generate a new tsig key:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:27939
- #, no-wrap
- msgid ""
- "keymgr -t mysecret > /etc/knot/secrets.conf\n"
- "chmod 600 /etc/knot/secrets.conf\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27945
- msgid "Also note that the generated key will be named @var{mysecret}, so it is the name that needs to be used in the @var{key} field of the @code{knot-acl-configuration} record and in other places that need to refer to that key."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27947
- msgid "It can also be used to add configuration not supported by this interface."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27948
- #, no-wrap
- msgid "@code{listen-v4} (default: @code{\"0.0.0.0\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27950 guix-git/doc/guix.texi:27953
- msgid "An ip address on which to listen."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27951
- #, no-wrap
- msgid "@code{listen-v6} (default: @code{\"::\"})"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27954
- #, no-wrap
- msgid "@code{listen-port} (default: @code{53})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27956
- msgid "A port on which to listen."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27957
- #, no-wrap
- msgid "@code{keys} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27959
- msgid "The list of knot-key-configuration used by this configuration."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27960
- #, no-wrap
- msgid "@code{acls} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27962
- msgid "The list of knot-acl-configuration used by this configuration."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27963
- #, no-wrap
- msgid "@code{remotes} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27965
- msgid "The list of knot-remote-configuration used by this configuration."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27966
- #, no-wrap
- msgid "@code{zones} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27968
- msgid "The list of knot-zone-configuration used by this configuration."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:27972
- #, no-wrap
- msgid "Knot Resolver Service"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:27974
- #, no-wrap
- msgid "{Scheme Variable} knot-resolver-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:27977
- msgid "This is the type of the knot resolver service, whose value should be an @code{knot-resolver-configuration} object as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:27987
- #, no-wrap
- msgid ""
- "(service knot-resolver-service-type\n"
- " (knot-resolver-configuration\n"
- " (kresd-config-file (plain-file \"kresd.conf\" \"\n"
- "net.listen('192.168.0.1', 5353)\n"
- "user('knot-resolver', 'knot-resolver')\n"
- "modules = @{ 'hints > iterate', 'stats', 'predict' @}\n"
- "cache.size = 100 * MB\n"
- "\"))))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:27990
- msgid "For more information, refer its @url{https://knot-resolver.readthedocs.org/en/stable/daemon.html#configuration, manual}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27992
- #, no-wrap
- msgid "{Data Type} knot-resolver-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:27994
- msgid "Data type representing the configuration of knot-resolver."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27996
- #, no-wrap
- msgid "@code{package} (default: @var{knot-resolver})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:27998
- msgid "Package object of the knot DNS resolver."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:27999
- #, no-wrap
- msgid "@code{kresd-config-file} (default: %kresd.conf)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28002
- msgid "File-like object of the kresd configuration file to use, by default it will listen on @code{127.0.0.1} and @code{::1}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28003
- #, no-wrap
- msgid "@code{garbage-collection-interval} (default: 1000)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28005
- msgid "Number of milliseconds for @code{kres-cache-gc} to periodically trim the cache."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:28010
- #, no-wrap
- msgid "Dnsmasq Service"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:28012
- #, no-wrap
- msgid "{Scheme Variable} dnsmasq-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:28015
- msgid "This is the type of the dnsmasq service, whose value should be an @code{dnsmasq-configuration} object as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:28021
- #, no-wrap
- msgid ""
- "(service dnsmasq-service-type\n"
- " (dnsmasq-configuration\n"
- " (no-resolv? #t)\n"
- " (servers '(\"192.168.1.1\"))))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:28024
- #, no-wrap
- msgid "{Data Type} dnsmasq-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:28026
- msgid "Data type representing the configuration of dnsmasq."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28028
- #, no-wrap
- msgid "@code{package} (default: @var{dnsmasq})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28030
- msgid "Package object of the dnsmasq server."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28031
- #, no-wrap
- msgid "@code{no-hosts?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28033
- msgid "When true, don't read the hostnames in /etc/hosts."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28034
- #, no-wrap
- msgid "@code{port} (default: @code{53})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28037
- msgid "The port to listen on. Setting this to zero completely disables DNS responses, leaving only DHCP and/or TFTP functions."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28038
- #, no-wrap
- msgid "@code{local-service?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28041
- msgid "Accept DNS queries only from hosts whose address is on a local subnet, ie a subnet for which an interface exists on the server."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28042
- #, no-wrap
- msgid "@code{listen-addresses} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28044
- msgid "Listen on the given IP addresses."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28045
- #, no-wrap
- msgid "@code{resolv-file} (default: @code{\"/etc/resolv.conf\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28047
- msgid "The file to read the IP address of the upstream nameservers from."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28048
- #, no-wrap
- msgid "@code{no-resolv?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28050
- msgid "When true, don't read @var{resolv-file}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28051
- #, no-wrap
- msgid "@code{servers} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28053
- msgid "Specify IP address of upstream servers directly."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28054
- #, no-wrap
- msgid "@code{addresses} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28058
- msgid "For each entry, specify an IP address to return for any host in the given domains. Queries in the domains are never forwarded and always replied to with the specified IP address."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28060
- msgid "This is useful for redirecting hosts locally, for example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:28069
- #, no-wrap
- msgid ""
- "(service dnsmasq-service-type\n"
- " (dnsmasq-configuration\n"
- " (addresses\n"
- " '(; Redirect to a local web-server.\n"
- " \"/example.org/127.0.0.1\"\n"
- " ; Redirect subdomain to a specific IP.\n"
- " \"/subdomain.example.org/192.168.1.42\"))))\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28072
- msgid "Note that rules in @file{/etc/hosts} take precedence over this."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28073
- #, no-wrap
- msgid "@code{cache-size} (default: @code{150})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28076
- msgid "Set the size of dnsmasq's cache. Setting the cache size to zero disables caching."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28077
- #, no-wrap
- msgid "@code{negative-cache?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28079
- msgid "When false, disable negative caching."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28080
- #, no-wrap
- msgid "@code{tftp-enable?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28082
- msgid "Whether to enable the built-in TFTP server."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28083
- #, no-wrap
- msgid "@code{tftp-no-fail?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28085
- msgid "If true, does not fail dnsmasq if the TFTP server could not start up."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28086
- #, no-wrap
- msgid "@code{tftp-single-port?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28088
- msgid "Whether to use only one single port for TFTP."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28089
- #, no-wrap
- msgid "@code{tftp-secure?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28091
- msgid "If true, only files owned by the user running the dnsmasq process are accessible."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28095
- msgid "If dnsmasq is being run as root, different rules apply: @code{tftp-secure?} has no effect, but only files which have the world-readable bit set are accessible."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28096
- #, no-wrap
- msgid "@code{tftp-max} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28098
- msgid "If set, sets the maximal number of concurrent connections allowed."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28099
- #, no-wrap
- msgid "@code{tftp-mtu} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28101
- msgid "If set, sets the MTU for TFTP packets to that value."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28102
- #, no-wrap
- msgid "@code{tftp-no-blocksize?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28104
- msgid "If true, stops the TFTP server from negotiating the blocksize with a client."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28105
- #, no-wrap
- msgid "@code{tftp-lowercase?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28107
- msgid "Whether to convert all filenames in TFTP requests to lowercase."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28108
- #, no-wrap
- msgid "@code{tftp-port-range} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28111
- msgid "If set, fixes the dynamical ports (one per client) to the given range (@code{\"<start>,<end>\"})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28112
- #, no-wrap
- msgid "@code{tftp-root} (default: @code{/var/empty,lo})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28119
- msgid "Look for files to transfer using TFTP relative to the given directory. When this is set, TFTP paths which include @samp{..} are rejected, to stop clients getting outside the specified root. Absolute paths (starting with @samp{/}) are allowed, but they must be within the TFTP-root. If the optional interface argument is given, the directory is only used for TFTP requests via that interface."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28120
- #, no-wrap
- msgid "@code{tftp-unique-root} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28125
- msgid "If set, add the IP or hardware address of the TFTP client as a path component on the end of the TFTP-root. Only valid if a TFTP root is set and the directory exists. Defaults to adding IP address (in standard dotted-quad format)."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28134
- msgid "For instance, if @option{--tftp-root} is @samp{/tftp} and client @samp{1.2.3.4} requests file @file{myfile} then the effective path will be @file{/tftp/1.2.3.4/myfile} if @file{/tftp/1.2.3.4} exists or @file{/tftp/myfile} otherwise. When @samp{=mac} is specified it will append the MAC address instead, using lowercase zero padded digits separated by dashes, e.g.: @samp{01-02-03-04-aa-bb}. Note that resolving MAC addresses is only possible if the client is in the local network or obtained a DHCP lease from dnsmasq."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:28138
- #, no-wrap
- msgid "ddclient Service"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:28140
- #, no-wrap
- msgid "ddclient"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:28144
- msgid "The ddclient service described below runs the ddclient daemon, which takes care of automatically updating DNS entries for service providers such as @uref{https://dyn.com/dns/, Dyn}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:28147
- msgid "The following example show instantiates the service with its default configuration:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:28150
- #, no-wrap
- msgid "(service ddclient-service-type)\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:28159
- msgid "Note that ddclient needs to access credentials that are stored in a @dfn{secret file}, by default @file{/etc/ddclient/secrets} (see @code{secret-file} below). You are expected to create this file manually, in an ``out-of-band'' fashion (you @emph{could} make this file part of the service configuration, for instance by using @code{plain-file}, but it will be world-readable @i{via} @file{/gnu/store}). See the examples in the @file{share/ddclient} directory of the @code{ddclient} package."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:28163
- msgid "Available @code{ddclient-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28164
- #, no-wrap
- msgid "{@code{ddclient-configuration} parameter} package ddclient"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28166
- msgid "The ddclient package."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28169
- #, no-wrap
- msgid "{@code{ddclient-configuration} parameter} integer daemon"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28171
- msgid "The period after which ddclient will retry to check IP and domain name."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28173
- msgid "Defaults to @samp{300}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28176
- #, no-wrap
- msgid "{@code{ddclient-configuration} parameter} boolean syslog"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28178
- msgid "Use syslog for the output."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28183
- #, no-wrap
- msgid "{@code{ddclient-configuration} parameter} string mail"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28185
- msgid "Mail to user."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28187 guix-git/doc/guix.texi:28194
- #: guix-git/doc/guix.texi:29996
- msgid "Defaults to @samp{\"root\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28190
- #, no-wrap
- msgid "{@code{ddclient-configuration} parameter} string mail-failure"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28192
- msgid "Mail failed update to user."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28197
- #, no-wrap
- msgid "{@code{ddclient-configuration} parameter} string pid"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28199
- msgid "The ddclient PID file."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28201
- msgid "Defaults to @samp{\"/var/run/ddclient/ddclient.pid\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28204
- #, no-wrap
- msgid "{@code{ddclient-configuration} parameter} boolean ssl"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28206
- msgid "Enable SSL support."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28211
- #, no-wrap
- msgid "{@code{ddclient-configuration} parameter} string user"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28214
- msgid "Specifies the user name or ID that is used when running ddclient program."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28216 guix-git/doc/guix.texi:28223
- msgid "Defaults to @samp{\"ddclient\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28219
- #, no-wrap
- msgid "{@code{ddclient-configuration} parameter} string group"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28221
- msgid "Group of the user who will run the ddclient program."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28226
- #, no-wrap
- msgid "{@code{ddclient-configuration} parameter} string secret-file"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28230
- msgid "Secret file which will be appended to @file{ddclient.conf} file. This file contains credentials for use by ddclient. You are expected to create it manually."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28232
- msgid "Defaults to @samp{\"/etc/ddclient/secrets.conf\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28235
- #, no-wrap
- msgid "{@code{ddclient-configuration} parameter} list extra-options"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28237
- msgid "Extra options will be appended to @file{ddclient.conf} file."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:28248
- #, no-wrap
- msgid "VPN (virtual private network)"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:28249
- #, no-wrap
- msgid "virtual private network (VPN)"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:28253
- msgid "The @code{(gnu services vpn)} module provides services related to @dfn{virtual private networks} (VPNs)."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:28254
- #, no-wrap
- msgid "Bitmask"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:28256
- #, no-wrap
- msgid "{Scheme Variable} bitmask-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:28261
- msgid "A service type for the @uref{https://bitmask.net, Bitmask} VPN client. It makes the client available in the system and loads its polkit policy. Please note that the client expects an active polkit-agent, which is either run by your desktop-environment or should be run manually."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:28263
- #, no-wrap
- msgid "OpenVPN"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:28267
- msgid "It provides a @emph{client} service for your machine to connect to a VPN, and a @emph{server} service for your machine to host a VPN@."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:28268
- #, no-wrap
- msgid "{Scheme Procedure} openvpn-client-service @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:28270
- msgid "[#:config (openvpn-client-configuration)]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:28272
- msgid "Return a service that runs @command{openvpn}, a VPN daemon, as a client."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:28274
- #, no-wrap
- msgid "{Scheme Procedure} openvpn-server-service @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:28276
- msgid "[#:config (openvpn-server-configuration)]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:28278
- msgid "Return a service that runs @command{openvpn}, a VPN daemon, as a server."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:28280
- msgid "Both can be run simultaneously."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:28285
- msgid "Available @code{openvpn-client-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28286
- #, no-wrap
- msgid "{@code{openvpn-client-configuration} parameter} package openvpn"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28288 guix-git/doc/guix.texi:28443
- msgid "The OpenVPN package."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28291
- #, no-wrap
- msgid "{@code{openvpn-client-configuration} parameter} string pid-file"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28293 guix-git/doc/guix.texi:28448
- msgid "The OpenVPN pid file."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28295 guix-git/doc/guix.texi:28450
- msgid "Defaults to @samp{\"/var/run/openvpn/openvpn.pid\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28298
- #, no-wrap
- msgid "{@code{openvpn-client-configuration} parameter} proto proto"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28301 guix-git/doc/guix.texi:28456
- msgid "The protocol (UDP or TCP) used to open a channel between clients and servers."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28303 guix-git/doc/guix.texi:28458
- msgid "Defaults to @samp{udp}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28306
- #, no-wrap
- msgid "{@code{openvpn-client-configuration} parameter} dev dev"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28308 guix-git/doc/guix.texi:28463
- msgid "The device type used to represent the VPN connection."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28310 guix-git/doc/guix.texi:28465
- msgid "Defaults to @samp{tun}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:28316 guix-git/doc/guix.texi:28471
- msgid "If you do not have some of these files (eg.@: you use a username and password), you can disable any of the following three fields by setting it to @code{'disabled}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28317
- #, no-wrap
- msgid "{@code{openvpn-client-configuration} parameter} maybe-string ca"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28319 guix-git/doc/guix.texi:28474
- msgid "The certificate authority to check connections against."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28321 guix-git/doc/guix.texi:28476
- msgid "Defaults to @samp{\"/etc/openvpn/ca.crt\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28324
- #, no-wrap
- msgid "{@code{openvpn-client-configuration} parameter} maybe-string cert"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28327 guix-git/doc/guix.texi:28482
- msgid "The certificate of the machine the daemon is running on. It should be signed by the authority given in @code{ca}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28329 guix-git/doc/guix.texi:28484
- msgid "Defaults to @samp{\"/etc/openvpn/client.crt\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28332
- #, no-wrap
- msgid "{@code{openvpn-client-configuration} parameter} maybe-string key"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28335 guix-git/doc/guix.texi:28490
- msgid "The key of the machine the daemon is running on. It must be the key whose certificate is @code{cert}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28337 guix-git/doc/guix.texi:28492
- msgid "Defaults to @samp{\"/etc/openvpn/client.key\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28340
- #, no-wrap
- msgid "{@code{openvpn-client-configuration} parameter} boolean comp-lzo?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28342 guix-git/doc/guix.texi:28497
- msgid "Whether to use the lzo compression algorithm."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28347
- #, no-wrap
- msgid "{@code{openvpn-client-configuration} parameter} boolean persist-key?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28349 guix-git/doc/guix.texi:28504
- msgid "Don't re-read key files across SIGUSR1 or --ping-restart."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28354
- #, no-wrap
- msgid "{@code{openvpn-client-configuration} parameter} boolean persist-tun?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28357 guix-git/doc/guix.texi:28512
- msgid "Don't close and reopen TUN/TAP device or run up/down scripts across SIGUSR1 or --ping-restart restarts."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28362
- #, no-wrap
- msgid "{@code{openvpn-client-configuration} parameter} boolean fast-io?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28365 guix-git/doc/guix.texi:28520
- msgid "(Experimental) Optimize TUN/TAP/UDP I/O writes by avoiding a call to poll/epoll/select prior to the write operation."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28369
- #, no-wrap
- msgid "{@code{openvpn-client-configuration} parameter} number verbosity"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28371 guix-git/doc/guix.texi:28526
- msgid "Verbosity level."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28373 guix-git/doc/guix.texi:28528
- #: guix-git/doc/guix.texi:30264 guix-git/doc/guix.texi:30488
- msgid "Defaults to @samp{3}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28376
- #, no-wrap
- msgid "{@code{openvpn-client-configuration} parameter} tls-auth-client tls-auth"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28379 guix-git/doc/guix.texi:28534
- msgid "Add an additional layer of HMAC authentication on top of the TLS control channel to protect against DoS attacks."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28384
- #, no-wrap
- msgid "{@code{openvpn-client-configuration} parameter} maybe-string auth-user-pass"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28388
- msgid "Authenticate with server using username/password. The option is a file containing username/password on 2 lines. Do not use a file-like object as it would be added to the store and readable by any user."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28390
- msgid "Defaults to @samp{'disabled}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28392
- #, no-wrap
- msgid "{@code{openvpn-client-configuration} parameter} key-usage verify-key-usage?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28394
- msgid "Whether to check the server certificate has server usage extension."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28399
- #, no-wrap
- msgid "{@code{openvpn-client-configuration} parameter} bind bind?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28401
- msgid "Bind to a specific local port number."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28406
- #, no-wrap
- msgid "{@code{openvpn-client-configuration} parameter} resolv-retry resolv-retry?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28408
- msgid "Retry resolving server address."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28413
- #, no-wrap
- msgid "{@code{openvpn-client-configuration} parameter} openvpn-remote-list remote"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28415
- msgid "A list of remote servers to connect to."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28419
- msgid "Available @code{openvpn-remote-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28420
- #, no-wrap
- msgid "{@code{openvpn-remote-configuration} parameter} string name"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28422
- msgid "Server name."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28424
- msgid "Defaults to @samp{\"my-server\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28427
- #, no-wrap
- msgid "{@code{openvpn-remote-configuration} parameter} number port"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28429
- msgid "Port number the server listens to."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28431 guix-git/doc/guix.texi:28543
- msgid "Defaults to @samp{1194}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:28440
- msgid "Available @code{openvpn-server-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28441
- #, no-wrap
- msgid "{@code{openvpn-server-configuration} parameter} package openvpn"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28446
- #, no-wrap
- msgid "{@code{openvpn-server-configuration} parameter} string pid-file"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28453
- #, no-wrap
- msgid "{@code{openvpn-server-configuration} parameter} proto proto"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28461
- #, no-wrap
- msgid "{@code{openvpn-server-configuration} parameter} dev dev"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28472
- #, no-wrap
- msgid "{@code{openvpn-server-configuration} parameter} maybe-string ca"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28479
- #, no-wrap
- msgid "{@code{openvpn-server-configuration} parameter} maybe-string cert"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28487
- #, no-wrap
- msgid "{@code{openvpn-server-configuration} parameter} maybe-string key"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28495
- #, no-wrap
- msgid "{@code{openvpn-server-configuration} parameter} boolean comp-lzo?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28502
- #, no-wrap
- msgid "{@code{openvpn-server-configuration} parameter} boolean persist-key?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28509
- #, no-wrap
- msgid "{@code{openvpn-server-configuration} parameter} boolean persist-tun?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28517
- #, no-wrap
- msgid "{@code{openvpn-server-configuration} parameter} boolean fast-io?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28524
- #, no-wrap
- msgid "{@code{openvpn-server-configuration} parameter} number verbosity"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28531
- #, no-wrap
- msgid "{@code{openvpn-server-configuration} parameter} tls-auth-server tls-auth"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28539
- #, no-wrap
- msgid "{@code{openvpn-server-configuration} parameter} number port"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28541
- msgid "Specifies the port number on which the server listens."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28546
- #, no-wrap
- msgid "{@code{openvpn-server-configuration} parameter} ip-mask server"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28548
- msgid "An ip and mask specifying the subnet inside the virtual network."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28550
- msgid "Defaults to @samp{\"10.8.0.0 255.255.255.0\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28553
- #, no-wrap
- msgid "{@code{openvpn-server-configuration} parameter} cidr6 server-ipv6"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28555
- msgid "A CIDR notation specifying the IPv6 subnet inside the virtual network."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28560
- #, no-wrap
- msgid "{@code{openvpn-server-configuration} parameter} string dh"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28562
- msgid "The Diffie-Hellman parameters file."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28564
- msgid "Defaults to @samp{\"/etc/openvpn/dh2048.pem\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28567
- #, no-wrap
- msgid "{@code{openvpn-server-configuration} parameter} string ifconfig-pool-persist"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28569
- msgid "The file that records client IPs."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28571
- msgid "Defaults to @samp{\"/etc/openvpn/ipp.txt\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28574
- #, no-wrap
- msgid "{@code{openvpn-server-configuration} parameter} gateway redirect-gateway?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28576
- msgid "When true, the server will act as a gateway for its clients."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28581
- #, no-wrap
- msgid "{@code{openvpn-server-configuration} parameter} boolean client-to-client?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28583
- msgid "When true, clients are allowed to talk to each other inside the VPN."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28588
- #, no-wrap
- msgid "{@code{openvpn-server-configuration} parameter} keepalive keepalive"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28594
- msgid "Causes ping-like messages to be sent back and forth over the link so that each side knows when the other side has gone down. @code{keepalive} requires a pair. The first element is the period of the ping sending, and the second element is the timeout before considering the other side down."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28597
- #, no-wrap
- msgid "{@code{openvpn-server-configuration} parameter} number max-clients"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28599
- msgid "The maximum number of clients."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28604
- #, no-wrap
- msgid "{@code{openvpn-server-configuration} parameter} string status"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28607
- msgid "The status file. This file shows a small report on current connection. It is truncated and rewritten every minute."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28609
- msgid "Defaults to @samp{\"/var/run/openvpn/status\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28612
- #, no-wrap
- msgid "{@code{openvpn-server-configuration} parameter} openvpn-ccd-list client-config-dir"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28614
- msgid "The list of configuration for some clients."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28618
- msgid "Available @code{openvpn-ccd-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28619
- #, no-wrap
- msgid "{@code{openvpn-ccd-configuration} parameter} string name"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28621
- msgid "Client name."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28623
- msgid "Defaults to @samp{\"client\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28626
- #, no-wrap
- msgid "{@code{openvpn-ccd-configuration} parameter} ip-mask iroute"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28628
- msgid "Client own network"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28633
- #, no-wrap
- msgid "{@code{openvpn-ccd-configuration} parameter} ip-mask ifconfig-push"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:28635
- msgid "Client VPN IP."
- msgstr ""
- #. type: subheading
- #: guix-git/doc/guix.texi:28644
- #, no-wrap
- msgid "strongSwan"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:28648
- msgid "Currently, the strongSwan service only provides legacy-style configuration with @file{ipsec.conf} and @file{ipsec.secrets} files."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:28649
- #, no-wrap
- msgid "{Scheme Variable} strongswan-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:28653
- msgid "A service type for configuring strongSwan for IPsec @acronym{VPN, Virtual Private Networking}. Its value must be a @code{strongswan-configuration} record as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:28659
- #, no-wrap
- msgid ""
- "(service strongswan-service-type\n"
- " (strongswan-configuration\n"
- " (ipsec-conf \"/etc/ipsec.conf\")\n"
- " (ipsec-secrets \"/etc/ipsec.secrets\")))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:28663
- #, no-wrap
- msgid "{Data Type} strongswan-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:28665
- msgid "Data type representing the configuration of the StrongSwan service."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:28667
- #, no-wrap
- msgid "strongswan"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28669
- msgid "The strongSwan package to use for this service."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28670
- #, no-wrap
- msgid "@code{ipsec-conf} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28673
- msgid "The file name of your @file{ipsec.conf}. If not @code{#f}, then this and @code{ipsec-secrets} must both be strings."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28674
- #, no-wrap
- msgid "@code{ipsec-secrets} (default @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28677
- msgid "The file name of your @file{ipsec.secrets}. If not @code{#f}, then this and @code{ipsec-conf} must both be strings."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:28681
- #, no-wrap
- msgid "Wireguard"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:28683
- #, no-wrap
- msgid "{Scheme Variable} wireguard-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:28686
- msgid "A service type for a Wireguard tunnel interface. Its value must be a @code{wireguard-configuration} record as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:28697
- #, no-wrap
- msgid ""
- "(service wireguard-service-type\n"
- " (wireguard-configuration\n"
- " (peers\n"
- " (list\n"
- " (wireguard-peer\n"
- " (name \"my-peer\")\n"
- " (endpoint \"my.wireguard.com:51820\")\n"
- " (public-key \"hzpKg9X1yqu1axN6iJp0mWf6BZGo8m1wteKwtTmDGF4=\")\n"
- " (allowed-ips '(\"10.0.0.2/32\")))))))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:28701
- #, no-wrap
- msgid "{Data Type} wireguard-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:28703
- msgid "Data type representing the configuration of the Wireguard service."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:28705
- #, no-wrap
- msgid "wireguard"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28707
- msgid "The wireguard package to use for this service."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28708
- #, no-wrap
- msgid "@code{interface} (default: @code{\"wg0\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28710
- msgid "The interface name for the VPN."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28711
- #, no-wrap
- msgid "@code{addresses} (default: @code{'(\"10.0.0.1/32\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28713
- msgid "The IP addresses to be assigned to the above interface."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28714
- #, no-wrap
- msgid "@code{port} (default: @code{51820})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28716
- msgid "The port on which to listen for incoming connections."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28717
- #, no-wrap
- msgid "@code{dns} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28719
- msgid "The DNS server(s) to announce to VPN clients via DHCP."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28720
- #, no-wrap
- msgid "@code{private-key} (default: @code{\"/etc/wireguard/private.key\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28723
- msgid "The private key file for the interface. It is automatically generated if the file does not exist."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28724
- #, no-wrap
- msgid "@code{peers} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28727
- msgid "The authorized peers on this interface. This is a list of @var{wireguard-peer} records."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:28731
- #, no-wrap
- msgid "{Data Type} wireguard-peer"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:28733
- msgid "Data type representing a Wireguard peer attached to a given interface."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28737
- msgid "The peer name."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28738
- #, no-wrap
- msgid "@code{endpoint} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28741
- msgid "The optional endpoint for the peer, such as @code{\"demo.wireguard.com:51820\"}."
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:28742 guix-git/doc/guix.texi:29137
- #: guix-git/doc/guix.texi:29174 guix-git/doc/guix.texi:34305
- #, no-wrap
- msgid "public-key"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28744
- msgid "The peer public-key represented as a base64 string."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:28745
- #, no-wrap
- msgid "allowed-ips"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28748
- msgid "A list of IP addresses from which incoming traffic for this peer is allowed and to which incoming traffic for this peer is directed."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28749
- #, no-wrap
- msgid "@code{keep-alive} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28754
- msgid "An optional time interval in seconds. A packet will be sent to the server endpoint once per time interval. This helps receiving incoming connections from this peer when you are behind a NAT or a firewall."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:28760
- #, no-wrap
- msgid "NFS"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:28765
- msgid "The @code{(gnu services nfs)} module provides the following services, which are most commonly used in relation to mounting or exporting directory trees as @dfn{network file systems} (NFS)."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:28769
- msgid "While it is possible to use the individual components that together make up a Network File System service, we recommended to configure an NFS server with the @code{nfs-service-type}."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:28770
- #, no-wrap
- msgid "NFS Service"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:28771
- #, no-wrap
- msgid "NFS, server"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:28776
- msgid "The NFS service takes care of setting up all NFS component services, kernel configuration file systems, and installs configuration files in the locations that NFS expects."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:28777
- #, no-wrap
- msgid "{Scheme Variable} nfs-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:28779
- msgid "A service type for a complete NFS server."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:28781
- #, no-wrap
- msgid "{Data Type} nfs-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:28784
- msgid "This data type represents the configuration of the NFS service and all of its subsystems."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:28786
- msgid "It has the following parameters:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28787 guix-git/doc/guix.texi:28912
- #: guix-git/doc/guix.texi:28937
- #, no-wrap
- msgid "@code{nfs-utils} (default: @code{nfs-utils})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28789
- msgid "The nfs-utils package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28790
- #, no-wrap
- msgid "@code{nfs-versions} (default: @code{'(\"4.2\" \"4.1\" \"4.0\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28793
- msgid "If a list of string values is provided, the @command{rpc.nfsd} daemon will be limited to supporting the given versions of the NFS protocol."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28794
- #, no-wrap
- msgid "@code{exports} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28799
- msgid "This is a list of directories the NFS server should export. Each entry is a list consisting of two elements: a directory name and a string containing all options. This is an example in which the directory @file{/export} is served to all NFS clients as a read-only share:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:28805
- #, no-wrap
- msgid ""
- "(nfs-configuration\n"
- " (exports\n"
- " '((\"/export\"\n"
- " \"*(ro,insecure,no_subtree_check,crossmnt,fsid=0)\"))))\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28807
- #, no-wrap
- msgid "@code{rpcmountd-port} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28809
- msgid "The network port that the @command{rpc.mountd} daemon should use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28810
- #, no-wrap
- msgid "@code{rpcstatd-port} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28812
- msgid "The network port that the @command{rpc.statd} daemon should use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28813 guix-git/doc/guix.texi:28861
- #, no-wrap
- msgid "@code{rpcbind} (default: @code{rpcbind})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28815 guix-git/doc/guix.texi:28863
- msgid "The rpcbind package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28816
- #, no-wrap
- msgid "@code{idmap-domain} (default: @code{\"localdomain\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28818
- msgid "The local NFSv4 domain name."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28819
- #, no-wrap
- msgid "@code{nfsd-port} (default: @code{2049})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28821
- msgid "The network port that the @command{nfsd} daemon should use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28822
- #, no-wrap
- msgid "@code{nfsd-threads} (default: @code{8})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28824
- msgid "The number of threads used by the @command{nfsd} daemon."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28825
- #, no-wrap
- msgid "@code{nfsd-tcp?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28827
- msgid "Whether the @command{nfsd} daemon should listen on a TCP socket."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28828
- #, no-wrap
- msgid "@code{nfsd-udp?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28830
- msgid "Whether the @command{nfsd} daemon should listen on a UDP socket."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28831 guix-git/doc/guix.texi:28915
- #: guix-git/doc/guix.texi:28940
- #, no-wrap
- msgid "@code{pipefs-directory} (default: @code{\"/var/lib/nfs/rpc_pipefs\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28833 guix-git/doc/guix.texi:28917
- #: guix-git/doc/guix.texi:28942
- msgid "The directory where the pipefs file system is mounted."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28834
- #, no-wrap
- msgid "@code{debug} (default: @code{'()\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28838
- msgid "A list of subsystems for which debugging output should be enabled. This is a list of symbols. Any of these symbols are valid: @code{nfsd}, @code{nfs}, @code{rpc}, @code{idmap}, @code{statd}, or @code{mountd}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:28843
- msgid "If you don't need a complete NFS service or prefer to build it yourself you can use the individual component services that are documented below."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:28844
- #, no-wrap
- msgid "RPC Bind Service"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:28845
- #, no-wrap
- msgid "rpcbind"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:28851
- msgid "The RPC Bind service provides a facility to map program numbers into universal addresses. Many NFS related services use this facility. Hence it is automatically started when a dependent service starts."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:28852
- #, no-wrap
- msgid "{Scheme Variable} rpcbind-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:28854
- msgid "A service type for the RPC portmapper daemon."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:28857
- #, no-wrap
- msgid "{Data Type} rpcbind-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:28860
- msgid "Data type representing the configuration of the RPC Bind Service. This type has the following parameters:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28864
- #, no-wrap
- msgid "@code{warm-start?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28868
- msgid "If this parameter is @code{#t}, then the daemon will read a state file on startup thus reloading state information saved by a previous instance."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:28872
- #, no-wrap
- msgid "Pipefs Pseudo File System"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:28873
- #, no-wrap
- msgid "pipefs"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:28874
- #, no-wrap
- msgid "rpc_pipefs"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:28878
- msgid "The pipefs file system is used to transfer NFS related data between the kernel and user space programs."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:28879
- #, no-wrap
- msgid "{Scheme Variable} pipefs-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:28881
- msgid "A service type for the pipefs pseudo file system."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:28883
- #, no-wrap
- msgid "{Data Type} pipefs-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:28886
- msgid "Data type representing the configuration of the pipefs pseudo file system service. This type has the following parameters:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28887
- #, no-wrap
- msgid "@code{mount-point} (default: @code{\"/var/lib/nfs/rpc_pipefs\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28889
- msgid "The directory to which the file system is to be attached."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:28893
- #, no-wrap
- msgid "GSS Daemon Service"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:28894
- #, no-wrap
- msgid "GSSD"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:28895
- #, no-wrap
- msgid "GSS"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:28896
- #, no-wrap
- msgid "global security system"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:28903
- msgid "The @dfn{global security system} (GSS) daemon provides strong security for RPC based protocols. Before exchanging RPC requests an RPC client must establish a security context. Typically this is done using the Kerberos command @command{kinit} or automatically at login time using PAM services (@pxref{Kerberos Services})."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:28904
- #, no-wrap
- msgid "{Scheme Variable} gss-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:28906
- msgid "A service type for the Global Security System (GSS) daemon."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:28908
- #, no-wrap
- msgid "{Data Type} gss-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:28911
- msgid "Data type representing the configuration of the GSS daemon service. This type has the following parameters:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28914
- msgid "The package in which the @command{rpc.gssd} command is to be found."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:28922
- #, no-wrap
- msgid "IDMAP Daemon Service"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:28923
- #, no-wrap
- msgid "idmapd"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:28924
- #, no-wrap
- msgid "name mapper"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:28928
- msgid "The idmap daemon service provides mapping between user IDs and user names. Typically it is required in order to access file systems mounted via NFSv4."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:28929
- #, no-wrap
- msgid "{Scheme Variable} idmap-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:28931
- msgid "A service type for the Identity Mapper (IDMAP) daemon."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:28933
- #, no-wrap
- msgid "{Data Type} idmap-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:28936
- msgid "Data type representing the configuration of the IDMAP daemon service. This type has the following parameters:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28939
- msgid "The package in which the @command{rpc.idmapd} command is to be found."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28943
- #, no-wrap
- msgid "@code{domain} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28947
- msgid "The local NFSv4 domain name. This must be a string or @code{#f}. If it is @code{#f} then the daemon will use the host's fully qualified domain name."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:28948
- #, no-wrap
- msgid "@code{verbosity} (default: @code{0})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:28950
- msgid "The verbosity level of the daemon."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:28961
- msgid "@uref{https://guix.gnu.org/cuirass/, Cuirass} is a continuous integration tool for Guix. It can be used both for development and for providing substitutes to others (@pxref{Substitutes})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:28963
- msgid "The @code{(gnu services cuirass)} module provides the following service."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:28964
- #, no-wrap
- msgid "{Scheme Procedure} cuirass-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:28967
- msgid "The type of the Cuirass service. Its value must be a @code{cuirass-configuration} object, as described below."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:28972
- msgid "To add build jobs, you have to set the @code{specifications} field of the configuration. For instance, the following example will build all the packages provided by the @code{my-channel} channel."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:28983
- #, no-wrap
- msgid ""
- "(define %cuirass-specs\n"
- " #~(list (specification\n"
- " (name \"my-channel\")\n"
- " (build '(channels my-channel))\n"
- " (channels\n"
- " (cons (channel\n"
- " (name 'my-channel)\n"
- " (url \"https://my-channel.git\"))\n"
- " %default-channels)))))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:28987 guix-git/doc/guix.texi:29001
- #, no-wrap
- msgid ""
- "(service cuirass-service-type\n"
- " (cuirass-configuration\n"
- " (specifications %cuirass-specs)))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:28991
- msgid "To build the @code{linux-libre} package defined by the default Guix channel, one can use the following configuration."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:28997
- #, no-wrap
- msgid ""
- "(define %cuirass-specs\n"
- " #~(list (specification\n"
- " (name \"my-linux\")\n"
- " (build '(packages \"linux-libre\")))))\n"
- "\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:29006
- msgid "The other configuration possibilities, as well as the specification record itself are described in the Cuirass manual (@pxref{Specifications,,, cuirass, Cuirass})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:29010
- msgid "While information related to build jobs is located directly in the specifications, global settings for the @command{cuirass} process are accessible in other @code{cuirass-configuration} fields."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:29011
- #, no-wrap
- msgid "{Data Type} cuirass-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:29013
- msgid "Data type representing the configuration of Cuirass."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29015 guix-git/doc/guix.texi:29152
- #, no-wrap
- msgid "@code{cuirass} (default: @code{cuirass})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29017 guix-git/doc/guix.texi:29154
- msgid "The Cuirass package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29018
- #, no-wrap
- msgid "@code{log-file} (default: @code{\"/var/log/cuirass.log\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29020 guix-git/doc/guix.texi:29124
- #: guix-git/doc/guix.texi:29167
- msgid "Location of the log file."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29021
- #, no-wrap
- msgid "@code{web-log-file} (default: @code{\"/var/log/cuirass-web.log\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29023
- msgid "Location of the log file used by the web interface."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29024
- #, no-wrap
- msgid "@code{cache-directory} (default: @code{\"/var/cache/cuirass\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29026
- msgid "Location of the repository cache."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29027
- #, no-wrap
- msgid "@code{user} (default: @code{\"cuirass\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29029
- msgid "Owner of the @code{cuirass} process."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29030
- #, no-wrap
- msgid "@code{group} (default: @code{\"cuirass\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29032
- msgid "Owner's group of the @code{cuirass} process."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29033
- #, no-wrap
- msgid "@code{interval} (default: @code{60})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29036
- msgid "Number of seconds between the poll of the repositories followed by the Cuirass jobs."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29037
- #, no-wrap
- msgid "@code{parameters} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29040
- msgid "Read parameters from the given @var{parameters} file. The supported parameters are described here (@pxref{Parameters,,, cuirass, Cuirass})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29041
- #, no-wrap
- msgid "@code{remote-server} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29044
- msgid "A @code{cuirass-remote-server-configuration} record to use the build remote mechanism or @code{#f} to use the default build mechanism."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29045
- #, no-wrap
- msgid "@code{database} (default: @code{\"dbname=cuirass host=/var/run/postgresql\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29050
- msgid "Use @var{database} as the database containing the jobs and the past build results. Since Cuirass uses PostgreSQL as a database engine, @var{database} must be a string such as @code{\"dbname=cuirass host=localhost\"}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29051
- #, no-wrap
- msgid "@code{port} (default: @code{8081})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29053
- msgid "Port number used by the HTTP server."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29057
- msgid "Listen on the network interface for @var{host}. The default is to accept connections from localhost."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29058
- #, no-wrap
- msgid "@code{specifications} (default: @code{#~'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29062
- msgid "A gexp (@pxref{G-Expressions}) that evaluates to a list of specifications records. The specification record is described in the Cuirass manual (@pxref{Specifications,,, cuirass, Cuirass})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29063
- #, no-wrap
- msgid "@code{use-substitutes?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29066
- msgid "This allows using substitutes to avoid building every dependencies of a job from source."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29067 guix-git/doc/guix.texi:36336
- #, no-wrap
- msgid "@code{one-shot?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29069
- msgid "Only evaluate specifications and build derivations once."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29070
- #, no-wrap
- msgid "@code{fallback?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29073
- msgid "When substituting a pre-built binary fails, fall back to building packages locally."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29076
- msgid "Extra options to pass when running the Cuirass processes."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:29080
- #, no-wrap
- msgid "remote build"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:29081
- #, no-wrap
- msgid "Cuirass remote building"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:29084
- msgid "Cuirass supports two mechanisms to build derivations."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29086
- #, no-wrap
- msgid "Using the local Guix daemon."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:29090
- msgid "This is the default build mechanism. Once the build jobs are evaluated, they are sent to the local Guix daemon. Cuirass then listens to the Guix daemon output to detect the various build events."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29091
- #, no-wrap
- msgid "Using the remote build mechanism."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:29095
- msgid "The build jobs are not submitted to the local Guix daemon. Instead, a remote server dispatches build requests to the connect remote workers, according to the build priorities."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:29102
- msgid "To enable this build mode a @code{cuirass-remote-server-configuration} record must be passed as @code{remote-server} argument of the @code{cuirass-configuration} record. The @code{cuirass-remote-server-configuration} record is described below."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:29107
- msgid "This build mode scales way better than the default build mode. This is the build mode that is used on the GNU Guix build farm at @url{https://ci.guix.gnu.org}. It should be preferred when using Cuirass to build large amount of packages."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:29108
- #, no-wrap
- msgid "{Data Type} cuirass-remote-server-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:29110
- msgid "Data type representing the configuration of the Cuirass remote-server."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29112
- #, no-wrap
- msgid "@code{backend-port} (default: @code{5555})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29115
- msgid "The TCP port for communicating with @code{remote-worker} processes using ZMQ. It defaults to @code{5555}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29116
- #, no-wrap
- msgid "@code{log-port} (default: @code{5556})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29118
- msgid "The TCP port of the log server. It defaults to @code{5556}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29119
- #, no-wrap
- msgid "@code{publish-port} (default: @code{5557})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29121
- msgid "The TCP port of the publish server. It defaults to @code{5557}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29122
- #, no-wrap
- msgid "@code{log-file} (default: @code{\"/var/log/cuirass-remote-server.log\"})"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29125
- #, no-wrap
- msgid "@code{cache} (default: @code{\"/var/cache/cuirass/remote\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29127
- msgid "Use @var{cache} directory to cache build log files."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29128
- #, no-wrap
- msgid "@code{trigger-url} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29131
- msgid "Once a substitute is successfully fetched, trigger substitute baking at @var{trigger-url}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29136
- msgid "If set to false, do not start a publish server and ignore the @code{publish-port} argument. This can be useful if there is already a standalone publish server standing next to the remote server."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:29138 guix-git/doc/guix.texi:29175
- #, no-wrap
- msgid "private-key"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:29147
- msgid "At least one remote worker must also be started on any machine of the local network to actually perform the builds and report their status."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:29148
- #, no-wrap
- msgid "{Data Type} cuirass-remote-worker-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:29150
- msgid "Data type representing the configuration of the Cuirass remote-worker."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29155
- #, no-wrap
- msgid "@code{workers} (default: @code{1})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29157
- msgid "Start @var{workers} parallel workers."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29161
- msgid "Do not use Avahi discovery and connect to the given @code{server} IP address instead."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29162
- #, no-wrap
- msgid "@code{systems} (default: @code{(list (%current-system))})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29164
- msgid "Only request builds for the given @var{systems}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29165
- #, no-wrap
- msgid "@code{log-file} (default: @code{\"/var/log/cuirass-remote-worker.log\"})"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29168
- #, no-wrap
- msgid "@code{publish-port} (default: @code{5558})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29170
- msgid "The TCP port of the publish server. It defaults to @code{5558}."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:29182
- #, no-wrap
- msgid "Laminar"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:29187
- msgid "@uref{https://laminar.ohwg.net/, Laminar} is a lightweight and modular Continuous Integration service. It doesn't have a configuration web UI instead uses version-controllable configuration files and scripts."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:29190
- msgid "Laminar encourages the use of existing tools such as bash and cron instead of reinventing them."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:29191
- #, no-wrap
- msgid "{Scheme Procedure} laminar-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:29194
- msgid "The type of the Laminar service. Its value must be a @code{laminar-configuration} object, as described below."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:29198
- msgid "All configuration values have defaults, a minimal configuration to get Laminar running is shown below. By default, the web interface is available on port 8080."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:29201
- #, no-wrap
- msgid "(service laminar-service-type)\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:29204
- #, no-wrap
- msgid "{Data Type} laminar-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:29206
- msgid "Data type representing the configuration of Laminar."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29208
- #, no-wrap
- msgid "@code{laminar} (default: @code{laminar})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29210
- msgid "The Laminar package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29211
- #, no-wrap
- msgid "@code{home-directory} (default: @code{\"/var/lib/laminar\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29213
- msgid "The directory for job configurations and run directories."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29214
- #, no-wrap
- msgid "@code{bind-http} (default: @code{\"*:8080\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29217
- msgid "The interface/port or unix socket on which laminard should listen for incoming connections to the web frontend."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29218
- #, no-wrap
- msgid "@code{bind-rpc} (default: @code{\"unix-abstract:laminar\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29221
- msgid "The interface/port or unix socket on which laminard should listen for incoming commands such as build triggers."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29222
- #, no-wrap
- msgid "@code{title} (default: @code{\"Laminar\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29224
- msgid "The page title to show in the web frontend."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29225
- #, no-wrap
- msgid "@code{keep-rundirs} (default: @code{0})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29229
- msgid "Set to an integer defining how many rundirs to keep per job. The lowest-numbered ones will be deleted. The default is 0, meaning all run dirs will be immediately deleted."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29230
- #, no-wrap
- msgid "@code{archive-url} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29233
- msgid "The web frontend served by laminard will use this URL to form links to artefacts archived jobs."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29234
- #, no-wrap
- msgid "@code{base-url} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29236
- msgid "Base URL to use for links to laminar itself."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:29243
- #, no-wrap
- msgid "tlp"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:29244
- #, no-wrap
- msgid "power management with TLP"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:29245
- #, no-wrap
- msgid "TLP daemon"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:29249
- msgid "The @code{(gnu services pm)} module provides a Guix service definition for the Linux power management tool TLP."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:29255
- msgid "TLP enables various powersaving modes in userspace and kernel. Contrary to @code{upower-service}, it is not a passive, monitoring tool, as it will apply custom settings each time a new power source is detected. More information can be found at @uref{https://linrunner.de/en/tlp/tlp.html, TLP home page}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:29256
- #, no-wrap
- msgid "{Scheme Variable} tlp-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:29260
- msgid "The service type for the TLP tool. The default settings are optimised for battery life on most systems, but you can tweak them to your heart's content by adding a valid @code{tlp-configuration}:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:29265
- #, no-wrap
- msgid ""
- "(service tlp-service-type\n"
- " (tlp-configuration\n"
- " (cpu-scaling-governor-on-ac (list \"performance\"))\n"
- " (sched-powersave-on-bat? #t)))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:29273
- msgid "Each parameter definition is preceded by its type; for example, @samp{boolean foo} indicates that the @code{foo} parameter should be specified as a boolean. Types starting with @code{maybe-} denote parameters that won't show up in TLP config file when their value is @code{'disabled}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:29283
- msgid "Available @code{tlp-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29284
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} package tlp"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29286
- msgid "The TLP package."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29289
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} boolean tlp-enable?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29291
- msgid "Set to true if you wish to enable TLP."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29296
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} string tlp-default-mode"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29299
- msgid "Default mode when no power supply can be detected. Alternatives are AC and BAT."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29301
- msgid "Defaults to @samp{\"AC\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29304
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} non-negative-integer disk-idle-secs-on-ac"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29307
- msgid "Number of seconds Linux kernel has to wait after the disk goes idle, before syncing on AC."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29312
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} non-negative-integer disk-idle-secs-on-bat"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29314
- msgid "Same as @code{disk-idle-ac} but on BAT mode."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29316
- msgid "Defaults to @samp{2}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29319
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} non-negative-integer max-lost-work-secs-on-ac"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29321
- msgid "Dirty pages flushing periodicity, expressed in seconds."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29323 guix-git/doc/guix.texi:29546
- #: guix-git/doc/guix.texi:31814 guix-git/doc/guix.texi:31822
- msgid "Defaults to @samp{15}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29326
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} non-negative-integer max-lost-work-secs-on-bat"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29328
- msgid "Same as @code{max-lost-work-secs-on-ac} but on BAT mode."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29330
- msgid "Defaults to @samp{60}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29333
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list cpu-scaling-governor-on-ac"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29337
- msgid "CPU frequency scaling governor on AC mode. With intel_pstate driver, alternatives are powersave and performance. With acpi-cpufreq driver, alternatives are ondemand, powersave, performance and conservative."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29342
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list cpu-scaling-governor-on-bat"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29344
- msgid "Same as @code{cpu-scaling-governor-on-ac} but on BAT mode."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29349
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-min-freq-on-ac"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29351
- msgid "Set the min available frequency for the scaling governor on AC."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29356
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-max-freq-on-ac"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29358
- msgid "Set the max available frequency for the scaling governor on AC."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29363
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-min-freq-on-bat"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29365
- msgid "Set the min available frequency for the scaling governor on BAT."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29370
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-max-freq-on-bat"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29372
- msgid "Set the max available frequency for the scaling governor on BAT."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29377
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-min-perf-on-ac"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29380
- msgid "Limit the min P-state to control the power dissipation of the CPU, in AC mode. Values are stated as a percentage of the available performance."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29385
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-max-perf-on-ac"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29388
- msgid "Limit the max P-state to control the power dissipation of the CPU, in AC mode. Values are stated as a percentage of the available performance."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29393
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-min-perf-on-bat"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29395
- msgid "Same as @code{cpu-min-perf-on-ac} on BAT mode."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29400
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-max-perf-on-bat"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29402
- msgid "Same as @code{cpu-max-perf-on-ac} on BAT mode."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29407
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} maybe-boolean cpu-boost-on-ac?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29409
- msgid "Enable CPU turbo boost feature on AC mode."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29414
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} maybe-boolean cpu-boost-on-bat?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29416
- msgid "Same as @code{cpu-boost-on-ac?} on BAT mode."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29421
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} boolean sched-powersave-on-ac?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29424
- msgid "Allow Linux kernel to minimize the number of CPU cores/hyper-threads used under light load conditions."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29429
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} boolean sched-powersave-on-bat?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29431
- msgid "Same as @code{sched-powersave-on-ac?} but on BAT mode."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29436
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} boolean nmi-watchdog?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29438
- msgid "Enable Linux kernel NMI watchdog."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29443
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} maybe-string phc-controls"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29446
- msgid "For Linux kernels with PHC patch applied, change CPU voltages. An example value would be @samp{\"F:V F:V F:V F:V\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29451
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} string energy-perf-policy-on-ac"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29454
- msgid "Set CPU performance versus energy saving policy on AC@. Alternatives are performance, normal, powersave."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29456 guix-git/doc/guix.texi:29554
- #: guix-git/doc/guix.texi:29584
- msgid "Defaults to @samp{\"performance\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29459
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} string energy-perf-policy-on-bat"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29461
- msgid "Same as @code{energy-perf-policy-ac} but on BAT mode."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29463 guix-git/doc/guix.texi:29561
- msgid "Defaults to @samp{\"powersave\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29466
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} space-separated-string-list disks-devices"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29468
- msgid "Hard disk devices."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29471
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} space-separated-string-list disk-apm-level-on-ac"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29473
- msgid "Hard disk advanced power management level."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29476
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} space-separated-string-list disk-apm-level-on-bat"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29478
- msgid "Same as @code{disk-apm-bat} but on BAT mode."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29481
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-spindown-timeout-on-ac"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29484
- msgid "Hard disk spin down timeout. One value has to be specified for each declared hard disk."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29489
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-spindown-timeout-on-bat"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29491
- msgid "Same as @code{disk-spindown-timeout-on-ac} but on BAT mode."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29496
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-iosched"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29500
- msgid "Select IO scheduler for disk devices. One value has to be specified for each declared hard disk. Example alternatives are cfq, deadline and noop."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29505
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} string sata-linkpwr-on-ac"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29508
- msgid "SATA aggressive link power management (ALPM) level. Alternatives are min_power, medium_power, max_performance."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29510
- msgid "Defaults to @samp{\"max_performance\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29513
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} string sata-linkpwr-on-bat"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29515
- msgid "Same as @code{sata-linkpwr-ac} but on BAT mode."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29517
- msgid "Defaults to @samp{\"min_power\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29520
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} maybe-string sata-linkpwr-blacklist"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29522
- msgid "Exclude specified SATA host devices for link power management."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29527
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} maybe-on-off-boolean ahci-runtime-pm-on-ac?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29530
- msgid "Enable Runtime Power Management for AHCI controller and disks on AC mode."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29535
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} maybe-on-off-boolean ahci-runtime-pm-on-bat?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29537
- msgid "Same as @code{ahci-runtime-pm-on-ac} on BAT mode."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29542
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} non-negative-integer ahci-runtime-pm-timeout"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29544
- msgid "Seconds of inactivity before disk is suspended."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29549
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} string pcie-aspm-on-ac"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29552
- msgid "PCI Express Active State Power Management level. Alternatives are default, performance, powersave."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29557
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} string pcie-aspm-on-bat"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29559
- msgid "Same as @code{pcie-aspm-ac} but on BAT mode."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29564
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} string radeon-power-profile-on-ac"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29567
- msgid "Radeon graphics clock speed level. Alternatives are low, mid, high, auto, default."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29569
- msgid "Defaults to @samp{\"high\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29572
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} string radeon-power-profile-on-bat"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29574
- msgid "Same as @code{radeon-power-ac} but on BAT mode."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29576
- msgid "Defaults to @samp{\"low\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29579
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} string radeon-dpm-state-on-ac"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29582
- msgid "Radeon dynamic power management method (DPM). Alternatives are battery, performance."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29587
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} string radeon-dpm-state-on-bat"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29589
- msgid "Same as @code{radeon-dpm-state-ac} but on BAT mode."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29591
- msgid "Defaults to @samp{\"battery\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29594
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} string radeon-dpm-perf-level-on-ac"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29596
- msgid "Radeon DPM performance level. Alternatives are auto, low, high."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29598 guix-git/doc/guix.texi:29605
- #: guix-git/doc/guix.texi:29679
- msgid "Defaults to @samp{\"auto\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29601
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} string radeon-dpm-perf-level-on-bat"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29603
- msgid "Same as @code{radeon-dpm-perf-ac} but on BAT mode."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29608
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} on-off-boolean wifi-pwr-on-ac?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29610
- msgid "Wifi power saving mode."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29615
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} on-off-boolean wifi-pwr-on-bat?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29617
- msgid "Same as @code{wifi-power-ac?} but on BAT mode."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29622
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} y-n-boolean wol-disable?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29624
- msgid "Disable wake on LAN."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29629
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} non-negative-integer sound-power-save-on-ac"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29632
- msgid "Timeout duration in seconds before activating audio power saving on Intel HDA and AC97 devices. A value of 0 disables power saving."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29637
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} non-negative-integer sound-power-save-on-bat"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29639
- msgid "Same as @code{sound-powersave-ac} but on BAT mode."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29644
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} y-n-boolean sound-power-save-controller?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29646
- msgid "Disable controller in powersaving mode on Intel HDA devices."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29651
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} boolean bay-poweroff-on-bat?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29655
- msgid "Enable optical drive in UltraBay/MediaBay on BAT mode. Drive can be powered on again by releasing (and reinserting) the eject lever or by pressing the disc eject button on newer models."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29660
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} string bay-device"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29662
- msgid "Name of the optical drive device to power off."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29664
- msgid "Defaults to @samp{\"sr0\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29667
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} string runtime-pm-on-ac"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29670
- msgid "Runtime Power Management for PCI(e) bus devices. Alternatives are on and auto."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29672
- msgid "Defaults to @samp{\"on\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29675
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} string runtime-pm-on-bat"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29677
- msgid "Same as @code{runtime-pm-ac} but on BAT mode."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29682
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} boolean runtime-pm-all?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29685
- msgid "Runtime Power Management for all PCI(e) bus devices, except blacklisted ones."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29690
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list runtime-pm-blacklist"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29692
- msgid "Exclude specified PCI(e) device addresses from Runtime Power Management."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29697
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} space-separated-string-list runtime-pm-driver-blacklist"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29700
- msgid "Exclude PCI(e) devices assigned to the specified drivers from Runtime Power Management."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29703
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} boolean usb-autosuspend?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29705
- msgid "Enable USB autosuspend feature."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29710
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} maybe-string usb-blacklist"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29712
- msgid "Exclude specified devices from USB autosuspend."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29717
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} boolean usb-blacklist-wwan?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29719
- msgid "Exclude WWAN devices from USB autosuspend."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29724
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} maybe-string usb-whitelist"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29727
- msgid "Include specified devices into USB autosuspend, even if they are already excluded by the driver or via @code{usb-blacklist-wwan?}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29732
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} maybe-boolean usb-autosuspend-disable-on-shutdown?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29734
- msgid "Enable USB autosuspend before shutdown."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29739
- #, no-wrap
- msgid "{@code{tlp-configuration} parameter} boolean restore-device-state-on-startup?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29742
- msgid "Restore radio device state (bluetooth, wifi, wwan) from previous shutdown on system startup."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:29747
- #, no-wrap
- msgid "thermald"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:29748
- #, no-wrap
- msgid "CPU frequency scaling with thermald"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:29749
- #, no-wrap
- msgid "Thermald daemon"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:29753
- msgid "The @code{(gnu services pm)} module provides an interface to thermald, a CPU frequency scaling service which helps prevent overheating."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:29754
- #, no-wrap
- msgid "{Scheme Variable} thermald-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:29759
- msgid "This is the service type for @uref{https://01.org/linux-thermal-daemon/, thermald}, the Linux Thermal Daemon, which is responsible for controlling the thermal state of processors and preventing overheating."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:29761
- #, no-wrap
- msgid "{Data Type} thermald-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:29763
- msgid "Data type representing the configuration of @code{thermald-service-type}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29765
- #, no-wrap
- msgid "@code{ignore-cpuid-check?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29767
- msgid "Ignore cpuid check for supported CPU models."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29768
- #, no-wrap
- msgid "@code{thermald} (default: @var{thermald})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29770
- msgid "Package object of thermald."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:29779
- msgid "The @code{(gnu services audio)} module provides a service to start MPD (the Music Player Daemon)."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:29780
- #, no-wrap
- msgid "mpd"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:29781
- #, no-wrap
- msgid "Music Player Daemon"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:29786
- msgid "The Music Player Daemon (MPD) is a service that can play music while being controlled from the local machine or over the network by a variety of clients."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:29789
- msgid "The following example shows how one might run @code{mpd} as user @code{\"bob\"} on port @code{6666}. It uses pulseaudio for output."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:29795
- #, no-wrap
- msgid ""
- "(service mpd-service-type\n"
- " (mpd-configuration\n"
- " (user \"bob\")\n"
- " (port \"6666\")))\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:29797
- #, no-wrap
- msgid "{Scheme Variable} mpd-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:29799
- msgid "The service type for @command{mpd}"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:29801
- #, no-wrap
- msgid "{Data Type} mpd-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:29803
- msgid "Data type representing the configuration of @command{mpd}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29805
- #, no-wrap
- msgid "@code{user} (default: @code{\"mpd\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29807
- msgid "The user to run mpd as."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29808
- #, no-wrap
- msgid "@code{music-dir} (default: @code{\"~/Music\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29810
- msgid "The directory to scan for music files."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29811
- #, no-wrap
- msgid "@code{playlist-dir} (default: @code{\"~/.mpd/playlists\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29813
- msgid "The directory to store playlists."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29814
- #, no-wrap
- msgid "@code{db-file} (default: @code{\"~/.mpd/tag_cache\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29816
- msgid "The location of the music database."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29817
- #, no-wrap
- msgid "@code{state-file} (default: @code{\"~/.mpd/state\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29819
- msgid "The location of the file that stores current MPD's state."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29820
- #, no-wrap
- msgid "@code{sticker-file} (default: @code{\"~/.mpd/sticker.sql\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29822
- msgid "The location of the sticker database."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29823
- #, no-wrap
- msgid "@code{port} (default: @code{\"6600\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29825
- msgid "The port to run mpd on."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29826
- #, no-wrap
- msgid "@code{address} (default: @code{\"any\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29829
- msgid "The address that mpd will bind to. To use a Unix domain socket, an absolute path can be specified here."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29830
- #, no-wrap
- msgid "@code{outputs} (default: @code{\"(list (mpd-output))\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29832
- msgid "The audio outputs that MPD can use. By default this is a single output using pulseaudio."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:29836
- #, no-wrap
- msgid "{Data Type} mpd-output"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:29838
- msgid "Data type representing an @command{mpd} audio output."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29840
- #, no-wrap
- msgid "@code{name} (default: @code{\"MPD\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29842
- msgid "The name of the audio output."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29843
- #, no-wrap
- msgid "@code{type} (default: @code{\"pulse\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29845
- msgid "The type of audio output."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29846
- #, no-wrap
- msgid "@code{enabled?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29851
- msgid "Specifies whether this audio output is enabled when MPD is started. By default, all audio outputs are enabled. This is just the default setting when there is no state file; with a state file, the previous state is restored."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29852
- #, no-wrap
- msgid "@code{tags?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29856
- msgid "If set to @code{#f}, then MPD will not send tags to this output. This is only useful for output plugins that can receive tags, for example the @code{httpd} output plugin."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:29857
- #, no-wrap
- msgid "@code{always-on?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29861
- msgid "If set to @code{#t}, then MPD attempts to keep this audio output always open. This may be useful for streaming servers, when you don’t want to disconnect all listeners even when playback is accidentally stopped."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:29862
- #, no-wrap
- msgid "mixer-type"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29868
- msgid "This field accepts a symbol that specifies which mixer should be used for this audio output: the @code{hardware} mixer, the @code{software} mixer, the @code{null} mixer (allows setting the volume, but with no effect; this can be used as a trick to implement an external mixer External Mixer) or no mixer (@code{none})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:29872
- msgid "An association list of option symbols to string values to be appended to the audio output configuration."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:29878
- msgid "The following example shows a configuration of @code{mpd} that provides an HTTP audio streaming output."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:29890
- #, no-wrap
- msgid ""
- "(service mpd-service-type\n"
- " (mpd-configuration\n"
- " (outputs\n"
- " (list (mpd-output\n"
- " (name \"streaming\")\n"
- " (type \"httpd\")\n"
- " (mixer-type 'null)\n"
- " (extra-options\n"
- " `((encoder . \"vorbis\")\n"
- " (port . \"8080\"))))))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:29899
- msgid "The @code{(gnu services virtualization)} module provides services for the libvirt and virtlog daemons, as well as other virtualization-related services."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:29900
- #, no-wrap
- msgid "Libvirt daemon"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:29905
- msgid "@code{libvirtd} is the server side daemon component of the libvirt virtualization management system. This daemon runs on host servers and performs required management tasks for virtualized guests."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:29906
- #, no-wrap
- msgid "{Scheme Variable} libvirt-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:29909
- msgid "This is the type of the @uref{https://libvirt.org, libvirt daemon}. Its value must be a @code{libvirt-configuration}."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:29915
- #, no-wrap
- msgid ""
- "(service libvirt-service-type\n"
- " (libvirt-configuration\n"
- " (unix-sock-group \"libvirt\")\n"
- " (tls-port \"16555\")))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:29920
- msgid "Available @code{libvirt-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29921
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} package libvirt"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29923
- msgid "Libvirt package."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29926
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} boolean listen-tls?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29929
- msgid "Flag listening for secure TLS connections on the public TCP/IP port. You must set @code{listen} for this to have any effect."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29932
- msgid "It is necessary to setup a CA and issue server certificates before using this capability."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29937
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} boolean listen-tcp?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29940
- msgid "Listen for unencrypted TCP connections on the public TCP/IP port. You must set @code{listen} for this to have any effect."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29944
- msgid "Using the TCP socket requires SASL authentication by default. Only SASL mechanisms which support data encryption are allowed. This is DIGEST_MD5 and GSSAPI (Kerberos5)."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29949
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} string tls-port"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29952
- msgid "Port for accepting secure TLS connections. This can be a port number, or service name."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29954
- msgid "Defaults to @samp{\"16514\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29957
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} string tcp-port"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29960
- msgid "Port for accepting insecure TCP connections. This can be a port number, or service name."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29962
- msgid "Defaults to @samp{\"16509\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29965
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} string listen-addr"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29967
- msgid "IP address or hostname used for client connections."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29972
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} boolean mdns-adv?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29974
- msgid "Flag toggling mDNS advertisement of the libvirt service."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29977
- msgid "Alternatively can disable for all services on a host by stopping the Avahi daemon."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29982
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} string mdns-name"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29985
- msgid "Default mDNS advertisement name. This must be unique on the immediate broadcast network."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29987
- msgid "Defaults to @samp{\"Virtualization Host <hostname>\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29990
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} string unix-sock-group"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29994
- msgid "UNIX domain socket group ownership. This can be used to allow a 'trusted' set of users access to management capabilities without becoming root."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:29999
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} string unix-sock-ro-perms"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30002
- msgid "UNIX socket permissions for the R/O socket. This is used for monitoring VM status only."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30004 guix-git/doc/guix.texi:30022
- msgid "Defaults to @samp{\"0777\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30007
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} string unix-sock-rw-perms"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30011
- msgid "UNIX socket permissions for the R/W socket. Default allows only root. If PolicyKit is enabled on the socket, the default will change to allow everyone (eg, 0777)"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30013
- msgid "Defaults to @samp{\"0770\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30016
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} string unix-sock-admin-perms"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30020
- msgid "UNIX socket permissions for the admin socket. Default allows only owner (root), do not change it unless you are sure to whom you are exposing the access to."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30025
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} string unix-sock-dir"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30027
- msgid "The directory in which sockets will be found/created."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30029
- msgid "Defaults to @samp{\"/var/run/libvirt\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30032
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} string auth-unix-ro"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30035
- msgid "Authentication scheme for UNIX read-only sockets. By default socket permissions allow anyone to connect"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30037 guix-git/doc/guix.texi:30046
- msgid "Defaults to @samp{\"polkit\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30040
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} string auth-unix-rw"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30044
- msgid "Authentication scheme for UNIX read-write sockets. By default socket permissions only allow root. If PolicyKit support was compiled into libvirt, the default will be to use 'polkit' auth."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30049
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} string auth-tcp"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30053
- msgid "Authentication scheme for TCP sockets. If you don't enable SASL, then all TCP traffic is cleartext. Don't do this outside of a dev/test scenario."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30055
- msgid "Defaults to @samp{\"sasl\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30058
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} string auth-tls"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30062
- msgid "Authentication scheme for TLS sockets. TLS sockets already have encryption provided by the TLS layer, and limited authentication is done by certificates."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30065
- msgid "It is possible to make use of any SASL authentication mechanism as well, by using 'sasl' for this option"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30067
- msgid "Defaults to @samp{\"none\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30070
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} optional-list access-drivers"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30072
- msgid "API access control scheme."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30075
- msgid "By default an authenticated user is allowed access to all APIs. Access drivers can place restrictions on this."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30080
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} string key-file"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30083
- msgid "Server key file path. If set to an empty string, then no private key is loaded."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30088
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} string cert-file"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30091
- msgid "Server key file path. If set to an empty string, then no certificate is loaded."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30096
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} string ca-file"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30099
- msgid "Server key file path. If set to an empty string, then no CA certificate is loaded."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30104
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} string crl-file"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30107
- msgid "Certificate revocation list path. If set to an empty string, then no CRL is loaded."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30112
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} boolean tls-no-sanity-cert"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30114
- msgid "Disable verification of our own server certificates."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30117
- msgid "When libvirtd starts it performs some sanity checks against its own certificates."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30122
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} boolean tls-no-verify-cert"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30124
- msgid "Disable verification of client certificates."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30128
- msgid "Client certificate verification is the primary authentication mechanism. Any client which does not present a certificate signed by the CA will be rejected."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30133
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} optional-list tls-allowed-dn-list"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30135
- msgid "Whitelist of allowed x509 Distinguished Name."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30140
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} optional-list sasl-allowed-usernames"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30143
- msgid "Whitelist of allowed SASL usernames. The format for username depends on the SASL authentication mechanism."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30148
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} string tls-priority"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30152
- msgid "Override the compile time default TLS priority string. The default is usually @samp{\"NORMAL\"} unless overridden at build time. Only set this is it is desired for libvirt to deviate from the global default settings."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30154
- msgid "Defaults to @samp{\"NORMAL\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30157
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} integer max-clients"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30160 guix-git/doc/guix.texi:30584
- msgid "Maximum number of concurrent client connections to allow over all sockets combined."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30162
- msgid "Defaults to @samp{5000}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30165
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} integer max-queued-clients"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30169
- msgid "Maximum length of queue of connections waiting to be accepted by the daemon. Note, that some protocols supporting retransmission may obey this so that a later reattempt at connection succeeds."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30174
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} integer max-anonymous-clients"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30177
- msgid "Maximum length of queue of accepted but not yet authenticated clients. Set this to zero to turn this feature off"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30179 guix-git/doc/guix.texi:30197
- #: guix-git/doc/guix.texi:30213
- msgid "Defaults to @samp{20}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30182
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} integer min-workers"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30184
- msgid "Number of workers to start up initially."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30189
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} integer max-workers"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30191
- msgid "Maximum number of worker threads."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30195
- msgid "If the number of active clients exceeds @code{min-workers}, then more threads are spawned, up to max_workers limit. Typically you'd want max_workers to equal maximum number of clients allowed."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30200
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} integer prio-workers"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30204
- msgid "Number of priority workers. If all workers from above pool are stuck, some calls marked as high priority (notably domainDestroy) can be executed in this pool."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30209
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} integer max-requests"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30211
- msgid "Total global limit on concurrent RPC calls."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30216
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} integer max-client-requests"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30220
- msgid "Limit on concurrent requests from a single client connection. To avoid one client monopolizing the server this should be a small fraction of the global max_requests and max_workers parameter."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30225
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} integer admin-min-workers"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30227
- msgid "Same as @code{min-workers} but for the admin interface."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30232
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} integer admin-max-workers"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30234
- msgid "Same as @code{max-workers} but for the admin interface."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30239
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} integer admin-max-clients"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30241
- msgid "Same as @code{max-clients} but for the admin interface."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30246
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} integer admin-max-queued-clients"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30248
- msgid "Same as @code{max-queued-clients} but for the admin interface."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30253
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} integer admin-max-client-requests"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30255
- msgid "Same as @code{max-client-requests} but for the admin interface."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30260
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} integer log-level"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30262 guix-git/doc/guix.texi:30486
- msgid "Logging level. 4 errors, 3 warnings, 2 information, 1 debug."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30267
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} string log-filters"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30269 guix-git/doc/guix.texi:30493
- msgid "Logging filters."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30272
- msgid "A filter allows to select a different logging level for a given category of logs. The format for a filter is one of:"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:30276 guix-git/doc/guix.texi:30500
- msgid "x:name"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:30279 guix-git/doc/guix.texi:30503
- msgid "x:+name"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30290
- msgid "where @code{name} is a string which is matched against the category given in the @code{VIR_LOG_INIT()} at the top of each libvirt source file, e.g., @samp{\"remote\"}, @samp{\"qemu\"}, or @samp{\"util.json\"} (the name in the filter can be a substring of the full category name, in order to match multiple similar categories), the optional @samp{\"+\"} prefix tells libvirt to log stack trace for each message matching name, and @code{x} is the minimal level where matching messages should be logged:"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:30294 guix-git/doc/guix.texi:30339
- #: guix-git/doc/guix.texi:30517 guix-git/doc/guix.texi:30562
- msgid "1: DEBUG"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:30297 guix-git/doc/guix.texi:30342
- #: guix-git/doc/guix.texi:30520 guix-git/doc/guix.texi:30565
- msgid "2: INFO"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:30300 guix-git/doc/guix.texi:30345
- #: guix-git/doc/guix.texi:30523 guix-git/doc/guix.texi:30568
- msgid "3: WARNING"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:30303 guix-git/doc/guix.texi:30348
- #: guix-git/doc/guix.texi:30526 guix-git/doc/guix.texi:30571
- msgid "4: ERROR"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30308 guix-git/doc/guix.texi:30531
- msgid "Multiple filters can be defined in a single filters statement, they just need to be separated by spaces."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30310 guix-git/doc/guix.texi:30533
- msgid "Defaults to @samp{\"3:remote 4:event\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30313
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} string log-outputs"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30315 guix-git/doc/guix.texi:30538
- msgid "Logging outputs."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30318
- msgid "An output is one of the places to save logging information. The format for an output can be:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:30320 guix-git/doc/guix.texi:30543
- #, no-wrap
- msgid "x:stderr"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:30322 guix-git/doc/guix.texi:30545
- msgid "output goes to stderr"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:30323 guix-git/doc/guix.texi:30546
- #, no-wrap
- msgid "x:syslog:name"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:30325 guix-git/doc/guix.texi:30548
- msgid "use syslog for the output and use the given name as the ident"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:30326 guix-git/doc/guix.texi:30549
- #, no-wrap
- msgid "x:file:file_path"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:30328 guix-git/doc/guix.texi:30551
- msgid "output to a file, with the given filepath"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:30329 guix-git/doc/guix.texi:30552
- #, no-wrap
- msgid "x:journald"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:30331 guix-git/doc/guix.texi:30554
- msgid "output to journald logging system"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30335 guix-git/doc/guix.texi:30558
- msgid "In all case the x prefix is the minimal level, acting as a filter"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30353 guix-git/doc/guix.texi:30576
- msgid "Multiple outputs can be defined, they just need to be separated by spaces."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30355 guix-git/doc/guix.texi:30578
- msgid "Defaults to @samp{\"3:stderr\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30358
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} integer audit-level"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30360
- msgid "Allows usage of the auditing subsystem to be altered"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:30364
- msgid "0: disable all auditing"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:30367
- msgid "1: enable auditing, only if enabled on host"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:30370
- msgid "2: enable auditing, and exit if disabled on host."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30377
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} boolean audit-logging"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30379
- msgid "Send audit messages via libvirt logging infrastructure."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30384
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} optional-string host-uuid"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30386
- msgid "Host UUID@. UUID must not have all digits be the same."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30391
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} string host-uuid-source"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30393
- msgid "Source to read host UUID."
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:30397
- msgid "@code{smbios}: fetch the UUID from @code{dmidecode -s system-uuid}"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:30400
- msgid "@code{machine-id}: fetch the UUID from @code{/etc/machine-id}"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30405
- msgid "If @code{dmidecode} does not provide a valid UUID a temporary UUID will be generated."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30407
- msgid "Defaults to @samp{\"smbios\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30410
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} integer keepalive-interval"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30415
- msgid "A keepalive message is sent to a client after @code{keepalive_interval} seconds of inactivity to check if the client is still responding. If set to -1, libvirtd will never send keepalive requests; however clients can still send them and the daemon will send responses."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30420
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} integer keepalive-count"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30424
- msgid "Maximum number of keepalive messages that are allowed to be sent to the client without getting any response before the connection is considered broken."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30431
- msgid "In other words, the connection is automatically closed approximately after @code{keepalive_interval * (keepalive_count + 1)} seconds since the last message received from the client. When @code{keepalive-count} is set to 0, connections will be automatically closed after @code{keepalive-interval} seconds of inactivity without sending any keepalive messages."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30436
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} integer admin-keepalive-interval"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30438 guix-git/doc/guix.texi:30445
- msgid "Same as above but for admin interface."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30443
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} integer admin-keepalive-count"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30450
- #, no-wrap
- msgid "{@code{libvirt-configuration} parameter} integer ovs-timeout"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30452
- msgid "Timeout for Open vSwitch calls."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30456
- msgid "The @code{ovs-vsctl} utility is used for the configuration and its timeout option is set by default to 5 seconds to avoid potential infinite waits blocking libvirt."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:30463
- #, no-wrap
- msgid "Virtlog daemon"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:30466
- msgid "The virtlogd service is a server side daemon component of libvirt that is used to manage logs from virtual machine consoles."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:30472
- msgid "This daemon is not used directly by libvirt client applications, rather it is called on their behalf by @code{libvirtd}. By maintaining the logs in a standalone daemon, the main @code{libvirtd} daemon can be restarted without risk of losing logs. The @code{virtlogd} daemon has the ability to re-exec() itself upon receiving @code{SIGUSR1}, to allow live upgrades without downtime."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:30473
- #, no-wrap
- msgid "{Scheme Variable} virtlog-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:30476
- msgid "This is the type of the virtlog daemon. Its value must be a @code{virtlog-configuration}."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:30481
- #, no-wrap
- msgid ""
- "(service virtlog-service-type\n"
- " (virtlog-configuration\n"
- " (max-clients 1000)))\n"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30484
- #, no-wrap
- msgid "{@code{virtlog-configuration} parameter} integer log-level"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30491
- #, no-wrap
- msgid "{@code{virtlog-configuration} parameter} string log-filters"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30496
- msgid "A filter allows to select a different logging level for a given category of logs The format for a filter is one of:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30513
- msgid "where @code{name} is a string which is matched against the category given in the @code{VIR_LOG_INIT()} at the top of each libvirt source file, e.g., \"remote\", \"qemu\", or \"util.json\" (the name in the filter can be a substring of the full category name, in order to match multiple similar categories), the optional \"+\" prefix tells libvirt to log stack trace for each message matching name, and @code{x} is the minimal level where matching messages should be logged:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30536
- #, no-wrap
- msgid "{@code{virtlog-configuration} parameter} string log-outputs"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30541
- msgid "An output is one of the places to save logging information The format for an output can be:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30581
- #, no-wrap
- msgid "{@code{virtlog-configuration} parameter} integer max-clients"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30586
- msgid "Defaults to @samp{1024}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30589
- #, no-wrap
- msgid "{@code{virtlog-configuration} parameter} integer max-size"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30591
- msgid "Maximum file size before rolling over."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30593
- msgid "Defaults to @samp{2MB}"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30596
- #, no-wrap
- msgid "{@code{virtlog-configuration} parameter} integer max-backups"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30598
- msgid "Maximum number of backup files to keep."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:30600
- msgid "Defaults to @samp{3}"
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:30604
- msgid "transparent-emulation-qemu"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:30604
- #, no-wrap
- msgid "Transparent Emulation with QEMU"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:30606 guix-git/doc/guix.texi:30686
- #, no-wrap
- msgid "emulation"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:30607
- #, no-wrap
- msgid "binfmt_misc"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:30615
- msgid "@code{qemu-binfmt-service-type} provides support for transparent emulation of program binaries built for different architectures---e.g., it allows you to transparently execute an ARMv7 program on an x86_64 machine. It achieves this by combining the @uref{https://www.qemu.org, QEMU} emulator and the @code{binfmt_misc} feature of the kernel Linux. This feature only allows you to emulate GNU/Linux on a different architecture, but see below for GNU/Hurd support."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:30616
- #, no-wrap
- msgid "{Scheme Variable} qemu-binfmt-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:30621
- msgid "This is the type of the QEMU/binfmt service for transparent emulation. Its value must be a @code{qemu-binfmt-configuration} object, which specifies the QEMU package to use as well as the architecture we want to emulated:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:30626
- #, no-wrap
- msgid ""
- "(service qemu-binfmt-service-type\n"
- " (qemu-binfmt-configuration\n"
- " (platforms (lookup-qemu-platforms \"arm\" \"aarch64\"))))\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:30632
- msgid "In this example, we enable transparent emulation for the ARM and aarch64 platforms. Running @code{herd stop qemu-binfmt} turns it off, and running @code{herd start qemu-binfmt} turns it back on (@pxref{Invoking herd, the @command{herd} command,, shepherd, The GNU Shepherd Manual})."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:30634
- #, no-wrap
- msgid "{Data Type} qemu-binfmt-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:30636
- msgid "This is the configuration for the @code{qemu-binfmt} service."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:30638
- #, no-wrap
- msgid "@code{platforms} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:30641
- msgid "The list of emulated QEMU platforms. Each item must be a @dfn{platform object} as returned by @code{lookup-qemu-platforms} (see below)."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:30644
- msgid "For example, let's suppose you're on an x86_64 machine and you have this service:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:30649
- #, no-wrap
- msgid ""
- "(service qemu-binfmt-service-type\n"
- " (qemu-binfmt-configuration\n"
- " (platforms (lookup-qemu-platforms \"arm\"))))\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:30652
- msgid "You can run:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:30655
- #, no-wrap
- msgid "guix build -s armhf-linux inkscape\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:30662
- msgid "and it will build Inkscape for ARMv7 @emph{as if it were a native build}, transparently using QEMU to emulate the ARMv7 CPU@. Pretty handy if you'd like to test a package build for an architecture you don't have access to!"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:30663
- #, no-wrap
- msgid "@code{qemu} (default: @code{qemu})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:30665 guix-git/doc/guix.texi:30723
- #: guix-git/doc/guix.texi:30805
- msgid "The QEMU package to use."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:30668
- #, no-wrap
- msgid "{Scheme Procedure} lookup-qemu-platforms @var{platforms}@dots{}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:30673
- msgid "Return the list of QEMU platform objects corresponding to @var{platforms}@dots{}. @var{platforms} must be a list of strings corresponding to platform names, such as @code{\"arm\"}, @code{\"sparc\"}, @code{\"mips64el\"}, and so on."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:30675
- #, no-wrap
- msgid "{Scheme Procedure} qemu-platform? @var{obj}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:30677
- msgid "Return true if @var{obj} is a platform object."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:30679
- #, no-wrap
- msgid "{Scheme Procedure} qemu-platform-name @var{platform}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:30681
- msgid "Return the name of @var{platform}---a string such as @code{\"arm\"}."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:30684
- #, no-wrap
- msgid "QEMU Guest Agent"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:30692
- msgid "The QEMU guest agent provides control over the emulated system to the host. The @code{qemu-guest-agent} service runs the agent on Guix guests. To control the agent from the host, open a socket by invoking QEMU with the following arguments:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:30699
- #, no-wrap
- msgid ""
- "qemu-system-x86_64 \\\n"
- "\t-chardev socket,path=/tmp/qga.sock,server=on,wait=off,id=qga0 \\\n"
- "\t-device virtio-serial \\\n"
- "\t-device virtserialport,chardev=qga0,name=org.qemu.guest_agent.0 \\\n"
- "\t...\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:30703
- msgid "This creates a socket at @file{/tmp/qga.sock} on the host. Once the guest agent is running, you can issue commands with @code{socat}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:30708
- #, no-wrap
- msgid ""
- "$ guix shell socat -- socat unix-connect:/tmp/qga.sock stdio\n"
- "@{\"execute\": \"guest-get-host-name\"@}\n"
- "@{\"return\": @{\"host-name\": \"guix\"@}@}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:30712
- msgid "See @url{https://wiki.qemu.org/Features/GuestAgent,QEMU guest agent documentation} for more options and commands."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:30713
- #, no-wrap
- msgid "{Scheme Variable} qemu-guest-agent-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:30715
- msgid "Service type for the QEMU guest agent service."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:30717
- #, no-wrap
- msgid "{Data Type} qemu-guest-agent-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:30719
- msgid "Configuration for the @code{qemu-guest-agent} service."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:30721 guix-git/doc/guix.texi:30803
- #, no-wrap
- msgid "@code{qemu} (default: @code{qemu-minimal})"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:30724
- #, no-wrap
- msgid "@code{device} (default: @code{\"\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:30727
- msgid "File name of the device or socket the agent uses to communicate with the host. If empty, QEMU uses a default file name."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:30731
- #, no-wrap
- msgid "The Hurd in a Virtual Machine"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:30734
- #, no-wrap
- msgid "the Hurd"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:30735
- #, no-wrap
- msgid "childhurd"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:30743
- msgid "Service @code{hurd-vm} provides support for running GNU/Hurd in a virtual machine (VM), a so-called @dfn{childhurd}. This service is meant to be used on GNU/Linux and the given GNU/Hurd operating system configuration is cross-compiled. The virtual machine is a Shepherd service that can be referred to by the names @code{hurd-vm} and @code{childhurd} and be controlled with commands such as:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:30747
- #, no-wrap
- msgid ""
- "herd start hurd-vm\n"
- "herd stop childhurd\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:30751
- msgid "When the service is running, you can view its console by connecting to it with a VNC client, for example with:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:30754
- #, no-wrap
- msgid "guix shell tigervnc-client -- vncviewer localhost:5900\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:30760
- msgid "The default configuration (see @code{hurd-vm-configuration} below) spawns a secure shell (SSH) server in your GNU/Hurd system, which QEMU (the virtual machine emulator) redirects to port 10222 on the host. Thus, you can connect over SSH to the childhurd with:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:30763
- #, no-wrap
- msgid "ssh root@@localhost -p 10022\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:30772
- msgid "The childhurd is volatile and stateless: it starts with a fresh root file system every time you restart it. By default though, all the files under @file{/etc/childhurd} on the host are copied as is to the root file system of the childhurd when it boots. This allows you to initialize ``secrets'' inside the VM: SSH host keys, authorized substitute keys, and so on---see the explanation of @code{secret-root} below."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:30773
- #, no-wrap
- msgid "{Scheme Variable} hurd-vm-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:30779
- msgid "This is the type of the Hurd in a Virtual Machine service. Its value must be a @code{hurd-vm-configuration} object, which specifies the operating system (@pxref{operating-system Reference}) and the disk size for the Hurd Virtual Machine, the QEMU package to use as well as the options for running it."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:30781
- msgid "For example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:30787
- #, no-wrap
- msgid ""
- "(service hurd-vm-service-type\n"
- " (hurd-vm-configuration\n"
- " (disk-size (* 5000 (expt 2 20))) ;5G\n"
- " (memory-size 1024))) ;1024MiB\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:30791
- msgid "would create a disk image big enough to build GNU@tie{}Hello, with some extra memory."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:30793
- #, no-wrap
- msgid "{Data Type} hurd-vm-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:30796
- msgid "The data type representing the configuration for @code{hurd-vm-service-type}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:30798
- #, no-wrap
- msgid "@code{os} (default: @var{%hurd-vm-operating-system})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:30802
- msgid "The operating system to instantiate. This default is bare-bones with a permissive OpenSSH secure shell daemon listening on port 2222 (@pxref{Networking Services, @code{openssh-service-type}})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:30806
- #, no-wrap
- msgid "@code{image} (default: @var{hurd-vm-disk-image})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:30809
- msgid "The procedure used to build the disk-image built from this configuration."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:30810
- #, no-wrap
- msgid "@code{disk-size} (default: @code{'guess})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:30812
- msgid "The size of the disk image."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:30813
- #, no-wrap
- msgid "@code{memory-size} (default: @code{512})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:30815
- msgid "The memory size of the Virtual Machine in mebibytes."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:30816
- #, no-wrap
- msgid "@code{options} (default: @code{'(\"--snapshot\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:30818
- msgid "The extra options for running QEMU."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:30823
- msgid "If set, a non-zero positive integer used to parameterize Childhurd instances. It is appended to the service's name, e.g. @code{childhurd1}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:30824
- #, no-wrap
- msgid "@code{net-options} (default: @var{hurd-vm-net-options})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:30826
- msgid "The procedure used to produce the list of QEMU networking options."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:30828
- msgid "By default, it produces"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:30836
- #, no-wrap
- msgid ""
- "'(\"--device\" \"rtl8139,netdev=net0\"\n"
- " \"--netdev\" (string-append\n"
- " \"user,id=net0,\"\n"
- " \"hostfwd=tcp:127.0.0.1:@var{secrets-port}-:1004,\"\n"
- " \"hostfwd=tcp:127.0.0.1:@var{ssh-port}-:2222,\"\n"
- " \"hostfwd=tcp:127.0.0.1:@var{vnc-port}-:5900\"))\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:30839
- msgid "with forwarded ports:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:30844
- #, no-wrap
- msgid ""
- "@var{secrets-port}: @code{(+ 11004 (* 1000 @var{ID}))}\n"
- "@var{ssh-port}: @code{(+ 10022 (* 1000 @var{ID}))}\n"
- "@var{vnc-port}: @code{(+ 15900 (* 1000 @var{ID}))}\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:30846
- #, no-wrap
- msgid "@code{secret-root} (default: @file{/etc/childhurd})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:30851
- msgid "The root directory with out-of-band secrets to be installed into the childhurd once it runs. Childhurds are volatile which means that on every startup, secrets such as the SSH host keys and Guix signing key are recreated."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:30855
- msgid "If the @file{/etc/childhurd} directory does not exist, the @code{secret-service} running in the Childhurd will be sent an empty list of secrets."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:30858
- msgid "By default, the service automatically populates @file{/etc/childhurd} with the following non-volatile secrets, unless they already exist:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:30867
- #, no-wrap
- msgid ""
- "/etc/childhurd/etc/guix/acl\n"
- "/etc/childhurd/etc/guix/signing-key.pub\n"
- "/etc/childhurd/etc/guix/signing-key.sec\n"
- "/etc/childhurd/etc/ssh/ssh_host_ed25519_key\n"
- "/etc/childhurd/etc/ssh/ssh_host_ecdsa_key\n"
- "/etc/childhurd/etc/ssh/ssh_host_ed25519_key.pub\n"
- "/etc/childhurd/etc/ssh/ssh_host_ecdsa_key.pub\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:30871
- msgid "These files are automatically sent to the guest Hurd VM when it boots, including permissions."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:30872
- #, no-wrap
- msgid "childhurd, offloading"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:30873
- #, no-wrap
- msgid "Hurd, offloading"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:30877
- msgid "Having these files in place means that only a couple of things are missing to allow the host to offload @code{i586-gnu} builds to the childhurd:"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:30882
- msgid "Authorizing the childhurd's key on the host so that the host accepts build results coming from the childhurd, which can be done like so:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:30886
- #, no-wrap
- msgid ""
- "guix archive --authorize < \\\n"
- " /etc/childhurd/etc/guix/signing-key.pub\n"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:30891
- msgid "Adding the childhurd to @file{/etc/guix/machines.scm} (@pxref{Daemon Offload Setup})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:30895
- msgid "We're working towards making that happen automatically---get in touch with us at @email{guix-devel@@gnu.org} to discuss it!"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:30902
- msgid "Note that by default the VM image is volatile, i.e., once stopped the contents are lost. If you want a stateful image instead, override the configuration's @code{image} and @code{options} without the @code{--snapshot} flag using something along these lines:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:30908
- #, no-wrap
- msgid ""
- "(service hurd-vm-service-type\n"
- " (hurd-vm-configuration\n"
- " (image (const \"/out/of/store/writable/hurd.img\"))\n"
- " (options '())))\n"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:30910
- #, no-wrap
- msgid "Ganeti"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:30912
- #, no-wrap
- msgid "ganeti"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:30919
- msgid "This service is considered experimental. Configuration options may be changed in a backwards-incompatible manner, and not all features have been thorougly tested. Users of this service are encouraged to share their experience at @email{guix-devel@@gnu.org}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:30929
- msgid "Ganeti is a virtual machine management system. It is designed to keep virtual machines running on a cluster of servers even in the event of hardware failures, and to make maintenance and recovery tasks easy. It consists of multiple services which are described later in this section. In addition to the Ganeti service, you will need the OpenSSH service (@pxref{Networking Services, @code{openssh-service-type}}), and update the @file{/etc/hosts} file (@pxref{operating-system Reference, @code{hosts-file}}) with the cluster name and address (or use a DNS server)."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:30934
- msgid "All nodes participating in a Ganeti cluster should have the same Ganeti and @file{/etc/hosts} configuration. Here is an example configuration for a Ganeti cluster node that supports multiple storage backends, and installs the @code{debootstrap} and @code{guix} @dfn{OS providers}:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:30944
- #, no-wrap
- msgid ""
- "(use-package-modules virtualization)\n"
- "(use-service-modules base ganeti networking ssh)\n"
- "(operating-system\n"
- " ;; @dots{}\n"
- " (host-name \"node1\")\n"
- " (hosts-file (plain-file \"hosts\" (format #f \"\n"
- "127.0.0.1 localhost\n"
- "::1 localhost\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:30949
- #, no-wrap
- msgid ""
- "192.168.1.200 ganeti.example.com\n"
- "192.168.1.201 node1.example.com node1\n"
- "192.168.1.202 node2.example.com node2\n"
- "\")))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:30970
- #, no-wrap
- msgid ""
- " ;; Install QEMU so we can use KVM-based instances, and LVM, DRBD and Ceph\n"
- " ;; in order to use the \"plain\", \"drbd\" and \"rbd\" storage backends.\n"
- " (packages (append (map specification->package\n"
- " '(\"qemu\" \"lvm2\" \"drbd-utils\" \"ceph\"\n"
- " ;; Add the debootstrap and guix OS providers.\n"
- " \"ganeti-instance-guix\" \"ganeti-instance-debootstrap\"))\n"
- " %base-packages))\n"
- " (services\n"
- " (append (list (service static-networking-service-type\n"
- " (list (static-networking\n"
- " (addresses\n"
- " (list (network-address\n"
- " (device \"eth0\")\n"
- " (value \"192.168.1.201/24\"))))\n"
- " (routes\n"
- " (list (network-route\n"
- " (destination \"default\")\n"
- " (gateway \"192.168.1.254\"))))\n"
- " (name-servers '(\"192.168.1.252\"\n"
- " \"192.168.1.253\")))))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:30975
- #, no-wrap
- msgid ""
- " ;; Ganeti uses SSH to communicate between nodes.\n"
- " (service openssh-service-type\n"
- " (openssh-configuration\n"
- " (permit-root-login 'prohibit-password)))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:30985
- #, no-wrap
- msgid ""
- " (service ganeti-service-type\n"
- " (ganeti-configuration\n"
- " ;; This list specifies allowed file system paths\n"
- " ;; for storing virtual machine images.\n"
- " (file-storage-paths '(\"/srv/ganeti/file-storage\"))\n"
- " ;; This variable configures a single \"variant\" for\n"
- " ;; both Debootstrap and Guix that works with KVM.\n"
- " (os %default-ganeti-os))))\n"
- " %base-services)))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:30993
- msgid "Users are advised to read the @url{http://docs.ganeti.org/ganeti/master/html/admin.html,Ganeti administrators guide} to learn about the various cluster options and day-to-day operations. There is also a @url{https://guix.gnu.org/blog/2020/running-a-ganeti-cluster-on-guix/,blog post} describing how to configure and initialize a small cluster."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:30994
- #, no-wrap
- msgid "{Scheme Variable} ganeti-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:30997
- msgid "This is a service type that includes all the various services that Ganeti nodes should run."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31002
- msgid "Its value is a @code{ganeti-configuration} object that defines the package to use for CLI operations, as well as configuration for the various daemons. Allowed file storage paths and available guest operating systems are also configured through this data type."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31004
- #, no-wrap
- msgid "{Data Type} ganeti-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31006
- msgid "The @code{ganeti} service takes the following configuration options:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31008 guix-git/doc/guix.texi:31236
- #: guix-git/doc/guix.texi:31286 guix-git/doc/guix.texi:31316
- #: guix-git/doc/guix.texi:31343 guix-git/doc/guix.texi:31375
- #: guix-git/doc/guix.texi:31428 guix-git/doc/guix.texi:31448
- #: guix-git/doc/guix.texi:31474 guix-git/doc/guix.texi:31507
- #: guix-git/doc/guix.texi:31547
- #, no-wrap
- msgid "@code{ganeti} (default: @code{ganeti})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31013
- msgid "The @code{ganeti} package to use. It will be installed to the system profile and make @command{gnt-cluster}, @command{gnt-instance}, etc available. Note that the value specified here does not affect the other services as each refer to a specific @code{ganeti} package (see below)."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31014
- #, no-wrap
- msgid "@code{noded-configuration} (default: @code{(ganeti-noded-configuration)})"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:31015
- #, no-wrap
- msgid "@code{confd-configuration} (default: @code{(ganeti-confd-configuration)})"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:31016
- #, no-wrap
- msgid "@code{wconfd-configuration} (default: @code{(ganeti-wconfd-configuration)})"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:31017
- #, no-wrap
- msgid "@code{luxid-configuration} (default: @code{(ganeti-luxid-configuration)})"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:31018
- #, no-wrap
- msgid "@code{rapi-configuration} (default: @code{(ganeti-rapi-configuration)})"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:31019
- #, no-wrap
- msgid "@code{kvmd-configuration} (default: @code{(ganeti-kvmd-configuration)})"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:31020
- #, no-wrap
- msgid "@code{mond-configuration} (default: @code{(ganeti-mond-configuration)})"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:31021
- #, no-wrap
- msgid "@code{metad-configuration} (default: @code{(ganeti-metad-configuration)})"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:31022
- #, no-wrap
- msgid "@code{watcher-configuration} (default: @code{(ganeti-watcher-configuration)})"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:31023
- #, no-wrap
- msgid "@code{cleaner-configuration} (default: @code{(ganeti-cleaner-configuration)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31028
- msgid "These options control the various daemons and cron jobs that are distributed with Ganeti. The possible values for these are described in detail below. To override a setting, you must use the configuration type for that service:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:31038
- #, no-wrap
- msgid ""
- "(service ganeti-service-type\n"
- " (ganeti-configuration\n"
- " (rapi-configuration\n"
- " (ganeti-rapi-configuration\n"
- " (interface \"eth1\"))))\n"
- " (watcher-configuration\n"
- " (ganeti-watcher-configuration\n"
- " (rapi-ip \"10.0.0.1\"))))\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31040
- #, no-wrap
- msgid "@code{file-storage-paths} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31042
- msgid "List of allowed directories for file storage backend."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31043
- #, no-wrap
- msgid "@code{os} (default: @code{%default-ganeti-os})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31045
- msgid "List of @code{<ganeti-os>} records."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31049
- msgid "In essence @code{ganeti-service-type} is shorthand for declaring each service individually:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:31060
- #, no-wrap
- msgid ""
- "(service ganeti-noded-service-type)\n"
- "(service ganeti-confd-service-type)\n"
- "(service ganeti-wconfd-service-type)\n"
- "(service ganeti-luxid-service-type)\n"
- "(service ganeti-kvmd-service-type)\n"
- "(service ganeti-mond-service-type)\n"
- "(service ganeti-metad-service-type)\n"
- "(service ganeti-watcher-service-type)\n"
- "(service ganeti-cleaner-service-type)\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31064
- msgid "Plus a service extension for @code{etc-service-type} that configures the file storage backend and OS variants."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31067
- #, no-wrap
- msgid "{Data Type} ganeti-os"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31070
- msgid "This data type is suitable for passing to the @code{os} parameter of @code{ganeti-configuration}. It takes the following parameters:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31076
- msgid "The name for this OS provider. It is only used to specify where the configuration ends up. Setting it to ``debootstrap'' will create @file{/etc/ganeti/instance-debootstrap}."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:31077
- #, no-wrap
- msgid "extension"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31080
- msgid "The file extension for variants of this OS type. For example @file{.conf} or @file{.scm}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31081
- #, no-wrap
- msgid "@code{variants} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31083
- msgid "List of @code{ganeti-os-variant} objects for this OS."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31087
- #, no-wrap
- msgid "{Data Type} ganeti-os-variant"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31090
- msgid "This is the data type for a Ganeti OS variant. It takes the following parameters:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31094
- msgid "The name of this variant."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:31095
- #, no-wrap
- msgid "configuration"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31097
- msgid "A configuration file for this variant."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31100
- #, no-wrap
- msgid "{Scheme Variable} %default-debootstrap-hooks"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31102
- msgid "This variable contains hooks to configure networking and the GRUB bootloader."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31104
- #, no-wrap
- msgid "{Scheme Variable} %default-debootstrap-extra-pkgs"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31106
- msgid "This variable contains a list of packages suitable for a fully-virtualized guest."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31108
- #, no-wrap
- msgid "{Data Type} debootstrap-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31111
- msgid "This data type creates configuration files suitable for the debootstrap OS provider."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31113
- #, no-wrap
- msgid "@code{hooks} (default: @code{%default-debootstrap-hooks})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31117
- msgid "When not @code{#f}, this must be a G-expression that specifies a directory with scripts that will run when the OS is installed. It can also be a list of @code{(name . file-like)} pairs. For example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:31120
- #, no-wrap
- msgid "`((99-hello-world . ,(plain-file \"#!/bin/sh\\necho Hello, World\")))\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31125
- msgid "That will create a directory with one executable named @code{99-hello-world} and run it every time this variant is installed. If set to @code{#f}, hooks in @file{/etc/ganeti/instance-debootstrap/hooks} will be used, if any."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31125
- #, no-wrap
- msgid "@code{proxy} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31127
- msgid "Optional HTTP proxy to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31127
- #, no-wrap
- msgid "@code{mirror} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31130
- msgid "The Debian mirror. Typically something like @code{http://ftp.no.debian.org/debian}. The default varies depending on the distribution."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31130
- #, no-wrap
- msgid "@code{arch} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31133
- msgid "The dpkg architecture. Set to @code{armhf} to debootstrap an ARMv7 instance on an AArch64 host. Default is to use the current system architecture."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31133
- #, no-wrap
- msgid "@code{suite} (default: @code{\"stable\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31136
- msgid "When set, this must be a Debian distribution ``suite'' such as @code{buster} or @code{focal}. If set to @code{#f}, the default for the OS provider is used."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31136
- #, no-wrap
- msgid "@code{extra-pkgs} (default: @code{%default-debootstrap-extra-pkgs})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31139
- msgid "List of extra packages that will get installed by dpkg in addition to the minimal system."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31139
- #, no-wrap
- msgid "@code{components} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31142
- msgid "When set, must be a list of Debian repository ``components''. For example @code{'(\"main\" \"contrib\")}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31142
- #, no-wrap
- msgid "@code{generate-cache?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31144
- msgid "Whether to automatically cache the generated debootstrap archive."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31144
- #, no-wrap
- msgid "@code{clean-cache} (default: @code{14})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31147
- msgid "Discard the cache after this amount of days. Use @code{#f} to never clear the cache."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31147
- #, no-wrap
- msgid "@code{partition-style} (default: @code{'msdos})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31150
- msgid "The type of partition to create. When set, it must be one of @code{'msdos}, @code{'none} or a string."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31150
- #, no-wrap
- msgid "@code{partition-alignment} (default: @code{2048})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31152
- msgid "Alignment of the partition in sectors."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:31155
- #, no-wrap
- msgid "{Scheme Procedure} debootstrap-variant @var{name} @var{configuration}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:31158
- msgid "This is a helper procedure that creates a @code{ganeti-os-variant} record. It takes two parameters: a name and a @code{debootstrap-configuration} object."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:31160
- #, no-wrap
- msgid "{Scheme Procedure} debootstrap-os @var{variants}@dots{}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:31163
- msgid "This is a helper procedure that creates a @code{ganeti-os} record. It takes a list of variants created with @code{debootstrap-variant}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:31165
- #, no-wrap
- msgid "{Scheme Procedure} guix-variant @var{name} @var{configuration}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:31170
- msgid "This is a helper procedure that creates a @code{ganeti-os-variant} record for use with the Guix OS provider. It takes a name and a G-expression that returns a ``file-like'' (@pxref{G-Expressions, file-like objects}) object containing a Guix System configuration."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:31172
- #, no-wrap
- msgid "{Scheme Procedure} guix-os @var{variants}@dots{}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:31175
- msgid "This is a helper procedure that creates a @code{ganeti-os} record. It takes a list of variants produced by @code{guix-variant}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31177
- #, no-wrap
- msgid "{Scheme Variable} %default-debootstrap-variants"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31181
- msgid "This is a convenience variable to make the debootstrap provider work ``out of the box'' without users having to declare variants manually. It contains a single debootstrap variant with the default configuration:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:31186
- #, no-wrap
- msgid ""
- "(list (debootstrap-variant\n"
- " \"default\"\n"
- " (debootstrap-configuration)))\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31189
- #, no-wrap
- msgid "{Scheme Variable} %default-guix-variants"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31193
- msgid "This is a convenience variable to make the Guix OS provider work without additional configuration. It creates a virtual machine that has an SSH server, a serial console, and authorizes the Ganeti hosts SSH keys."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:31199
- #, no-wrap
- msgid ""
- "(list (guix-variant\n"
- " \"default\"\n"
- " (file-append ganeti-instance-guix\n"
- " \"/share/doc/ganeti-instance-guix/examples/dynamic.scm\")))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:31205
- msgid "Users can implement support for OS providers unbeknownst to Guix by extending the @code{ganeti-os} and @code{ganeti-os-variant} records appropriately. For example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:31214
- #, no-wrap
- msgid ""
- "(ganeti-os\n"
- " (name \"custom\")\n"
- " (extension \".conf\")\n"
- " (variants\n"
- " (list (ganeti-os-variant\n"
- " (name \"foo\")\n"
- " (configuration (plain-file \"bar\" \"this is fine\"))))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:31219
- msgid "That creates @file{/etc/ganeti/instance-custom/variants/foo.conf} which points to a file in the store with contents @code{this is fine}. It also creates @file{/etc/ganeti/instance-custom/variants/variants.list} with contents @code{foo}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:31222
- msgid "Obviously this may not work for all OS providers out there. If you find the interface limiting, please reach out to @email{guix-devel@@gnu.org}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:31225
- msgid "The rest of this section documents the various services that are included by @code{ganeti-service-type}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31226
- #, no-wrap
- msgid "{Scheme Variable} ganeti-noded-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31230
- msgid "@command{ganeti-noded} is the daemon responsible for node-specific functions within the Ganeti system. The value of this service must be a @code{ganeti-noded-configuration} object."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31232
- #, no-wrap
- msgid "{Data Type} ganeti-noded-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31234
- msgid "This is the configuration for the @code{ganeti-noded} service."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31238 guix-git/doc/guix.texi:31288
- #: guix-git/doc/guix.texi:31318 guix-git/doc/guix.texi:31345
- #: guix-git/doc/guix.texi:31377 guix-git/doc/guix.texi:31430
- #: guix-git/doc/guix.texi:31450 guix-git/doc/guix.texi:31476
- #: guix-git/doc/guix.texi:31509
- msgid "The @code{ganeti} package to use for this service."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31239
- #, no-wrap
- msgid "@code{port} (default: @code{1811})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31241
- msgid "The TCP port on which the node daemon listens for network requests."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31242 guix-git/doc/guix.texi:31292
- #: guix-git/doc/guix.texi:31384 guix-git/doc/guix.texi:31454
- #, no-wrap
- msgid "@code{address} (default: @code{\"0.0.0.0\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31245
- msgid "The network address that the daemon will bind to. The default address means bind to all available addresses."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31249
- msgid "When this is set, it must be a specific network interface (e.g.@: @code{eth0}) that the daemon will bind to."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31250 guix-git/doc/guix.texi:31392
- #, no-wrap
- msgid "@code{max-clients} (default: @code{20})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31254
- msgid "This sets a limit on the maximum number of simultaneous client connections that the daemon will handle. Connections above this count are accepted, but no responses will be sent until enough connections have closed."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31255 guix-git/doc/guix.texi:31397
- #, no-wrap
- msgid "@code{ssl?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31259
- msgid "Whether to use SSL/TLS to encrypt network communications. The certificate is automatically provisioned by the cluster and can be rotated with @command{gnt-cluster renew-crypto}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31260 guix-git/doc/guix.texi:31400
- #, no-wrap
- msgid "@code{ssl-key} (default: @file{\"/var/lib/ganeti/server.pem\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31262 guix-git/doc/guix.texi:31402
- msgid "This can be used to provide a specific encryption key for TLS communications."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31263 guix-git/doc/guix.texi:31403
- #, no-wrap
- msgid "@code{ssl-cert} (default: @file{\"/var/lib/ganeti/server.pem\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31265 guix-git/doc/guix.texi:31405
- msgid "This can be used to provide a specific certificate for TLS communications."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31269 guix-git/doc/guix.texi:31409
- msgid "When true, the daemon performs additional logging for debugging purposes. Note that this will leak encryption details to the log files, use with caution."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31273
- #, no-wrap
- msgid "{Scheme Variable} ganeti-confd-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31279
- msgid "@command{ganeti-confd} answers queries related to the configuration of a Ganeti cluster. The purpose of this daemon is to have a highly available and fast way to query cluster configuration values. It is automatically active on all @dfn{master candidates}. The value of this service must be a @code{ganeti-confd-configuration} object."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31282
- #, no-wrap
- msgid "{Data Type} ganeti-confd-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31284
- msgid "This is the configuration for the @code{ganeti-confd} service."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31289
- #, no-wrap
- msgid "@code{port} (default: @code{1814})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31291
- msgid "The UDP port on which to listen for network requests."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31294
- msgid "Network address that the daemon will bind to."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31297 guix-git/doc/guix.texi:31326
- #: guix-git/doc/guix.texi:31353 guix-git/doc/guix.texi:31433
- #: guix-git/doc/guix.texi:31460 guix-git/doc/guix.texi:31486
- msgid "When true, the daemon performs additional logging for debugging purposes."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31301
- #, no-wrap
- msgid "{Scheme Variable} ganeti-wconfd-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31307
- msgid "@command{ganeti-wconfd} is the daemon that has authoritative knowledge about the cluster configuration and is the only entity that can accept changes to it. All jobs that need to modify the configuration will do so by sending appropriate requests to this daemon. It only runs on the @dfn{master node} and will automatically disable itself on other nodes."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31310
- msgid "The value of this service must be a @code{ganeti-wconfd-configuration} object."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31312
- #, no-wrap
- msgid "{Data Type} ganeti-wconfd-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31314
- msgid "This is the configuration for the @code{ganeti-wconfd} service."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31319 guix-git/doc/guix.texi:31346
- #, no-wrap
- msgid "@code{no-voting?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31323
- msgid "The daemon will refuse to start if the majority of cluster nodes does not agree that it is running on the master node. Set to @code{#t} to start even if a quorum can not be reached (dangerous, use with caution)."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31330
- #, no-wrap
- msgid "{Scheme Variable} ganeti-luxid-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31335
- msgid "@command{ganeti-luxid} is a daemon used to answer queries related to the configuration and the current live state of a Ganeti cluster. Additionally, it is the authoritative daemon for the Ganeti job queue. Jobs can be submitted via this daemon and it schedules and starts them."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31337
- msgid "It takes a @code{ganeti-luxid-configuration} object."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31339
- #, no-wrap
- msgid "{Data Type} ganeti-luxid-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31341
- msgid "This is the configuration for the @code{ganeti-luxid} service."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31350
- msgid "The daemon will refuse to start if it cannot verify that the majority of cluster nodes believes that it is running on the master node. Set to @code{#t} to ignore such checks and start anyway (this can be dangerous)."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31357
- #, no-wrap
- msgid "{Scheme Variable} ganeti-rapi-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31361
- msgid "@command{ganeti-rapi} provides a remote API for Ganeti clusters. It runs on the master node and can be used to perform cluster actions programmatically via a JSON-based RPC protocol."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31367
- msgid "Most query operations are allowed without authentication (unless @var{require-authentication?} is set), whereas write operations require explicit authorization via the @file{/var/lib/ganeti/rapi/users} file. See the @url{http://docs.ganeti.org/ganeti/master/html/rapi.html, Ganeti Remote API documentation} for more information."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31369
- msgid "The value of this service must be a @code{ganeti-rapi-configuration} object."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31371
- #, no-wrap
- msgid "{Data Type} ganeti-rapi-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31373
- msgid "This is the configuration for the @code{ganeti-rapi} service."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31378
- #, no-wrap
- msgid "@code{require-authentication?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31380
- msgid "Whether to require authentication even for read-only operations."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31381
- #, no-wrap
- msgid "@code{port} (default: @code{5080})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31383
- msgid "The TCP port on which to listen to API requests."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31387
- msgid "The network address that the service will bind to. By default it listens on all configured addresses."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31391
- msgid "When set, it must specify a specific network interface such as @code{eth0} that the daemon will bind to."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31396
- msgid "The maximum number of simultaneous client requests to handle. Further connections are allowed, but no responses are sent until enough connections have closed."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31399
- msgid "Whether to use SSL/TLS encryption on the RAPI port."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31413
- #, no-wrap
- msgid "{Scheme Variable} ganeti-kvmd-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31421
- msgid "@command{ganeti-kvmd} is responsible for determining whether a given KVM instance was shut down by an administrator or a user. Normally Ganeti will restart an instance that was not stopped through Ganeti itself. If the cluster option @code{user_shutdown} is true, this daemon monitors the @code{QMP} socket provided by QEMU and listens for shutdown events, and marks the instance as @dfn{USER_down} instead of @dfn{ERROR_down} when it shuts down gracefully by itself."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31423
- msgid "It takes a @code{ganeti-kvmd-configuration} object."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31425
- #, no-wrap
- msgid "{Data Type} ganeti-kvmd-configuration"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31437
- #, no-wrap
- msgid "{Scheme Variable} ganeti-mond-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31441
- msgid "@command{ganeti-mond} is an optional daemon that provides Ganeti monitoring functionality. It is responsible for running data collectors and publish the collected information through a HTTP interface."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31443
- msgid "It takes a @code{ganeti-mond-configuration} object."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31445
- #, no-wrap
- msgid "{Data Type} ganeti-mond-configuration"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31451
- #, no-wrap
- msgid "@code{port} (default: @code{1815})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31453 guix-git/doc/guix.texi:31479
- msgid "The port on which the daemon will listen."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31457
- msgid "The network address that the daemon will bind to. By default it binds to all available interfaces."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31464
- #, no-wrap
- msgid "{Scheme Variable} ganeti-metad-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31467
- msgid "@command{ganeti-metad} is an optional daemon that can be used to provide information about the cluster to instances or OS install scripts."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31469
- msgid "It takes a @code{ganeti-metad-configuration} object."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31471
- #, no-wrap
- msgid "{Data Type} ganeti-metad-configuration"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31483
- msgid "If set, the daemon will bind to this address only. If left unset, the behavior depends on the cluster configuration."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31490
- #, no-wrap
- msgid "{Scheme Variable} ganeti-watcher-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31498
- msgid "@command{ganeti-watcher} is a script designed to run periodically and ensure the health of a cluster. It will automatically restart instances that have stopped without Ganeti's consent, and repairs DRBD links in case a node has rebooted. It also archives old cluster jobs and restarts Ganeti daemons that are not running. If the cluster parameter @code{ensure_node_health} is set, the watcher will also shutdown instances and DRBD devices if the node it is running on is declared offline by known master candidates."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31500
- msgid "It can be paused on all nodes with @command{gnt-cluster watcher pause}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31502
- msgid "The service takes a @code{ganeti-watcher-configuration} object."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31504
- #, no-wrap
- msgid "{Data Type} ganeti-watcher-configuration"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31510
- #, no-wrap
- msgid "@code{schedule} (default: @code{'(next-second-from (next-minute (range 0 60 5)))})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31512
- msgid "How often to run the script. The default is every five minutes."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31513
- #, no-wrap
- msgid "@code{rapi-ip} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31516
- msgid "This option needs to be specified only if the RAPI daemon is configured to use a particular interface or address. By default the cluster address is used."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31517
- #, no-wrap
- msgid "@code{job-age} (default: @code{(* 6 3600)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31520
- msgid "Archive cluster jobs older than this age, specified in seconds. The default is 6 hours. This keeps @command{gnt-job list} manageable."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31521
- #, no-wrap
- msgid "@code{verify-disks?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31525
- msgid "If this is @code{#f}, the watcher will not try to repair broken DRBD links automatically. Administrators will need to use @command{gnt-cluster verify-disks} manually instead."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31528
- msgid "When @code{#t}, the script performs additional logging for debugging purposes."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31532
- #, no-wrap
- msgid "{Scheme Variable} ganeti-cleaner-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31540
- msgid "@command{ganeti-cleaner} is a script designed to run periodically and remove old files from the cluster. This service type controls two @dfn{cron jobs}: one intended for the master node that permanently purges old cluster jobs, and one intended for every node that removes expired X509 certificates, keys, and outdated @command{ganeti-watcher} information. Like all Ganeti services, it is safe to include even on non-master nodes as it will disable itself as necessary."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:31542
- msgid "It takes a @code{ganeti-cleaner-configuration} object."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31544
- #, no-wrap
- msgid "{Data Type} ganeti-cleaner-configuration"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31549
- msgid "The @code{ganeti} package to use for the @command{gnt-cleaner} command."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31550
- #, no-wrap
- msgid "@code{master-schedule} (default: @code{\"45 1 * * *\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31553
- msgid "How often to run the master cleaning job. The default is once per day, at 01:45:00."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31554
- #, no-wrap
- msgid "@code{node-schedule} (default: @code{\"45 2 * * *\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31557
- msgid "How often to run the node cleaning job. The default is once per day, at 02:45:00."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:31571
- msgid "The @code{(gnu services version-control)} module provides a service to allow remote access to local Git repositories. There are three options: the @code{git-daemon-service}, which provides access to repositories via the @code{git://} unsecured TCP-based protocol, extending the @code{nginx} web server to proxy some requests to @code{git-http-backend}, or providing a web interface with @code{cgit-service-type}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:31572
- #, no-wrap
- msgid "{Scheme Procedure} git-daemon-service [#:config (git-daemon-configuration)]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:31576
- msgid "Return a service that runs @command{git daemon}, a simple TCP server to expose repositories over the Git protocol for anonymous access."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:31582
- msgid "The optional @var{config} argument should be a @code{<git-daemon-configuration>} object, by default it allows read-only access to exported@footnote{By creating the magic file @file{git-daemon-export-ok} in the repository directory.} repositories under @file{/srv/git}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31585
- #, no-wrap
- msgid "{Data Type} git-daemon-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31587
- msgid "Data type representing the configuration for @code{git-daemon-service}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31589
- #, no-wrap
- msgid "@code{package} (default: @code{git})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31591 guix-git/doc/guix.texi:31651
- msgid "Package object of the Git distributed version control system."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31592 guix-git/doc/guix.texi:31655
- #, no-wrap
- msgid "@code{export-all?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31595
- msgid "Whether to allow access for all Git repositories, even if they do not have the @file{git-daemon-export-ok} file."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31596
- #, no-wrap
- msgid "@code{base-path} (default: @file{/srv/git})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31602
- msgid "Whether to remap all the path requests as relative to the given path. If you run @command{git daemon} with @code{(base-path \"/srv/git\")} on @samp{example.com}, then if you later try to pull @indicateurl{git://example.com/hello.git}, git daemon will interpret the path as @file{/srv/git/hello.git}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31603
- #, no-wrap
- msgid "@code{user-path} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31611
- msgid "Whether to allow @code{~user} notation to be used in requests. When specified with empty string, requests to @indicateurl{git://host/~alice/foo} is taken as a request to access @code{foo} repository in the home directory of user @code{alice}. If @code{(user-path \"@var{path}\")} is specified, the same request is taken as a request to access @file{@var{path}/foo} repository in the home directory of user @code{alice}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31612
- #, no-wrap
- msgid "@code{listen} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31615
- msgid "Whether to listen on specific IP addresses or hostnames, defaults to all."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31616
- #, no-wrap
- msgid "@code{port} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31618
- msgid "Whether to listen on an alternative port, which defaults to 9418."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31619
- #, no-wrap
- msgid "@code{whitelist} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31621
- msgid "If not empty, only allow access to this list of directories."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31625
- msgid "Extra options will be passed to @command{git daemon}, please run @command{man git-daemon} for more information."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:31639
- msgid "The @code{git://} protocol lacks authentication. When you pull from a repository fetched via @code{git://}, you don't know whether the data you receive was modified or is even coming from the specified host, and your connection is subject to eavesdropping. It's better to use an authenticated and encrypted transport, such as @code{https}. Although Git allows you to serve repositories using unsophisticated file-based web servers, there is a faster protocol implemented by the @code{git-http-backend} program. This program is the back-end of a proper Git web service. It is designed to sit behind a FastCGI proxy. @xref{Web Services}, for more on running the necessary @code{fcgiwrap} daemon."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:31642
- msgid "Guix has a separate configuration data type for serving Git repositories over HTTP."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31643
- #, no-wrap
- msgid "{Data Type} git-http-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:31647
- msgid "Data type representing the configuration for a future @code{git-http-service-type}; can currently be used to configure Nginx through @code{git-http-nginx-location-configuration}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31649
- #, no-wrap
- msgid "@code{package} (default: @var{git})"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31652
- #, no-wrap
- msgid "@code{git-root} (default: @file{/srv/git})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31654
- msgid "Directory containing the Git repositories to expose to the world."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31658
- msgid "Whether to expose access for all Git repositories in @var{git-root}, even if they do not have the @file{git-daemon-export-ok} file."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31659
- #, no-wrap
- msgid "@code{uri-path} (default: @samp{/git/})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31664
- msgid "Path prefix for Git access. With the default @samp{/git/} prefix, this will map @indicateurl{http://@var{server}/git/@var{repo}.git} to @file{/srv/git/@var{repo}.git}. Requests whose URI paths do not begin with this prefix are not passed on to this Git instance."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:31665
- #, no-wrap
- msgid "@code{fcgiwrap-socket} (default: @code{127.0.0.1:9000})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:31668
- msgid "The socket on which the @code{fcgiwrap} daemon is listening. @xref{Web Services}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:31675
- msgid "There is no @code{git-http-service-type}, currently; instead you can create an @code{nginx-location-configuration} from a @code{git-http-configuration} and then add that location to a web server."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:31676
- #, no-wrap
- msgid "{Scheme Procedure} git-http-nginx-location-configuration @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:31681
- msgid "[config=(git-http-configuration)] Compute an @code{nginx-location-configuration} that corresponds to the given Git http configuration. An example nginx service definition to serve the default @file{/srv/git} over HTTPS might be:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:31698
- #, no-wrap
- msgid ""
- "(service nginx-service-type\n"
- " (nginx-configuration\n"
- " (server-blocks\n"
- " (list\n"
- " (nginx-server-configuration\n"
- " (listen '(\"443 ssl\"))\n"
- " (server-name \"git.my-host.org\")\n"
- " (ssl-certificate\n"
- " \"/etc/letsencrypt/live/git.my-host.org/fullchain.pem\")\n"
- " (ssl-certificate-key\n"
- " \"/etc/letsencrypt/live/git.my-host.org/privkey.pem\")\n"
- " (locations\n"
- " (list\n"
- " (git-http-nginx-location-configuration\n"
- " (git-http-configuration (uri-path \"/\"))))))))))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:31705
- msgid "This example assumes that you are using Let's Encrypt to get your TLS certificate. @xref{Certificate Services}. The default @code{certbot} service will redirect all HTTP traffic on @code{git.my-host.org} to HTTPS@. You will also need to add an @code{fcgiwrap} proxy to your system services. @xref{Web Services}."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:31707
- #, no-wrap
- msgid "Cgit Service"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:31709
- #, no-wrap
- msgid "Cgit service"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:31710
- #, no-wrap
- msgid "Git, web interface"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:31713
- msgid "@uref{https://git.zx2c4.com/cgit/, Cgit} is a web frontend for Git repositories written in C."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:31716
- msgid "The following example will configure the service with default values. By default, Cgit can be accessed on port 80 (@code{http://localhost:80})."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:31719
- #, no-wrap
- msgid "(service cgit-service-type)\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:31723
- msgid "The @code{file-object} type designates either a file-like object (@pxref{G-Expressions, file-like objects}) or a string."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:31727
- msgid "Available @code{cgit-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31728
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} package package"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31730
- msgid "The CGIT package."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31733
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} nginx-server-configuration-list nginx"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31738
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} file-object about-filter"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31741
- msgid "Specifies a command which will be invoked to format the content of about pages (both top-level and for each repository)."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31746
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} string agefile"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31749
- msgid "Specifies a path, relative to each repository path, which can be used to specify the date and time of the youngest commit in the repository."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31754
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} file-object auth-filter"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31757
- msgid "Specifies a command that will be invoked for authenticating repository access."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31762
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} string branch-sort"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31765
- msgid "Flag which, when set to @samp{age}, enables date ordering in the branch ref list, and when set @samp{name} enables ordering by branch name."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31767
- msgid "Defaults to @samp{\"name\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31770
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} string cache-root"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31772
- msgid "Path used to store the cgit cache entries."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31774
- msgid "Defaults to @samp{\"/var/cache/cgit\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31777
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} integer cache-static-ttl"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31780
- msgid "Number which specifies the time-to-live, in minutes, for the cached version of repository pages accessed with a fixed SHA1."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31782 guix-git/doc/guix.texi:32225
- msgid "Defaults to @samp{-1}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31785
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} integer cache-dynamic-ttl"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31788
- msgid "Number which specifies the time-to-live, in minutes, for the cached version of repository pages accessed without a fixed SHA1."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31793
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} integer cache-repo-ttl"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31796
- msgid "Number which specifies the time-to-live, in minutes, for the cached version of the repository summary page."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31801
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} integer cache-root-ttl"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31804
- msgid "Number which specifies the time-to-live, in minutes, for the cached version of the repository index page."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31809
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} integer cache-scanrc-ttl"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31812
- msgid "Number which specifies the time-to-live, in minutes, for the result of scanning a path for Git repositories."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31817
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} integer cache-about-ttl"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31820
- msgid "Number which specifies the time-to-live, in minutes, for the cached version of the repository about page."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31825
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} integer cache-snapshot-ttl"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31828
- msgid "Number which specifies the time-to-live, in minutes, for the cached version of snapshots."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31833
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} integer cache-size"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31836
- msgid "The maximum number of entries in the cgit cache. When set to @samp{0}, caching is disabled."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31841
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} boolean case-sensitive-sort?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31843
- msgid "Sort items in the repo list case sensitively."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31848
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} list clone-prefix"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31851
- msgid "List of common prefixes which, when combined with a repository URL, generates valid clone URLs for the repository."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31856
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} list clone-url"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31858
- msgid "List of @code{clone-url} templates."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31863
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} file-object commit-filter"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31865
- msgid "Command which will be invoked to format commit messages."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31870
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} string commit-sort"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31874 guix-git/doc/guix.texi:32432
- msgid "Flag which, when set to @samp{date}, enables strict date ordering in the commit log, and when set to @samp{topo} enables strict topological ordering."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31876
- msgid "Defaults to @samp{\"git log\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31879
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} file-object css"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31881
- msgid "URL which specifies the css document to include in all cgit pages."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31883
- msgid "Defaults to @samp{\"/share/cgit/cgit.css\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31886
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} file-object email-filter"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31890
- msgid "Specifies a command which will be invoked to format names and email address of committers, authors, and taggers, as represented in various places throughout the cgit interface."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31895
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} boolean embedded?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31898
- msgid "Flag which, when set to @samp{#t}, will make cgit generate a HTML fragment suitable for embedding in other HTML pages."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31903
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} boolean enable-commit-graph?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31907
- msgid "Flag which, when set to @samp{#t}, will make cgit print an ASCII-art commit history graph to the left of the commit messages in the repository log page."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31912
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} boolean enable-filter-overrides?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31915
- msgid "Flag which, when set to @samp{#t}, allows all filter settings to be overridden in repository-specific cgitrc files."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31920
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} boolean enable-follow-links?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31923
- msgid "Flag which, when set to @samp{#t}, allows users to follow a file in the log view."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31928
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} boolean enable-http-clone?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31931
- msgid "If set to @samp{#t}, cgit will act as an dumb HTTP endpoint for Git clones."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31936
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} boolean enable-index-links?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31939
- msgid "Flag which, when set to @samp{#t}, will make cgit generate extra links \"summary\", \"commit\", \"tree\" for each repo in the repository index."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31944
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} boolean enable-index-owner?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31947
- msgid "Flag which, when set to @samp{#t}, will make cgit display the owner of each repo in the repository index."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31952
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} boolean enable-log-filecount?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31955
- msgid "Flag which, when set to @samp{#t}, will make cgit print the number of modified files for each commit on the repository log page."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31960
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} boolean enable-log-linecount?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31963
- msgid "Flag which, when set to @samp{#t}, will make cgit print the number of added and removed lines for each commit on the repository log page."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31968
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} boolean enable-remote-branches?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31971 guix-git/doc/guix.texi:32495
- msgid "Flag which, when set to @code{#t}, will make cgit display remote branches in the summary and refs views."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31976
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} boolean enable-subject-links?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31980
- msgid "Flag which, when set to @code{1}, will make cgit use the subject of the parent commit as link text when generating links to parent commits in commit view."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31985
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} boolean enable-html-serving?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31989
- msgid "Flag which, when set to @samp{#t}, will make cgit use the subject of the parent commit as link text when generating links to parent commits in commit view."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31994
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} boolean enable-tree-linenumbers?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:31997
- msgid "Flag which, when set to @samp{#t}, will make cgit generate linenumber links for plaintext blobs printed in the tree view."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32002
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} boolean enable-git-config?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32005
- msgid "Flag which, when set to @samp{#f}, will allow cgit to use Git config to set any repo specific settings."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32010
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} file-object favicon"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32012
- msgid "URL used as link to a shortcut icon for cgit."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32014
- msgid "Defaults to @samp{\"/favicon.ico\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32017
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} string footer"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32021
- msgid "The content of the file specified with this option will be included verbatim at the bottom of all pages (i.e.@: it replaces the standard \"generated by...\"@: message)."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32026
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} string head-include"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32029
- msgid "The content of the file specified with this option will be included verbatim in the HTML HEAD section on all pages."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32034
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} string header"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32037
- msgid "The content of the file specified with this option will be included verbatim at the top of all pages."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32042
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} file-object include"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32045
- msgid "Name of a configfile to include before the rest of the current config- file is parsed."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32050
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} string index-header"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32053
- msgid "The content of the file specified with this option will be included verbatim above the repository index."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32058
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} string index-info"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32061
- msgid "The content of the file specified with this option will be included verbatim below the heading on the repository index page."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32066
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} boolean local-time?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32069
- msgid "Flag which, if set to @samp{#t}, makes cgit print commit and tag times in the servers timezone."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32074
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} file-object logo"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32077
- msgid "URL which specifies the source of an image which will be used as a logo on all cgit pages."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32079
- msgid "Defaults to @samp{\"/share/cgit/cgit.png\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32082
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} string logo-link"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32084 guix-git/doc/guix.texi:32541
- msgid "URL loaded when clicking on the cgit logo image."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32089
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} file-object owner-filter"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32092
- msgid "Command which will be invoked to format the Owner column of the main page."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32097
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} integer max-atom-items"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32099
- msgid "Number of items to display in atom feeds view."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32104
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} integer max-commit-count"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32106
- msgid "Number of entries to list per page in \"log\" view."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32111
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} integer max-message-length"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32113
- msgid "Number of commit message characters to display in \"log\" view."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32115 guix-git/doc/guix.texi:32131
- msgid "Defaults to @samp{80}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32118
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} integer max-repo-count"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32121
- msgid "Specifies the number of entries to list per page on the repository index page."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32126
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} integer max-repodesc-length"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32129
- msgid "Specifies the maximum number of repo description characters to display on the repository index page."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32134
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} integer max-blob-size"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32136
- msgid "Specifies the maximum size of a blob to display HTML for in KBytes."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32141
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} string max-stats"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32144
- msgid "Maximum statistics period. Valid values are @samp{week},@samp{month}, @samp{quarter} and @samp{year}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32149
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} mimetype-alist mimetype"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32151
- msgid "Mimetype for the specified filename extension."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32155
- msgid "Defaults to @samp{((gif \"image/gif\") (html \"text/html\") (jpg \"image/jpeg\") (jpeg \"image/jpeg\") (pdf \"application/pdf\") (png \"image/png\") (svg \"image/svg+xml\"))}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32158
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} file-object mimetype-file"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32160
- msgid "Specifies the file to use for automatic mimetype lookup."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32165
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} string module-link"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32168
- msgid "Text which will be used as the formatstring for a hyperlink when a submodule is printed in a directory listing."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32173
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} boolean nocache?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32175
- msgid "If set to the value @samp{#t} caching will be disabled."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32180
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} boolean noplainemail?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32183
- msgid "If set to @samp{#t} showing full author email addresses will be disabled."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32188
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} boolean noheader?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32191
- msgid "Flag which, when set to @samp{#t}, will make cgit omit the standard header on all pages."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32196
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} project-list project-list"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32200
- msgid "A list of subdirectories inside of @code{repository-directory}, relative to it, that should loaded as Git repositories. An empty list means that all subdirectories will be loaded."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32205
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} file-object readme"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32207
- msgid "Text which will be used as default value for @code{cgit-repo-readme}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32212
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} boolean remove-suffix?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32216
- msgid "If set to @code{#t} and @code{repository-directory} is enabled, if any repositories are found with a suffix of @code{.git}, this suffix will be removed for the URL and name."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32221
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} integer renamelimit"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32223
- msgid "Maximum number of files to consider when detecting renames."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32228
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} string repository-sort"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32230
- msgid "The way in which repositories in each section are sorted."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32235
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} robots-list robots"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32237
- msgid "Text used as content for the @code{robots} meta-tag."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32239
- msgid "Defaults to @samp{(\"noindex\" \"nofollow\")}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32242
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} string root-desc"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32244
- msgid "Text printed below the heading on the repository index page."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32246
- msgid "Defaults to @samp{\"a fast webinterface for the git dscm\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32249
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} string root-readme"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32252
- msgid "The content of the file specified with this option will be included verbatim below the ``about'' link on the repository index page."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32257
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} string root-title"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32259
- msgid "Text printed as heading on the repository index page."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32264
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} boolean scan-hidden-path"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32270
- msgid "If set to @samp{#t} and repository-directory is enabled, repository-directory will recurse into directories whose name starts with a period. Otherwise, repository-directory will stay away from such directories, considered as ``hidden''. Note that this does not apply to the @file{.git} directory in non-bare repos."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32275
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} list snapshots"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32278
- msgid "Text which specifies the default set of snapshot formats that cgit generates links for."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32283
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} repository-directory repository-directory"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32286
- msgid "Name of the directory to scan for repositories (represents @code{scan-path})."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32288
- msgid "Defaults to @samp{\"/srv/git\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32291
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} string section"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32294 guix-git/doc/guix.texi:32610
- msgid "The name of the current repository section - all repositories defined after this option will inherit the current section name."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32299
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} string section-sort"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32302
- msgid "Flag which, when set to @samp{1}, will sort the sections on the repository listing by name."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32307
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} integer section-from-path"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32310
- msgid "A number which, if defined prior to repository-directory, specifies how many path elements from each repo path to use as a default section name."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32315
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} boolean side-by-side-diffs?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32318
- msgid "If set to @samp{#t} shows side-by-side diffs instead of unidiffs per default."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32323
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} file-object source-filter"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32326
- msgid "Specifies a command which will be invoked to format plaintext blobs in the tree view."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32331
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} integer summary-branches"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32334
- msgid "Specifies the number of branches to display in the repository ``summary'' view."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32339
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} integer summary-log"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32342
- msgid "Specifies the number of log entries to display in the repository ``summary'' view."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32347
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} integer summary-tags"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32350
- msgid "Specifies the number of tags to display in the repository ``summary'' view."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32355
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} string strict-export"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32358
- msgid "Filename which, if specified, needs to be present within the repository for cgit to allow access to that repository."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32363
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} string virtual-root"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32365
- msgid "URL which, if specified, will be used as root for all cgit links."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32367
- msgid "Defaults to @samp{\"/\"}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32370
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} repository-cgit-configuration-list repositories"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32372
- msgid "A list of @dfn{cgit-repo} records to use with config."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32376
- msgid "Available @code{repository-cgit-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32377
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} repo-list snapshots"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32380
- msgid "A mask of snapshot formats for this repo that cgit generates links for, restricted by the global @code{snapshots} setting."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32385
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} repo-file-object source-filter"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32387
- msgid "Override the default @code{source-filter}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32392
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} repo-string url"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32394
- msgid "The relative URL used to access the repository."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32399
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} repo-file-object about-filter"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32401
- msgid "Override the default @code{about-filter}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32406
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} repo-string branch-sort"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32409
- msgid "Flag which, when set to @samp{age}, enables date ordering in the branch ref list, and when set to @samp{name} enables ordering by branch name."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32414
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} repo-list clone-url"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32416
- msgid "A list of URLs which can be used to clone repo."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32421
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} repo-file-object commit-filter"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32423
- msgid "Override the default @code{commit-filter}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32428
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} repo-string commit-sort"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32437
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} repo-string defbranch"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32442
- msgid "The name of the default branch for this repository. If no such branch exists in the repository, the first branch name (when sorted) is used as default instead. By default branch pointed to by HEAD, or ``master'' if there is no suitable HEAD."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32447
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} repo-string desc"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32449
- msgid "The value to show as repository description."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32454
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} repo-string homepage"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32456
- msgid "The value to show as repository homepage."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32461
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} repo-file-object email-filter"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32463
- msgid "Override the default @code{email-filter}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32468
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-commit-graph?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32471
- msgid "A flag which can be used to disable the global setting @code{enable-commit-graph?}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32476
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-log-filecount?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32479
- msgid "A flag which can be used to disable the global setting @code{enable-log-filecount?}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32484
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-log-linecount?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32487
- msgid "A flag which can be used to disable the global setting @code{enable-log-linecount?}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32492
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-remote-branches?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32500
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-subject-links?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32503
- msgid "A flag which can be used to override the global setting @code{enable-subject-links?}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32508
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-html-serving?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32511
- msgid "A flag which can be used to override the global setting @code{enable-html-serving?}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32516
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} repo-boolean hide?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32519
- msgid "Flag which, when set to @code{#t}, hides the repository from the repository index."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32524
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} repo-boolean ignore?"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32526
- msgid "Flag which, when set to @samp{#t}, ignores the repository."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32531
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} repo-file-object logo"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32534
- msgid "URL which specifies the source of an image which will be used as a logo on this repo’s pages."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32539
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} repo-string logo-link"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32546
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} repo-file-object owner-filter"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32548
- msgid "Override the default @code{owner-filter}."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32553
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} repo-string module-link"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32557
- msgid "Text which will be used as the formatstring for a hyperlink when a submodule is printed in a directory listing. The arguments for the formatstring are the path and SHA1 of the submodule commit."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32562
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} module-link-path module-link-path"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32566
- msgid "Text which will be used as the formatstring for a hyperlink when a submodule with the specified subdirectory path is printed in a directory listing."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32571
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} repo-string max-stats"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32573
- msgid "Override the default maximum statistics period."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32578
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} repo-string name"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32580
- msgid "The value to show as repository name."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32585
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} repo-string owner"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32587
- msgid "A value used to identify the owner of the repository."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32592
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} repo-string path"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32594
- msgid "An absolute path to the repository directory."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32599
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} repo-string readme"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32602
- msgid "A path (relative to repo) which specifies a file to include verbatim as the ``About'' page for this repo."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32607
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} repo-string section"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32615
- #, no-wrap
- msgid "{@code{repository-cgit-configuration} parameter} repo-list extra-options"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32617 guix-git/doc/guix.texi:32626
- msgid "Extra options will be appended to cgitrc file."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32624
- #, no-wrap
- msgid "{@code{cgit-configuration} parameter} list extra-options"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:32638
- msgid "However, it could be that you just want to get a @code{cgitrc} up and running. In that case, you can pass an @code{opaque-cgit-configuration} as a record to @code{cgit-service-type}. As its name indicates, an opaque configuration does not have easy reflective capabilities."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:32640
- msgid "Available @code{opaque-cgit-configuration} fields are:"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32641
- #, no-wrap
- msgid "{@code{opaque-cgit-configuration} parameter} package cgit"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32643
- msgid "The cgit package."
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32645
- #, no-wrap
- msgid "{@code{opaque-cgit-configuration} parameter} string string"
- msgstr ""
- #. type: deftypevr
- #: guix-git/doc/guix.texi:32647
- msgid "The contents of the @code{cgitrc}, as a string."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:32651
- msgid "For example, if your @code{cgitrc} is just the empty string, you could instantiate a cgit service like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:32656
- #, no-wrap
- msgid ""
- "(service cgit-service-type\n"
- " (opaque-cgit-configuration\n"
- " (cgitrc \"\")))\n"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:32658
- #, no-wrap
- msgid "Gitolite Service"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:32660
- #, no-wrap
- msgid "Gitolite service"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:32661
- #, no-wrap
- msgid "Git, hosting"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:32664
- msgid "@uref{https://gitolite.com/gitolite/, Gitolite} is a tool for hosting Git repositories on a central server."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:32667
- msgid "Gitolite can handle multiple repositories and users, and supports flexible configuration of the permissions for the users on the repositories."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:32670
- msgid "The following example will configure Gitolite using the default @code{git} user, and the provided SSH public key."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:32677
- #, no-wrap
- msgid ""
- "(service gitolite-service-type\n"
- " (gitolite-configuration\n"
- " (admin-pubkey (plain-file\n"
- " \"yourname.pub\"\n"
- " \"ssh-rsa AAAA... guix@@example.com\"))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:32682
- msgid "Gitolite is configured through a special admin repository which you can clone, for example, if you setup Gitolite on @code{example.com}, you would run the following command to clone the admin repository."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:32685
- #, no-wrap
- msgid "git clone git@@example.com:gitolite-admin\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:32691
- msgid "When the Gitolite service is activated, the provided @code{admin-pubkey} will be inserted in to the @file{keydir} directory in the gitolite-admin repository. If this results in a change in the repository, it will be committed using the message ``gitolite setup by GNU Guix''."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:32692
- #, no-wrap
- msgid "{Data Type} gitolite-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:32694
- msgid "Data type representing the configuration for @code{gitolite-service-type}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:32696
- #, no-wrap
- msgid "@code{package} (default: @var{gitolite})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32698
- msgid "Gitolite package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:32699
- #, no-wrap
- msgid "@code{user} (default: @var{git})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32702
- msgid "User to use for Gitolite. This will be user that you use when accessing Gitolite over SSH."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:32703
- #, no-wrap
- msgid "@code{group} (default: @var{git})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32705
- msgid "Group to use for Gitolite."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:32706
- #, no-wrap
- msgid "@code{home-directory} (default: @var{\"/var/lib/gitolite\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32708
- msgid "Directory in which to store the Gitolite configuration and repositories."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:32709
- #, no-wrap
- msgid "@code{rc-file} (default: @var{(gitolite-rc-file)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32712
- msgid "A ``file-like'' object (@pxref{G-Expressions, file-like objects}), representing the configuration for Gitolite."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:32713
- #, no-wrap
- msgid "@code{admin-pubkey} (default: @var{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32717
- msgid "A ``file-like'' object (@pxref{G-Expressions, file-like objects}) used to setup Gitolite. This will be inserted in to the @file{keydir} directory within the gitolite-admin repository."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32719
- msgid "To specify the SSH key as a string, use the @code{plain-file} function."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:32722
- #, no-wrap
- msgid "(plain-file \"yourname.pub\" \"ssh-rsa AAAA... guix@@example.com\")\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:32727
- #, no-wrap
- msgid "{Data Type} gitolite-rc-file"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:32729
- msgid "Data type representing the Gitolite RC file."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:32731
- #, no-wrap
- msgid "@code{umask} (default: @code{#o0077})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32734
- msgid "This controls the permissions Gitolite sets on the repositories and their contents."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32738
- msgid "A value like @code{#o0027} will give read access to the group used by Gitolite (by default: @code{git}). This is necessary when using Gitolite with software like cgit or gitweb."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:32739
- #, no-wrap
- msgid "@code{unsafe-pattern} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32744
- msgid "An optional Perl regular expression for catching unsafe configurations in the configuration file. See @uref{https://gitolite.com/gitolite/git-config.html#compensating-for-unsafe_patt, Gitolite's documentation} for more information."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32751
- msgid "When the value is not @code{#f}, it should be a string containing a Perl regular expression, such as @samp{\"[`~#\\$\\&()|;<>]\"}, which is the default value used by gitolite. It rejects any special character in configuration that might be interpreted by a shell, which is useful when sharing the administration burden with other people that do not otherwise have shell access on the server."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:32752
- #, no-wrap
- msgid "@code{git-config-keys} (default: @code{\"\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32755
- msgid "Gitolite allows you to set git config values using the @samp{config} keyword. This setting allows control over the config keys to accept."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:32756
- #, no-wrap
- msgid "@code{roles} (default: @code{'((\"READERS\" . 1) (\"WRITERS\" . ))})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32758
- msgid "Set the role names allowed to be used by users running the perms command."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:32759
- #, no-wrap
- msgid "@code{enable} (default: @code{'(\"help\" \"desc\" \"info\" \"perms\" \"writable\" \"ssh-authkeys\" \"git-config\" \"daemon\" \"gitweb\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32761
- msgid "This setting controls the commands and features to enable within Gitolite."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:32766
- #, no-wrap
- msgid "Gitile Service"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:32768
- #, no-wrap
- msgid "Gitile service"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:32769
- #, no-wrap
- msgid "Git, forge"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:32772
- msgid "@uref{https://git.lepiller.eu/gitile, Gitile} is a Git forge for viewing public git repository contents from a web browser."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:32778
- msgid "Gitile works best in collaboration with Gitolite, and will serve the public repositories from Gitolite by default. The service should listen only on a local port, and a webserver should be configured to serve static resources. The gitile service provides an easy way to extend the Nginx service for that purpose (@pxref{NGINX})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:32782
- msgid "The following example will configure Gitile to serve repositories from a custom location, with some default messages for the home page and the footers."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:32805
- #, no-wrap
- msgid ""
- "(service gitile-service-type\n"
- " (gitile-configuration\n"
- " (repositories \"/srv/git\")\n"
- " (base-git-url \"https://myweb.site/git\")\n"
- " (index-title \"My git repositories\")\n"
- " (intro '((p \"This is all my public work!\")))\n"
- " (footer '((p \"This is the end\")))\n"
- " (nginx-server-block\n"
- " (nginx-server-configuration\n"
- " (ssl-certificate\n"
- " \"/etc/letsencrypt/live/myweb.site/fullchain.pem\")\n"
- " (ssl-certificate-key\n"
- " \"/etc/letsencrypt/live/myweb.site/privkey.pem\")\n"
- " (listen '(\"443 ssl http2\" \"[::]:443 ssl http2\"))\n"
- " (locations\n"
- " (list\n"
- " ;; Allow for https anonymous fetch on /git/ urls.\n"
- " (git-http-nginx-location-configuration\n"
- " (git-http-configuration\n"
- " (uri-path \"/git/\")\n"
- " (git-root \"/var/lib/gitolite/repositories\")))))))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:32814
- msgid "In addition to the configuration record, you should configure your git repositories to contain some optional information. First, your public repositories need to contain the @file{git-daemon-export-ok} magic file that allows Git to export the repository. Gitile uses the presence of this file to detect public repositories it should make accessible. To do so with Gitolite for instance, modify your @file{conf/gitolite.conf} to include this in the repositories you want to make public:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:32818
- #, no-wrap
- msgid ""
- "repo foo\n"
- " R = daemon\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:32824
- msgid "In addition, Gitile can read the repository configuration to display more information on the repository. Gitile uses the gitweb namespace for its configuration. As an example, you can use the following in your @file{conf/gitolite.conf}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:32831
- #, no-wrap
- msgid ""
- "repo foo\n"
- " R = daemon\n"
- " desc = A long description, optionally with <i>HTML</i>, shown on the index page\n"
- " config gitweb.name = The Foo Project\n"
- " config gitweb.synopsis = A short description, shown on the main page of the project\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:32837
- msgid "Do not forget to commit and push these changes once you are satisfied. You may need to change your gitolite configuration to allow the previous configuration options to be set. One way to do that is to add the following service definition:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:32849
- #, no-wrap
- msgid ""
- "(service gitolite-service-type\n"
- " (gitolite-configuration\n"
- " (admin-pubkey (local-file \"key.pub\"))\n"
- " (rc-file\n"
- " (gitolite-rc-file\n"
- " (umask #o0027)\n"
- " ;; Allow to set any configuration key\n"
- " (git-config-keys \".*\")\n"
- " ;; Allow any text as a valid configuration value\n"
- " (unsafe-patt \"^$\")))))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:32851
- #, no-wrap
- msgid "{Data Type} gitile-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:32853
- msgid "Data type representing the configuration for @code{gitile-service-type}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:32855
- #, no-wrap
- msgid "@code{package} (default: @var{gitile})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32857
- msgid "Gitile package to use."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32860
- msgid "The host on which gitile is listening."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:32861
- #, no-wrap
- msgid "@code{port} (default: @code{8080})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32863
- msgid "The port on which gitile is listening."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:32864
- #, no-wrap
- msgid "@code{database} (default: @code{\"/var/lib/gitile/gitile-db.sql\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32866
- msgid "The location of the database."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:32867
- #, no-wrap
- msgid "@code{repositories} (default: @code{\"/var/lib/gitolite/repositories\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32871
- msgid "The location of the repositories. Note that only public repositories will be shown by Gitile. To make a repository public, add an empty @file{git-daemon-export-ok} file at the root of that repository."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:32872
- #, no-wrap
- msgid "base-git-url"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32874
- msgid "The base git url that will be used to show clone commands."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:32875
- #, no-wrap
- msgid "@code{index-title} (default: @code{\"Index\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32877
- msgid "The page title for the index page that lists all the available repositories."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:32878
- #, no-wrap
- msgid "@code{intro} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32881
- msgid "The intro content, as a list of sxml expressions. This is shown above the list of repositories, on the index page."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:32882
- #, no-wrap
- msgid "@code{footer} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32885
- msgid "The footer content, as a list of sxml expressions. This is shown on every page served by Gitile."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:32886
- #, no-wrap
- msgid "nginx-server-block"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32889
- msgid "An nginx server block that will be extended and used as a reverse proxy by Gitile to serve its pages, and as a normal web server to serve its assets."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32893
- msgid "You can use this block to add more custom URLs to your domain, such as a @code{/git/} URL for anonymous clones, or serving any other files you would like to serve."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:32900
- #, no-wrap
- msgid "The Battle for Wesnoth Service"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:32901
- #, no-wrap
- msgid "wesnothd"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:32905
- msgid "@uref{https://wesnoth.org, The Battle for Wesnoth} is a fantasy, turn based tactical strategy game, with several single player campaigns, and multiplayer games (both networked and local)."
- msgstr ""
- #. type: defvar
- #: guix-git/doc/guix.texi:32906
- #, no-wrap
- msgid "{Scheme Variable} wesnothd-service-type"
- msgstr ""
- #. type: defvar
- #: guix-git/doc/guix.texi:32910
- msgid "Service type for the wesnothd service. Its value must be a @code{wesnothd-configuration} object. To run wesnothd in the default configuration, instantiate it as:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:32913
- #, no-wrap
- msgid "(service wesnothd-service-type)\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:32916
- #, no-wrap
- msgid "{Data Type} wesnothd-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:32918
- msgid "Data type representing the configuration of @command{wesnothd}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:32920
- #, no-wrap
- msgid "@code{package} (default: @code{wesnoth-server})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32922
- msgid "The wesnoth server package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:32923
- #, no-wrap
- msgid "@code{port} (default: @code{15000})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32925
- msgid "The port to bind the server to."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:32931
- #, no-wrap
- msgid "pam-mount"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:32936
- msgid "The @code{(gnu services pam-mount)} module provides a service allowing users to mount volumes when they log in. It should be able to mount any volume format supported by the system."
- msgstr ""
- #. type: defvar
- #: guix-git/doc/guix.texi:32937
- #, no-wrap
- msgid "{Scheme Variable} pam-mount-service-type"
- msgstr ""
- #. type: defvar
- #: guix-git/doc/guix.texi:32939
- msgid "Service type for PAM Mount support."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:32941
- #, no-wrap
- msgid "{Data Type} pam-mount-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:32943
- msgid "Data type representing the configuration of PAM Mount."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:32947
- #, no-wrap
- msgid "rules"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32950
- msgid "The configuration rules that will be used to generate @file{/etc/security/pam_mount.conf.xml}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32954
- msgid "The configuration rules are SXML elements (@pxref{SXML,,, guile, GNU Guile Reference Manual}), and the default ones don't mount anything for anyone at login:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:32969
- #, no-wrap
- msgid ""
- "`((debug (@@ (enable \"0\")))\n"
- " (mntoptions (@@ (allow ,(string-join\n"
- " '(\"nosuid\" \"nodev\" \"loop\"\n"
- " \"encryption\" \"fsck\" \"nonempty\"\n"
- " \"allow_root\" \"allow_other\")\n"
- " \",\"))))\n"
- " (mntoptions (@@ (require \"nosuid,nodev\")))\n"
- " (logout (@@ (wait \"0\")\n"
- " (hup \"0\")\n"
- " (term \"no\")\n"
- " (kill \"no\")))\n"
- " (mkmountpoint (@@ (enable \"1\")\n"
- " (remove \"true\"))))\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:32975
- msgid "Some @code{volume} elements must be added to automatically mount volumes at login. Here's an example allowing the user @code{alice} to mount her encrypted @env{HOME} directory and allowing the user @code{bob} to mount the partition where he stores his data:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:33000
- #, no-wrap
- msgid ""
- "(define pam-mount-rules\n"
- "`((debug (@@ (enable \"0\")))\n"
- " (volume (@@ (user \"alice\")\n"
- " (fstype \"crypt\")\n"
- " (path \"/dev/sda2\")\n"
- " (mountpoint \"/home/alice\")))\n"
- " (volume (@@ (user \"bob\")\n"
- " (fstype \"auto\")\n"
- " (path \"/dev/sdb3\")\n"
- " (mountpoint \"/home/bob/data\")\n"
- " (options \"defaults,autodefrag,compress\")))\n"
- " (mntoptions (@@ (allow ,(string-join\n"
- " '(\"nosuid\" \"nodev\" \"loop\"\n"
- " \"encryption\" \"fsck\" \"nonempty\"\n"
- " \"allow_root\" \"allow_other\")\n"
- " \",\"))))\n"
- " (mntoptions (@@ (require \"nosuid,nodev\")))\n"
- " (logout (@@ (wait \"0\")\n"
- " (hup \"0\")\n"
- " (term \"no\")\n"
- " (kill \"no\")))\n"
- " (mkmountpoint (@@ (enable \"1\")\n"
- " (remove \"true\")))))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:33004
- #, no-wrap
- msgid ""
- "(service pam-mount-service-type\n"
- " (pam-mount-configuration\n"
- " (rules pam-mount-rules)))\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33008
- msgid "The complete list of possible options can be found in the man page for @uref{http://pam-mount.sourceforge.net/pam_mount.conf.5.html, pam_mount.conf}."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:33015
- #, no-wrap
- msgid "Guix Build Coordinator"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33021
- msgid "The @uref{https://git.cbaines.net/guix/build-coordinator/,Guix Build Coordinator} aids in distributing derivation builds among machines running an @dfn{agent}. The build daemon is still used to build the derivations, but the Guix Build Coordinator manages allocating builds and working with the results."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33027
- msgid "The Guix Build Coordinator consists of one @dfn{coordinator}, and one or more connected @dfn{agent} processes. The coordinator process handles clients submitting builds, and allocating builds to agents. The agent processes talk to a build daemon to actually perform the builds, then send the results back to the coordinator."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33031
- msgid "There is a script to run the coordinator component of the Guix Build Coordinator, but the Guix service uses a custom Guile script instead, to provide better integration with G-expressions used in the configuration."
- msgstr ""
- #. type: defvar
- #: guix-git/doc/guix.texi:33032
- #, no-wrap
- msgid "{Scheme Variable} guix-build-coordinator-service-type"
- msgstr ""
- #. type: defvar
- #: guix-git/doc/guix.texi:33035
- msgid "Service type for the Guix Build Coordinator. Its value must be a @code{guix-build-coordinator-configuration} object."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33037
- #, no-wrap
- msgid "{Data Type} guix-build-coordinator-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33039
- msgid "Data type representing the configuration of the Guix Build Coordinator."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33041 guix-git/doc/guix.texi:33211
- #, no-wrap
- msgid "@code{package} (default: @code{guix-build-coordinator})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33043 guix-git/doc/guix.texi:33087
- #: guix-git/doc/guix.texi:33213
- msgid "The Guix Build Coordinator package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33044
- #, no-wrap
- msgid "@code{user} (default: @code{\"guix-build-coordinator\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33046 guix-git/doc/guix.texi:33090
- #: guix-git/doc/guix.texi:33216 guix-git/doc/guix.texi:33262
- msgid "The system user to run the service as."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33047
- #, no-wrap
- msgid "@code{group} (default: @code{\"guix-build-coordinator\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33049 guix-git/doc/guix.texi:33265
- msgid "The system group to run the service as."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33050
- #, no-wrap
- msgid "@code{database-uri-string} (default: @code{\"sqlite:///var/lib/guix-build-coordinator/guix_build_coordinator.db\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33052
- msgid "The URI to use for the database."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33053
- #, no-wrap
- msgid "@code{agent-communication-uri} (default: @code{\"http://0.0.0.0:8745\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33055
- msgid "The URI describing how to listen to requests from agent processes."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33056
- #, no-wrap
- msgid "@code{client-communication-uri} (default: @code{\"http://127.0.0.1:8746\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33060
- msgid "The URI describing how to listen to requests from clients. The client API allows submitting builds and currently isn't authenticated, so take care when configuring this value."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33061
- #, no-wrap
- msgid "@code{allocation-strategy} (default: @code{#~basic-build-allocation-strategy})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33065
- msgid "A G-expression for the allocation strategy to be used. This is a procedure that takes the datastore as an argument and populates the allocation plan in the database."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33066
- #, no-wrap
- msgid "@code{hooks} (default: @var{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33069
- msgid "An association list of hooks. These provide a way to execute arbitrary code upon certain events, like a build result being processed."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33070
- #, no-wrap
- msgid "@code{guile} (default: @code{guile-3.0-latest})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33072
- msgid "The Guile package with which to run the Guix Build Coordinator."
- msgstr ""
- #. type: defvar
- #: guix-git/doc/guix.texi:33076
- #, no-wrap
- msgid "{Scheme Variable} guix-build-coordinator-agent-service-type"
- msgstr ""
- #. type: defvar
- #: guix-git/doc/guix.texi:33079
- msgid "Service type for a Guix Build Coordinator agent. Its value must be a @code{guix-build-coordinator-agent-configuration} object."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33081
- #, no-wrap
- msgid "{Data Type} guix-build-coordinator-agent-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33083
- msgid "Data type representing the configuration a Guix Build Coordinator agent."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33085
- #, no-wrap
- msgid "@code{package} (default: @code{guix-build-coordinator/agent-only})"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33088
- #, no-wrap
- msgid "@code{user} (default: @code{\"guix-build-coordinator-agent\"})"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33091
- #, no-wrap
- msgid "@code{coordinator} (default: @code{\"http://localhost:8745\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33093 guix-git/doc/guix.texi:33219
- msgid "The URI to use when connecting to the coordinator."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:33094
- #, no-wrap
- msgid "authentication"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33097
- msgid "Record describing how this agent should authenticate with the coordinator. Possible record types are described below."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33098 guix-git/doc/guix.texi:33220
- #, no-wrap
- msgid "@code{systems} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33101
- msgid "The systems for which this agent should fetch builds. The agent process will use the current system it's running on as the default."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33102
- #, no-wrap
- msgid "@code{max-parallel-builds} (default: @code{1})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33104
- msgid "The number of builds to perform in parallel."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33105
- #, no-wrap
- msgid "@code{max-1min-load-average} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33109
- msgid "Load average value to look at when considering starting new builds, if the 1 minute load average exceeds this value, the agent will wait before starting new builds."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33113
- msgid "This will be unspecified if the value is @code{#f}, and the agent will use the number of cores reported by the system as the max 1 minute load average."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33114
- #, no-wrap
- msgid "@code{derivation-substitute-urls} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33117
- msgid "URLs from which to attempt to fetch substitutes for derivations, if the derivations aren't already available."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33118
- #, no-wrap
- msgid "@code{non-derivation-substitute-urls} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33121
- msgid "URLs from which to attempt to fetch substitutes for build inputs, if the input store items aren't already available."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33125
- #, no-wrap
- msgid "{Data Type} guix-build-coordinator-agent-password-auth"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33128
- msgid "Data type representing an agent authenticating with a coordinator via a UUID and password."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33134 guix-git/doc/guix.texi:33150
- msgid "The UUID of the agent. This should be generated by the coordinator process, stored in the coordinator database, and used by the intended agent."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33137
- msgid "The password to use when connecting to the coordinator."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33141
- #, no-wrap
- msgid "{Data Type} guix-build-coordinator-agent-password-file-auth"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33144
- msgid "Data type representing an agent authenticating with a coordinator via a UUID and password read from a file."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:33151
- #, no-wrap
- msgid "password-file"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33154
- msgid "A file containing the password to use when connecting to the coordinator."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33158
- #, no-wrap
- msgid "{Data Type} guix-build-coordinator-agent-dynamic-auth"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33161
- msgid "Data type representing an agent authenticating with a coordinator via a dynamic auth token and agent name."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:33163 guix-git/doc/guix.texi:33180
- #, fuzzy, no-wrap
- msgid "agent-name"
- msgstr "نام بسته"
- #. type: table
- #: guix-git/doc/guix.texi:33167 guix-git/doc/guix.texi:33184
- msgid "Name of an agent, this is used to match up to an existing entry in the database if there is one. When no existing entry is found, a new entry is automatically added."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:33168
- #, no-wrap
- msgid "token"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33171
- msgid "Dynamic auth token, this is created and stored in the coordinator database, and is used by the agent to authenticate."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33175
- #, no-wrap
- msgid "{Data Type} guix-build-coordinator-agent-dynamic-auth-with-file"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33178
- msgid "Data type representing an agent authenticating with a coordinator via a dynamic auth token read from a file and agent name."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:33185
- #, no-wrap
- msgid "token-file"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33188
- msgid "File containing the dynamic auth token, this is created and stored in the coordinator database, and is used by the agent to authenticate."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33198
- msgid "The Guix Build Coordinator package contains a script to query an instance of the Guix Data Service for derivations to build, and then submit builds for those derivations to the coordinator. The service type below assists in running this script. This is an additional tool that may be useful when building derivations contained within an instance of the Guix Data Service."
- msgstr ""
- #. type: defvar
- #: guix-git/doc/guix.texi:33199
- #, no-wrap
- msgid "{Scheme Variable} guix-build-coordinator-queue-builds-service-type"
- msgstr ""
- #. type: defvar
- #: guix-git/doc/guix.texi:33204
- msgid "Service type for the guix-build-coordinator-queue-builds-from-guix-data-service script. Its value must be a @code{guix-build-coordinator-queue-builds-configuration} object."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33206
- #, no-wrap
- msgid "{Data Type} guix-build-coordinator-queue-builds-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33209
- msgid "Data type representing the options to the queue builds from guix data service script."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33214
- #, no-wrap
- msgid "@code{user} (default: @code{\"guix-build-coordinator-queue-builds\"})"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33217
- #, no-wrap
- msgid "@code{coordinator} (default: @code{\"http://localhost:8746\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33222
- msgid "The systems for which to fetch derivations to build."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33223
- #, no-wrap
- msgid "@code{systems-and-targets} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33226
- msgid "An association list of system and target pairs for which to fetch derivations to build."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33227
- #, no-wrap
- msgid "@code{guix-data-service} (default: @code{\"https://data.guix.gnu.org\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33230
- msgid "The Guix Data Service instance from which to query to find out about derivations to build."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33231
- #, no-wrap
- msgid "@code{processed-commits-file} (default: @code{\"/var/cache/guix-build-coordinator-queue-builds/processed-commits\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33234
- msgid "A file to record which commits have been processed, to avoid needlessly processing them again if the service is restarted."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:33238
- #, no-wrap
- msgid "Guix Data Service"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33242
- msgid "The @uref{http://data.guix.gnu.org,Guix Data Service} processes, stores and provides data about GNU Guix. This includes information about packages, derivations and lint warnings."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33245
- msgid "The data is stored in a PostgreSQL database, and available through a web interface."
- msgstr ""
- #. type: defvar
- #: guix-git/doc/guix.texi:33246
- #, no-wrap
- msgid "{Scheme Variable} guix-data-service-type"
- msgstr ""
- #. type: defvar
- #: guix-git/doc/guix.texi:33251
- msgid "Service type for the Guix Data Service. Its value must be a @code{guix-data-service-configuration} object. The service optionally extends the getmail service, as the guix-commits mailing list is used to find out about changes in the Guix git repository."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33253
- #, no-wrap
- msgid "{Data Type} guix-data-service-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33255
- msgid "Data type representing the configuration of the Guix Data Service."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33257
- #, no-wrap
- msgid "@code{package} (default: @code{guix-data-service})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33259
- msgid "The Guix Data Service package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33260
- #, no-wrap
- msgid "@code{user} (default: @code{\"guix-data-service\"})"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33263
- #, no-wrap
- msgid "@code{group} (default: @code{\"guix-data-service\"})"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33266
- #, no-wrap
- msgid "@code{port} (default: @code{8765})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33268
- msgid "The port to bind the web service to."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33269
- #, no-wrap
- msgid "@code{host} (default: @code{\"127.0.0.1\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33271
- msgid "The host to bind the web service to."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33272
- #, no-wrap
- msgid "@code{getmail-idle-mailboxes} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33275
- msgid "If set, this is the list of mailboxes that the getmail service will be configured to listen to."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33276
- #, no-wrap
- msgid "@code{commits-getmail-retriever-configuration} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33280
- msgid "If set, this is the @code{getmail-retriever-configuration} object with which to configure getmail to fetch mail from the guix-commits mailing list."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33281
- #, no-wrap
- msgid "@code{extra-options} (default: @var{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33283
- msgid "Extra command line options for @code{guix-data-service}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33284
- #, no-wrap
- msgid "@code{extra-process-jobs-options} (default: @var{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33286
- msgid "Extra command line options for @code{guix-data-service-process-jobs}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:33293
- #, no-wrap
- msgid "oom"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:33294
- #, no-wrap
- msgid "out of memory killer"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:33295
- #, no-wrap
- msgid "earlyoom"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:33296
- #, no-wrap
- msgid "early out of memory daemon"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:33297
- #, no-wrap
- msgid "Early OOM Service"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33304
- msgid "@uref{https://github.com/rfjakob/earlyoom,Early OOM}, also known as Earlyoom, is a minimalist out of memory (OOM) daemon that runs in user space and provides a more responsive and configurable alternative to the in-kernel OOM killer. It is useful to prevent the system from becoming unresponsive when it runs out of memory."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:33305
- #, no-wrap
- msgid "{Scheme Variable} earlyoom-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:33310
- msgid "The service type for running @command{earlyoom}, the Early OOM daemon. Its value must be a @code{earlyoom-configuration} object, described below. The service can be instantiated in its default configuration with:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:33313
- #, no-wrap
- msgid "(service earlyoom-service-type)\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33316
- #, no-wrap
- msgid "{Data Type} earlyoom-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33318
- msgid "This is the configuration record for the @code{earlyoom-service-type}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33320
- #, no-wrap
- msgid "@code{earlyoom} (default: @var{earlyoom})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33322
- msgid "The Earlyoom package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33323
- #, no-wrap
- msgid "@code{minimum-available-memory} (default: @code{10})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33325
- msgid "The threshold for the minimum @emph{available} memory, in percentages."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33326
- #, no-wrap
- msgid "@code{minimum-free-swap} (default: @code{10})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33328
- msgid "The threshold for the minimum free swap memory, in percentages."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33329
- #, no-wrap
- msgid "@code{prefer-regexp} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33332
- msgid "A regular expression (as a string) to match the names of the processes that should be preferably killed."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33333
- #, no-wrap
- msgid "@code{avoid-regexp} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33336
- msgid "A regular expression (as a string) to match the names of the processes that should @emph{not} be killed."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33337
- #, no-wrap
- msgid "@code{memory-report-interval} (default: @code{0})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33340
- msgid "The interval in seconds at which a memory report is printed. It is disabled by default."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33341
- #, no-wrap
- msgid "@code{ignore-positive-oom-score-adj?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33344
- msgid "A boolean indicating whether the positive adjustments set in @file{/proc/*/oom_score_adj} should be ignored."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33345
- #, no-wrap
- msgid "@code{show-debug-messages?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33348
- msgid "A boolean indicating whether debug messages should be printed. The logs are saved at @file{/var/log/earlyoom.log}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33349
- #, no-wrap
- msgid "@code{send-notification-command} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33352
- msgid "This can be used to provide a custom command used for sending notifications."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:33355
- #, no-wrap
- msgid "modprobe"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:33356
- #, no-wrap
- msgid "kernel module loader"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:33357
- #, no-wrap
- msgid "Kernel Module Loader Service"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33363
- msgid "The kernel module loader service allows one to load loadable kernel modules at boot. This is especially useful for modules that don't autoload and need to be manually loaded, as is the case with @code{ddcci}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:33364
- #, no-wrap
- msgid "{Scheme Variable} kernel-module-loader-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:33370
- msgid "The service type for loading loadable kernel modules at boot with @command{modprobe}. Its value must be a list of strings representing module names. For example loading the drivers provided by @code{ddcci-driver-linux}, in debugging mode by passing some module parameters, can be done as follow:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:33375
- #, no-wrap
- msgid ""
- "(use-modules (gnu) (gnu services))\n"
- "(use-package-modules linux)\n"
- "(use-service-modules linux)\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:33379
- #, no-wrap
- msgid ""
- "(define ddcci-config\n"
- " (plain-file \"ddcci.conf\"\n"
- " \"options ddcci dyndbg delay=120\"))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:33389
- #, no-wrap
- msgid ""
- "(operating-system\n"
- " ...\n"
- " (services (cons* (service kernel-module-loader-service-type\n"
- " '(\"ddcci\" \"ddcci_backlight\"))\n"
- " (simple-service 'ddcci-config etc-service-type\n"
- " (list `(\"modprobe.d/ddcci.conf\"\n"
- " ,ddcci-config)))\n"
- " %base-services))\n"
- " (kernel-loadable-modules (list ddcci-driver-linux)))\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:33392
- #, no-wrap
- msgid "rasdaemon"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:33393
- #, no-wrap
- msgid "Platform Reliability, Availability and Serviceability daemon"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:33394
- #, no-wrap
- msgid "Rasdaemon Service"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33399
- msgid "The Rasdaemon service provides a daemon which monitors platform @acronym{RAS, Reliability@comma{} Availability@comma{} and Serviceability} reports from Linux kernel trace events, logging them to syslogd."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33402
- msgid "Reliability, Availability and Serviceability is a concept used on servers meant to measure their robustness."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33405
- msgid "@strong{Relability} is the probability that a system will produce correct outputs:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33407
- #, no-wrap
- msgid "Generally measured as Mean Time Between Failures (MTBF), and"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33408
- #, no-wrap
- msgid "Enhanced by features that help to avoid, detect and repair hardware"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:33410
- msgid "faults"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33414
- msgid "@strong{Availability} is the probability that a system is operational at a given time:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33416
- #, no-wrap
- msgid "Generally measured as a percentage of downtime per a period of time, and"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33417
- #, no-wrap
- msgid "Often uses mechanisms to detect and correct hardware faults in runtime."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33422
- msgid "@strong{Serviceability} is the simplicity and speed with which a system can be repaired or maintained:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33424
- #, no-wrap
- msgid "Generally measured on Mean Time Between Repair (MTBR)."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33429
- msgid "Among the monitoring measures, the most usual ones include:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33431
- #, no-wrap
- msgid "CPU – detect errors at instruction execution and at L1/L2/L3 caches;"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33432
- #, no-wrap
- msgid "Memory – add error correction logic (ECC) to detect and correct errors;"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33433
- #, no-wrap
- msgid "I/O – add CRC checksums for transferred data;"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33434
- #, no-wrap
- msgid "Storage – RAID, journal file systems, checksums, Self-Monitoring,"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:33436
- msgid "Analysis and Reporting Technology (SMART)."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33442
- msgid "By monitoring the number of occurrences of error detections, it is possible to identify if the probability of hardware errors is increasing, and, on such case, do a preventive maintenance to replace a degraded component while those errors are correctable."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33446
- msgid "For detailed information about the types of error events gathered and how to make sense of them, see the kernel administrator's guide at @url{https://www.kernel.org/doc/html/latest/admin-guide/ras.html}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33447
- #, no-wrap
- msgid "{Scheme Variable} rasdaemon-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33450
- msgid "Service type for the @command{rasdaemon} service. It accepts a @code{rasdaemon-configuration} object. Instantiating like"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:33453
- #, no-wrap
- msgid "(service rasdaemon-service-type)\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33457
- msgid "will load with a default configuration, which monitors all events and logs to syslogd."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33459
- #, no-wrap
- msgid "{Data Type} rasdaemon-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33461
- msgid "The data type representing the configuration of @command{rasdaemon}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33463
- #, no-wrap
- msgid "@code{record?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33468
- msgid "A boolean indicating whether to record the events in an SQLite database. This provides a more structured access to the information contained in the log file. The database location is hard-coded to @file{/var/lib/rasdaemon/ras-mc_event.db}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:33472
- #, no-wrap
- msgid "zram"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:33473
- #, no-wrap
- msgid "compressed swap"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:33474
- #, no-wrap
- msgid "Compressed RAM-based block devices"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:33475
- #, no-wrap
- msgid "Zram Device Service"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33481
- msgid "The Zram device service provides a compressed swap device in system memory. The Linux Kernel documentation has more information about @uref{https://www.kernel.org/doc/html/latest/admin-guide/blockdev/zram.html,zram} devices."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:33482
- #, no-wrap
- msgid "{Scheme Variable} zram-device-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:33486
- msgid "This service creates the zram block device, formats it as swap and enables it as a swap device. The service's value is a @code{zram-device-configuration} record."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33487
- #, no-wrap
- msgid "{Data Type} zram-device-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33490
- msgid "This is the data type representing the configuration for the zram-device service."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33492
- #, no-wrap
- msgid "@code{size} (default @code{\"1G\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33496
- msgid "This is the amount of space you wish to provide for the zram device. It accepts a string and can be a number of bytes or use a suffix, eg.: @code{\"512M\"} or @code{1024000}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33496
- #, no-wrap
- msgid "@code{compression-algorithm} (default @code{'lzo})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33500
- msgid "This is the compression algorithm you wish to use. It is difficult to list all the possible compression options, but common ones supported by Guix's Linux Libre Kernel include @code{'lzo}, @code{'lz4} and @code{'zstd}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33500
- #, no-wrap
- msgid "@code{memory-limit} (default @code{0})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33507
- msgid "This is the maximum amount of memory which the zram device can use. Setting it to '0' disables the limit. While it is generally expected that compression will be 2:1, it is possible that uncompressable data can be written to swap and this is a method to limit how much memory can be used. It accepts a string and can be a number of bytes or use a suffix, eg.: @code{\"2G\"}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33507
- #, no-wrap
- msgid "@code{priority} (default @code{-1})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33512
- msgid "This is the priority of the swap device created from the zram device. @code{swapon} accepts values between -1 and 32767, with higher values indicating higher priority. Higher priority swap will generally be used first."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33520
- #, no-wrap
- msgid "{Scheme Variable} hurd-console-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33522
- msgid "This service starts the fancy @code{VGA} console client on the Hurd."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33524
- msgid "The service's value is a @code{hurd-console-configuration} record."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33526
- #, no-wrap
- msgid "{Data Type} hurd-console-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33529
- msgid "This is the data type representing the configuration for the hurd-console-service."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33531 guix-git/doc/guix.texi:33547
- #, no-wrap
- msgid "@code{hurd} (default: @var{hurd})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33533 guix-git/doc/guix.texi:33549
- msgid "The Hurd package to use."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33536
- #, no-wrap
- msgid "{Scheme Variable} hurd-getty-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33538
- msgid "This service starts a tty using the Hurd @code{getty} program."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33540
- msgid "The service's value is a @code{hurd-getty-configuration} record."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33542
- #, no-wrap
- msgid "{Data Type} hurd-getty-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33545
- msgid "This is the data type representing the configuration for the hurd-getty-service."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33552
- msgid "The name of the console this Getty runs on---e.g., @code{\"tty1\"}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33553
- #, no-wrap
- msgid "@code{baud-rate} (default: @code{38400})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33555
- msgid "An integer specifying the baud rate of the tty."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:33562
- #, no-wrap
- msgid "fingerprint"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:33563
- #, no-wrap
- msgid "Fingerprint Service"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33567
- msgid "The @code{(gnu services authentication)} module provides a DBus service to read and identify fingerprints via a fingerprint sensor."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33568
- #, no-wrap
- msgid "{Scheme Variable} fprintd-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33571
- msgid "The service type for @command{fprintd}, which provides the fingerprint reading capability."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:33574
- #, no-wrap
- msgid "(service fprintd-service-type)\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:33577
- #, no-wrap
- msgid "sysctl"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:33578
- #, no-wrap
- msgid "System Control Service"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33582
- msgid "The @code{(gnu services sysctl)} provides a service to configure kernel parameters at boot."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33583
- #, no-wrap
- msgid "{Scheme Variable} sysctl-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33587
- msgid "The service type for @command{sysctl}, which modifies kernel parameters under @file{/proc/sys/}. To enable IPv4 forwarding, it can be instantiated as:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:33592
- #, no-wrap
- msgid ""
- "(service sysctl-service-type\n"
- " (sysctl-configuration\n"
- " (settings '((\"net.ipv4.ip_forward\" . \"1\")))))\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33599
- msgid "Since @code{sysctl-service-type} is used in the default lists of services, @code{%base-services} and @code{%desktop-services}, you can use @code{modify-services} to change its configuration and add the kernel parameters that you want (@pxref{Service Reference, @code{modify-services}})."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:33606
- #, no-wrap
- msgid ""
- "(modify-services %base-services\n"
- " (sysctl-service-type config =>\n"
- " (sysctl-configuration\n"
- " (settings (append '((\"net.ipv4.ip_forward\" . \"1\"))\n"
- " %default-sysctl-settings)))))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33610
- #, no-wrap
- msgid "{Data Type} sysctl-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33612
- msgid "The data type representing the configuration of @command{sysctl}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33614
- #, no-wrap
- msgid "@code{sysctl} (default: @code{(file-append procps \"/sbin/sysctl\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33616
- msgid "The @command{sysctl} executable to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33617
- #, no-wrap
- msgid "@code{settings} (default: @code{%default-sysctl-settings})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33619
- msgid "An association list specifies kernel parameters and their values."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33622
- #, no-wrap
- msgid "{Scheme Variable} %default-sysctl-settings"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33625
- msgid "An association list specifying the default @command{sysctl} parameters on Guix System."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:33627
- #, no-wrap
- msgid "pcscd"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:33628
- #, no-wrap
- msgid "PC/SC Smart Card Daemon Service"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33635
- msgid "The @code{(gnu services security-token)} module provides the following service to run @command{pcscd}, the PC/SC Smart Card Daemon. @command{pcscd} is the daemon program for pcsc-lite and the MuscleCard framework. It is a resource manager that coordinates communications with smart card readers, smart cards and cryptographic tokens that are connected to the system."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33636
- #, no-wrap
- msgid "{Scheme Variable} pcscd-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33640
- msgid "Service type for the @command{pcscd} service. Its value must be a @code{pcscd-configuration} object. To run pcscd in the default configuration, instantiate it as:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:33643
- #, no-wrap
- msgid "(service pcscd-service-type)\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33646
- #, no-wrap
- msgid "{Data Type} pcscd-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33648
- msgid "The data type representing the configuration of @command{pcscd}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33650
- #, no-wrap
- msgid "@code{pcsc-lite} (default: @code{pcsc-lite})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33652
- msgid "The pcsc-lite package that provides pcscd."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33652
- #, no-wrap
- msgid "@code{usb-drivers} (default: @code{(list ccid)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33655
- msgid "List of packages that provide USB drivers to pcscd. Drivers are expected to be under @file{pcsc/drivers} in the store directory of the package."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:33658
- #, no-wrap
- msgid "lirc"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:33659
- #, no-wrap
- msgid "Lirc Service"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33662
- msgid "The @code{(gnu services lirc)} module provides the following service."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:33663
- #, no-wrap
- msgid "{Scheme Procedure} lirc-service [#:lirc lirc] @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:33668
- msgid "[#:device #f] [#:driver #f] [#:config-file #f] @ [#:extra-options '()] Return a service that runs @url{http://www.lirc.org,LIRC}, a daemon that decodes infrared signals from remote controls."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:33672
- msgid "Optionally, @var{device}, @var{driver} and @var{config-file} (configuration file name) may be specified. See @command{lircd} manual for details."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:33675
- msgid "Finally, @var{extra-options} is a list of additional command-line options passed to @command{lircd}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:33677
- #, no-wrap
- msgid "spice"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:33678
- #, no-wrap
- msgid "Spice Service"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33681
- msgid "The @code{(gnu services spice)} module provides the following service."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:33682
- #, no-wrap
- msgid "{Scheme Procedure} spice-vdagent-service [#:spice-vdagent]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:33686
- msgid "Returns a service that runs @url{https://www.spice-space.org,VDAGENT}, a daemon that enables sharing the clipboard with a vm and setting the guest display resolution when the graphical console window resizes."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:33688
- #, no-wrap
- msgid "inputattach"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:33689
- #, no-wrap
- msgid "inputattach Service"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:33691
- #, no-wrap
- msgid "tablet input, for Xorg"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:33692
- #, no-wrap
- msgid "touchscreen input, for Xorg"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33696
- msgid "The @uref{https://linuxwacom.github.io/, inputattach} service allows you to use input devices such as Wacom tablets, touchscreens, or joysticks with the Xorg display server."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:33697
- #, no-wrap
- msgid "{Scheme Variable} inputattach-service-type"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:33700
- msgid "Type of a service that runs @command{inputattach} on a device and dispatches events from it."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33702
- #, no-wrap
- msgid "{Data Type} inputattach-configuration"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33704
- #, no-wrap
- msgid "@code{device-type} (default: @code{\"wacom\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33707
- msgid "The type of device to connect to. Run @command{inputattach --help}, from the @code{inputattach} package, to see the list of supported device types."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33708
- #, no-wrap
- msgid "@code{device} (default: @code{\"/dev/ttyS0\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33710
- msgid "The device file to connect to the device."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33714
- msgid "Baud rate to use for the serial connection. Should be a number or @code{#f}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33715
- #, no-wrap
- msgid "@code{log-file} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33717
- msgid "If true, this must be the name of a file to log messages to."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:33720
- #, no-wrap
- msgid "Dictionary Service"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:33721
- #, no-wrap
- msgid "dictionary"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33723
- msgid "The @code{(gnu services dict)} module provides the following service:"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33724
- #, no-wrap
- msgid "{Scheme Variable} dicod-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33727
- msgid "This is the type of the service that runs the @command{dicod} daemon, an implementation of DICT server (@pxref{Dicod,,, dico, GNU Dico Manual})."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:33729
- #, no-wrap
- msgid "{Scheme Procedure} dicod-service [#:config (dicod-configuration)]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:33732
- msgid "Return a service that runs the @command{dicod} daemon, an implementation of DICT server (@pxref{Dicod,,, dico, GNU Dico Manual})."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:33736
- msgid "The optional @var{config} argument specifies the configuration for @command{dicod}, which should be a @code{<dicod-configuration>} object, by default it serves the GNU Collaborative International Dictionary of English."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:33740
- msgid "You can add @command{open localhost} to your @file{~/.dico} file to make @code{localhost} the default server for @command{dico} client (@pxref{Initialization File,,, dico, GNU Dico Manual})."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33742
- #, no-wrap
- msgid "{Data Type} dicod-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33744
- msgid "Data type representing the configuration of dicod."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33746
- #, no-wrap
- msgid "@code{dico} (default: @var{dico})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33748
- msgid "Package object of the GNU Dico dictionary server."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33749
- #, no-wrap
- msgid "@code{interfaces} (default: @var{'(\"localhost\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33753
- msgid "This is the list of IP addresses and ports and possibly socket file names to listen to (@pxref{Server Settings, @code{listen} directive,, dico, GNU Dico Manual})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33754
- #, no-wrap
- msgid "@code{handlers} (default: @var{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33756
- msgid "List of @code{<dicod-handler>} objects denoting handlers (module instances)."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33757
- #, no-wrap
- msgid "@code{databases} (default: @var{(list %dicod-database:gcide)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33759
- msgid "List of @code{<dicod-database>} objects denoting dictionaries to be served."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33762
- #, no-wrap
- msgid "{Data Type} dicod-handler"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33764
- msgid "Data type representing a dictionary handler (module instance)."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33768
- msgid "Name of the handler (module instance)."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33769
- #, no-wrap
- msgid "@code{module} (default: @var{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33773
- msgid "Name of the dicod module of the handler (instance). If it is @code{#f}, the module has the same name as the handler. (@pxref{Modules,,, dico, GNU Dico Manual})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33776
- msgid "List of strings or gexps representing the arguments for the module handler"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33779
- #, no-wrap
- msgid "{Data Type} dicod-database"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33781
- msgid "Data type representing a dictionary database."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33785
- msgid "Name of the database, will be used in DICT commands."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:33786
- #, no-wrap
- msgid "handler"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33789
- msgid "Name of the dicod handler (module instance) used by this database (@pxref{Handlers,,, dico, GNU Dico Manual})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33790
- #, no-wrap
- msgid "@code{complex?} (default: @var{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33793
- msgid "Whether the database configuration complex. The complex configuration will need a corresponding @code{<dicod-handler>} object, otherwise not."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33797
- msgid "List of strings or gexps representing the arguments for the database (@pxref{Databases,,, dico, GNU Dico Manual})."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33800
- #, no-wrap
- msgid "{Scheme Variable} %dicod-database:gcide"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33803
- msgid "A @code{<dicod-database>} object serving the GNU Collaborative International Dictionary of English using the @code{gcide} package."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33806
- msgid "The following is an example @code{dicod-service} configuration."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:33821
- #, no-wrap
- msgid ""
- "(dicod-service #:config\n"
- " (dicod-configuration\n"
- " (handlers (list (dicod-handler\n"
- " (name \"wordnet\")\n"
- " (module \"dictorg\")\n"
- " (options\n"
- " (list #~(string-append \"dbdir=\" #$wordnet))))))\n"
- " (databases (list (dicod-database\n"
- " (name \"wordnet\")\n"
- " (complex? #t)\n"
- " (handler \"wordnet\")\n"
- " (options '(\"database=wn\")))\n"
- " %dicod-database:gcide))))\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:33823
- #, no-wrap
- msgid "Docker"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:33824
- #, no-wrap
- msgid "Docker Service"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33827
- msgid "The @code{(gnu services docker)} module provides the following services."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33828
- #, no-wrap
- msgid "{Scheme Variable} docker-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33833
- msgid "This is the type of the service that runs @url{https://www.docker.com,Docker}, a daemon that can execute application bundles (sometimes referred to as ``containers'') in isolated environments."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33836
- #, no-wrap
- msgid "{Data Type} docker-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33838
- msgid "This is the data type representing the configuration of Docker and Containerd."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33841
- #, no-wrap
- msgid "@code{docker} (default: @code{docker})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33843
- msgid "The Docker daemon package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33844
- #, no-wrap
- msgid "@code{docker-cli} (default: @code{docker-cli})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33846
- msgid "The Docker client package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33847
- #, no-wrap
- msgid "@code{containerd} (default: @var{containerd})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33849
- msgid "The Containerd package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33850
- #, no-wrap
- msgid "@code{proxy} (default @var{docker-libnetwork-cmd-proxy})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33852
- msgid "The Docker user-land networking proxy package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33853
- #, no-wrap
- msgid "@code{enable-proxy?} (default @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33855
- msgid "Enable or disable the use of the Docker user-land networking proxy."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33856
- #, no-wrap
- msgid "@code{debug?} (default @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33858
- msgid "Enable or disable debug output."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33859
- #, no-wrap
- msgid "@code{enable-iptables?} (default @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33861
- msgid "Enable or disable the addition of iptables rules."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33862
- #, no-wrap
- msgid "@code{environment-variables} (default: @code{()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33864
- msgid "List of environment variables to set for @command{dockerd}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33867
- msgid "This must be a list of strings where each string has the form @samp{@var{key}=@var{value}} as in this example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:33871
- #, no-wrap
- msgid ""
- "(list \"LANGUAGE=eo:ca:eu\"\n"
- " \"TMPDIR=/tmp/dockerd\")\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:33876
- #, no-wrap
- msgid "Singularity, container service"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33877
- #, no-wrap
- msgid "{Scheme Variable} singularity-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33882
- msgid "This is the type of the service that allows you to run @url{https://www.sylabs.io/singularity/, Singularity}, a Docker-style tool to create and run application bundles (aka. ``containers''). The value for this service is the Singularity package to use."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33886
- msgid "The service does not install a daemon; instead, it installs helper programs as setuid-root (@pxref{Setuid Programs}) such that unprivileged users can invoke @command{singularity run} and similar commands."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:33888
- #, no-wrap
- msgid "Audit"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:33889
- #, no-wrap
- msgid "Auditd Service"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33892
- msgid "The @code{(gnu services auditd)} module provides the following service."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33893
- #, no-wrap
- msgid "{Scheme Variable} auditd-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33898
- msgid "This is the type of the service that runs @url{https://people.redhat.com/sgrubb/audit/,auditd}, a daemon that tracks security-relevant information on your system."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33900
- msgid "Examples of things that can be tracked:"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:33904
- msgid "File accesses"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:33906
- msgid "System calls"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:33908
- msgid "Invoked commands"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:33910
- msgid "Failed login attempts"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:33912
- msgid "Firewall filtering"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:33914
- msgid "Network access"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33925
- msgid "@command{auditctl} from the @code{audit} package can be used in order to add or remove events to be tracked (until the next reboot). In order to permanently track events, put the command line arguments of auditctl into a file called @code{audit.rules} in the configuration directory (see below). @command{aureport} from the @code{audit} package can be used in order to view a report of all recorded events. The audit daemon by default logs into the file @file{/var/log/audit.log}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33928
- #, no-wrap
- msgid "{Data Type} auditd-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33930
- msgid "This is the data type representing the configuration of auditd."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33933
- #, no-wrap
- msgid "@code{audit} (default: @code{audit})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33935
- msgid "The audit package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33936
- #, no-wrap
- msgid "@code{configuration-directory} (default: @code{%default-auditd-configuration-directory})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33940
- msgid "The directory containing the configuration file for the audit package, which must be named @code{auditd.conf}, and optionally some audit rules to instantiate on startup."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:33944
- #, no-wrap
- msgid "rshiny"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:33945
- #, no-wrap
- msgid "R-Shiny service"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33948
- msgid "The @code{(gnu services science)} module provides the following service."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33949
- #, no-wrap
- msgid "{Scheme Variable} rshiny-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33954
- msgid "This is a type of service which is used to run a webapp created with @code{r-shiny}. This service sets the @env{R_LIBS_USER} environment variable and runs the provided script to call @code{runApp}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33955
- #, no-wrap
- msgid "{Data Type} rshiny-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:33957
- msgid "This is the data type representing the configuration of rshiny."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33960
- #, no-wrap
- msgid "@code{package} (default: @code{r-shiny})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33962
- msgid "The package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:33963
- #, no-wrap
- msgid "@code{binary} (defaunlt @code{\"rshiny\"})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33966
- msgid "The name of the binary or shell script located at @code{package/bin/} to run when the service is run."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:33968
- msgid "The common way to create this file is as follows:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:33985
- #, no-wrap
- msgid ""
- "@dots{}\n"
- "(let* ((out (assoc-ref %outputs \"out\"))\n"
- " (targetdir (string-append out \"/share/\" ,name))\n"
- " (app (string-append out \"/bin/\" ,name))\n"
- " (Rbin (search-input-file %build-inputs \"/bin/Rscript\")))\n"
- " ;; @dots{}\n"
- " (mkdir-p (string-append out \"/bin\"))\n"
- " (call-with-output-file app\n"
- " (lambda (port)\n"
- " (format port\n"
- "\"#!~a\n"
- "library(shiny)\n"
- "setwd(\\\"~a\\\")\n"
- "runApp(launch.browser=0, port=4202)~%\\n\"\n"
- " Rbin targetdir))))\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:33991
- #, no-wrap
- msgid "Nix"
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:33992
- #, no-wrap
- msgid "Nix service"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:33995
- msgid "The @code{(gnu services nix)} module provides the following service."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:33996
- #, no-wrap
- msgid "{Scheme Variable} nix-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:34001
- msgid "This is the type of the service that runs build daemon of the @url{https://nixos.org/nix/, Nix} package manager. Here is an example showing how to use it:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:34006
- #, no-wrap
- msgid ""
- "(use-modules (gnu))\n"
- "(use-service-modules nix)\n"
- "(use-package-modules package-management)\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:34011
- #, no-wrap
- msgid ""
- "(operating-system\n"
- " ;; @dots{}\n"
- " (packages (append (list nix)\n"
- " %base-packages))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:34014
- #, no-wrap
- msgid ""
- " (services (append (list (service nix-service-type))\n"
- " %base-services)))\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:34017
- msgid "After @command{guix system reconfigure} configure Nix for your user:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34019
- #, no-wrap
- msgid "Add a Nix channel and update it. See"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:34021
- msgid "@url{https://nixos.org/nix/manual/, Nix Package Manager Guide}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34022
- #, no-wrap
- msgid "Create a symlink to your profile and activate Nix profile:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:34028
- #, no-wrap
- msgid ""
- "$ ln -s \"/nix/var/nix/profiles/per-user/$USER/profile\" ~/.nix-profile\n"
- "$ source /run/current-system/profile/etc/profile.d/nix.sh\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:34032
- #, no-wrap
- msgid "{Data Type} nix-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:34034
- msgid "This data type represents the configuration of the Nix daemon."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34036
- #, no-wrap
- msgid "@code{nix} (default: @code{nix})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34038
- msgid "The Nix package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34039
- #, no-wrap
- msgid "@code{sandbox} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34041
- msgid "Specifies whether builds are sandboxed by default."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34042
- #, no-wrap
- msgid "@code{build-sandbox-items} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34045
- msgid "This is a list of strings or objects appended to the @code{build-sandbox-items} field of the configuration file."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34053
- msgid "Extra command line options for @code{nix-service-type}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:34059
- #, no-wrap
- msgid "setuid programs"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34069
- msgid "Some programs need to run with ``root'' privileges, even when they are launched by unprivileged users. A notorious example is the @command{passwd} program, which users can run to change their password, and which needs to access the @file{/etc/passwd} and @file{/etc/shadow} files---something normally restricted to root, for obvious security reasons. To address that, these executables are @dfn{setuid-root}, meaning that they always run with root privileges (@pxref{How Change Persona,,, libc, The GNU C Library Reference Manual}, for more info about the setuid mechanism)."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34076
- msgid "The store itself @emph{cannot} contain setuid programs: that would be a security issue since any user on the system can write derivations that populate the store (@pxref{The Store}). Thus, a different mechanism is used: instead of changing the setuid bit directly on files that are in the store, we let the system administrator @emph{declare} which programs should be setuid root."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34083
- msgid "The @code{setuid-programs} field of an @code{operating-system} declaration contains a list of @code{<setuid-program>} denoting the names of programs to have a setuid or setgid bit set (@pxref{Using the Configuration System}). For instance, the @command{mount.nfs} program, which is part of the nfs-utils package, with a setuid root can be designated like this:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:34087
- #, no-wrap
- msgid ""
- "(setuid-program\n"
- " (program (file-append nfs-utils \"/sbin/mount.nfs\")))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34092
- msgid "And then, to make @command{mount.nfs} setuid on your system, add the previous example to your operating system declaration by appending it to @code{%setuid-programs} like this:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:34098
- #, no-wrap
- msgid ""
- "(setuid-programs\n"
- " (append (list (setuid-program\n"
- " (program (file-append nfs-utils \"/sbin/mount.nfs\"))))\n"
- " %setuid-programs))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:34100
- #, no-wrap
- msgid "{Data Type} setuid-program"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:34102
- msgid "This data type represents a program with a setuid or setgid bit set."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:34104
- #, no-wrap
- msgid "program"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34106
- msgid "A file-like object having its setuid and/or setgid bit set."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34107
- #, no-wrap
- msgid "@code{setuid?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34109
- msgid "Whether to set user setuid bit."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34110
- #, no-wrap
- msgid "@code{setgid?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34112
- msgid "Whether to set group setgid bit."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34113
- #, no-wrap
- msgid "@code{user} (default: @code{0})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34116
- msgid "UID (integer) or user name (string) for the user owner of the program, defaults to root."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34117
- #, no-wrap
- msgid "@code{group} (default: @code{0})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34120
- msgid "GID (integer) goup name (string) for the group owner of the program, defaults to root."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34126
- msgid "A default set of setuid programs is defined by the @code{%setuid-programs} variable of the @code{(gnu system)} module."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:34127
- #, no-wrap
- msgid "{Scheme Variable} %setuid-programs"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:34130
- msgid "A list of @code{<setuid-program>} denoting common programs that are setuid-root."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:34133
- msgid "The list includes commands such as @command{passwd}, @command{ping}, @command{su}, and @command{sudo}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34139
- msgid "Under the hood, the actual setuid programs are created in the @file{/run/setuid-programs} directory at system activation time. The files in this directory refer to the ``real'' binaries, which are in the store."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:34143
- #, no-wrap
- msgid "HTTPS, certificates"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:34144
- #, no-wrap
- msgid "X.509 certificates"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:34145
- #, no-wrap
- msgid "TLS"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34152
- msgid "Web servers available over HTTPS (that is, HTTP over the transport-layer security mechanism, TLS) send client programs an @dfn{X.509 certificate} that the client can then use to @emph{authenticate} the server. To do that, clients verify that the server's certificate is signed by a so-called @dfn{certificate authority} (CA). But to verify the CA's signature, clients must have first acquired the CA's certificate."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34156
- msgid "Web browsers such as GNU@tie{}IceCat include their own set of CA certificates, such that they are able to verify CA signatures out-of-the-box."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34160
- msgid "However, most other programs that can talk HTTPS---@command{wget}, @command{git}, @command{w3m}, etc.---need to be told where CA certificates can be found."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34167
- msgid "In Guix, this is done by adding a package that provides certificates to the @code{packages} field of the @code{operating-system} declaration (@pxref{operating-system Reference}). Guix includes one such package, @code{nss-certs}, which is a set of CA certificates provided as part of Mozilla's Network Security Services."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34172
- msgid "Note that it is @emph{not} part of @code{%base-packages}, so you need to explicitly add it. The @file{/etc/ssl/certs} directory, which is where most applications and libraries look for certificates by default, points to the certificates installed globally."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34182
- msgid "Unprivileged users, including users of Guix on a foreign distro, can also install their own certificate package in their profile. A number of environment variables need to be defined so that applications and libraries know where to find them. Namely, the OpenSSL library honors the @env{SSL_CERT_DIR} and @env{SSL_CERT_FILE} variables. Some applications add their own environment variables; for instance, the Git version control system honors the certificate bundle pointed to by the @env{GIT_SSL_CAINFO} environment variable. Thus, you would typically run something like:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:34188
- #, no-wrap
- msgid ""
- "guix install nss-certs\n"
- "export SSL_CERT_DIR=\"$HOME/.guix-profile/etc/ssl/certs\"\n"
- "export SSL_CERT_FILE=\"$HOME/.guix-profile/etc/ssl/certs/ca-certificates.crt\"\n"
- "export GIT_SSL_CAINFO=\"$SSL_CERT_FILE\"\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34193
- msgid "As another example, R requires the @env{CURL_CA_BUNDLE} environment variable to point to a certificate bundle, so you would have to run something like this:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:34197
- #, no-wrap
- msgid ""
- "guix install nss-certs\n"
- "export CURL_CA_BUNDLE=\"$HOME/.guix-profile/etc/ssl/certs/ca-certificates.crt\"\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34201
- msgid "For other applications you may want to look up the required environment variable in the relevant documentation."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:34206
- #, no-wrap
- msgid "name service switch"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:34207
- #, no-wrap
- msgid "NSS"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34216
- msgid "The @code{(gnu system nss)} module provides bindings to the configuration file of the libc @dfn{name service switch} or @dfn{NSS} (@pxref{NSS Configuration File,,, libc, The GNU C Library Reference Manual}). In a nutshell, the NSS is a mechanism that allows libc to be extended with new ``name'' lookup methods for system databases, which includes host names, service names, user accounts, and more (@pxref{Name Service Switch, System Databases and Name Service Switch,, libc, The GNU C Library Reference Manual})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34223
- msgid "The NSS configuration specifies, for each system database, which lookup method is to be used, and how the various methods are chained together---for instance, under which circumstances NSS should try the next method in the list. The NSS configuration is given in the @code{name-service-switch} field of @code{operating-system} declarations (@pxref{operating-system Reference, @code{name-service-switch}})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:34224
- #, no-wrap
- msgid "nss-mdns"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:34225
- #, no-wrap
- msgid ".local, host name lookup"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34230
- msgid "As an example, the declaration below configures the NSS to use the @uref{https://0pointer.de/lennart/projects/nss-mdns/, @code{nss-mdns} back-end}, which supports host name lookups over multicast DNS (mDNS) for host names ending in @code{.local}:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:34234
- #, no-wrap
- msgid ""
- "(name-service-switch\n"
- " (hosts (list %files ;first, check /etc/hosts\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:34239
- #, no-wrap
- msgid ""
- " ;; If the above did not succeed, try\n"
- " ;; with 'mdns_minimal'.\n"
- " (name-service\n"
- " (name \"mdns_minimal\")\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:34245
- #, no-wrap
- msgid ""
- " ;; 'mdns_minimal' is authoritative for\n"
- " ;; '.local'. When it returns \"not found\",\n"
- " ;; no need to try the next methods.\n"
- " (reaction (lookup-specification\n"
- " (not-found => return))))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:34249
- #, no-wrap
- msgid ""
- " ;; Then fall back to DNS.\n"
- " (name-service\n"
- " (name \"dns\"))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:34253
- #, no-wrap
- msgid ""
- " ;; Finally, try with the \"full\" 'mdns'.\n"
- " (name-service\n"
- " (name \"mdns\")))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34258
- msgid "Do not worry: the @code{%mdns-host-lookup-nss} variable (see below) contains this configuration, so you will not have to type it if all you want is to have @code{.local} host lookup working."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34266
- msgid "Note that, in this case, in addition to setting the @code{name-service-switch} of the @code{operating-system} declaration, you also need to use @code{avahi-service-type} (@pxref{Networking Services, @code{avahi-service-type}}), or @code{%desktop-services}, which includes it (@pxref{Desktop Services}). Doing this makes @code{nss-mdns} accessible to the name service cache daemon (@pxref{Base Services, @code{nscd-service}})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34269
- msgid "For convenience, the following variables provide typical NSS configurations."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:34270
- #, no-wrap
- msgid "{Scheme Variable} %default-nss"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:34273
- msgid "This is the default name service switch configuration, a @code{name-service-switch} object."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:34275
- #, no-wrap
- msgid "{Scheme Variable} %mdns-host-lookup-nss"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:34278
- msgid "This is the name service switch configuration with support for host name lookup over multicast DNS (mDNS) for host names ending in @code{.local}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34288
- msgid "The reference for name service switch configuration is given below. It is a direct mapping of the configuration file format of the C library , so please refer to the C library manual for more information (@pxref{NSS Configuration File,,, libc, The GNU C Library Reference Manual}). Compared to the configuration file format of libc NSS, it has the advantage not only of adding this warm parenthetic feel that we like, but also static checks: you will know about syntax errors and typos as soon as you run @command{guix system}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:34289
- #, no-wrap
- msgid "{Data Type} name-service-switch"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:34294
- msgid "This is the data type representation the configuration of libc's name service switch (NSS). Each field below represents one of the supported system databases."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34296
- #, no-wrap
- msgid "aliases"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:34297
- #, no-wrap
- msgid "ethers"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:34299
- #, no-wrap
- msgid "gshadow"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:34300
- #, no-wrap
- msgid "hosts"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:34301
- #, no-wrap
- msgid "initgroups"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:34302
- #, no-wrap
- msgid "netgroup"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:34303
- #, no-wrap
- msgid "networks"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:34306
- #, no-wrap
- msgid "rpc"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:34308
- #, no-wrap
- msgid "shadow"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34311
- msgid "The system databases handled by the NSS@. Each of these fields must be a list of @code{<name-service>} objects (see below)."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:34314
- #, no-wrap
- msgid "{Data Type} name-service"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:34318
- msgid "This is the data type representing an actual name service and the associated lookup action."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34323
- msgid "A string denoting the name service (@pxref{Services in the NSS configuration,,, libc, The GNU C Library Reference Manual})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34328
- msgid "Note that name services listed here must be visible to nscd. This is achieved by passing the @code{#:name-services} argument to @code{nscd-service} the list of packages providing the needed name services (@pxref{Base Services, @code{nscd-service}})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34329
- #, no-wrap
- msgid "reaction"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34333
- msgid "An action specified using the @code{lookup-specification} macro (@pxref{Actions in the NSS configuration,,, libc, The GNU C Library Reference Manual}). For example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:34337
- #, no-wrap
- msgid ""
- "(lookup-specification (unavailable => continue)\n"
- " (success => return))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34351
- msgid "For bootstrapping purposes, the Linux-Libre kernel is passed an @dfn{initial RAM disk}, or @dfn{initrd}. An initrd contains a temporary root file system as well as an initialization script. The latter is responsible for mounting the real root file system, and for loading any kernel modules that may be needed to achieve that."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34360
- msgid "The @code{initrd-modules} field of an @code{operating-system} declaration allows you to specify Linux-libre kernel modules that must be available in the initrd. In particular, this is where you would list modules needed to actually drive the hard disk where your root partition is---although the default value of @code{initrd-modules} should cover most use cases. For example, assuming you need the @code{megaraid_sas} module in addition to the default modules to be able to access your root file system, you would write:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:34365
- #, no-wrap
- msgid ""
- "(operating-system\n"
- " ;; @dots{}\n"
- " (initrd-modules (cons \"megaraid_sas\" %base-initrd-modules)))\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:34367
- #, no-wrap
- msgid "{Scheme Variable} %base-initrd-modules"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:34369
- msgid "This is the list of kernel modules included in the initrd by default."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34377
- msgid "Furthermore, if you need lower-level customization, the @code{initrd} field of an @code{operating-system} declaration allows you to specify which initrd you would like to use. The @code{(gnu system linux-initrd)} module provides three ways to build an initrd: the high-level @code{base-initrd} procedure and the low-level @code{raw-initrd} and @code{expression->initrd} procedures."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34382
- msgid "The @code{base-initrd} procedure is intended to cover most common uses. For example, if you want to add a bunch of kernel modules to be loaded at boot time, you can define the @code{initrd} field of the operating system declaration like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:34390
- #, no-wrap
- msgid ""
- "(initrd (lambda (file-systems . rest)\n"
- " ;; Create a standard initrd but set up networking\n"
- " ;; with the parameters QEMU expects by default.\n"
- " (apply base-initrd file-systems\n"
- " #:qemu-networking? #t\n"
- " rest)))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34395
- msgid "The @code{base-initrd} procedure also handles common use cases that involves using the system as a QEMU guest, or as a ``live'' system with volatile root file system."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34402
- msgid "The @code{base-initrd} procedure is built from @code{raw-initrd} procedure. Unlike @code{base-initrd}, @code{raw-initrd} doesn't do anything high-level, such as trying to guess which kernel modules and packages should be included to the initrd. An example use of @code{raw-initrd} is when a user has a custom Linux kernel configuration and default kernel modules included by @code{base-initrd} are not available."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34407
- msgid "The initial RAM disk produced by @code{base-initrd} or @code{raw-initrd} honors several options passed on the Linux kernel command line (that is, arguments passed @i{via} the @code{linux} command of GRUB, or the @code{-append} option of QEMU), notably:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34409
- #, no-wrap
- msgid "--load=@var{boot}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34412
- msgid "Tell the initial RAM disk to load @var{boot}, a file containing a Scheme program, once it has mounted the root file system."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34416
- msgid "Guix uses this option to yield control to a boot program that runs the service activation programs and then spawns the GNU@tie{}Shepherd, the initialization system."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34417
- #, no-wrap
- msgid "--root=@var{root}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34422
- msgid "Mount @var{root} as the root file system. @var{root} can be a device name like @code{/dev/sda1}, a file system label, or a file system UUID. When unspecified, the device name from the root file system of the operating system declaration is used."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34423
- #, no-wrap
- msgid "fsck.mode=@var{mode}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34429
- msgid "Whether to check the @var{root} file system for errors before mounting it. @var{mode} is one of @code{skip} (never check), @code{force} (always check), or @code{auto} to respect the root file-system object's 'check?' setting (@pxref{File Systems}) and run a full scan only if the file system was not cleanly shut down."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34432
- msgid "@code{auto} is the default if this option is not present or if @var{mode} is not one of the above."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34433
- #, no-wrap
- msgid "fsck.repair=@var{level}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34438
- msgid "The level of repairs to perform automatically if errors are found in the @var{root} file system. @var{level} is one of @code{no} (do not write to @var{root} at all if possible), @code{yes} (repair as much as possible), or @code{preen} to repair problems considered safe to repair automatically."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34441
- msgid "@code{preen} is the default if this option is not present or if @var{level} is not one of the above."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34445
- msgid "Have @file{/run/booted-system} and @file{/run/current-system} point to @var{system}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34446
- #, no-wrap
- msgid "modprobe.blacklist=@var{modules}@dots{}"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:34447
- #, no-wrap
- msgid "module, black-listing"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:34448
- #, no-wrap
- msgid "black list, of kernel modules"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34453
- msgid "Instruct the initial RAM disk as well as the @command{modprobe} command (from the kmod package) to refuse to load @var{modules}. @var{modules} must be a comma-separated list of module names---e.g., @code{usbkbd,9pnet}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34454
- #, no-wrap
- msgid "--repl"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34460
- msgid "Start a read-eval-print loop (REPL) from the initial RAM disk before it tries to load kernel modules and to mount the root file system. Our marketing team calls it @dfn{boot-to-Guile}. The Schemer in you will love it. @xref{Using Guile Interactively,,, guile, GNU Guile Reference Manual}, for more information on Guile's REPL."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34466
- msgid "Now that you know all the features that initial RAM disks produced by @code{base-initrd} and @code{raw-initrd} provide, here is how to use it and customize it further."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:34469
- #, no-wrap
- msgid "{Scheme Procedure} raw-initrd @var{file-systems} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:34483
- msgid "[#:linux-modules '()] [#:mapped-devices '()] @ [#:keyboard-layout #f] @ [#:helper-packages '()] [#:qemu-networking? #f] [#:volatile-root? #f] Return a derivation that builds a raw initrd. @var{file-systems} is a list of file systems to be mounted by the initrd, possibly in addition to the root file system specified on the kernel command line via @option{--root}. @var{linux-modules} is a list of kernel modules to be loaded at boot time. @var{mapped-devices} is a list of device mappings to realize before @var{file-systems} are mounted (@pxref{Mapped Devices}). @var{helper-packages} is a list of packages to be copied in the initrd. It may include @code{e2fsck/static} or other packages needed by the initrd to check the root file system."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:34489 guix-git/doc/guix.texi:34513
- msgid "When true, @var{keyboard-layout} is a @code{<keyboard-layout>} record denoting the desired console keyboard layout. This is done before @var{mapped-devices} are set up and before @var{file-systems} are mounted such that, should the user need to enter a passphrase or use the REPL, this happens using the intended keyboard layout."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:34493
- msgid "When @var{qemu-networking?} is true, set up networking with the standard QEMU parameters. When @var{virtio?} is true, load additional modules so that the initrd can be used as a QEMU guest with para-virtualized I/O drivers."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:34496
- msgid "When @var{volatile-root?} is true, the root file system is writable but any changes to it are lost."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:34498
- #, no-wrap
- msgid "{Scheme Procedure} base-initrd @var{file-systems} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:34507
- msgid "[#:mapped-devices '()] [#:keyboard-layout #f] @ [#:qemu-networking? #f] [#:volatile-root? #f] @ [#:linux-modules '()] Return as a file-like object a generic initrd, with kernel modules taken from @var{linux}. @var{file-systems} is a list of file-systems to be mounted by the initrd, possibly in addition to the root file system specified on the kernel command line via @option{--root}. @var{mapped-devices} is a list of device mappings to realize before @var{file-systems} are mounted."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:34515
- msgid "@var{qemu-networking?} and @var{volatile-root?} behaves as in @code{raw-initrd}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:34520
- msgid "The initrd is automatically populated with all the kernel modules necessary for @var{file-systems} and for the given options. Additional kernel modules can be listed in @var{linux-modules}. They will be added to the initrd, and loaded at boot time in the order in which they appear."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34527
- msgid "Needless to say, the initrds we produce and use embed a statically-linked Guile, and the initialization program is a Guile program. That gives a lot of flexibility. The @code{expression->initrd} procedure builds such an initrd, given the program to run in that initrd."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:34528
- #, no-wrap
- msgid "{Scheme Procedure} expression->initrd @var{exp} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:34534
- msgid "[#:guile %guile-static-stripped] [#:name \"guile-initrd\"] Return as a file-like object a Linux initrd (a gzipped cpio archive) containing @var{guile} and that evaluates @var{exp}, a G-expression, upon booting. All the derivations referenced by @var{exp} are automatically copied to the initrd."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:34540
- #, no-wrap
- msgid "boot loader"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34547
- msgid "The operating system supports multiple bootloaders. The bootloader is configured using @code{bootloader-configuration} declaration. All the fields of this structure are bootloader agnostic except for one field, @code{bootloader} that indicates the bootloader to be configured and installed."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34552
- msgid "Some of the bootloaders do not honor every field of @code{bootloader-configuration}. For instance, the extlinux bootloader does not support themes and thus ignores the @code{theme} field."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:34553
- #, no-wrap
- msgid "{Data Type} bootloader-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:34555
- msgid "The type of a bootloader configuration declaration."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:34559
- #, no-wrap
- msgid "EFI, bootloader"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:34560
- #, no-wrap
- msgid "UEFI, bootloader"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:34561
- #, no-wrap
- msgid "BIOS, bootloader"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34566
- msgid "The bootloader to use, as a @code{bootloader} object. For now @code{grub-bootloader}, @code{grub-efi-bootloader}, @code{grub-efi-netboot-bootloader}, @code{extlinux-bootloader} and @code{u-boot-bootloader} are supported."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:34567
- #, no-wrap
- msgid "ARM, bootloaders"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:34568
- #, no-wrap
- msgid "AArch64, bootloaders"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34573
- msgid "Available bootloaders are described in @code{(gnu bootloader @dots{})} modules. In particular, @code{(gnu bootloader u-boot)} contains definitions of bootloaders for a wide range of ARM and AArch64 systems, using the @uref{https://www.denx.de/wiki/U-Boot/, U-Boot bootloader}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34579
- msgid "@code{grub-efi-bootloader} allows to boot on modern systems using the @dfn{Unified Extensible Firmware Interface} (UEFI). This is what you should use if the installation image contains a @file{/sys/firmware/efi} directory when you boot it on your system."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34583
- msgid "@code{grub-bootloader} allows you to boot in particular Intel-based machines in ``legacy'' BIOS mode."
- msgstr ""
- #. type: vindex
- #: guix-git/doc/guix.texi:34584
- #, no-wrap
- msgid "grub-efi-netboot-bootloader"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34588
- msgid "@code{grub-efi-netboot-bootloader} allows you to boot your system over network through TFTP@. In combination with an NFS root file system this allows you to build a diskless Guix system."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34594
- msgid "The installation of the @code{grub-efi-netboot-bootloader} generates the content of the TFTP root directory at @code{targets} (@pxref{Bootloader Configuration, @code{targets}}), to be served by a TFTP server. You may want to mount your TFTP server directories onto the @code{targets} to move the required files to the TFTP server automatically."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34603
- msgid "If you plan to use an NFS root file system as well (actually if you mount the store from an NFS share), then the TFTP server needs to serve the file @file{/boot/grub/grub.cfg} and other files from the store (like GRUBs background image, the kernel (@pxref{operating-system Reference, @code{kernel}}) and the initrd (@pxref{operating-system Reference, @code{initrd}})), too. All these files from the store will be accessed by GRUB through TFTP with their normal store path, for example as @file{tftp://tftp-server/gnu/store/…-initrd/initrd.cpio.gz}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34612
- msgid "Two symlinks are created to make this possible. For each target in the @code{targets} field, the first symlink is @samp{target}@file{/efi/Guix/boot/grub/grub.cfg} pointing to @file{../../../boot/grub/grub.cfg}, where @samp{target} may be @file{/boot}. In this case the link is not leaving the served TFTP root directory, but otherwise it does. The second link is @samp{target}@file{/gnu/store} and points to @file{../gnu/store}. This link is leaving the served TFTP root directory."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34618
- msgid "The assumption behind all this is that you have an NFS server exporting the root file system for your Guix system, and additionally a TFTP server exporting your @code{targets} directories—usually a single @file{/boot}—from that same root file system for your Guix system. In this constellation the symlinks will work."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34623
- msgid "For other constellations you will have to program your own bootloader installer, which then takes care to make necessary files from the store accessible through TFTP, for example by copying them into the TFTP root directory to your @code{targets}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34628
- msgid "It is important to note that symlinks pointing outside the TFTP root directory may need to be allowed in the configuration of your TFTP server. Further the store link exposes the whole store through TFTP@. Both points need to be considered carefully for security aspects."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34633
- msgid "Beside the @code{grub-efi-netboot-bootloader}, the already mentioned TFTP and NFS servers, you also need a properly configured DHCP server to make the booting over netboot possible. For all this we can currently only recommend you to look for instructions about @acronym{PXE, Preboot eXecution Environment}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34637
- msgid "This is a list of strings denoting the targets onto which to install the bootloader."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34647
- msgid "The interpretation of targets depends on the bootloader in question. For @code{grub-bootloader}, for example, they should be device names understood by the bootloader @command{installer} command, such as @code{/dev/sda} or @code{(hd0)} (@pxref{Invoking grub-install,,, grub, GNU GRUB Manual}). For @code{grub-efi-bootloader}, they should be mount points of the EFI file system, usually @file{/boot/efi}. For @code{grub-efi-netboot-bootloader}, @code{targets} should be the mount points corresponding to TFTP root directories served by your TFTP server."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34648
- #, no-wrap
- msgid "@code{menu-entries} (default: @code{()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34652
- msgid "A possibly empty list of @code{menu-entry} objects (see below), denoting entries to appear in the bootloader menu, in addition to the current system entry and the entry pointing to previous system generations."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34653
- #, no-wrap
- msgid "@code{default-entry} (default: @code{0})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34656
- msgid "The index of the default boot menu entry. Index 0 is for the entry of the current system."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34657
- #, no-wrap
- msgid "@code{timeout} (default: @code{5})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34660
- msgid "The number of seconds to wait for keyboard input before booting. Set to 0 to boot immediately, and to -1 to wait indefinitely."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:34661
- #, no-wrap
- msgid "keyboard layout, for the bootloader"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34665
- msgid "If this is @code{#f}, the bootloader's menu (if any) uses the default keyboard layout, usually US@tie{}English (``qwerty'')."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34668
- msgid "Otherwise, this must be a @code{keyboard-layout} object (@pxref{Keyboard Layout})."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:34672
- msgid "This option is currently ignored by bootloaders other than @code{grub} and @code{grub-efi}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34674
- #, no-wrap
- msgid "@code{theme} (default: @var{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34678
- msgid "The bootloader theme object describing the theme to use. If no theme is provided, some bootloaders might use a default theme, that's true for GRUB."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34679
- #, no-wrap
- msgid "@code{terminal-outputs} (default: @code{'(gfxterm)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34686
- msgid "The output terminals used for the bootloader boot menu, as a list of symbols. GRUB accepts the values: @code{console}, @code{serial}, @code{serial_@{0-3@}}, @code{gfxterm}, @code{vga_text}, @code{mda_text}, @code{morse}, and @code{pkmodem}. This field corresponds to the GRUB variable @code{GRUB_TERMINAL_OUTPUT} (@pxref{Simple configuration,,, grub,GNU GRUB manual})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34687
- #, no-wrap
- msgid "@code{terminal-inputs} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34695
- msgid "The input terminals used for the bootloader boot menu, as a list of symbols. For GRUB, the default is the native platform terminal as determined at run-time. GRUB accepts the values: @code{console}, @code{serial}, @code{serial_@{0-3@}}, @code{at_keyboard}, and @code{usb_keyboard}. This field corresponds to the GRUB variable @code{GRUB_TERMINAL_INPUT} (@pxref{Simple configuration,,, grub,GNU GRUB manual})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34696
- #, no-wrap
- msgid "@code{serial-unit} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34700
- msgid "The serial unit used by the bootloader, as an integer from 0 to 3. For GRUB, it is chosen at run-time; currently GRUB chooses 0, which corresponds to COM1 (@pxref{Serial terminal,,, grub,GNU GRUB manual})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34701
- #, no-wrap
- msgid "@code{serial-speed} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34705
- msgid "The speed of the serial interface, as an integer. For GRUB, the default value is chosen at run-time; currently GRUB chooses 9600@tie{}bps (@pxref{Serial terminal,,, grub,GNU GRUB manual})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:34709
- #, no-wrap
- msgid "dual boot"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:34710
- #, no-wrap
- msgid "boot menu"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34716
- msgid "Should you want to list additional boot menu entries @i{via} the @code{menu-entries} field above, you will need to create them with the @code{menu-entry} form. For example, imagine you want to be able to boot another distro (hard to imagine!), you can define a menu entry along these lines:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:34723
- #, no-wrap
- msgid ""
- "(menu-entry\n"
- " (label \"The Other Distro\")\n"
- " (linux \"/boot/old/vmlinux-2.6.32\")\n"
- " (linux-arguments '(\"root=/dev/sda2\"))\n"
- " (initrd \"/boot/old/initrd\"))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34726
- msgid "Details below."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:34727
- #, no-wrap
- msgid "{Data Type} menu-entry"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:34729
- msgid "The type of an entry in the bootloader menu."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34734
- msgid "The label to show in the menu---e.g., @code{\"GNU\"}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34735
- #, no-wrap
- msgid "@code{linux} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34737
- msgid "The Linux kernel image to boot, for example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:34740
- #, no-wrap
- msgid "(file-append linux-libre \"/bzImage\")\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34745
- msgid "For GRUB, it is also possible to specify a device explicitly in the file path using GRUB's device naming convention (@pxref{Naming convention,,, grub, GNU GRUB manual}), for example:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:34748
- #, no-wrap
- msgid "\"(hd0,msdos1)/boot/vmlinuz\"\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34752
- msgid "If the device is specified explicitly as above, then the @code{device} field is ignored entirely."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34753
- #, no-wrap
- msgid "@code{linux-arguments} (default: @code{()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34756
- msgid "The list of extra Linux kernel command-line arguments---e.g., @code{(\"console=ttyS0\")}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34757
- #, no-wrap
- msgid "@code{initrd} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34760
- msgid "A G-Expression or string denoting the file name of the initial RAM disk to use (@pxref{G-Expressions})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34764
- msgid "The device where the kernel and initrd are to be found---i.e., for GRUB, @dfn{root} for this menu entry (@pxref{root,,, grub, GNU GRUB manual})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34770
- msgid "This may be a file system label (a string), a file system UUID (a bytevector, @pxref{File Systems}), or @code{#f}, in which case the bootloader will search the device containing the file specified by the @code{linux} field (@pxref{search,,, grub, GNU GRUB manual}). It must @emph{not} be an OS device name such as @file{/dev/sda1}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34771
- #, no-wrap
- msgid "@code{multiboot-kernel} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34775
- msgid "The kernel to boot in Multiboot-mode (@pxref{multiboot,,, grub, GNU GRUB manual}). When this field is set, a Multiboot menu-entry is generated. For example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:34778
- #, no-wrap
- msgid "(file-append mach \"/boot/gnumach\")\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34780
- #, no-wrap
- msgid "@code{multiboot-arguments} (default: @code{()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34782
- msgid "The list of extra command-line arguments for the multiboot-kernel."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34783
- #, no-wrap
- msgid "@code{multiboot-modules} (default: @code{()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34785
- msgid "The list of commands for loading Multiboot modules. For example:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:34791
- #, no-wrap
- msgid ""
- "(list (list (file-append hurd \"/hurd/ext2fs.static\") \"ext2fs\"\n"
- " @dots{})\n"
- " (list (file-append libc \"/lib/ld.so.1\") \"exec\"\n"
- " @dots{}))\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:34796 guix-git/doc/guix.texi:34855
- #, no-wrap
- msgid "HDPI"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:34797 guix-git/doc/guix.texi:34856
- #, no-wrap
- msgid "HiDPI"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:34798 guix-git/doc/guix.texi:34857
- #, no-wrap
- msgid "resolution"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34802
- msgid "For now only GRUB has theme support. GRUB themes are created using the @code{grub-theme} form, which is not fully documented yet."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:34803
- #, no-wrap
- msgid "{Data Type} grub-theme"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:34805
- msgid "Data type representing the configuration of the GRUB theme."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34807
- #, no-wrap
- msgid "@code{gfxmode} (default: @code{'(\"auto\")})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34810
- msgid "The GRUB @code{gfxmode} to set (a list of screen resolution strings, @pxref{gfxmode,,, grub, GNU GRUB manual})."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:34813
- #, no-wrap
- msgid "{Scheme Procedure} grub-theme"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:34817
- msgid "Return the default GRUB theme used by the operating system if no @code{theme} field is specified in @code{bootloader-configuration} record."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:34820
- msgid "It comes with a fancy background image displaying the GNU and Guix logos."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34824
- msgid "For example, to override the default resolution, you may use something like"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:34832
- #, no-wrap
- msgid ""
- "(bootloader\n"
- " (bootloader-configuration\n"
- " ;; @dots{}\n"
- " (theme (grub-theme\n"
- " (inherit (grub-theme))\n"
- " (gfxmode '(\"1024x786x32\" \"auto\"))))))\n"
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:34835
- #, no-wrap
- msgid "Invoking @code{guix system}"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34840
- msgid "Once you have written an operating system declaration as seen in the previous section, it can be @dfn{instantiated} using the @command{guix system} command. The synopsis is:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:34843
- #, no-wrap
- msgid "guix system @var{options}@dots{} @var{action} @var{file}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:34849
- msgid "@var{file} must be the name of a file containing an @code{operating-system} declaration. @var{action} specifies how the operating system is instantiated. Currently the following values are supported:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34851 guix-git/doc/guix.texi:37496
- #, no-wrap
- msgid "search"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34854
- msgid "Display available service type definitions that match the given regular expressions, sorted by relevance:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:34876
- #, no-wrap
- msgid ""
- "$ guix system search console\n"
- "name: console-fonts\n"
- "location: gnu/services/base.scm:806:2\n"
- "extends: shepherd-root\n"
- "description: Install the given fonts on the specified ttys (fonts are per\n"
- "+ virtual console on GNU/Linux). The value of this service is a list of\n"
- "+ tty/font pairs. The font can be the name of a font provided by the `kbd'\n"
- "+ package or any valid argument to `setfont', as in this example:\n"
- "+\n"
- "+ '((\"tty1\" . \"LatGrkCyr-8x16\")\n"
- "+ (\"tty2\" . (file-append\n"
- "+ font-tamzen\n"
- "+ \"/share/kbd/consolefonts/TamzenForPowerline10x20.psf\"))\n"
- "+ (\"tty3\" . (file-append\n"
- "+ font-terminus\n"
- "+ \"/share/consolefonts/ter-132n\"))) ; for HDPI\n"
- "relevance: 9\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:34882
- #, no-wrap
- msgid ""
- "name: mingetty\n"
- "location: gnu/services/base.scm:1190:2\n"
- "extends: shepherd-root\n"
- "description: Provide console login using the `mingetty' program.\n"
- "relevance: 2\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:34889
- #, no-wrap
- msgid ""
- "name: login\n"
- "location: gnu/services/base.scm:860:2\n"
- "extends: pam\n"
- "description: Provide a console log-in service as specified by its\n"
- "+ configuration value, a `login-configuration' object.\n"
- "relevance: 2\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:34891 guix-git/doc/guix.texi:37549
- #, no-wrap
- msgid "@dots{}\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34896 guix-git/doc/guix.texi:37554
- msgid "As for @command{guix package --search}, the result is written in @code{recutils} format, which makes it easy to filter the output (@pxref{Top, GNU recutils databases,, recutils, GNU recutils manual})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34897 guix-git/doc/guix.texi:37555
- #, no-wrap
- msgid "reconfigure"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34902
- msgid "Build the operating system described in @var{file}, activate it, and switch to it@footnote{This action (and the related actions @code{switch-generation} and @code{roll-back}) are usable only on systems already running Guix System.}."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:34910
- msgid "It is highly recommended to run @command{guix pull} once before you run @command{guix system reconfigure} for the first time (@pxref{Invoking guix pull}). Failing to do that you would see an older version of Guix once @command{reconfigure} has completed."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34918
- msgid "This effects all the configuration specified in @var{file}: user accounts, system services, global package list, setuid programs, etc. The command starts system services specified in @var{file} that are not currently running; if a service is currently running this command will arrange for it to be upgraded the next time it is stopped (e.g.@: by @code{herd stop X} or @code{herd restart X})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34924
- msgid "This command creates a new generation whose number is one greater than the current generation (as reported by @command{guix system list-generations}). If that generation already exists, it will be overwritten. This behavior mirrors that of @command{guix package} (@pxref{Invoking guix package})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34929
- msgid "It also adds a bootloader menu entry for the new OS configuration, ---unless @option{--no-bootloader} is passed. For GRUB, it moves entries for older configurations to a submenu, allowing you to choose an older system generation at boot time should you need it."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:34930 guix-git/doc/guix.texi:35261
- #: guix-git/doc/guix.texi:36223
- #, no-wrap
- msgid "provenance tracking, of the operating system"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34935
- msgid "Upon completion, the new system is deployed under @file{/run/current-system}. This directory contains @dfn{provenance meta-data}: the list of channels in use (@pxref{Channels}) and @var{file} itself, when available. You can view it by running:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:34938
- #, no-wrap
- msgid "guix system describe\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34944
- msgid "This information is useful should you later want to inspect how this particular generation was built. In fact, assuming @var{file} is self-contained, you can later rebuild generation @var{n} of your operating system with:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:34950
- #, no-wrap
- msgid ""
- "guix time-machine \\\n"
- " -C /var/guix/profiles/system-@var{n}-link/channels.scm -- \\\n"
- " system reconfigure \\\n"
- " /var/guix/profiles/system-@var{n}-link/configuration.scm\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34956
- msgid "You can think of it as some sort of built-in version control! Your system is not just a binary artifact: @emph{it carries its own source}. @xref{Service Reference, @code{provenance-service-type}}, for more information on provenance tracking."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34962
- msgid "By default, @command{reconfigure} @emph{prevents you from downgrading your system}, which could (re)introduce security vulnerabilities and also cause problems with ``stateful'' services such as database management systems. You can override that behavior by passing @option{--allow-downgrades}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:34963 guix-git/doc/guix.texi:37614
- #, no-wrap
- msgid "switch-generation"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34972
- msgid "Switch to an existing system generation. This action atomically switches the system profile to the specified system generation. It also rearranges the system's existing bootloader menu entries. It makes the menu entry for the specified system generation the default, and it moves the entries for the other generations to a submenu, if supported by the bootloader being used. The next time the system boots, it will use the specified system generation."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34976
- msgid "The bootloader itself is not being reinstalled when using this command. Thus, the installed bootloader is used with an updated configuration file."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34980
- msgid "The target generation can be specified explicitly by its generation number. For example, the following invocation would switch to system generation 7:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:34983
- #, no-wrap
- msgid "guix system switch-generation 7\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:34991 guix-git/doc/guix.texi:37633
- msgid "The target generation can also be specified relative to the current generation with the form @code{+N} or @code{-N}, where @code{+3} means ``3 generations ahead of the current generation,'' and @code{-1} means ``1 generation prior to the current generation.'' When specifying a negative value such as @code{-1}, you must precede it with @code{--} to prevent it from being parsed as an option. For example:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:34994
- #, no-wrap
- msgid "guix system switch-generation -- -1\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35002
- msgid "Currently, the effect of invoking this action is @emph{only} to switch the system profile to an existing generation and rearrange the bootloader menu entries. To actually start using the target system generation, you must reboot after running this action. In the future, it will be updated to do the same things as @command{reconfigure}, like activating and deactivating services."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35004 guix-git/doc/guix.texi:37639
- msgid "This action will fail if the specified generation does not exist."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35005 guix-git/doc/guix.texi:37640
- #, no-wrap
- msgid "roll-back"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35011
- msgid "Switch to the preceding system generation. The next time the system boots, it will use the preceding system generation. This is the inverse of @command{reconfigure}, and it is exactly the same as invoking @command{switch-generation} with an argument of @code{-1}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35015
- msgid "Currently, as with @command{switch-generation}, you must reboot after running this action to actually start using the preceding system generation."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35016 guix-git/doc/guix.texi:37646
- #, no-wrap
- msgid "delete-generations"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:35017
- #, no-wrap
- msgid "deleting system generations"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:35018 guix-git/doc/guix.texi:37648
- #, no-wrap
- msgid "saving space"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35022
- msgid "Delete system generations, making them candidates for garbage collection (@pxref{Invoking guix gc}, for information on how to run the ``garbage collector'')."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35026
- msgid "This works in the same way as @samp{guix package --delete-generations} (@pxref{Invoking guix package, @option{--delete-generations}}). With no arguments, all system generations but the current one are deleted:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:35029
- #, no-wrap
- msgid "guix system delete-generations\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35033
- msgid "You can also select the generations you want to delete. The example below deletes all the system generations that are more than two months old:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:35036
- #, no-wrap
- msgid "guix system delete-generations 2m\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35041
- msgid "Running this command automatically reinstalls the bootloader with an updated list of menu entries---e.g., the ``old generations'' sub-menu in GRUB no longer lists the generations that have been deleted."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35046
- msgid "Build the derivation of the operating system, which includes all the configuration files and programs needed to boot and run the system. This action does not actually install anything."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35047
- #, no-wrap
- msgid "init"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35051
- msgid "Populate the given directory with all the files necessary to run the operating system specified in @var{file}. This is useful for first-time installations of Guix System. For instance:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:35054
- #, no-wrap
- msgid "guix system init my-os-config.scm /mnt\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35061
- msgid "copies to @file{/mnt} all the store items required by the configuration specified in @file{my-os-config.scm}. This includes configuration files, packages, and so on. It also creates other essential files needed for the system to operate correctly---e.g., the @file{/etc}, @file{/var}, and @file{/run} directories, and the @file{/bin/sh} file."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35065
- msgid "This command also installs bootloader on the targets specified in @file{my-os-config}, unless the @option{--no-bootloader} option was passed."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35066
- #, no-wrap
- msgid "vm"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:35067 guix-git/doc/guix.texi:35634
- #, no-wrap
- msgid "virtual machine"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:35068
- #, no-wrap
- msgid "VM"
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:35072
- msgid "guix system vm"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35072
- msgid "Build a virtual machine (VM) that contains the operating system declared in @var{file}, and return a script to run that VM."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:35080
- msgid "The @code{vm} action and others below can use KVM support in the Linux-libre kernel. Specifically, if the machine has hardware virtualization support, the corresponding KVM kernel module should be loaded, and the @file{/dev/kvm} device node must exist and be readable and writable by the user and by the build users of the daemon (@pxref{Build Environment Setup})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35085
- msgid "Arguments given to the script are passed to QEMU as in the example below, which enables networking and requests 1@tie{}GiB of RAM for the emulated machine:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:35088
- #, no-wrap
- msgid "$ /gnu/store/@dots{}-run-vm.sh -m 1024 -smp 2 -nic user,model=virtio-net-pci\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35091
- msgid "It's possible to combine the two steps into one:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:35094
- #, no-wrap
- msgid "$ $(guix system vm my-config.scm) -m 1024 -smp 2 -nic user,model=virtio-net-pci\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35097
- msgid "The VM shares its store with the host system."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35102
- msgid "Additional file systems can be shared between the host and the VM using the @option{--share} and @option{--expose} command-line options: the former specifies a directory to be shared with write access, while the latter provides read-only access to the shared directory."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35106
- msgid "The example below creates a VM in which the user's home directory is accessible read-only, and where the @file{/exchange} directory is a read-write mapping of @file{$HOME/tmp} on the host:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:35110
- #, no-wrap
- msgid ""
- "guix system vm my-config.scm \\\n"
- " --expose=$HOME --share=$HOME/tmp=/exchange\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35115
- msgid "On GNU/Linux, the default is to boot directly to the kernel; this has the advantage of requiring only a very tiny root disk image since the store of the host can then be mounted."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35120
- msgid "The @option{--full-boot} option forces a complete boot sequence, starting with the bootloader. This requires more disk space since a root image containing at least the kernel, initrd, and bootloader data files must be created."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35123
- msgid "The @option{--image-size} option can be used to specify the size of the image."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35130
- msgid "The @option{--no-graphic} option will instruct @command{guix system} to spawn a headless VM that will use the invoking tty for IO. Among other things, this enables copy-pasting, and scrollback. Use the @kbd{ctrl-a} prefix to issue QEMU commands; e.g. @kbd{ctrl-a h} prints a help, @kbd{ctrl-a x} quits the VM, and @kbd{ctrl-a c} switches between the QEMU monitor and the VM."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:35131
- #, no-wrap
- msgid "System images, creation in various formats"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:35132
- #, no-wrap
- msgid "Creating system images in various formats"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35133
- #, no-wrap
- msgid "image"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:35134
- #, no-wrap
- msgid "image, creating disk images"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35146
- msgid "The @code{image} command can produce various image types. The image type can be selected using the @option{--image-type} option. It defaults to @code{efi-raw}. When its value is @code{iso9660}, the @option{--label} option can be used to specify a volume ID with @code{image}. By default, the root file system of a disk image is mounted non-volatile; the @option{--volatile} option can be provided to make it volatile instead. When using @code{image}, the bootloader installed on the generated image is taken from the provided @code{operating-system} definition. The following example demonstrates how to generate an image that uses the @code{grub-efi-bootloader} bootloader and boot it with QEMU:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:35154
- #, no-wrap
- msgid ""
- "image=$(guix system image --image-type=qcow2 \\\n"
- " gnu/system/examples/lightweight-desktop.tmpl)\n"
- "cp $image /tmp/my-image.qcow2\n"
- "chmod +w /tmp/my-image.qcow2\n"
- "qemu-system-x86_64 -enable-kvm -hda /tmp/my-image.qcow2 -m 1000 \\\n"
- " -bios $(guix build ovmf)/share/firmware/ovmf_x64.bin\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35160
- msgid "When using the @code{efi-raw} image type, a raw disk image is produced; it can be copied as is to a USB stick, for instance. Assuming @code{/dev/sdc} is the device corresponding to a USB stick, one can copy the image to it using the following command:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:35163
- #, no-wrap
- msgid "# dd if=$(guix system image my-os.scm) of=/dev/sdc status=progress\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35167
- msgid "The @code{--list-image-types} command lists all the available image types."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:35168
- #, no-wrap
- msgid "creating virtual machine images"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35177
- msgid "When using the @code{qcow2} image type, the returned image is in qcow2 format, which the QEMU emulator can efficiently use. @xref{Running Guix in a VM}, for more information on how to run the image in a virtual machine. The @code{grub-bootloader} bootloader is always used independently of what is declared in the @code{operating-system} file passed as argument. This is to make it easier to work with QEMU, which uses the SeaBIOS BIOS by default, expecting a bootloader to be installed in the Master Boot Record (MBR)."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:35178
- #, no-wrap
- msgid "docker-image, creating docker images"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35184
- msgid "When using the @code{docker} image type, a Docker image is produced. Guix builds the image from scratch, not from a pre-existing Docker base image. As a result, it contains @emph{exactly} what you define in the operating system configuration file. You can then load the image and launch a Docker container using commands like the following:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:35189
- #, no-wrap
- msgid ""
- "image_id=\"$(docker load < guix-system-docker-image.tar.gz)\"\n"
- "container_id=\"$(docker create $image_id)\"\n"
- "docker start $container_id\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35196
- msgid "This command starts a new Docker container from the specified image. It will boot the Guix system in the usual manner, which means it will start any services you have defined in the operating system configuration. You can get an interactive shell running in the container using @command{docker exec}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:35199
- #, no-wrap
- msgid "docker exec -ti $container_id /run/current-system/profile/bin/bash --login\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35206
- msgid "Depending on what you run in the Docker container, it may be necessary to give the container additional permissions. For example, if you intend to build software using Guix inside of the Docker container, you may need to pass the @option{--privileged} option to @code{docker create}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35210
- msgid "Last, the @option{--network} option applies to @command{guix system docker-image}: it produces an image where network is supposedly shared with the host, and thus without services like nscd or NetworkManager."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35218
- msgid "Return a script to run the operating system declared in @var{file} within a container. Containers are a set of lightweight isolation mechanisms provided by the kernel Linux-libre. Containers are substantially less resource-demanding than full virtual machines since the kernel, shared objects, and other resources can be shared with the host system; this also means they provide thinner isolation."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35222
- msgid "Currently, the script must be run as root in order to support more than a single user and group. The container shares its store with the host system."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35226
- msgid "As with the @code{vm} action (@pxref{guix system vm}), additional file systems to be shared between the host and container can be specified using the @option{--share} and @option{--expose} options:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:35230
- #, no-wrap
- msgid ""
- "guix system container my-config.scm \\\n"
- " --expose=$HOME --share=$HOME/tmp=/exchange\n"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:35234
- msgid "This option requires Linux-libre 3.19 or newer."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35241 guix-git/doc/guix.texi:37710
- msgid "@var{options} can contain any of the common build options (@pxref{Common Build Options}). In addition, @var{options} can contain one of the following:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35250
- msgid "Consider the operating-system @var{expr} evaluates to. This is an alternative to specifying a file which evaluates to an operating system. This is used to generate the Guix system installer @pxref{Building the Installation Image})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35255
- msgid "Attempt to build for @var{system} instead of the host system type. This works as per @command{guix build} (@pxref{Invoking guix build})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35260
- msgid "Return the derivation file name of the given operating system without building anything."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35269
- msgid "As discussed above, @command{guix system init} and @command{guix system reconfigure} always save provenance information @i{via} a dedicated service (@pxref{Service Reference, @code{provenance-service-type}}). However, other commands don't do that by default. If you wish to, say, create a virtual machine image that contains provenance information, you can run:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:35272
- #, no-wrap
- msgid "guix system image -t qcow2 --save-provenance config.scm\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35279
- msgid "That way, the resulting image will effectively ``embed its own source'' in the form of meta-data in @file{/run/current-system}. With that information, one can rebuild the image to make sure it really contains what it pretends to contain; or they could use that to derive a variant of the image."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35280
- #, no-wrap
- msgid "--image-type=@var{type}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35283
- msgid "For the @code{image} action, create an image with given @var{type}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35286
- msgid "When this option is omitted, @command{guix system} uses the @code{efi-raw} image type."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:35287
- #, no-wrap
- msgid "ISO-9660 format"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:35288
- #, no-wrap
- msgid "CD image format"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:35289
- #, no-wrap
- msgid "DVD image format"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35292
- msgid "@option{--image-type=iso9660} produces an ISO-9660 image, suitable for burning on CDs and DVDs."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35293
- #, no-wrap
- msgid "--image-size=@var{size}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35298
- msgid "For the @code{image} action, create an image of the given @var{size}. @var{size} may be a number of bytes, or it may include a unit as a suffix (@pxref{Block size, size specifications,, coreutils, GNU Coreutils})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35302
- msgid "When this option is omitted, @command{guix system} computes an estimate of the image size as a function of the size of the system declared in @var{file}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35307
- msgid "For the @code{container} action, allow containers to access the host network, that is, do not create a network namespace."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35313
- #, no-wrap
- msgid "--skip-checks"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35315
- msgid "Skip pre-installation safety checks."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35322
- msgid "By default, @command{guix system init} and @command{guix system reconfigure} perform safety checks: they make sure the file systems that appear in the @code{operating-system} declaration actually exist (@pxref{File Systems}), and that any Linux kernel modules that may be needed at boot time are listed in @code{initrd-modules} (@pxref{Initial RAM Disk}). Passing this option skips these tests altogether."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35325
- msgid "Instruct @command{guix system reconfigure} to allow system downgrades."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35333
- msgid "By default, @command{reconfigure} prevents you from downgrading your system. It achieves that by comparing the provenance info of your system (shown by @command{guix system describe}) with that of your @command{guix} command (shown by @command{guix describe}). If the commits for @command{guix} are not descendants of those used for your system, @command{guix system reconfigure} errors out. Passing @option{--allow-downgrades} allows you to bypass these checks."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:35339
- #, no-wrap
- msgid "on-error"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:35340
- #, no-wrap
- msgid "on-error strategy"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:35341
- #, no-wrap
- msgid "error strategy"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35342
- #, no-wrap
- msgid "--on-error=@var{strategy}"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35345
- msgid "Apply @var{strategy} when an error occurs when reading @var{file}. @var{strategy} may be one of the following:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35347
- #, no-wrap
- msgid "nothing-special"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35349
- msgid "Report the error concisely and exit. This is the default strategy."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35350
- #, no-wrap
- msgid "backtrace"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35352
- msgid "Likewise, but also display a backtrace."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35353
- #, no-wrap
- msgid "debug"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35359
- msgid "Report the error and enter Guile's debugger. From there, you can run commands such as @code{,bt} to get a backtrace, @code{,locals} to display local variable values, and more generally inspect the state of the program. @xref{Debug Commands,,, guile, GNU Guile Reference Manual}, for a list of available debugging commands."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35366
- msgid "Once you have built, configured, re-configured, and re-re-configured your Guix installation, you may find it useful to list the operating system generations available on disk---and that you can choose from the bootloader boot menu:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35369 guix-git/doc/guix.texi:37673
- #, no-wrap
- msgid "describe"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35372
- msgid "Describe the current system generation: its file name, the kernel and bootloader used, etc., as well as provenance information when available."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35373 guix-git/doc/guix.texi:37677
- #, no-wrap
- msgid "list-generations"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35378
- msgid "List a summary of each generation of the operating system available on disk, in a human-readable way. This is similar to the @option{--list-generations} option of @command{guix package} (@pxref{Invoking guix package})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35383 guix-git/doc/guix.texi:37687
- msgid "Optionally, one can specify a pattern, with the same syntax that is used in @command{guix package --list-generations}, to restrict the list of generations displayed. For instance, the following command displays generations that are up to 10 days old:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:35386
- #, no-wrap
- msgid "$ guix system list-generations 10d\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35393
- msgid "The @command{guix system} command has even more to offer! The following sub-commands allow you to visualize how your system services relate to each other:"
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:35395
- msgid "system-extension-graph"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35397
- #, no-wrap
- msgid "extension-graph"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35404
- msgid "Emit to standard output the @dfn{service extension graph} of the operating system defined in @var{file} (@pxref{Service Composition}, for more information on service extensions). By default the output is in Dot/Graphviz format, but you can choose a different format with @option{--graph-backend}, as with @command{guix graph} (@pxref{Invoking guix graph, @option{--backend}}):"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35406
- msgid "The command:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:35409
- #, no-wrap
- msgid "$ guix system extension-graph @var{file} | xdot -\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35412
- msgid "shows the extension relations among services."
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:35414
- msgid "system-shepherd-graph"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35414
- #, no-wrap
- msgid "shepherd-graph"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35419
- msgid "Emit to standard output the @dfn{dependency graph} of shepherd services of the operating system defined in @var{file}. @xref{Shepherd Services}, for more information and for an example graph."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35422
- msgid "Again, the default output format is Dot/Graphviz, but you can pass @option{--graph-backend} to select a different one."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:35426
- #, no-wrap
- msgid "Invoking @code{guix deploy}"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35434
- msgid "We've already seen @code{operating-system} declarations used to manage a machine's configuration locally. Suppose you need to configure multiple machines, though---perhaps you're managing a service on the web that's comprised of several servers. @command{guix deploy} enables you to use those same @code{operating-system} declarations to manage multiple remote hosts at once as a logical ``deployment''."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:35439 guix-git/doc/guix.texi:36900
- msgid "The functionality described in this section is still under development and is subject to change. Get in touch with us on @email{guix-devel@@gnu.org}!"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:35443
- #, no-wrap
- msgid "guix deploy @var{file}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35447
- msgid "Such an invocation will deploy the machines that the code within @var{file} evaluates to. As an example, @var{file} might contain a definition like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:35454
- #, no-wrap
- msgid ""
- ";; This is a Guix deployment of a \"bare bones\" setup, with\n"
- ";; no X11 display server, to a machine with an SSH daemon\n"
- ";; listening on localhost:2222. A configuration such as this\n"
- ";; may be appropriate for virtual machine with ports\n"
- ";; forwarded to the host's loopback interface.\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:35457
- #, no-wrap
- msgid ""
- "(use-service-modules networking ssh)\n"
- "(use-package-modules bootloaders)\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:35478
- #, no-wrap
- msgid ""
- "(define %system\n"
- " (operating-system\n"
- " (host-name \"gnu-deployed\")\n"
- " (timezone \"Etc/UTC\")\n"
- " (bootloader (bootloader-configuration\n"
- " (bootloader grub-bootloader)\n"
- " (targets '(\"/dev/vda\"))\n"
- " (terminal-outputs '(console))))\n"
- " (file-systems (cons (file-system\n"
- " (mount-point \"/\")\n"
- " (device \"/dev/vda1\")\n"
- " (type \"ext4\"))\n"
- " %base-file-systems))\n"
- " (services\n"
- " (append (list (service dhcp-client-service-type)\n"
- " (service openssh-service-type\n"
- " (openssh-configuration\n"
- " (permit-root-login #t)\n"
- " (allow-empty-passwords? #t))))\n"
- " %base-services))))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:35488
- #, no-wrap
- msgid ""
- "(list (machine\n"
- " (operating-system %system)\n"
- " (environment managed-host-environment-type)\n"
- " (configuration (machine-ssh-configuration\n"
- " (host-name \"localhost\")\n"
- " (system \"x86_64-linux\")\n"
- " (user \"alice\")\n"
- " (identity \"./id_rsa\")\n"
- " (port 2222)))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35501
- msgid "The file should evaluate to a list of @var{machine} objects. This example, upon being deployed, will create a new generation on the remote system realizing the @code{operating-system} declaration @code{%system}. @code{environment} and @code{configuration} specify how the machine should be provisioned---that is, how the computing resources should be created and managed. The above example does not create any resources, as a @code{'managed-host} is a machine that is already running the Guix system and available over the network. This is a particularly simple case; a more complex deployment may involve, for example, starting virtual machines through a Virtual Private Server (VPS) provider. In such a case, a different @var{environment} type would be used."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35506
- msgid "Do note that you first need to generate a key pair on the coordinator machine to allow the daemon to export signed archives of files from the store (@pxref{Invoking guix archive}), though this step is automatic on Guix System:"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35514
- msgid "Each target machine must authorize the key of the master machine so that it accepts store items it receives from the coordinator:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:35517
- #, no-wrap
- msgid "# guix archive --authorize < coordinator-public-key.txt\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35528
- msgid "@code{user}, in this example, specifies the name of the user account to log in as to perform the deployment. Its default value is @code{root}, but root login over SSH may be forbidden in some cases. To work around this, @command{guix deploy} can log in as an unprivileged user and employ @code{sudo} to escalate privileges. This will only work if @code{sudo} is currently installed on the remote and can be invoked non-interactively as @code{user}. That is, the line in @code{sudoers} granting @code{user} the ability to use @code{sudo} must contain the @code{NOPASSWD} tag. This can be accomplished with the following operating system configuration snippet:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:35532
- #, no-wrap
- msgid ""
- "(use-modules ...\n"
- " (gnu system)) ;for %sudoers-specification\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:35534
- #, no-wrap
- msgid ""
- "(define %user \"username\")\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:35542
- #, no-wrap
- msgid ""
- "(operating-system\n"
- " ...\n"
- " (sudoers-file\n"
- " (plain-file \"sudoers\"\n"
- " (string-append (plain-file-content %sudoers-specification)\n"
- " (format #f \"~a ALL = NOPASSWD: ALL~%\"\n"
- " %user)))))\n"
- "\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35547
- msgid "For more information regarding the format of the @file{sudoers} file, consult @command{man sudoers}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:35548
- #, no-wrap
- msgid "{Data Type} machine"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:35551
- msgid "This is the data type representing a single machine in a heterogeneous Guix deployment."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35555
- msgid "The object of the operating system configuration to deploy."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:35556
- #, no-wrap
- msgid "environment"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35558
- msgid "An @code{environment-type} describing how the machine should be provisioned."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35559
- #, no-wrap
- msgid "@code{configuration} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35564
- msgid "An object describing the configuration for the machine's @code{environment}. If the @code{environment} has a default configuration, @code{#f} may be used. If @code{#f} is used for an environment with no default configuration, however, an error will be thrown."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:35567
- #, no-wrap
- msgid "{Data Type} machine-ssh-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:35570
- msgid "This is the data type representing the SSH client parameters for a machine with an @code{environment} of @code{managed-host-environment-type}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35573
- #, no-wrap
- msgid "@code{build-locally?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35575
- msgid "If false, system derivations will be built on the machine being deployed to."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:35575
- #, no-wrap
- msgid "system"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35578
- msgid "The system type describing the architecture of the machine being deployed to---e.g., @code{\"x86_64-linux\"}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35578
- #, no-wrap
- msgid "@code{authorize?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35581
- msgid "If true, the coordinator's signing key will be added to the remote's ACL keyring."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35583
- #, no-wrap
- msgid "@code{identity} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35586
- msgid "If specified, the path to the SSH private key to use to authenticate with the remote host."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35587
- #, no-wrap
- msgid "@code{host-key} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35589
- msgid "This should be the SSH host key of the machine, which looks like this:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:35592
- #, no-wrap
- msgid "ssh-ed25519 AAAAC3Nz@dots{} root@@example.org\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35597
- msgid "When @code{host-key} is @code{#f}, the server is authenticated against the @file{~/.ssh/known_hosts} file, just like the OpenSSH @command{ssh} client does."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35598
- #, no-wrap
- msgid "@code{allow-downgrades?} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35600
- msgid "Whether to allow potential downgrades."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35608
- msgid "Like @command{guix system reconfigure}, @command{guix deploy} compares the channel commits currently deployed on the remote host (as returned by @command{guix system describe}) to those currently in use (as returned by @command{guix describe}) to determine whether commits currently in use are descendants of those deployed. When this is not the case and @code{allow-downgrades?} is false, it raises an error. This ensures you do not accidentally downgrade remote machines."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:35611
- #, no-wrap
- msgid "{Data Type} digital-ocean-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:35614
- msgid "This is the data type describing the Droplet that should be created for a machine with an @code{environment} of @code{digital-ocean-environment-type}."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:35616
- #, no-wrap
- msgid "ssh-key"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35619
- msgid "The path to the SSH private key to use to authenticate with the remote host. In the future, this field may not exist."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:35619
- #, no-wrap
- msgid "tags"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35622
- msgid "A list of string ``tags'' that uniquely identify the machine. Must be given such that no two machines in the deployment have the same set of tags."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:35622
- #, no-wrap
- msgid "region"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35624
- msgid "A Digital Ocean region slug, such as @code{\"nyc3\"}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35626
- msgid "A Digital Ocean size slug, such as @code{\"s-1vcpu-1gb\"}"
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:35626
- #, no-wrap
- msgid "enable-ipv6?"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35628
- msgid "Whether or not the droplet should be created with IPv6 networking."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:35632
- #, no-wrap
- msgid "Running Guix in a Virtual Machine"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35640
- msgid "To run Guix in a virtual machine (VM), one can use the pre-built Guix VM image distributed at @url{@value{BASE-URL}/guix-system-vm-image-@value{VERSION}.x86_64-linux.qcow2}. This image is a compressed image in QCOW format. You can pass it to an emulator such as @uref{https://qemu.org/, QEMU} (see below for details)."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35647
- msgid "This image boots the Xfce graphical environment and it contains some commonly used tools. You can install more software in the image by running @command{guix package} in a terminal (@pxref{Invoking guix package}). You can also reconfigure the system based on its initial configuration file available as @file{/run/current-system/configuration.scm} (@pxref{Using the Configuration System})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35650
- msgid "Instead of using this pre-built image, one can also build their own image using @command{guix system image} (@pxref{Invoking guix system})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:35651
- #, no-wrap
- msgid "QEMU"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35658
- msgid "If you built your own image, you must copy it out of the store (@pxref{The Store}) and give yourself permission to write to the copy before you can use it. When invoking QEMU, you must choose a system emulator that is suitable for your hardware platform. Here is a minimal QEMU invocation that will boot the result of @command{guix system image -t qcow2} on x86_64 hardware:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:35665
- #, no-wrap
- msgid ""
- "$ qemu-system-x86_64 \\\n"
- " -nic user,model=virtio-net-pci \\\n"
- " -enable-kvm -m 1024 \\\n"
- " -device virtio-blk,drive=myhd \\\n"
- " -drive if=none,file=/tmp/qemu-image,id=myhd\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35668
- msgid "Here is what each of these options means:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35670
- #, no-wrap
- msgid "qemu-system-x86_64"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35673
- msgid "This specifies the hardware platform to emulate. This should match the host."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35674
- #, no-wrap
- msgid "-nic user,model=virtio-net-pci"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35682
- msgid "Enable the unprivileged user-mode network stack. The guest OS can access the host but not vice versa. This is the simplest way to get the guest OS online. @code{model} specifies which network device to emulate: @code{virtio-net-pci} is a special device made for virtualized operating systems and recommended for most uses. Assuming your hardware platform is x86_64, you can get a list of available NIC models by running @command{qemu-system-x86_64 -nic model=help}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35683
- #, no-wrap
- msgid "-enable-kvm"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35687
- msgid "If your system has hardware virtualization extensions, enabling the virtual machine support (KVM) of the Linux kernel will make things run faster."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35689
- #, no-wrap
- msgid "-m 1024"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35692
- msgid "RAM available to the guest OS, in mebibytes. Defaults to 128@tie{}MiB, which may be insufficient for some operations."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35693
- #, no-wrap
- msgid "-device virtio-blk,drive=myhd"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35698
- msgid "Create a @code{virtio-blk} drive called ``myhd''. @code{virtio-blk} is a ``paravirtualization'' mechanism for block devices that allows QEMU to achieve better performance than if it were emulating a complete disk drive. See the QEMU and KVM documentation for more info."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35699
- #, no-wrap
- msgid "-drive if=none,file=/tmp/qemu-image,id=myhd"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35702
- msgid "Use our QCOW image, the @file{/tmp/qemu-image} file, as the backing store of the ``myhd'' drive."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35712
- msgid "The default @command{run-vm.sh} script that is returned by an invocation of @command{guix system vm} does not add a @command{-nic user} flag by default. To get network access from within the vm add the @code{(dhcp-client-service)} to your system definition and start the VM using @command{$(guix system vm config.scm) -nic user}. An important caveat of using @command{-nic user} for networking is that @command{ping} will not work, because it uses the ICMP protocol. You'll have to use a different command to check for network connectivity, for example @command{guix download}."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:35713
- #, no-wrap
- msgid "Connecting Through SSH"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35721
- msgid "To enable SSH inside a VM you need to add an SSH server like @code{openssh-service-type} to your VM (@pxref{Networking Services, @code{openssh-service-type}}). In addition you need to forward the SSH port, 22 by default, to the host. You can do this with"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:35724
- #, no-wrap
- msgid "$(guix system vm config.scm) -nic user,model=virtio-net-pci,hostfwd=tcp::10022-:22\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35727
- msgid "To connect to the VM you can run"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:35730
- #, no-wrap
- msgid "ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -p 10022 localhost\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35737
- msgid "The @command{-p} tells @command{ssh} the port you want to connect to. @command{-o UserKnownHostsFile=/dev/null} prevents @command{ssh} from complaining every time you modify your @command{config.scm} file and the @command{-o StrictHostKeyChecking=no} prevents you from having to allow a connection to an unknown host every time you connect."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:35743
- msgid "If you find the above @samp{hostfwd} example not to be working (e.g., your SSH client hangs attempting to connect to the mapped port of your VM), make sure that your Guix System VM has networking support, such as by using the @code{dhcp-client-service-type} service type."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:35745
- #, no-wrap
- msgid "Using @command{virt-viewer} with Spice"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35751
- msgid "As an alternative to the default @command{qemu} graphical client you can use the @command{remote-viewer} from the @command{virt-viewer} package. To connect pass the @command{-spice port=5930,disable-ticketing} flag to @command{qemu}. See previous section for further information on how to do this."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35754
- msgid "Spice also allows you to do some nice stuff like share your clipboard with your VM@. To enable that you'll also have to pass the following flags to @command{qemu}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:35760
- #, no-wrap
- msgid ""
- "-device virtio-serial-pci,id=virtio-serial0,max_ports=16,bus=pci.0,addr=0x5\n"
- "-chardev spicevmc,name=vdagent,id=vdagent\n"
- "-device virtserialport,nr=1,bus=virtio-serial0.0,chardev=vdagent,\\\n"
- "name=com.redhat.spice.0\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35764
- msgid "You'll also need to add the @code{(spice-vdagent-service)} to your system definition (@pxref{Miscellaneous Services, Spice service})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35771
- msgid "The previous sections show the available services and how one can combine them in an @code{operating-system} declaration. But how do we define them in the first place? And what is a service anyway?"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:35784
- #, no-wrap
- msgid "daemons"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35797
- msgid "Here we define a @dfn{service} as, broadly, something that extends the functionality of the operating system. Often a service is a process---a @dfn{daemon}---started when the system boots: a secure shell server, a Web server, the Guix build daemon, etc. Sometimes a service is a daemon whose execution can be triggered by another daemon---e.g., an FTP server started by @command{inetd} or a D-Bus service activated by @command{dbus-daemon}. Occasionally, a service does not map to a daemon. For instance, the ``account'' service collects user accounts and makes sure they exist when the system runs; the ``udev'' service collects device management rules and makes them available to the eudev daemon; the @file{/etc} service populates the @file{/etc} directory of the system."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:35798
- #, no-wrap
- msgid "service extensions"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35810
- msgid "Guix system services are connected by @dfn{extensions}. For instance, the secure shell service @emph{extends} the Shepherd---the initialization system, running as PID@tie{}1---by giving it the command lines to start and stop the secure shell daemon (@pxref{Networking Services, @code{openssh-service-type}}); the UPower service extends the D-Bus service by passing it its @file{.service} specification, and extends the udev service by passing it device management rules (@pxref{Desktop Services, @code{upower-service}}); the Guix daemon service extends the Shepherd by passing it the command lines to start and stop the daemon, and extends the account service by passing it a list of required build user accounts (@pxref{Base Services})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35814
- msgid "All in all, services and their ``extends'' relations form a directed acyclic graph (DAG). If we represent services as boxes and extensions as arrows, a typical system might provide something like this:"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35816
- msgid "@image{images/service-graph,,5in,Typical service extension graph.}"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:35817
- #, no-wrap
- msgid "system service"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35825
- msgid "At the bottom, we see the @dfn{system service}, which produces the directory containing everything to run and boot the system, as returned by the @command{guix system build} command. @xref{Service Reference}, to learn about the other service types shown here. @xref{system-extension-graph, the @command{guix system extension-graph} command}, for information on how to generate this representation for a particular operating system definition."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:35826
- #, no-wrap
- msgid "service types"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35832
- msgid "Technically, developers can define @dfn{service types} to express these relations. There can be any number of services of a given type on the system---for instance, a system running two instances of the GNU secure shell server (lsh) has two instances of @code{lsh-service-type}, with different parameters."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35835
- msgid "The following section describes the programming interface for service types and services."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35842
- msgid "A @dfn{service type} is a node in the DAG described above. Let us start with a simple example, the service type for the Guix build daemon (@pxref{Invoking guix-daemon}):"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:35852
- #, no-wrap
- msgid ""
- "(define guix-service-type\n"
- " (service-type\n"
- " (name 'guix)\n"
- " (extensions\n"
- " (list (service-extension shepherd-root-service-type guix-shepherd-service)\n"
- " (service-extension account-service-type guix-accounts)\n"
- " (service-extension activation-service-type guix-activation)))\n"
- " (default-value (guix-configuration))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35856
- msgid "It defines three things:"
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:35860
- msgid "A name, whose sole purpose is to make inspection and debugging easier."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:35865
- msgid "A list of @dfn{service extensions}, where each extension designates the target service type and a procedure that, given the parameters of the service, returns a list of objects to extend the service of that type."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:35868
- msgid "Every service type has at least one service extension. The only exception is the @dfn{boot service type}, which is the ultimate service."
- msgstr ""
- #. type: enumerate
- #: guix-git/doc/guix.texi:35871
- msgid "Optionally, a default value for instances of this type."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35874
- msgid "In this example, @code{guix-service-type} extends three services:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35876
- #, no-wrap
- msgid "shepherd-root-service-type"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35881
- msgid "The @code{guix-shepherd-service} procedure defines how the Shepherd service is extended. Namely, it returns a @code{<shepherd-service>} object that defines how @command{guix-daemon} is started and stopped (@pxref{Shepherd Services})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35882
- #, no-wrap
- msgid "account-service-type"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35887
- msgid "This extension for this service is computed by @code{guix-accounts}, which returns a list of @code{user-group} and @code{user-account} objects representing the build user accounts (@pxref{Invoking guix-daemon})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35888
- #, no-wrap
- msgid "activation-service-type"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35892
- msgid "Here @code{guix-activation} is a procedure that returns a gexp, which is a code snippet to run at ``activation time''---e.g., when the service is booted."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35895
- msgid "A service of this type is instantiated like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:35901
- #, no-wrap
- msgid ""
- "(service guix-service-type\n"
- " (guix-configuration\n"
- " (build-accounts 5)\n"
- " (extra-options '(\"--gc-keep-derivations\"))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35909
- msgid "The second argument to the @code{service} form is a value representing the parameters of this specific service instance. @xref{guix-configuration-type, @code{guix-configuration}}, for information about the @code{guix-configuration} data type. When the value is omitted, the default value specified by @code{guix-service-type} is used:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:35912
- #, no-wrap
- msgid "(service guix-service-type)\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35916
- msgid "@code{guix-service-type} is quite simple because it extends other services but is not extensible itself."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35920
- msgid "The service type for an @emph{extensible} service looks like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:35927
- #, no-wrap
- msgid ""
- "(define udev-service-type\n"
- " (service-type (name 'udev)\n"
- " (extensions\n"
- " (list (service-extension shepherd-root-service-type\n"
- " udev-shepherd-service)))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:35935
- #, no-wrap
- msgid ""
- " (compose concatenate) ;concatenate the list of rules\n"
- " (extend (lambda (config rules)\n"
- " (match config\n"
- " (($ <udev-configuration> udev initial-rules)\n"
- " (udev-configuration\n"
- " (udev udev) ;the udev package to use\n"
- " (rules (append initial-rules rules)))))))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35941
- msgid "This is the service type for the @uref{https://wiki.gentoo.org/wiki/Project:Eudev, eudev device management daemon}. Compared to the previous example, in addition to an extension of @code{shepherd-root-service-type}, we see two new fields:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35943
- #, no-wrap
- msgid "compose"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35946
- msgid "This is the procedure to @dfn{compose} the list of extensions to services of this type."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35949
- msgid "Services can extend the udev service by passing it lists of rules; we compose those extensions simply by concatenating them."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:35950
- #, no-wrap
- msgid "extend"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35953
- msgid "This procedure defines how the value of the service is @dfn{extended} with the composition of the extensions."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35958
- msgid "Udev extensions are composed into a list of rules, but the udev service value is itself a @code{<udev-configuration>} record. So here, we extend that record by appending the list of rules it contains to the list of contributed rules."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:35964
- msgid "This is a string giving an overview of the service type. The string can contain Texinfo markup (@pxref{Overview,,, texinfo, GNU Texinfo}). The @command{guix system search} command searches these strings and displays them (@pxref{Invoking guix system})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35969
- msgid "There can be only one instance of an extensible service type such as @code{udev-service-type}. If there were more, the @code{service-extension} specifications would be ambiguous."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35972
- msgid "Still here? The next section provides a reference of the programming interface for services."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:35980
- msgid "We have seen an overview of service types (@pxref{Service Types and Services}). This section provides a reference on how to manipulate services and service types. This interface is provided by the @code{(gnu services)} module."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:35981
- #, no-wrap
- msgid "{Scheme Procedure} service @var{type} [@var{value}]"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:35985
- msgid "Return a new service of @var{type}, a @code{<service-type>} object (see below). @var{value} can be any object; it represents the parameters of this particular service instance."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:35989
- msgid "When @var{value} is omitted, the default value specified by @var{type} is used; if @var{type} does not specify a default value, an error is raised."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:35991
- msgid "For instance, this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:35994
- #, no-wrap
- msgid "(service openssh-service-type)\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:35998
- msgid "is equivalent to this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36002
- #, no-wrap
- msgid ""
- "(service openssh-service-type\n"
- " (openssh-configuration))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36006
- msgid "In both cases the result is an instance of @code{openssh-service-type} with the default configuration."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36008
- #, no-wrap
- msgid "{Scheme Procedure} service? @var{obj}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36010
- msgid "Return true if @var{obj} is a service."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36012
- #, no-wrap
- msgid "{Scheme Procedure} service-kind @var{service}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36014
- msgid "Return the type of @var{service}---i.e., a @code{<service-type>} object."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36016
- #, no-wrap
- msgid "{Scheme Procedure} service-value @var{service}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36019
- msgid "Return the value associated with @var{service}. It represents its parameters."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36022
- msgid "Here is an example of how a service is created and manipulated:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36031
- #, no-wrap
- msgid ""
- "(define s\n"
- " (service nginx-service-type\n"
- " (nginx-configuration\n"
- " (nginx nginx)\n"
- " (log-directory log-directory)\n"
- " (run-directory run-directory)\n"
- " (file config-file))))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36034
- #, no-wrap
- msgid ""
- "(service? s)\n"
- "@result{} #t\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36037
- #, no-wrap
- msgid ""
- "(eq? (service-kind s) nginx-service-type)\n"
- "@result{} #t\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36047
- msgid "The @code{modify-services} form provides a handy way to change the parameters of some of the services of a list such as @code{%base-services} (@pxref{Base Services, @code{%base-services}}). It evaluates to a list of services. Of course, you could always use standard list combinators such as @code{map} and @code{fold} to do that (@pxref{SRFI-1, List Library,, guile, GNU Guile Reference Manual}); @code{modify-services} simply provides a more concise form for this common pattern."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36048
- #, no-wrap
- msgid "{Scheme Syntax} modify-services @var{services} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36050
- msgid "(@var{type} @var{variable} => @var{body}) @dots{}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36053
- msgid "Modify the services listed in @var{services} according to the given clauses. Each clause has the form:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:36056
- #, no-wrap
- msgid "(@var{type} @var{variable} => @var{body})\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36063
- msgid "where @var{type} is a service type---e.g., @code{guix-service-type}---and @var{variable} is an identifier that is bound within the @var{body} to the service parameters---e.g., a @code{guix-configuration} instance---of the original service of that @var{type}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36070
- msgid "The @var{body} should evaluate to the new service parameters, which will be used to configure the new service. This new service will replace the original in the resulting list. Because a service's service parameters are created using @code{define-record-type*}, you can write a succinct @var{body} that evaluates to the new service parameters by using the @code{inherit} feature that @code{define-record-type*} provides."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36072
- msgid "Clauses can also have the following form:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36075
- #, no-wrap
- msgid "(delete @var{type})\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36079
- msgid "Such a clause removes all services of the given @var{type} from @var{services}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36081
- msgid "@xref{Using the Configuration System}, for example usage."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36088
- msgid "Next comes the programming interface for service types. This is something you want to know when writing new service definitions, but not necessarily when simply looking for ways to customize your @code{operating-system} declaration."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:36089
- #, no-wrap
- msgid "{Data Type} service-type"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:36090
- #, no-wrap
- msgid "service type"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:36093
- msgid "This is the representation of a @dfn{service type} (@pxref{Service Types and Services})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36097
- msgid "This is a symbol, used only to simplify inspection and debugging."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:36098
- #, no-wrap
- msgid "extensions"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36100
- msgid "A non-empty list of @code{<service-extension>} objects (see below)."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:36101
- #, no-wrap
- msgid "@code{compose} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36105
- msgid "If this is @code{#f}, then the service type denotes services that cannot be extended---i.e., services that do not receive ``values'' from other services."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36109
- msgid "Otherwise, it must be a one-argument procedure. The procedure is called by @code{fold-services} and is passed a list of values collected from extensions. It may return any single value."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:36110
- #, no-wrap
- msgid "@code{extend} (default: @code{#f})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36112
- msgid "If this is @code{#f}, services of this type cannot be extended."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36118
- msgid "Otherwise, it must be a two-argument procedure: @code{fold-services} calls it, passing it the initial value of the service as the first argument and the result of applying @code{compose} to the extension values as the second argument. It must return a value that is a valid parameter value for the service instance."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36124
- msgid "This is a string, possibly using Texinfo markup, describing in a couple of sentences what the service is about. This string allows users to find about the service through @command{guix system search} (@pxref{Invoking guix system})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:36125
- #, no-wrap
- msgid "@code{default-value} (default: @code{&no-default-value})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36128
- msgid "The default value associated for instances of this service type. This allows users to use the @code{service} form without its second argument:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36131
- #, no-wrap
- msgid "(service @var{type})\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36135
- msgid "The returned service in this case has the default value specified by @var{type}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:36138
- msgid "@xref{Service Types and Services}, for examples."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36140
- #, no-wrap
- msgid "{Scheme Procedure} service-extension @var{target-type} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36146
- msgid "@var{compute} Return a new extension for services of type @var{target-type}. @var{compute} must be a one-argument procedure: @code{fold-services} calls it, passing it the value associated with the service that provides the extension; it must return a valid value for the target service."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36148
- #, no-wrap
- msgid "{Scheme Procedure} service-extension? @var{obj}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36150
- msgid "Return true if @var{obj} is a service extension."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36156
- msgid "Occasionally, you might want to simply extend an existing service. This involves creating a new service type and specifying the extension of interest, which can be verbose; the @code{simple-service} procedure provides a shorthand for this."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36157
- #, no-wrap
- msgid "{Scheme Procedure} simple-service @var{name} @var{target} @var{value}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36161
- msgid "Return a service that extends @var{target} with @var{value}. This works by creating a singleton service type @var{name}, of which the returned service is an instance."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36164
- msgid "For example, this extends mcron (@pxref{Scheduled Job Execution}) with an additional job:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36168
- #, no-wrap
- msgid ""
- "(simple-service 'my-mcron-job mcron-service-type\n"
- " #~(job '(next-hour (3)) \"guix gc -F 2G\"))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36178
- msgid "At the core of the service abstraction lies the @code{fold-services} procedure, which is responsible for ``compiling'' a list of services down to a single directory that contains everything needed to boot and run the system---the directory shown by the @command{guix system build} command (@pxref{Invoking guix system}). In essence, it propagates service extensions down the service graph, updating each node parameters on the way, until it reaches the root node."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36179
- #, no-wrap
- msgid "{Scheme Procedure} fold-services @var{services} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36183
- msgid "[#:target-type @var{system-service-type}] Fold @var{services} by propagating their extensions down to the root of type @var{target-type}; return the root service adjusted accordingly."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36187
- msgid "Lastly, the @code{(gnu services)} module also defines several essential service types, some of which are listed below."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:36188
- #, no-wrap
- msgid "{Scheme Variable} system-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:36191
- msgid "This is the root of the service graph. It produces the system directory as returned by the @command{guix system build} command."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:36193
- #, no-wrap
- msgid "{Scheme Variable} boot-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:36196
- msgid "The type of the ``boot service'', which produces the @dfn{boot script}. The boot script is what the initial RAM disk runs when booting."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:36198
- #, no-wrap
- msgid "{Scheme Variable} etc-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:36202
- msgid "The type of the @file{/etc} service. This service is used to create files under @file{/etc} and can be extended by passing it name/file tuples such as:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36205
- #, no-wrap
- msgid "(list `(\"issue\" ,(plain-file \"issue\" \"Welcome!\\n\")))\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:36209
- msgid "In this example, the effect would be to add an @file{/etc/issue} file pointing to the given file."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:36211
- #, no-wrap
- msgid "{Scheme Variable} setuid-program-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:36215
- msgid "Type for the ``setuid-program service''. This service collects lists of executable file names, passed as gexps, and adds them to the set of setuid-root programs on the system (@pxref{Setuid Programs})."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:36217
- #, no-wrap
- msgid "{Scheme Variable} profile-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:36221
- msgid "Type of the service that populates the @dfn{system profile}---i.e., the programs under @file{/run/current-system/profile}. Other services can extend it by passing it lists of packages to add to the system profile."
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:36225
- msgid "provenance-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:36225
- #, no-wrap
- msgid "{Scheme Variable} provenance-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:36229
- msgid "This is the type of the service that records @dfn{provenance meta-data} in the system itself. It creates several files under @file{/run/current-system}:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:36231
- #, no-wrap
- msgid "channels.scm"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36236
- msgid "This is a ``channel file'' that can be passed to @command{guix pull -C} or @command{guix time-machine -C}, and which describes the channels used to build the system, if that information was available (@pxref{Channels})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:36237
- #, no-wrap
- msgid "configuration.scm"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36242
- msgid "This is the file that was passed as the value for this @code{provenance-service-type} service. By default, @command{guix system reconfigure} automatically passes the OS configuration file it received on the command line."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:36243
- #, no-wrap
- msgid "provenance"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36246
- msgid "This contains the same information as the two other files but in a format that is more readily processable."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:36250
- msgid "In general, these two pieces of information (channels and configuration file) are enough to reproduce the operating system ``from source''."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:36251
- #, no-wrap
- msgid "Caveats"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:36258
- msgid "This information is necessary to rebuild your operating system, but it is not always sufficient. In particular, @file{configuration.scm} itself is insufficient if it is not self-contained---if it refers to external Guile modules or to extra files. If you want @file{configuration.scm} to be self-contained, we recommend that modules or files it refers to be part of a channel."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:36266
- msgid "Besides, provenance meta-data is ``silent'' in the sense that it does not change the bits contained in your system, @emph{except for the meta-data bits themselves}. Two different OS configurations or sets of channels can lead to the same system, bit-for-bit; when @code{provenance-service-type} is used, these two systems will have different meta-data and thus different store file names, which makes comparison less trivial."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:36271
- msgid "This service is automatically added to your operating system configuration when you use @command{guix system reconfigure}, @command{guix system init}, or @command{guix deploy}."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:36273
- #, no-wrap
- msgid "{Scheme Variable} linux-loadable-module-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:36277
- msgid "Type of the service that collects lists of packages containing kernel-loadable modules, and adds them to the set of kernel-loadable modules."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:36280
- msgid "This service type is intended to be extended by other service types, such as below:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36286
- #, no-wrap
- msgid ""
- "(simple-service 'installing-module\n"
- " linux-loadable-module-service-type\n"
- " (list module-to-install-1\n"
- " module-to-install-2))\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:36290
- msgid "This does not actually load modules at bootup, only adds it to the kernel profile so that it @emph{can} be loaded by other means."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:36295 guix-git/doc/guix.texi:37447
- #, no-wrap
- msgid "shepherd services"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:36296
- #, no-wrap
- msgid "PID 1"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:36297
- #, no-wrap
- msgid "init system"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36303
- msgid "The @code{(gnu services shepherd)} module provides a way to define services managed by the GNU@tie{}Shepherd, which is the initialization system---the first process that is started when the system boots, also known as PID@tie{}1 (@pxref{Introduction,,, shepherd, The GNU Shepherd Manual})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36309
- msgid "Services in the Shepherd can depend on each other. For instance, the SSH daemon may need to be started after the syslog daemon has been started, which in turn can only happen once all the file systems have been mounted. The simple operating system defined earlier (@pxref{Using the Configuration System}) results in a service graph like this:"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36311
- msgid "@image{images/shepherd-graph,,5in,Typical shepherd service graph.}"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36315
- msgid "You can actually generate such a graph for any operating system definition using the @command{guix system shepherd-graph} command (@pxref{system-shepherd-graph, @command{guix system shepherd-graph}})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36319
- msgid "The @code{%shepherd-root-service} is a service object representing PID@tie{}1, of type @code{shepherd-root-service-type}; it can be extended by passing it lists of @code{<shepherd-service>} objects."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:36320
- #, no-wrap
- msgid "{Data Type} shepherd-service"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:36322
- msgid "The data type representing a service managed by the Shepherd."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:36324
- #, no-wrap
- msgid "provision"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36326
- msgid "This is a list of symbols denoting what the service provides."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36331
- msgid "These are the names that may be passed to @command{herd start}, @command{herd status}, and similar commands (@pxref{Invoking herd,,, shepherd, The GNU Shepherd Manual}). @xref{Slots of services, the @code{provides} slot,, shepherd, The GNU Shepherd Manual}, for details."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:36332
- #, no-wrap
- msgid "@code{requirement} (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36334
- msgid "List of symbols denoting the Shepherd services this one depends on."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:36335
- #, no-wrap
- msgid "one-shot services, for the Shepherd"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36340
- msgid "Whether this service is @dfn{one-shot}. One-shot services stop immediately after their @code{start} action has completed. @xref{Slots of services,,, shepherd, The GNU Shepherd Manual}, for more info."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:36341
- #, no-wrap
- msgid "@code{respawn?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36344
- msgid "Whether to restart the service when it stops, for instance when the underlying process dies."
- msgstr ""
- #. type: code{#1}
- #: guix-git/doc/guix.texi:36345
- #, no-wrap
- msgid "start"
- msgstr ""
- #. type: itemx
- #: guix-git/doc/guix.texi:36346
- #, no-wrap
- msgid "@code{stop} (default: @code{#~(const #f)})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36352
- msgid "The @code{start} and @code{stop} fields refer to the Shepherd's facilities to start and stop processes (@pxref{Service De- and Constructors,,, shepherd, The GNU Shepherd Manual}). They are given as G-expressions that get expanded in the Shepherd configuration file (@pxref{G-Expressions})."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:36353
- #, no-wrap
- msgid "@code{actions} (default: @code{'()})"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:36354
- #, no-wrap
- msgid "actions, of Shepherd services"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36359
- msgid "This is a list of @code{shepherd-action} objects (see below) defining @dfn{actions} supported by the service, in addition to the standard @code{start} and @code{stop} actions. Actions listed here become available as @command{herd} sub-commands:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:36362
- #, no-wrap
- msgid "herd @var{action} @var{service} [@var{arguments}@dots{}]\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:36364
- #, no-wrap
- msgid "@code{auto-start?} (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36367
- msgid "Whether this service should be started automatically by the Shepherd. If it is @code{#f} the service has to be started manually with @code{herd start}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36370
- msgid "A documentation string, as shown when running:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:36373
- #, no-wrap
- msgid "herd doc @var{service-name}\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36377
- msgid "where @var{service-name} is one of the symbols in @code{provision} (@pxref{Invoking herd,,, shepherd, The GNU Shepherd Manual})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36381
- msgid "This is the list of modules that must be in scope when @code{start} and @code{stop} are evaluated."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36389
- msgid "The example below defines a Shepherd service that spawns @command{syslogd}, the system logger from the GNU Networking Utilities (@pxref{syslogd invocation, @command{syslogd},, inetutils, GNU Inetutils}):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:36401
- #, no-wrap
- msgid ""
- "(let ((config (plain-file \"syslogd.conf\" \"@dots{}\")))\n"
- " (shepherd-service\n"
- " (documentation \"Run the syslog daemon (syslogd).\")\n"
- " (provision '(syslogd))\n"
- " (requirement '(user-processes))\n"
- " (start #~(make-forkexec-constructor\n"
- " (list #$(file-append inetutils \"/libexec/syslogd\")\n"
- " \"--rcfile\" #$config)\n"
- " #:pid-file \"/var/run/syslog.pid\"))\n"
- " (stop #~(make-kill-destructor))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36416
- msgid "Key elements in this example are the @code{start} and @code{stop} fields: they are @dfn{staged} code snippets that use the @code{make-forkexec-constructor} procedure provided by the Shepherd and its dual, @code{make-kill-destructor} (@pxref{Service De- and Constructors,,, shepherd, The GNU Shepherd Manual}). The @code{start} field will have @command{shepherd} spawn @command{syslogd} with the given option; note that we pass @code{config} after @option{--rcfile}, which is a configuration file declared above (contents of this file are omitted). Likewise, the @code{stop} field tells how this service is to be stopped; in this case, it is stopped by making the @code{kill} system call on its PID@. Code staging is achieved using G-expressions: @code{#~} stages code, while @code{#$} ``escapes'' back to host code (@pxref{G-Expressions})."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:36417
- #, no-wrap
- msgid "{Data Type} shepherd-action"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:36420
- msgid "This is the data type that defines additional actions implemented by a Shepherd service (see above)."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36424
- msgid "Symbol naming the action."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36427
- msgid "This is a documentation string for the action. It can be viewed by running:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:36430
- #, no-wrap
- msgid "herd doc @var{service} action @var{action}\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:36432
- #, no-wrap
- msgid "procedure"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36436
- msgid "This should be a gexp that evaluates to a procedure of at least one argument, which is the ``running value'' of the service (@pxref{Slots of services,,, shepherd, The GNU Shepherd Manual})."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:36440
- msgid "The following example defines an action called @code{say-hello} that kindly greets the user:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36449
- #, no-wrap
- msgid ""
- "(shepherd-action\n"
- " (name 'say-hello)\n"
- " (documentation \"Say hi!\")\n"
- " (procedure #~(lambda (running . args)\n"
- " (format #t \"Hello, friend! arguments: ~s\\n\"\n"
- " args)\n"
- " #t)))\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:36452
- msgid "Assuming this action is added to the @code{example} service, then you can do:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:36458
- #, no-wrap
- msgid ""
- "# herd say-hello example\n"
- "Hello, friend! arguments: ()\n"
- "# herd say-hello example a b c\n"
- "Hello, friend! arguments: (\"a\" \"b\" \"c\")\n"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:36463
- msgid "This, as you can see, is a fairly sophisticated way to say hello. @xref{Service Convenience,,, shepherd, The GNU Shepherd Manual}, for more info on actions."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:36465
- #, no-wrap
- msgid "{Scheme Variable} shepherd-root-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:36467
- msgid "The service type for the Shepherd ``root service''---i.e., PID@tie{}1."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:36472
- msgid "This is the service type that extensions target when they want to create shepherd services (@pxref{Service Types and Services}, for an example). Each extension must pass a list of @code{<shepherd-service>}. Its value must be a @code{shepherd-configuration}, as described below."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:36474
- #, no-wrap
- msgid "{Data Type} shepherd-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:36476 guix-git/doc/guix.texi:37463
- msgid "This data type represents the Shepherd's configuration."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:36478 guix-git/doc/guix.texi:37465
- #, no-wrap
- msgid "shepherd (default: @code{shepherd})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36480 guix-git/doc/guix.texi:37467
- msgid "The Shepherd package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:36481 guix-git/doc/guix.texi:37471
- #, no-wrap
- msgid "services (default: @code{'()})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:36485 guix-git/doc/guix.texi:37475
- msgid "A list of @code{<shepherd-service>} to start. You should probably use the service extension mechanism instead (@pxref{Shepherd Services})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36490
- msgid "The following example specifies the Shepherd package for the operating system:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36505
- #, no-wrap
- msgid ""
- "(operating-system\n"
- " ;; ...\n"
- " (services (append (list openssh-service-type))\n"
- " ;; ...\n"
- " %desktop-services)\n"
- " ;; ...\n"
- " ;; Use own Shepherd package.\n"
- " (essential-services\n"
- " (modify-services (operating-system-default-essential-services\n"
- " this-operating-system)\n"
- " (shepherd-root-service-type config => (shepherd-configuration\n"
- " (inherit config)\n"
- " (shepherd my-shepherd))))))\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:36507
- #, no-wrap
- msgid "{Scheme Variable} %shepherd-root-service"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:36509
- msgid "This service represents PID@tie{}1."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:36513
- #, fuzzy, no-wrap
- #| msgid "Documentation"
- msgid "complex configurations"
- msgstr "مستندات"
- #. type: Plain text
- #: guix-git/doc/guix.texi:36518
- msgid "Some programs might have rather complex configuration files or formats, and to make it easier to create Scheme bindings for these configuration files, you can use the utilities defined in the @code{(gnu services configuration)} module."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36526
- msgid "The main utility is the @code{define-configuration} macro, which you will use to define a Scheme record type (@pxref{Record Overview,,, guile, GNU Guile Reference Manual}). The Scheme record will be serialized to a configuration file by using @dfn{serializers}, which are procedures that take some kind of Scheme value and returns a G-expression (@pxref{G-Expressions}), which should, once serialized to the disk, return a string. More details are listed below."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36527
- #, no-wrap
- msgid "{Scheme Syntax} define-configuration @var{name} @var{clause1} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36531
- msgid "@var{clause2} ... Create a record type named @code{@var{name}} that contains the fields found in the clauses."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36533
- msgid "A clause can have one of the following forms:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:36538
- #, no-wrap
- msgid ""
- "(@var{field-name}\n"
- " (@var{type} @var{default-value})\n"
- " @var{documentation})\n"
- " \n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:36543
- #, no-wrap
- msgid ""
- "(@var{field-name}\n"
- " (@var{type} @var{default-value})\n"
- " @var{documentation}\n"
- " @var{serializer})\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:36547
- #, no-wrap
- msgid ""
- "(@var{field-name}\n"
- " (@var{type})\n"
- " @var{documentation})\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:36552
- #, no-wrap
- msgid ""
- "(@var{field-name}\n"
- " (@var{type})\n"
- " @var{documentation}\n"
- " @var{serializer})\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36556
- msgid "@var{field-name} is an identifier that denotes the name of the field in the generated record."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36564
- msgid "@var{type} is the type of the value corresponding to @var{field-name}; since Guile is untyped, a predicate procedure---@code{@var{type}?}---will be called on the value corresponding to the field to ensure that the value is of the correct type. This means that if say, @var{type} is @code{package}, then a procedure named @code{package?} will be applied on the value to make sure that it is indeed a @code{<package>} object."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36568
- msgid "@var{default-value} is the default value corresponding to the field; if none is specified, the user is forced to provide a value when creating an object of the record type."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36573
- msgid "@var{documentation} is a string formatted with Texinfo syntax which should provide a description of what setting this field does."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36580
- msgid "@var{serializer} is the name of a procedure which takes two arguments, the first is the name of the field, and the second is the value corresponding to the field. The procedure should return a string or G-expression (@pxref{G-Expressions}) that represents the content that will be serialized to the configuration file. If none is specified, a procedure of the name @code{serialize-@var{type}} will be used."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36582
- msgid "A simple serializer procedure could look like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36587
- #, no-wrap
- msgid ""
- "(define (serialize-boolean field-name value)\n"
- " (let ((value (if value \"true\" \"false\")))\n"
- " #~(string-append #$field-name #$value)))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36598
- msgid "In some cases multiple different configuration records might be defined in the same file, but their serializers for the same type might have to be different, because they have different configuration formats. For example, the @code{serialize-boolean} procedure for the Getmail service would have to be different for the one for the Transmission service. To make it easier to deal with this situation, one can specify a serializer prefix by using the @code{prefix} literal in the @code{define-configuration} form. This means that one doesn't have to manually specify a custom @var{serializer} for every field."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36602
- #, no-wrap
- msgid ""
- "(define (foo-serialize-string field-name value)\n"
- " @dots{})\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36605
- #, no-wrap
- msgid ""
- "(define (bar-serialize-string field-name value)\n"
- " @dots{})\n"
- " \n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36611
- #, no-wrap
- msgid ""
- "(define-configuration foo-configuration\n"
- " (label\n"
- " (string)\n"
- " \"The name of label.\")\n"
- " (prefix foo-))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36617
- #, no-wrap
- msgid ""
- "(define-configuration bar-configuration\n"
- " (ip-address\n"
- " (string)\n"
- " \"The IPv4 address for this device.\")\n"
- " (prefix bar-))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36623
- msgid "However, in some cases you might not want to serialize any of the values of the record, to do this, you can use the @code{no-serialization} literal. There is also the @code{define-configuration/no-serialization} macro which is a shorthand of this."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36631
- #, no-wrap
- msgid ""
- ";; Nothing will be serialized to disk.\n"
- "(define-configuration foo-configuration\n"
- " (field\n"
- " (string \"test\")\n"
- " \"Some documentation.\")\n"
- " (no-serialization))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36637
- #, no-wrap
- msgid ""
- ";; The same thing as above.\n"
- "(define-configuration/no-serialization bar-configuration\n"
- " (field\n"
- " (string \"test\")\n"
- " \"Some documentation.\"))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36640
- #, no-wrap
- msgid "{Scheme Syntax} define-maybe @var{type}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36645
- msgid "Sometimes a field should not be serialized if the user doesn’t specify a value. To achieve this, you can use the @code{define-maybe} macro to define a ``maybe type''; if the value of a maybe type is set to the @code{disabled}, it will not be serialized."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36652
- msgid "When defining a ``maybe type'', the corresponding serializer for the regular type will be used by default. For example, a field of type @code{maybe-string} will be serialized using the @code{serialize-string} procedure by default, you can of course change this by specifying a custom serializer procedure. Likewise, the type of the value would have to be a string, unless it is set to the @code{disabled} symbol."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36655
- #, no-wrap
- msgid ""
- "(define-maybe string)\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36658
- #, no-wrap
- msgid ""
- "(define (serialize-string field-name value)\n"
- " @dots{})\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36665
- #, no-wrap
- msgid ""
- "(define-configuration baz-configuration\n"
- " (name\n"
- " ;; Nothing will be serialized by default. If set to a string, the\n"
- " ;; `serialize-string' procedure will be used to serialize the string.\n"
- " (maybe-string 'disabled)\n"
- " \"The name of this module.\"))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36669
- msgid "Like with @code{define-configuration}, one can set a prefix for the serializer name by using the @code{prefix} literal."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36673
- #, no-wrap
- msgid ""
- "(define-maybe integer\n"
- " (prefix baz-))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36676
- #, no-wrap
- msgid ""
- "(define (baz-serialize-interger field-name value)\n"
- " @dots{})\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36683
- msgid "There is also the @code{no-serialization} literal, which when set means that no serializer will be defined for the ``maybe type'', regardless of its value is @code{disabled} or not. @code{define-maybe/no-serialization} is a shorthand for specifying the @code{no-serialization} literal."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36686
- #, no-wrap
- msgid ""
- "(define-maybe/no-serialization symbol)\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36691
- #, no-wrap
- msgid ""
- "(define-configuration/no-serialization test-configuration\n"
- " (mode\n"
- " (maybe-symbol 'disabled)\n"
- " \"Docstring.\"))\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36694
- #, no-wrap
- msgid "{Scheme Procedure} serialize-configuration @var{configuration} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36700
- msgid "@var{fields} Return a G-expression that contains the values corresponding to the @var{fields} of @var{configuration}, a record that has been generated by @code{define-configuration}. The G-expression can then be serialized to disk by using something like @code{mixed-text-file}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36702
- #, no-wrap
- msgid "{Scheme Procedure} validate-configuration @var{configuration}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36706
- msgid "@var{fields} Type-check @var{fields}, a list of field names of @var{configuration}, a configuration record created by @code{define-configuration}."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36708
- #, no-wrap
- msgid "{Scheme Procedure} empty-serializer @var{field-name} @var{value}"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36711
- msgid "A serializer that just returns an empty string. The @code{serialize-package} procedure is an alias for this."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36716
- msgid "Once you have defined a configuration record, you will most likely also want to document it so that other people know to use it. To help with that, there are two procedures, both of which are documented below."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36717
- #, no-wrap
- msgid "{Scheme Procedure} generate-documentation @var{documentation} @"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36724
- msgid "@var{documentation-name} Generate a Texinfo fragment from the docstrings in @var{documentation}, a list of @code{(@var{label} @var{fields} @var{sub-documentation} ...)}. @var{label} should be a symbol and should be the name of the configuration record. @var{fields} should be a list of all the fields available for the configuration record."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36729
- msgid "@var{sub-documentation} is a @code{(@var{field-name} @var{configuration-name})} tuple. @var{field-name} is the name of the field which takes another configuration record as its value, and @var{configuration-name} is the name of that configuration record."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36736
- msgid "@var{sub-documentation} is only needed if there are nested configuration records. For example, the @code{getmail-configuration} record (@pxref{Mail Services}) accepts a @code{getmail-configuration-file} record in one of its @code{rcfile} field, therefore documentation for @code{getmail-configuration-file} is nested in @code{getmail-configuration}."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36743
- #, no-wrap
- msgid ""
- "(generate-documentation\n"
- " `((getmail-configuration ,getmail-configuration-fields\n"
- " (rcfile getmail-configuration-file))\n"
- " @dots{})\n"
- " 'getmail-configuration)\n"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36747
- msgid "@var{documentation-name} should be a symbol and should be the name of the configuration record."
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36750
- #, no-wrap
- msgid "{Scheme Procedure} configuration->documentation"
- msgstr ""
- #. type: deffn
- #: guix-git/doc/guix.texi:36757
- msgid "@var{configuration-symbol} Take @var{configuration-symbol}, the symbol corresponding to the name used when defining a configuration record with @code{define-configuration}, and print the Texinfo documentation of its fields. This is useful if there aren’t any nested configuration records since it only prints the documentation for the top-level fields."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36765
- msgid "As of right now, there is no automated way to generate documentation for configuration records and put them in the manual. Instead, every time you make a change to the docstrings of a configuration record, you have to manually call @code{generate-documentation} or @code{configuration->documentation}, and paste the output into the @file{doc/guix.texi} file."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36769
- msgid "Below is an example of a record type created using @code{define-configuration} and friends."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36776
- #, no-wrap
- msgid ""
- "(use-modules (gnu services)\n"
- " (guix gexp)\n"
- " (gnu services configuration)\n"
- " (srfi srfi-26)\n"
- " (srfi srfi-1))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36784
- #, no-wrap
- msgid ""
- ";; Turn field names, which are Scheme symbols into strings\n"
- "(define (uglify-field-name field-name)\n"
- " (let ((str (symbol->string field-name)))\n"
- " ;; field? -> is-field\n"
- " (if (string-suffix? \"?\" str)\n"
- " (string-append \"is-\" (string-drop-right str 1))\n"
- " str)))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36787
- #, no-wrap
- msgid ""
- "(define (serialize-string field-name value)\n"
- " #~(string-append #$(uglify-field-name field-name) \" = \" #$value \"\\n\"))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36790
- #, no-wrap
- msgid ""
- "(define (serialize-integer field-name value)\n"
- " (serialize-string field-name (number->string value)))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36793
- #, no-wrap
- msgid ""
- "(define (serialize-boolean field-name value)\n"
- " (serialize-string field-name (if value \"true\" \"false\")))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36796
- #, no-wrap
- msgid ""
- "(define (serialize-contact-name field-name value)\n"
- " #~(string-append \"\\n[\" #$value \"]\\n\"))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36799
- #, no-wrap
- msgid ""
- "(define (list-of-contact-configurations? lst)\n"
- " (every contact-configuration? lst))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36804
- #, no-wrap
- msgid ""
- "(define (serialize-list-of-contact-configurations field-name value)\n"
- " #~(string-append #$@@(map (cut serialize-configuration <>\n"
- " contact-configuration-fields)\n"
- " value)))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36811
- #, no-wrap
- msgid ""
- "(define (serialize-contacts-list-configuration configuration)\n"
- " (mixed-text-file\n"
- " \"contactrc\"\n"
- " #~(string-append \"[Owner]\\n\"\n"
- " #$(serialize-configuration\n"
- " configuration contacts-list-configuration-fields))))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36814
- #, no-wrap
- msgid ""
- "(define-maybe integer)\n"
- "(define-maybe string)\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36829
- #, no-wrap
- msgid ""
- "(define-configuration contact-configuration\n"
- " (name\n"
- " (string)\n"
- " \"The name of the contact.\"\n"
- " serialize-contact-name)\n"
- " (phone-number\n"
- " (maybe-integer 'disabled)\n"
- " \"The person's phone number.\")\n"
- " (email\n"
- " (maybe-string 'disabled)\n"
- " \"The person's email address.\")\n"
- " (married?\n"
- " (boolean)\n"
- " \"Whether the person is married.\"))\n"
- "\n"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36841
- #, no-wrap
- msgid ""
- "(define-configuration contacts-list-configuration\n"
- " (name\n"
- " (string)\n"
- " \"The name of the owner of this contact list.\")\n"
- " (email\n"
- " (string)\n"
- " \"The owner's email address.\")\n"
- " (contacts\n"
- " (list-of-contact-configurations '())\n"
- " \"A list of @@code@{contact-configuation@} records which contain\n"
- "information about all your contacts.\"))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36844
- msgid "A contacts list configuration could then be created like this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:36860
- #, no-wrap
- msgid ""
- "(define my-contacts\n"
- " (contacts-list-configuration\n"
- " (name \"Alice\")\n"
- " (email \"alice@@example.org\")\n"
- " (contacts\n"
- " (list (contact-configuration\n"
- " (name \"Bob\")\n"
- " (phone-number 1234)\n"
- " (email \"bob@@gnu.org\")\n"
- " (married? #f))\n"
- " (contact-configuration\n"
- " (name \"Charlie\")\n"
- " (phone-number 0000)\n"
- " (married? #t))))))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36864
- msgid "After serializing the configuration to disk, the resulting file would look like this:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:36869
- #, no-wrap
- msgid ""
- "[owner]\n"
- "name = Alice\n"
- "email = alice@@example.org\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:36874
- #, no-wrap
- msgid ""
- "[Bob]\n"
- "phone-number = 1234\n"
- "email = bob@@gnu.org\n"
- "is-married = false\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:36878
- #, no-wrap
- msgid ""
- "[Charlie]\n"
- "phone-number = 0\n"
- "is-married = true\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:36883
- #, no-wrap
- msgid "home configuration"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36895
- msgid "Guix supports declarative configuration of @dfn{home environments} by utilizing the configuration mechanism described in the previous chapter (@pxref{Defining Services}), but for user's dotfiles and packages. It works both on Guix System and foreign distros and allows users to declare all the packages and services that should be installed and configured for the user. Once a user has written a file containing @code{home-environment} record, such a configuration can be @dfn{instantiated} by an unprivileged user with the @command{guix home} command (@pxref{Invoking guix home})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36912
- msgid "The user's home environment usually consists of three basic parts: software, configuration, and state. Software in mainstream distros are usually installed system-wide, but with GNU Guix most software packages can be installed on a per-user basis without needing root privileges, and are thus considered part of the user’s @dfn{home environment}. Packages on their own not very useful in many cases, because often they require some additional configuration, usually config files that reside in @env{XDG_CONFIG_HOME} (@file{~/.config} by default) or other directories. Everything else can be considered state, like media files, application databases, and logs."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36915
- msgid "Using Guix for managing home environments provides a number of advantages:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:36918
- #, no-wrap
- msgid "All software can be configured in one language (Guile Scheme),"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:36921
- msgid "this gives users the ability to share values between configurations of different programs."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:36922
- #, no-wrap
- msgid "A well-defined home environment is self-contained and can be"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:36925
- msgid "created in a declarative and reproducible way---there is no need to grab external binaries or manually edit some configuration file."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:36926
- #, no-wrap
- msgid "After every @command{guix home reconfigure} invocation, a new home"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:36930
- msgid "environment generation will be created. This means that users can rollback to a previous home environment generation so they don’t have to worry about breaking their configuration."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:36931
- #, no-wrap
- msgid "It is possible to manage stateful data with Guix Home, this"
- msgstr ""
- #. type: itemize
- #: guix-git/doc/guix.texi:36936
- msgid "includes the ability to automatically clone Git repositories on the initial setup of the machine, and periodically running commands like @command{rsync} to sync data with another host. This functionality is still in an experimental stage, though."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:36944 guix-git/doc/guix.texi:36946
- #: guix-git/doc/guix.texi:36947
- #, no-wrap
- msgid "Declaring the Home Environment"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:36944
- msgid "Customizing your Home."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:36944 guix-git/doc/guix.texi:37014
- #: guix-git/doc/guix.texi:37015
- #, no-wrap
- msgid "Configuring the Shell"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:36944
- msgid "Enabling home environment."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:36944 guix-git/doc/guix.texi:37061
- #: guix-git/doc/guix.texi:37062
- #, no-wrap
- msgid "Home Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:36944
- msgid "Specifying home services."
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:36944
- msgid "Instantiating a home configuration."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36953
- msgid "The home environment is configured by providing a @code{home-environment} declaration in a file that can be passed to the @command{guix home} command (@pxref{Invoking guix home}). The easiest way to get started is by generating an initial configuration with @command{guix home import}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:36956
- #, no-wrap
- msgid "guix home import ~/src/guix-config\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36964
- msgid "The @command{guix home import} command reads some of the ``dot files'' such as @file{~/.bashrc} found in your home directory and copies them to the given directory, @file{~/src/guix-config} in this case; it also reads the contents of your profile, @file{~/.guix-profile}, and, based on that, it populates @file{~/src/guix-config/home-configuration.scm} with a Home configuration that resembles your current configuration."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36970
- msgid "A simple setup can include Bash and a custom text configuration, like in the example below. Don't be afraid to declare home environment parts, which overlaps with your current dot files: before installing any configuration files, Guix Home will back up existing config files to a separate place in the home directory."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:36976
- msgid "It is highly recommended that you manage your shell or shells with Guix Home, because it will make sure that all the necessary scripts are sourced by the shell configuration file. Otherwise you will need to do it manually. (@pxref{Configuring the Shell})."
- msgstr ""
- #. type: findex
- #: guix-git/doc/guix.texi:36978
- #, no-wrap
- msgid "home-environment"
- msgstr ""
- #. type: include
- #: guix-git/doc/guix.texi:36980
- #, no-wrap
- msgid "he-config-bare-bones.scm"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36987
- msgid "The @code{packages} field should be self-explanatory, it will install the list of packages into the user's profile. The most important field is @code{services}, it contains a list of @dfn{home services}, which are the basic building blocks of a home environment."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36995
- msgid "There is no daemon (at least not necessarily) related to a home service, a home service is just an element that is used to declare part of home environment and extend other parts of it. The extension mechanism discussed in the previous chapter (@pxref{Defining Services}) should not be confused with Shepherd services (@pxref{Shepherd Services}). Using this extension mechanism and some Scheme code that glues things together gives the user the freedom to declare their own, very custom, home environments."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:36998
- msgid "Once you have a configuration file that suits your needs, you can reconfigure your home by running:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37001
- #, no-wrap
- msgid "guix home reconfigure config.scm\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37005
- msgid "This ``builds'' your home environment and creates @file{~/.guix-home} pointing to it. Voilà!"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:37012
- msgid "Make sure the operating system has elogind, systemd, or a similar mechanism to create the XDG run-time directory and has the @env{XDG_RUNTIME_DIR} variable set. Failing that, the @file{on-first-login} script will not execute anything, and processes like user Shepherd and its descendants will not start."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37018
- msgid "This section is safe to skip if your shell or shells are managed by Guix Home. Otherwise, read it carefully."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37025
- msgid "There are a few scripts that must be evaluated by a login shell to activate the home environment. The shell startup files only read by login shells often have @code{profile} suffix. For more information about login shells see @ref{Invoking Bash,,, bash, The GNU Bash Reference Manual} and see @ref{Bash Startup Files,,, bash, The GNU Bash Reference Manual}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37032
- msgid "The first script that needs to be sourced is @file{setup-environment}, which sets all the necessary environment variables (including variables declared by the user) and the second one is @file{on-first-login}, which starts Shepherd for the current user and performs actions declared by other home services that extends @code{home-run-on-first-login-service-type}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37035
- msgid "Guix Home will always create @file{~/.profile}, which contains the following lines:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37040
- #, no-wrap
- msgid ""
- "HOME_ENVIRONMENT=$HOME/.guix-home\n"
- ". $HOME_ENVIRONMENT/setup-environment\n"
- "$HOME_ENVIRONMENT/on-first-login\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37050
- msgid "This makes POSIX compliant login shells activate the home environment. However, in most cases this file won't be read by most modern shells, because they are run in non POSIX mode by default and have their own @file{*profile} startup files. For example Bash will prefer @file{~/.bash_profile} in case it exists and only if it doesn't will it fallback to @file{~/.profile}. Zsh (if no additional options are specified) will ignore @file{~/.profile}, even if @file{~/.zprofile} doesn't exist."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37055
- msgid "To make your shell respect @file{~/.profile}, add @code{. ~/.profile} or @code{source ~/profile} to the startup file for the login shell. In case of Bash, it is @file{~/.bash_profile}, and in case of Zsh, it is @file{~/.zprofile}."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:37059
- msgid "This step is only required if your shell is NOT managed by Guix Home. Otherwise, everything will be done automatically."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:37063
- #, no-wrap
- msgid "home services"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37072
- msgid "A @dfn{home service} is not necessarily something that has a daemon and is managed by Shepherd (@pxref{Jump Start,,, shepherd, The GNU Shepherd Manual}), in most cases it doesn't. It's a simple building block of the home environment, often declaring a set of packages to be installed in the home environment profile, a set of config files to be symlinked into @env{XDG_CONFIG_HOME} (@file{~/.config} by default), and environment variables to be set by a login shell."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37080
- msgid "There is a service extension mechanism (@pxref{Service Composition}) which allows home services to extend other home services and utilize capabilities they provide; for example: declare mcron jobs (@pxref{Top,,, mcron, GNU@tie{}Mcron}) by extending @ref{Mcron Home Service}; declare daemons by extending @ref{Shepherd Home Service}; add commands, which will be invoked on by the Bash by extending @ref{Shells Home Services, @code{home-bash-service-type}}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37091
- msgid "A good way to discover avaliable home services is using the @command{guix home search} command (@pxref{Invoking guix home}). After the required home services are found, include its module with the @code{use-modules} form (@pxref{use-modules,, Using Guile Modules, guile, The GNU Guile Reference Manual}), or the @code{#:use-modules} directive (@pxref{define-module,, Creating Guile Modules, guile, The GNU Guile Reference Manual}) and declare a home service using the @code{service} function, or extend a service type by declaring a new service with the @code{simple-service} procedure from @code{(gnu services)}."
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:37097 guix-git/doc/guix.texi:37100
- #: guix-git/doc/guix.texi:37101
- #, no-wrap
- msgid "Essential Home Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:37097
- msgid "Environment variables, packages, on-* scripts."
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:37097
- msgid "Shells: Shells Home Services"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:37097
- msgid "POSIX shells, Bash, Zsh."
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:37097
- msgid "Mcron: Mcron Home Service"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:37097
- msgid "Scheduled User's Job Execution."
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:37097
- msgid "Shepherd: Shepherd Home Service"
- msgstr ""
- #. type: menuentry
- #: guix-git/doc/guix.texi:37097
- msgid "Managing User's Daemons."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37106
- msgid "There are a few essential home services defined in @code{(gnu services)}, they are mostly for internal use and are required to build a home environment, but some of them will be useful for the end user."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:37107
- #, no-wrap
- msgid "environment variables"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:37109
- #, no-wrap
- msgid "{Scheme Variable} home-environment-variables-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:37114
- msgid "The service of this type will be instantiated by every home environment automatically by default, there is no need to define it, but someone may want to extend it with a list of pairs to set some environment variables."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:37118
- #, no-wrap
- msgid ""
- "(list (\"ENV_VAR1\" . \"value1\")\n"
- " (\"ENV_VAR2\" . \"value2\"))\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:37123
- msgid "The easiest way to extend a service type, without defining new service type is to use the @code{simple-service} helper from @code{(gnu services)}."
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:37131
- #, no-wrap
- msgid ""
- "(simple-service 'some-useful-env-vars-service\n"
- "\t\thome-environment-variables-service-type\n"
- "\t\t`((\"LESSHISTFILE\" . \"$XDG_CACHE_HOME/.lesshst\")\n"
- " (\"SHELL\" . ,(file-append zsh \"/bin/zsh\"))\n"
- " (\"USELESS_VAR\" . #f)\n"
- " (\"_JAVA_AWT_WM_NONREPARENTING\" . #t)))\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:37136
- msgid "If you include such a service in you home environment definition, it will add the following content to the @file{setup-environment} script (which is expected to be sourced by the login shell):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37141
- #, no-wrap
- msgid ""
- "export LESSHISTFILE=$XDG_CACHE_HOME/.lesshst\n"
- "export SHELL=/gnu/store/2hsg15n644f0glrcbkb1kqknmmqdar03-zsh-5.8/bin/zsh\n"
- "export _JAVA_AWT_WM_NONREPARENTING\n"
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:37148
- msgid "Make sure that module @code{(gnu packages shells)} is imported with @code{use-modules} or any other way, this namespace contains the definition of the @code{zsh} packages, which is used in the example above."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:37161
- msgid "The association list (@pxref{Association Lists, alists, Association Lists, guile, The GNU Guile Reference manual}) is a data structure containing key-value pairs, for @code{home-environment-variables-service-type} the key is always a string, the value can be a string, string-valued gexp (@pxref{G-Expressions}), file-like object (@pxref{G-Expressions, file-like object}) or boolean. For gexps, the variable will be set to the value of the gexp; for file-like objects, it will be set to the path of the file in the store (@pxref{The Store}); for @code{#t}, it will export the variable without any value; and for @code{#f}, it will omit variable."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:37164
- #, no-wrap
- msgid "{Scheme Variable} home-profile-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:37170
- msgid "The service of this type will be instantiated by every home environment automatically, there is no need to define it, but you may want to extend it with a list of packages if you want to install additional packages into your profile. Other services, which need to make some programs avaliable to the user will also extend this service type."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:37172
- msgid "The extension value is just a list of packages:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:37175
- #, no-wrap
- msgid "(list htop vim emacs)\n"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:37185
- msgid "The same approach as @code{simple-service} (@pxref{Service Reference, simple-service}) for @code{home-environment-variables-service-type} can be used here, too. Make sure that modules containing the specified packages are imported with @code{use-modules}. To find a package or information about its module use @command{guix search} (@pxref{Invoking guix package}). Alternatively, @code{specification->package} can be used to get the package record from string without importing related module."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37189
- msgid "There are few more essential services, but users are not expected to extend them."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:37190
- #, no-wrap
- msgid "{Scheme Variable} home-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:37195
- msgid "The root of home services DAG, it generates a folder, which later will be symlinked to @file{~/.guix-home}, it contains configurations, profile with binaries and libraries, and some necessary scripts to glue things together."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:37197
- #, no-wrap
- msgid "{Scheme Variable} home-run-on-first-login-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:37202
- msgid "The service of this type generates a Guile script, which is expected to be executed by the login shell. It is only executed if the special flag file inside @env{XDG_RUNTIME_DIR} hasn't been created, this prevents redundant executions of the script if multiple login shells are spawned."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:37208
- msgid "It can be extended with a gexp. However, to autostart an application, users @emph{should not} use this service, in most cases it's better to extend @code{home-shepherd-service-type} with a Shepherd service (@pxref{Shepherd Services}), or extend the shell's startup file with the required command using the appropriate service type."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:37210
- #, no-wrap
- msgid "{Scheme Variable} home-activation-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:37214
- msgid "The service of this type generates a guile script, which runs on every @command{guix home reconfigure} invocation or any other action, which leads to the activation of the home environment."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:37216
- #, no-wrap
- msgid "Shells Home Services"
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:37217
- #, no-wrap
- msgid "Shells"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:37219 guix-git/doc/guix.texi:37500
- #, no-wrap
- msgid "shell"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:37220
- #, no-wrap
- msgid "login shell"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:37221
- #, no-wrap
- msgid "interactive shell"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:37222 guix-git/doc/guix.texi:37502
- #, no-wrap
- msgid "bash"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:37223 guix-git/doc/guix.texi:37503
- #, no-wrap
- msgid "zsh"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37229
- msgid "Shells play a quite important role in the environment initialization process, you can configure them manually as described in section @ref{Configuring the Shell}, but the recommended way is to use home services listed below. It's both easier and more reliable."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37239
- msgid "Each home environment instantiates @code{home-shell-profile-service-type}, which creates a @file{~/.profile} startup file for all POSIX-compatible shells. This file contains all the necessary steps to properly initialize the environment, but many modern shells like Bash or Zsh prefer their own startup files, that's why the respective home services (@code{home-bash-service-type} and @code{home-zsh-service-type}) ensure that @file{~/.profile} is sourced by @file{~/.bash_profile} and @file{~/.zprofile}, respectively."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:37240
- #, no-wrap
- msgid "Shell Profile Service"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:37242
- #, no-wrap
- msgid "{Data Type} home-shell-profile-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:37244
- msgid "Available @code{home-shell-profile-configuration} fields are:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:37246
- #, no-wrap
- msgid "@code{profile} (default: @code{()}) (type: text-config)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37256
- msgid "@code{home-shell-profile} is instantiated automatically by @code{home-environment}, DO NOT create this service manually, it can only be extended. @code{profile} is a list of file-like objects, which will go to @file{~/.profile}. By default @file{~/.profile} contains the initialization code, which have to be evaluated by login shell to make home-environment's profile avaliable to the user, but other commands can be added to the file if it is really necessary. In most cases shell's configuration files are preferred places for user's customizations. Extend home-shell-profile service only if you really know what you do."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:37261
- #, no-wrap
- msgid "Bash Home Service"
- msgstr ""
- #. type: anchor{#1}
- #: guix-git/doc/guix.texi:37264
- msgid "home-bash-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:37264
- #, no-wrap
- msgid "{Data Type} home-bash-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:37266
- msgid "Available @code{home-bash-configuration} fields are:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:37268
- #, no-wrap
- msgid "@code{package} (default: @code{bash}) (type: package)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37270
- msgid "The Bash package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:37271
- #, no-wrap
- msgid "@code{guix-defaults?} (default: @code{#t}) (type: boolean)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37274
- msgid "Add sane defaults like reading @file{/etc/bashrc} and coloring the output of @command{ls} to the end of the @file{.bashrc} file."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:37275 guix-git/doc/guix.texi:37329
- #: guix-git/doc/guix.texi:37368
- #, no-wrap
- msgid "@code{environment-variables} (default: @code{()}) (type: alist)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37280
- msgid "Association list of environment variables to set for the Bash session. The rules for the @code{home-environment-variables-service-type} apply here (@pxref{Essential Home Services}). The contents of this field will be added after the contents of the @code{bash-profile} field."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:37281 guix-git/doc/guix.texi:37334
- #, no-wrap
- msgid "@code{aliases} (default: @code{()}) (type: alist)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37286
- msgid "Association list of aliases to set for the Bash session. The aliases will be defined after the contents of the @code{bashrc} field has been put in the @file{.bashrc} file. The alias will automatically be quoted, so something line this:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:37289
- #, no-wrap
- msgid "'((\\\"ls\\\" . \\\"ls -alF\\\"))\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37292
- msgid "turns into"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37295
- #, no-wrap
- msgid "alias ls=\\\"ls -alF\\\"\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:37297 guix-git/doc/guix.texi:37338
- #, no-wrap
- msgid "@code{bash-profile} (default: @code{()}) (type: text-config)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37302
- msgid "List of file-like objects, which will be added to @file{.bash_profile}. Used for executing user's commands at start of login shell (In most cases the shell started on tty just after login). @file{.bash_login} won't be ever read, because @file{.bash_profile} always present."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:37303 guix-git/doc/guix.texi:37342
- #, no-wrap
- msgid "@code{bashrc} (default: @code{()}) (type: text-config)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37308
- msgid "List of file-like objects, which will be added to @file{.bashrc}. Used for executing user's commands at start of interactive shell (The shell for interactive usage started by typing @code{bash} or by terminal app or any other program)."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:37309 guix-git/doc/guix.texi:37346
- #, no-wrap
- msgid "@code{bash-logout} (default: @code{()}) (type: text-config)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37314
- msgid "List of file-like objects, which will be added to @file{.bash_logout}. Used for executing user's commands at the exit of login shell. It won't be read in some cases (if the shell terminates by exec'ing another process for example)."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37324
- msgid "You can extend the Bash service by using the @code{home-bash-extension} configuration record, whose fields most mirror that of @code{home-bash-configuration} (@pxref{home-bash-configuration}). The contents of the extensions will be added to the end of the corresponding Bash configuration files (@pxref{Bash Startup Files,,, bash, The GNU Bash Reference Manual}."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:37325
- #, no-wrap
- msgid "{Data Type} home-bash-extension"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:37327
- msgid "Available @code{home-bash-extension} fields are:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37333
- msgid "Additional environment variables to set. These will be combined with the environment variables from other extensions and the base service to form one coherent block of environment variables."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37337
- msgid "Additional aliases to set. These will be combined with the aliases from other extensions and the base service."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37341
- msgid "Additional text blocks to add to @file{.bash_profile}, which will be combined with text blocks from other extensions and the base service."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37345
- msgid "Additional text blocks to add to @file{.bashrc}, which will be combined with text blocks from other extensions and the base service."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37349
- msgid "Additional text blocks to add to @file{.bash_logout}, which will be combined with text blocks from other extensions and the base service."
- msgstr ""
- #. type: subsubheading
- #: guix-git/doc/guix.texi:37353
- #, no-wrap
- msgid "Zsh Home Service"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:37355
- #, no-wrap
- msgid "{Data Type} home-zsh-configuration"
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:37357
- msgid "Available @code{home-zsh-configuration} fields are:"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:37359
- #, no-wrap
- msgid "@code{package} (default: @code{zsh}) (type: package)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37361
- msgid "The Zsh package to use."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:37362
- #, no-wrap
- msgid "@code{xdg-flavor?} (default: @code{#t}) (type: boolean)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37367
- msgid "Place all the configs to @file{$XDG_CONFIG_HOME/zsh}. Makes @file{~/.zshenv} to set @env{ZDOTDIR} to @file{$XDG_CONFIG_HOME/zsh}. Shell startup process will continue with @file{$XDG_CONFIG_HOME/zsh/.zshenv}."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37370
- msgid "Association list of environment variables to set for the Zsh session."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:37371
- #, no-wrap
- msgid "@code{zshenv} (default: @code{()}) (type: text-config)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37376
- msgid "List of file-like objects, which will be added to @file{.zshenv}. Used for setting user's shell environment variables. Must not contain commands assuming the presence of tty or producing output. Will be read always. Will be read before any other file in @env{ZDOTDIR}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:37377
- #, no-wrap
- msgid "@code{zprofile} (default: @code{()}) (type: text-config)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37382
- msgid "List of file-like objects, which will be added to @file{.zprofile}. Used for executing user's commands at start of login shell (In most cases the shell started on tty just after login). Will be read before @file{.zlogin}."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:37383
- #, no-wrap
- msgid "@code{zshrc} (default: @code{()}) (type: text-config)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37388
- msgid "List of file-like objects, which will be added to @file{.zshrc}. Used for executing user's commands at start of interactive shell (The shell for interactive usage started by typing @code{zsh} or by terminal app or any other program)."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:37389
- #, no-wrap
- msgid "@code{zlogin} (default: @code{()}) (type: text-config)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37393
- msgid "List of file-like objects, which will be added to @file{.zlogin}. Used for executing user's commands at the end of starting process of login shell."
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:37394
- #, no-wrap
- msgid "@code{zlogout} (default: @code{()}) (type: text-config)"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37399
- msgid "List of file-like objects, which will be added to @file{.zlogout}. Used for executing user's commands at the exit of login shell. It won't be read in some cases (if the shell terminates by exec'ing another process for example)."
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:37404
- #, no-wrap
- msgid "Mcron Home Service"
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:37405
- #, no-wrap
- msgid "Scheduled User's Job Execution"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37418
- msgid "The @code{(gnu home services mcron)} module provides an interface to GNU@tie{}mcron, a daemon to run jobs at scheduled times (@pxref{Top,,, mcron, GNU@tie{}mcron}). The information about system's mcron is applicable here (@pxref{Scheduled Job Execution}), the only difference for home services is that they have to be declared in a @code{home-envirnoment} record instead of an @code{operating-system} record."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:37419
- #, no-wrap
- msgid "{Scheme Variable} home-mcron-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:37423
- msgid "This is the type of the @code{mcron} home service, whose value is an @code{home-mcron-configuration} object. It allows to manage scheduled tasks."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:37430
- #, no-wrap
- msgid "{Data Type} home-mcron-configuration"
- msgstr ""
- #. type: node
- #: guix-git/doc/guix.texi:37444
- #, no-wrap
- msgid "Shepherd Home Service"
- msgstr ""
- #. type: subsection
- #: guix-git/doc/guix.texi:37445
- #, no-wrap
- msgid "Managing User's Daemons"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:37449
- #, no-wrap
- msgid "{Scheme Variable} home-shepherd-service-type"
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:37454
- msgid "The service type for the userland Shepherd, which allows one to manage long-running processes or one-shot tasks. User's Shepherd is not an init process (PID 1), but almost all other information described in (@pxref{Shepherd Services}) is applicable here too."
- msgstr ""
- #. type: defvr
- #: guix-git/doc/guix.texi:37459
- msgid "This is the service type that extensions target when they want to create shepherd services (@pxref{Service Types and Services}, for an example). Each extension must pass a list of @code{<shepherd-service>}. Its value must be a @code{home-shepherd-configuration}, as described below."
- msgstr ""
- #. type: deftp
- #: guix-git/doc/guix.texi:37461
- #, no-wrap
- msgid "{Data Type} home-shepherd-configuration"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:37468
- #, no-wrap
- msgid "auto-start? (default: @code{#t})"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37470
- msgid "Whether or not to start Shepherd on first login."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:37479
- #, no-wrap
- msgid "Invoking @code{guix home}"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37484
- msgid "Once you have written a home environment declaration (@pxref{Declaring the Home Environment,,,,}, it can be @dfn{instantiated} using the @command{guix home} command. The synopsis is:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37487
- #, no-wrap
- msgid "guix home @var{options}@dots{} @var{action} @var{file}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37494
- msgid "@var{file} must be the name of a file containing a @code{home-environment} declaration. @var{action} specifies how the home environment is instantiated, but there are few auxiliary actions which don't instantiate it. Currently the following values are supported:"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37499
- msgid "Display available home service type definitions that match the given regular expressions, sorted by relevance:"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:37501
- #, no-wrap
- msgid "shell-profile"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37513
- #, no-wrap
- msgid ""
- "$ guix home search shell\n"
- "name: home-shell-profile\n"
- "location: gnu/home/services/shells.scm:73:2\n"
- "extends: home-files\n"
- "description: Create `~/.profile', which is used for environment initialization\n"
- "+ of POSIX compatible login shells. Can be extended with a list of strings or\n"
- "+ gexps.\n"
- "relevance: 6\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37519
- #, no-wrap
- msgid ""
- "name: home-zsh-plugin-manager\n"
- "location: gnu/home/services/shellutils.scm:28:2\n"
- "extends: home-zsh home-profile\n"
- "description: Install plugins in profile and configure Zsh to load them.\n"
- "relevance: 1\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37526
- #, no-wrap
- msgid ""
- "name: home-zsh-direnv\n"
- "location: gnu/home/services/shellutils.scm:69:2\n"
- "extends: home-profile home-zsh\n"
- "description: Enables `direnv' for `zsh'. Adds hook to `.zshrc' and installs a\n"
- "+ package in the profile.\n"
- "relevance: 1\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37535
- #, no-wrap
- msgid ""
- "name: home-zsh-autosuggestions\n"
- "location: gnu/home/services/shellutils.scm:43:2\n"
- "extends: home-zsh-plugin-manager home-zsh\n"
- "description: Enables Fish-like fast/unobtrusive autosuggestions for `zsh' and\n"
- "+ sets reasonable default values for some plugin's variables to improve perfomance\n"
- "+ and adjust behavior: `(history completion)' is set for strategy, manual rebind\n"
- "+ and async are enabled.\n"
- "relevance: 1\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37541
- #, no-wrap
- msgid ""
- "name: home-zsh\n"
- "location: gnu/home/services/shells.scm:236:2\n"
- "extends: home-files home-profile\n"
- "description: Install and configure Zsh.\n"
- "relevance: 1\n"
- "\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37547
- #, no-wrap
- msgid ""
- "name: home-bash\n"
- "location: gnu/home/services/shells.scm:388:2\n"
- "extends: home-files home-profile\n"
- "description: Install and configure Bash.\n"
- "relevance: 1\n"
- "\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37563
- msgid "Build the home environment described in @var{file}, and switch to it. Switching means that the activation script will be evaluated and (in basic scenario) symlinks to configuration files generated from @code{home-environment} declaration will be created in @file{~}. If the file with the same path already exists in home folder it will be moved to @file{~/TIMESTAMP-guix-home-legacy-configs-backup}, where TIMESTAMP is a current UNIX epoch time."
- msgstr ""
- #. type: quotation
- #: guix-git/doc/guix.texi:37568
- msgid "It is highly recommended to run @command{guix pull} once before you run @command{guix home reconfigure} for the first time (@pxref{Invoking guix pull})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37575
- msgid "This effects all the configuration specified in @var{file}. The command starts Shepherd services specified in @var{file} that are not currently running; if a service is currently running, this command will arrange for it to be upgraded the next time it is stopped (e.g.@: by @code{herd stop X} or @code{herd restart X})."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37581
- msgid "This command creates a new generation whose number is one greater than the current generation (as reported by @command{guix home list-generations}). If that generation already exists, it will be overwritten. This behavior mirrors that of @command{guix package} (@pxref{Invoking guix package})."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:37582
- #, no-wrap
- msgid "provenance tracking, of the home environment"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37587
- msgid "Upon completion, the new home is deployed under @file{~/.guix-home}. This directory contains @dfn{provenance meta-data}: the list of channels in use (@pxref{Channels}) and @var{file} itself, when available. You can view the provenance information by running:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37590
- #, no-wrap
- msgid "guix home describe\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37596
- msgid "This information is useful should you later want to inspect how this particular generation was built. In fact, assuming @var{file} is self-contained, you can later rebuild generation @var{n} of your home environment with:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37602
- #, no-wrap
- msgid ""
- "guix time-machine \\\n"
- " -C /var/guix/profiles/per-user/@var{USER}/guix-home-@var{n}-link/channels.scm -- \\\n"
- " home reconfigure \\\n"
- " /var/guix/profiles/per-user/@var{USER}/guix-home-@var{n}-link/configuration.scm\n"
- "\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37609
- msgid "You can think of it as some sort of built-in version control! Your home is not just a binary artifact: @emph{it carries its own source}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:37615
- #, fuzzy, no-wrap
- #| msgid "Documentation"
- msgid "home generations"
- msgstr "مستندات"
- #. type: table
- #: guix-git/doc/guix.texi:37618
- msgid "Switch to an existing home generation. This action atomically switches the home profile to the specified home generation."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37622
- msgid "The target generation can be specified explicitly by its generation number. For example, the following invocation would switch to home generation 7:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37625
- #, no-wrap
- msgid "guix home switch-generation 7\n"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37636
- #, no-wrap
- msgid "guix home switch-generation -- -1\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37645
- msgid "Switch to the preceding home generation. This is the inverse of @command{reconfigure}, and it is exactly the same as invoking @command{switch-generation} with an argument of @code{-1}."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:37647
- #, no-wrap
- msgid "deleting home generations"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37652
- msgid "Delete home generations, making them candidates for garbage collection (@pxref{Invoking guix gc}, for information on how to run the ``garbage collector'')."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37656
- msgid "This works in the same way as @samp{guix package --delete-generations} (@pxref{Invoking guix package, @option{--delete-generations}}). With no arguments, all home generations but the current one are deleted:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37659
- #, no-wrap
- msgid "guix home delete-generations\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37663
- msgid "You can also select the generations you want to delete. The example below deletes all the home generations that are more than two months old:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37666
- #, no-wrap
- msgid "guix home delete-generations 2m\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37672
- msgid "Build the derivation of the home environment, which includes all the configuration files and programs needed. This action does not actually install anything."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37676
- msgid "Describe the current home generation: its file name, as well as provenance information when available."
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37682
- msgid "List a summary of each generation of the home environment available on disk, in a human-readable way. This is similar to the @option{--list-generations} option of @command{guix package} (@pxref{Invoking guix package})."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37690
- #, no-wrap
- msgid "$ guix home list-generations 10d\n"
- msgstr ""
- #. type: item
- #: guix-git/doc/guix.texi:37692
- #, no-wrap
- msgid "import"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37699
- msgid "Generate a @dfn{home environment} from the packages in the default profile and configuration files found in the user's home directory. The configuration files will be copied to the specified directory, and a @file{home-configuration.scm} will be populated with the home environment. Note that not every home service that exists is supported (@pxref{Home Services})."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37703
- #, no-wrap
- msgid ""
- "$ guix home import ~/guix-config\n"
- "guix home: '/home/alice/guix-config' populated with all the Home configuration files\n"
- msgstr ""
- #. type: table
- #: guix-git/doc/guix.texi:37718
- msgid "Consider the home-environment @var{expr} evaluates to. This is an alternative to specifying a file which evaluates to a home environment."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:37724
- #, no-wrap
- msgid "documentation, searching for"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:37725
- #, no-wrap
- msgid "searching for documentation"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:37726
- #, no-wrap
- msgid "Info, documentation format"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:37727
- #, no-wrap
- msgid "man pages"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:37728
- #, no-wrap
- msgid "manual pages"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37735
- msgid "In most cases packages installed with Guix come with documentation. There are two main documentation formats: ``Info'', a browsable hypertext format used for GNU software, and ``manual pages'' (or ``man pages''), the linear documentation format traditionally found on Unix. Info manuals are accessed with the @command{info} command or with Emacs, and man pages are accessed using @command{man}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37739
- msgid "You can look for documentation of software installed on your system by keyword. For example, the following command searches for information about ``TLS'' in Info manuals:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37747
- #, no-wrap
- msgid ""
- "$ info -k TLS\n"
- "\"(emacs)Network Security\" -- STARTTLS\n"
- "\"(emacs)Network Security\" -- TLS\n"
- "\"(gnutls)Core TLS API\" -- gnutls_certificate_set_verify_flags\n"
- "\"(gnutls)Core TLS API\" -- gnutls_certificate_set_verify_function\n"
- "@dots{}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37753
- msgid "The command below searches for the same keyword in man pages@footnote{The database searched by @command{man -k} is only created in profiles that contain the @code{man-db} package.}:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37759
- #, no-wrap
- msgid ""
- "$ man -k TLS\n"
- "SSL (7) - OpenSSL SSL/TLS library\n"
- "certtool (1) - GnuTLS certificate tool\n"
- "@dots {}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37765
- msgid "These searches are purely local to your computer so you have the guarantee that documentation you find corresponds to what you have actually installed, you can access it off-line, and your privacy is respected."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37768
- msgid "Once you have these results, you can view the relevant documentation by running, say:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37771
- #, no-wrap
- msgid "$ info \"(gnutls)Core TLS API\"\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37775
- msgid "or:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37778
- #, no-wrap
- msgid "$ man certtool\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37786
- msgid "Info manuals contain sections and indices as well as hyperlinks like those found in Web pages. The @command{info} reader (@pxref{Top, Info reader,, info-stnd, Stand-alone GNU Info}) and its Emacs counterpart (@pxref{Misc Help,,, emacs, The GNU Emacs Manual}) provide intuitive key bindings to navigate manuals. @xref{Getting Started,,, info, Info: An Introduction}, for an introduction to Info navigation."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:37790
- #, no-wrap
- msgid "debugging files"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37796
- msgid "Program binaries, as produced by the GCC compilers for instance, are typically written in the ELF format, with a section containing @dfn{debugging information}. Debugging information is what allows the debugger, GDB, to map binary code to source code; it is required to debug a compiled program in good conditions."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37800
- msgid "This chapter explains how to use separate debug info when packages provide it, and how to rebuild packages with debug info when it's missing."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37816
- msgid "The problem with debugging information is that is takes up a fair amount of disk space. For example, debugging information for the GNU C Library weighs in at more than 60 MiB@. Thus, as a user, keeping all the debugging info of all the installed programs is usually not an option. Yet, space savings should not come at the cost of an impediment to debugging---especially in the GNU system, which should make it easier for users to exert their computing freedom (@pxref{GNU Distribution})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37823
- msgid "Thankfully, the GNU Binary Utilities (Binutils) and GDB provide a mechanism that allows users to get the best of both worlds: debugging information can be stripped from the binaries and stored in separate files. GDB is then able to load debugging information from those files, when they are available (@pxref{Separate Debug Files,,, gdb, Debugging with GDB})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37831
- msgid "The GNU distribution takes advantage of this by storing debugging information in the @code{lib/debug} sub-directory of a separate package output unimaginatively called @code{debug} (@pxref{Packages with Multiple Outputs}). Users can choose to install the @code{debug} output of a package when they need it. For instance, the following command installs the debugging information for the GNU C Library and for GNU Guile:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37834
- #, no-wrap
- msgid "guix install glibc:debug guile:debug\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37840
- msgid "GDB must then be told to look for debug files in the user's profile, by setting the @code{debug-file-directory} variable (consider setting it from the @file{~/.gdbinit} file, @pxref{Startup,,, gdb, Debugging with GDB}):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37843
- #, no-wrap
- msgid "(gdb) set debug-file-directory ~/.guix-profile/lib/debug\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37847
- msgid "From there on, GDB will pick up debugging information from the @file{.debug} files under @file{~/.guix-profile/lib/debug}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37852
- msgid "Below is an alternative GDB script which is useful when working with other profiles. It takes advantage of the optional Guile integration in GDB. This snippet is included by default on Guix System in the @file{~/.gdbinit} file."
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37860
- #, no-wrap
- msgid ""
- "guile\n"
- "(use-modules (gdb))\n"
- "(execute (string-append \"set debug-file-directory \"\n"
- " (or (getenv \"GDB_DEBUG_FILE_DIRECTORY\")\n"
- " \"~/.guix-profile/lib/debug\")))\n"
- "end\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37868
- msgid "In addition, you will most likely want GDB to be able to show the source code being debugged. To do that, you will have to unpack the source code of the package of interest (obtained with @code{guix build --source}, @pxref{Invoking guix build}), and to point GDB to that source directory using the @code{directory} command (@pxref{Source Path, @code{directory},, gdb, Debugging with GDB})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37876
- msgid "The @code{debug} output mechanism in Guix is implemented by the @code{gnu-build-system} (@pxref{Build Systems}). Currently, it is opt-in---debugging information is available only for the packages with definitions explicitly declaring a @code{debug} output. To check whether a package has a @code{debug} output, use @command{guix package --list-available} (@pxref{Invoking guix package})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37878
- msgid "Read on for how to deal with packages lacking a @code{debug} output."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37890
- msgid "As we saw above, some packages, but not all, provide debugging info in a @code{debug} output. What can you do when debugging info is missing? The @option{--with-debug-info} option provides a solution to that: it allows you to rebuild the package(s) for which debugging info is missing---and only those---and to graft those onto the application you're debugging. Thus, while it's not as fast as installing a @code{debug} output, it is relatively inexpensive."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37895
- msgid "Let's illustrate that. Suppose you're experiencing a bug in Inkscape and would like to see what's going on in GLib, a library that's deep down in its dependency graph. As it turns out, GLib does not have a @code{debug} output and the backtrace GDB shows is all sadness:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37906
- #, no-wrap
- msgid ""
- "(gdb) bt\n"
- "#0 0x00007ffff5f92190 in g_getenv ()\n"
- " from /gnu/store/@dots{}-glib-2.62.6/lib/libglib-2.0.so.0\n"
- "#1 0x00007ffff608a7d6 in gobject_init_ctor ()\n"
- " from /gnu/store/@dots{}-glib-2.62.6/lib/libgobject-2.0.so.0\n"
- "#2 0x00007ffff7fe275a in call_init (l=<optimized out>, argc=argc@@entry=1, argv=argv@@entry=0x7fffffffcfd8, \n"
- " env=env@@entry=0x7fffffffcfe8) at dl-init.c:72\n"
- "#3 0x00007ffff7fe2866 in call_init (env=0x7fffffffcfe8, argv=0x7fffffffcfd8, argc=1, l=<optimized out>)\n"
- " at dl-init.c:118\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37910
- msgid "To address that, you install Inkscape linked against a variant GLib that contains debug info:"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37916
- msgid "This time, debugging will be a whole lot nicer:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:37934
- #, no-wrap
- msgid ""
- "$ gdb --args sh -c 'exec inkscape'\n"
- "@dots{}\n"
- "(gdb) b g_getenv\n"
- "Function \"g_getenv\" not defined.\n"
- "Make breakpoint pending on future shared library load? (y or [n]) y\n"
- "Breakpoint 1 (g_getenv) pending.\n"
- "(gdb) r\n"
- "Starting program: /gnu/store/@dots{}-profile/bin/sh -c exec\\ inkscape\n"
- "@dots{}\n"
- "(gdb) bt\n"
- "#0 g_getenv (variable=variable@@entry=0x7ffff60c7a2e \"GOBJECT_DEBUG\") at ../glib-2.62.6/glib/genviron.c:252\n"
- "#1 0x00007ffff608a7d6 in gobject_init () at ../glib-2.62.6/gobject/gtype.c:4380\n"
- "#2 gobject_init_ctor () at ../glib-2.62.6/gobject/gtype.c:4493\n"
- "#3 0x00007ffff7fe275a in call_init (l=<optimized out>, argc=argc@@entry=3, argv=argv@@entry=0x7fffffffd088, \n"
- " env=env@@entry=0x7fffffffd0a8) at dl-init.c:72\n"
- "@dots{}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37937
- msgid "Much better!"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37941
- msgid "Note that there can be packages for which @option{--with-debug-info} will not have the desired effect. @xref{Package Transformation Options, @option{--with-debug-info}}, for more information."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:37945
- #, no-wrap
- msgid "security updates"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37954
- msgid "Occasionally, important security vulnerabilities are discovered in software packages and must be patched. Guix developers try hard to keep track of known vulnerabilities and to apply fixes as soon as possible in the @code{master} branch of Guix (we do not yet provide a ``stable'' branch containing only security updates). The @command{guix lint} tool helps developers find out about vulnerable versions of software packages in the distribution:"
- msgstr ""
- #. type: smallexample
- #: guix-git/doc/guix.texi:37961
- #, no-wrap
- msgid ""
- "$ guix lint -c cve\n"
- "gnu/packages/base.scm:652:2: glibc@@2.21: probably vulnerable to CVE-2015-1781, CVE-2015-7547\n"
- "gnu/packages/gcc.scm:334:2: gcc@@4.9.3: probably vulnerable to CVE-2015-5276\n"
- "gnu/packages/image.scm:312:2: openjpeg@@2.1.0: probably vulnerable to CVE-2016-1923, CVE-2016-1924\n"
- "@dots{}\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37964
- msgid "@xref{Invoking guix lint}, for more information."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37973
- msgid "Guix follows a functional package management discipline (@pxref{Introduction}), which implies that, when a package is changed, @emph{every package that depends on it} must be rebuilt. This can significantly slow down the deployment of fixes in core packages such as libc or Bash, since basically the whole distribution would need to be rebuilt. Using pre-built binaries helps (@pxref{Substitutes}), but deployment may still take more time than desired."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:37974
- #, no-wrap
- msgid "grafts"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37982
- msgid "To address this, Guix implements @dfn{grafts}, a mechanism that allows for fast deployment of critical updates without the costs associated with a whole-distribution rebuild. The idea is to rebuild only the package that needs to be patched, and then to ``graft'' it onto packages explicitly installed by the user and that were previously referring to the original package. The cost of grafting is typically very low, and order of magnitudes lower than a full rebuild of the dependency chain."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:37983
- #, no-wrap
- msgid "replacements of packages, for grafts"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:37989
- msgid "For instance, suppose a security update needs to be applied to Bash. Guix developers will provide a package definition for the ``fixed'' Bash, say @code{bash-fixed}, in the usual way (@pxref{Defining Packages}). Then, the original package definition is augmented with a @code{replacement} field pointing to the package containing the bug fix:"
- msgstr ""
- #. type: lisp
- #: guix-git/doc/guix.texi:37996
- #, no-wrap
- msgid ""
- "(define bash\n"
- " (package\n"
- " (name \"bash\")\n"
- " ;; @dots{}\n"
- " (replacement bash-fixed)))\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38006
- msgid "From there on, any package depending directly or indirectly on Bash---as reported by @command{guix gc --requisites} (@pxref{Invoking guix gc})---that is installed is automatically ``rewritten'' to refer to @code{bash-fixed} instead of @code{bash}. This grafting process takes time proportional to the size of the package, usually less than a minute for an ``average'' package on a recent machine. Grafting is recursive: when an indirect dependency requires grafting, then grafting ``propagates'' up to the package that the user is installing."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38014
- msgid "Currently, the length of the name and version of the graft and that of the package it replaces (@code{bash-fixed} and @code{bash} in the example above) must be equal. This restriction mostly comes from the fact that grafting works by patching files, including binary files, directly. Other restrictions may apply: for instance, when adding a graft to a package providing a shared library, the original shared library and its replacement must have the same @code{SONAME} and be binary-compatible."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38018
- msgid "The @option{--no-grafts} command-line option allows you to forcefully avoid grafting (@pxref{Common Build Options, @option{--no-grafts}}). Thus, the command:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:38021
- #, no-wrap
- msgid "guix build bash --no-grafts\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38025
- msgid "returns the store file name of the original Bash, whereas:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:38028
- #, no-wrap
- msgid "guix build bash\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38033
- msgid "returns the store file name of the ``fixed'', replacement Bash. This allows you to distinguish between the two variants of Bash."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38036
- msgid "To verify which Bash your whole profile refers to, you can run (@pxref{Invoking guix gc}):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:38039
- #, no-wrap
- msgid "guix gc -R $(readlink -f ~/.guix-profile) | grep bash\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38044
- msgid "@dots{} and compare the store file names that you get with those above. Likewise for a complete Guix system generation:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:38047
- #, no-wrap
- msgid "guix gc -R $(guix system build my-config.scm) | grep bash\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38051
- msgid "Lastly, to check which Bash running processes are using, you can use the @command{lsof} command:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:38054
- #, no-wrap
- msgid "lsof | grep /gnu/store/.*bash\n"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:38062
- #, no-wrap
- msgid "bootstrapping"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38069
- msgid "Bootstrapping in our context refers to how the distribution gets built ``from nothing''. Remember that the build environment of a derivation contains nothing but its declared inputs (@pxref{Introduction}). So there's an obvious chicken-and-egg problem: how does the first package get built? How does the first compiler get compiled?"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38077
- msgid "It is tempting to think of this question as one that only die-hard hackers may care about. However, while the answer to that question is technical in nature, its implications are wide-ranging. How the distribution is bootstrapped defines the extent to which we, as individuals and as a collective of users and hackers, can trust the software we run. It is a central concern from the standpoint of @emph{security} and from a @emph{user freedom} viewpoint."
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:38078 guix-git/doc/guix.texi:38290
- #, no-wrap
- msgid "bootstrap binaries"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38088
- msgid "The GNU system is primarily made of C code, with libc at its core. The GNU build system itself assumes the availability of a Bourne shell and command-line tools provided by GNU Coreutils, Awk, Findutils, `sed', and `grep'. Furthermore, build programs---programs that run @code{./configure}, @code{make}, etc.---are written in Guile Scheme (@pxref{Derivations}). Consequently, to be able to build anything at all, from scratch, Guix relies on pre-built binaries of Guile, GCC, Binutils, libc, and the other packages mentioned above---the @dfn{bootstrap binaries}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38092
- msgid "These bootstrap binaries are ``taken for granted'', though we can also re-create them if needed (@pxref{Preparing to Use the Bootstrap Binaries})."
- msgstr ""
- #. type: section
- #: guix-git/doc/guix.texi:38099
- #, no-wrap
- msgid "The Reduced Binary Seed Bootstrap"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38106
- msgid "Guix---like other GNU/Linux distributions---is traditionally bootstrapped from a set of bootstrap binaries: Bourne shell, command-line tools provided by GNU Coreutils, Awk, Findutils, `sed', and `grep' and Guile, GCC, Binutils, and the GNU C Library (@pxref{Bootstrapping}). Usually, these bootstrap binaries are ``taken for granted.''"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38112
- msgid "Taking the bootstrap binaries for granted means that we consider them to be a correct and trustworthy ``seed'' for building the complete system. Therein lies a problem: the combined size of these bootstrap binaries is about 250MB (@pxref{Bootstrappable Builds,,, mes, GNU Mes}). Auditing or even inspecting these is next to impossible."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38117
- msgid "For @code{i686-linux} and @code{x86_64-linux}, Guix now features a ``Reduced Binary Seed'' bootstrap @footnote{We would like to say: ``Full Source Bootstrap'' and while we are working towards that goal it would be hyperbole to use that term for what we do now.}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38123
- msgid "The Reduced Binary Seed bootstrap removes the most critical tools---from a trust perspective---from the bootstrap binaries: GCC, Binutils and the GNU C Library are replaced by: @code{bootstrap-mescc-tools} (a tiny assembler and linker) and @code{bootstrap-mes} (a small Scheme Interpreter and a C compiler written in Scheme and the Mes C Library, built for TinyCC and for GCC)."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38128
- msgid "Using these new binary seeds the ``missing'' Binutils, GCC, and the GNU C Library are built from source. From here on the more traditional bootstrap process resumes. This approach has reduced the bootstrap binaries in size to about 145MB in Guix v1.1."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38136
- msgid "The next step that Guix has taken is to replace the shell and all its utilities with implementations in Guile Scheme, the @emph{Scheme-only bootstrap}. Gash (@pxref{Gash,,, gash, The Gash manual}) is a POSIX-compatible shell that replaces Bash, and it comes with Gash Utils which has minimalist replacements for Awk, the GNU Core Utilities, Grep, Gzip, Sed, and Tar. The rest of the bootstrap binary seeds that were removed are now built from source."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38146
- msgid "Building the GNU System from source is currently only possible by adding some historical GNU packages as intermediate steps@footnote{Packages such as @code{gcc-2.95.3}, @code{binutils-2.14}, @code{glibc-2.2.5}, @code{gzip-1.2.4}, @code{tar-1.22}, and some others. For details, see @file{gnu/packages/commencement.scm}.}. As Gash and Gash Utils mature, and GNU packages become more bootstrappable again (e.g., new releases of GNU Sed will also ship as gzipped tarballs again, as alternative to the hard to bootstrap @code{xz}-compression), this set of added packages can hopefully be reduced again."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38150
- msgid "The graph below shows the resulting dependency graph for @code{gcc-core-mesboot0}, the bootstrap compiler used for the traditional bootstrap of the rest of the Guix System."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38153
- msgid "@image{images/gcc-core-mesboot0-graph,6in,,Dependency graph of gcc-core-mesboot0}"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38160
- msgid "The only significant binary bootstrap seeds that remain@footnote{ Ignoring the 68KB @code{mescc-tools}; that will be removed later, together with @code{mes}.} are a Scheme interpreter and a Scheme compiler: GNU Mes and GNU Guile@footnote{Not shown in this graph are the static binaries for @file{bash}, @code{tar}, and @code{xz} that are used to get Guile running.}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38163
- msgid "This further reduction has brought down the size of the binary seed to about 60MB for @code{i686-linux} and @code{x86_64-linux}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38168
- msgid "Work is ongoing to remove all binary blobs from our free software bootstrap stack, working towards a Full Source Bootstrap. Also ongoing is work to bring these bootstraps to the @code{arm-linux} and @code{aarch64-linux} architectures and to the Hurd."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38172
- msgid "If you are interested, join us on @samp{#bootstrappable} on the Freenode IRC network or discuss on @email{bug-mes@@gnu.org} or @email{gash-devel@@nongnu.org}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38179
- msgid "@image{images/bootstrap-graph,6in,,Dependency graph of the early bootstrap derivations}"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38184
- msgid "The figure above shows the very beginning of the dependency graph of the distribution, corresponding to the package definitions of the @code{(gnu packages bootstrap)} module. A similar figure can be generated with @command{guix graph} (@pxref{Invoking guix graph}), along the lines of:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:38189
- #, no-wrap
- msgid ""
- "guix graph -t derivation \\\n"
- " -e '(@@@@ (gnu packages bootstrap) %bootstrap-gcc)' \\\n"
- " | dot -Tps > gcc.ps\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38192
- msgid "or, for the further Reduced Binary Seed bootstrap"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:38197
- #, no-wrap
- msgid ""
- "guix graph -t derivation \\\n"
- " -e '(@@@@ (gnu packages bootstrap) %bootstrap-mes)' \\\n"
- " | dot -Tps > mes.ps\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38206
- msgid "At this level of detail, things are slightly complex. First, Guile itself consists of an ELF executable, along with many source and compiled Scheme files that are dynamically loaded when it runs. This gets stored in the @file{guile-2.0.7.tar.xz} tarball shown in this graph. This tarball is part of Guix's ``source'' distribution, and gets inserted into the store with @code{add-to-store} (@pxref{The Store})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38215
- msgid "But how do we write a derivation that unpacks this tarball and adds it to the store? To solve this problem, the @code{guile-bootstrap-2.0.drv} derivation---the first one that gets built---uses @code{bash} as its builder, which runs @code{build-bootstrap-guile.sh}, which in turn calls @code{tar} to unpack the tarball. Thus, @file{bash}, @file{tar}, @file{xz}, and @file{mkdir} are statically-linked binaries, also part of the Guix source distribution, whose sole purpose is to allow the Guile tarball to be unpacked."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38227
- msgid "Once @code{guile-bootstrap-2.0.drv} is built, we have a functioning Guile that can be used to run subsequent build programs. Its first task is to download tarballs containing the other pre-built binaries---this is what the @file{.tar.xz.drv} derivations do. Guix modules such as @code{ftp-client.scm} are used for this purpose. The @code{module-import.drv} derivations import those modules in a directory in the store, using the original layout. The @code{module-import-compiled.drv} derivations compile those modules, and write them in an output directory with the right layout. This corresponds to the @code{#:modules} argument of @code{build-expression->derivation} (@pxref{Derivations})."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38232
- msgid "Finally, the various tarballs are unpacked by the derivations @code{gcc-bootstrap-0.drv}, @code{glibc-bootstrap-0.drv}, or @code{bootstrap-mes-0.drv} and @code{bootstrap-mescc-tools-0.drv}, at which point we have a working C tool chain."
- msgstr ""
- #. type: unnumberedsec
- #: guix-git/doc/guix.texi:38233
- #, no-wrap
- msgid "Building the Build Tools"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38242
- msgid "Bootstrapping is complete when we have a full tool chain that does not depend on the pre-built bootstrap tools discussed above. This no-dependency requirement is verified by checking whether the files of the final tool chain contain references to the @file{/gnu/store} directories of the bootstrap inputs. The process that leads to this ``final'' tool chain is described by the package definitions found in the @code{(gnu packages commencement)} module."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38249
- msgid "The @command{guix graph} command allows us to ``zoom out'' compared to the graph above, by looking at the level of package objects instead of individual derivations---remember that a package may translate to several derivations, typically one derivation to download its source, one to build the Guile modules it needs, and one to actually build the package from source. The command:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:38254
- #, no-wrap
- msgid ""
- "guix graph -t bag \\\n"
- " -e '(@@@@ (gnu packages commencement)\n"
- " glibc-final-with-bootstrap-bash)' | xdot -\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38261
- msgid "displays the dependency graph leading to the ``final'' C library@footnote{You may notice the @code{glibc-intermediate} label, suggesting that it is not @emph{quite} final, but as a good approximation, we will consider it final.}, depicted below."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38263
- msgid "@image{images/bootstrap-packages,6in,,Dependency graph of the early packages}"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38269
- msgid "The first tool that gets built with the bootstrap binaries is GNU@tie{}Make---noted @code{make-boot0} above---which is a prerequisite for all the following packages. From there Findutils and Diffutils get built."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38274
- msgid "Then come the first-stage Binutils and GCC, built as pseudo cross tools---i.e., with @option{--target} equal to @option{--host}. They are used to build libc. Thanks to this cross-build trick, this libc is guaranteed not to hold any reference to the initial tool chain."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38280
- msgid "From there the final Binutils and GCC (not shown above) are built. GCC uses @command{ld} from the final Binutils, and links programs against the just-built libc. This tool chain is used to build the other packages used by Guix and by the GNU Build System: Guile, Bash, Coreutils, etc."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38286
- msgid "And voilà! At this point we have the complete set of build tools that the GNU Build System expects. These are in the @code{%final-inputs} variable of the @code{(gnu packages commencement)} module, and are implicitly used by any package that uses @code{gnu-build-system} (@pxref{Build Systems, @code{gnu-build-system}})."
- msgstr ""
- #. type: unnumberedsec
- #: guix-git/doc/guix.texi:38288
- #, no-wrap
- msgid "Building the Bootstrap Binaries"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38295
- msgid "Because the final tool chain does not depend on the bootstrap binaries, those rarely need to be updated. Nevertheless, it is useful to have an automated way to produce them, should an update occur, and this is what the @code{(gnu packages make-bootstrap)} module provides."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38301
- msgid "The following command builds the tarballs containing the bootstrap binaries (Binutils, GCC, glibc, for the traditional bootstrap and linux-libre-headers, bootstrap-mescc-tools, bootstrap-mes for the Reduced Binary Seed bootstrap, and Guile, and a tarball containing a mixture of Coreutils and other basic command-line tools):"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:38304
- #, no-wrap
- msgid "guix build bootstrap-tarballs\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38309
- msgid "The generated tarballs are those that should be referred to in the @code{(gnu packages bootstrap)} module mentioned at the beginning of this section."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38315
- msgid "Still here? Then perhaps by now you've started to wonder: when do we reach a fixed point? That is an interesting question! The answer is unknown, but if you would like to investigate further (and have significant computational and storage resources to do so), then let us know."
- msgstr ""
- #. type: unnumberedsec
- #: guix-git/doc/guix.texi:38316
- #, no-wrap
- msgid "Reducing the Set of Bootstrap Binaries"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38324
- msgid "Our traditional bootstrap includes GCC, GNU Libc, Guile, etc. That's a lot of binary code! Why is that a problem? It's a problem because these big chunks of binary code are practically non-auditable, which makes it hard to establish what source code produced them. Every unauditable binary also leaves us vulnerable to compiler backdoors as described by Ken Thompson in the 1984 paper @emph{Reflections on Trusting Trust}."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38330
- msgid "This is mitigated by the fact that our bootstrap binaries were generated from an earlier Guix revision. Nevertheless it lacks the level of transparency that we get in the rest of the package dependency graph, where Guix always gives us a source-to-binary mapping. Thus, our goal is to reduce the set of bootstrap binaries to the bare minimum."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38336
- msgid "The @uref{https://bootstrappable.org, Bootstrappable.org web site} lists on-going projects to do that. One of these is about replacing the bootstrap GCC with a sequence of assemblers, interpreters, and compilers of increasing complexity, which could be built from source starting from a simple and auditable assembler."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38345
- msgid "Our first major achievement is the replacement of of GCC, the GNU C Library and Binutils by MesCC-Tools (a simple hex linker and macro assembler) and Mes (@pxref{Top, GNU Mes Reference Manual,, mes, GNU Mes}, a Scheme interpreter and C compiler in Scheme). Neither MesCC-Tools nor Mes can be fully bootstrapped yet and thus we inject them as binary seeds. We call this the Reduced Binary Seed bootstrap, as it has halved the size of our bootstrap binaries! Also, it has eliminated the C compiler binary; i686-linux and x86_64-linux Guix packages are now bootstrapped without any binary C compiler."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38348
- msgid "Work is ongoing to make MesCC-Tools and Mes fully bootstrappable and we are also looking at any other bootstrap binaries. Your help is welcome!"
- msgstr ""
- #. type: chapter
- #: guix-git/doc/guix.texi:38350
- #, no-wrap
- msgid "Porting to a New Platform"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38359
- msgid "As discussed above, the GNU distribution is self-contained, and self-containment is achieved by relying on pre-built ``bootstrap binaries'' (@pxref{Bootstrapping}). These binaries are specific to an operating system kernel, CPU architecture, and application binary interface (ABI). Thus, to port the distribution to a platform that is not yet supported, one must build those bootstrap binaries, and update the @code{(gnu packages bootstrap)} module to use them on that platform."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38364
- msgid "Fortunately, Guix can @emph{cross compile} those bootstrap binaries. When everything goes well, and assuming the GNU tool chain supports the target platform, this can be as simple as running a command like this one:"
- msgstr ""
- #. type: example
- #: guix-git/doc/guix.texi:38367
- #, no-wrap
- msgid "guix build --target=armv5tel-linux-gnueabi bootstrap-tarballs\n"
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38374
- msgid "For this to work, the @code{glibc-dynamic-linker} procedure in @code{(gnu packages bootstrap)} must be augmented to return the right file name for libc's dynamic linker on that platform; likewise, @code{system->linux-architecture} in @code{(gnu packages linux)} must be taught about the new platform."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38383
- msgid "Once these are built, the @code{(gnu packages bootstrap)} module needs to be updated to refer to these binaries on the target platform. That is, the hashes and URLs of the bootstrap tarballs for the new platform must be added alongside those of the currently supported platforms. The bootstrap Guile tarball is treated specially: it is expected to be available locally, and @file{gnu/local.mk} has rules to download it for the supported architectures; a rule for the new platform must be added as well."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38392
- msgid "In practice, there may be some complications. First, it may be that the extended GNU triplet that specifies an ABI (like the @code{eabi} suffix above) is not recognized by all the GNU tools. Typically, glibc recognizes some of these, whereas GCC uses an extra @option{--with-abi} configure flag (see @code{gcc.scm} for examples of how to handle this). Second, some of the required packages could fail to build for that platform. Lastly, the generated binaries could be broken for some reason."
- msgstr ""
- #. type: include
- #: guix-git/doc/guix.texi:38394
- #, no-wrap
- msgid "contributing.texi"
- msgstr "contributing.fa.texi"
- #. type: Plain text
- #: guix-git/doc/guix.texi:38407
- msgid "Guix is based on the @uref{https://nixos.org/nix/, Nix package manager}, which was designed and implemented by Eelco Dolstra, with contributions from other people (see the @file{nix/AUTHORS} file in Guix). Nix pioneered functional package management, and promoted unprecedented features, such as transactional package upgrades and rollbacks, per-user profiles, and referentially transparent build processes. Without this work, Guix would not exist."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38410
- msgid "The Nix-based software distributions, Nixpkgs and NixOS, have also been an inspiration for Guix."
- msgstr ""
- #. type: Plain text
- #: guix-git/doc/guix.texi:38416
- msgid "GNU@tie{}Guix itself is a collective work with contributions from a number of people. See the @file{AUTHORS} file in Guix for more information on these fine people. The @file{THANKS} file lists people who have helped by reporting bugs, taking care of the infrastructure, providing artwork and themes, making suggestions, and more---thank you!"
- msgstr ""
- #. type: cindex
- #: guix-git/doc/guix.texi:38421
- #, no-wrap
- msgid "license, GNU Free Documentation License"
- msgstr ""
- #. type: include
- #: guix-git/doc/guix.texi:38422
- #, no-wrap
- msgid "fdl-1.3.texi"
- msgstr ""
|
