diff --git a/manual/.gitignore b/manual/.gitignore new file mode 100644 index 0000000..9b3eb97 --- /dev/null +++ b/manual/.gitignore @@ -0,0 +1,19 @@ +# Copyright (C) 2024 Denis 'GNUtoo' Carikli +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +# See the comment in the ../manual/images/SOIC16.png target in website/Makefile +/images/SOIC-16.png + +/version.texi diff --git a/manual/SOIC-16.jpeg b/manual/SOIC-16.jpeg new file mode 100644 index 0000000..91389dc Binary files /dev/null and b/manual/SOIC-16.jpeg differ diff --git a/manual/fdl-1.3.texi b/manual/fdl-1.3.texi new file mode 100644 index 0000000..eaf3da0 --- /dev/null +++ b/manual/fdl-1.3.texi @@ -0,0 +1,505 @@ +@c The GNU Free Documentation License. +@center Version 1.3, 3 November 2008 + +@c This file is intended to be included within another document, +@c hence no sectioning command or @node. + +@display +Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. +@uref{https://fsf.org/} + +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. +@end display + +@enumerate 0 +@item +PREAMBLE + +The purpose of this License is to make a manual, textbook, or other +functional and useful document @dfn{free} in the sense of freedom: to +assure everyone the effective freedom to copy and redistribute it, +with or without modifying it, either commercially or noncommercially. +Secondarily, this License preserves for the author and publisher a way +to get credit for their work, while not being considered responsible +for modifications made by others. + +This License is a kind of ``copyleft'', which means that derivative +works of the document must themselves be free in the same sense. It +complements the GNU General Public License, which is a copyleft +license designed for free software. + +We have designed this License in order to use it for manuals for free +software, because free software needs free documentation: a free +program should come with manuals providing the same freedoms that the +software does. But this License is not limited to software manuals; +it can be used for any textual work, regardless of subject matter or +whether it is published as a printed book. We recommend this License +principally for works whose purpose is instruction or reference. + +@item +APPLICABILITY AND DEFINITIONS + +This License applies to any manual or other work, in any medium, that +contains a notice placed by the copyright holder saying it can be +distributed under the terms of this License. Such a notice grants a +world-wide, royalty-free license, unlimited in duration, to use that +work under the conditions stated herein. The ``Document'', below, +refers to any such manual or work. Any member of the public is a +licensee, and is addressed as ``you''. You accept the license if you +copy, modify or distribute the work in a way requiring permission +under copyright law. + +A ``Modified Version'' of the Document means any work containing the +Document or a portion of it, either copied verbatim, or with +modifications and/or translated into another language. + +A ``Secondary Section'' is a named appendix or a front-matter section +of the Document that deals exclusively with the relationship of the +publishers or authors of the Document to the Document's overall +subject (or to related matters) and contains nothing that could fall +directly within that overall subject. (Thus, if the Document is in +part a textbook of mathematics, a Secondary Section may not explain +any mathematics.) The relationship could be a matter of historical +connection with the subject or with related matters, or of legal, +commercial, philosophical, ethical or political position regarding +them. + +The ``Invariant Sections'' are certain Secondary Sections whose titles +are designated, as being those of Invariant Sections, in the notice +that says that the Document is released under this License. If a +section does not fit the above definition of Secondary then it is not +allowed to be designated as Invariant. The Document may contain zero +Invariant Sections. If the Document does not identify any Invariant +Sections then there are none. + +The ``Cover Texts'' are certain short passages of text that are listed, +as Front-Cover Texts or Back-Cover Texts, in the notice that says that +the Document is released under this License. A Front-Cover Text may +be at most 5 words, and a Back-Cover Text may be at most 25 words. + +A ``Transparent'' copy of the Document means a machine-readable copy, +represented in a format whose specification is available to the +general public, that is suitable for revising the document +straightforwardly with generic text editors or (for images composed of +pixels) generic paint programs or (for drawings) some widely available +drawing editor, and that is suitable for input to text formatters or +for automatic translation to a variety of formats suitable for input +to text formatters. A copy made in an otherwise Transparent file +format whose markup, or absence of markup, has been arranged to thwart +or discourage subsequent modification by readers is not Transparent. +An image format is not Transparent if used for any substantial amount +of text. A copy that is not ``Transparent'' is called ``Opaque''. + +Examples of suitable formats for Transparent copies include plain +ASCII without markup, Texinfo input format, La@TeX{} input +format, SGML or XML using a publicly available +DTD, and standard-conforming simple HTML, +PostScript or PDF designed for human modification. Examples +of transparent image formats include PNG, XCF and +JPG@. Opaque formats include proprietary formats that can be +read and edited only by proprietary word processors, SGML or +XML for which the DTD and/or processing tools are +not generally available, and the machine-generated HTML, +PostScript or PDF produced by some word processors for +output purposes only. + +The ``Title Page'' means, for a printed book, the title page itself, +plus such following pages as are needed to hold, legibly, the material +this License requires to appear in the title page. For works in +formats which do not have any title page as such, ``Title Page'' means +the text near the most prominent appearance of the work's title, +preceding the beginning of the body of the text. + +The ``publisher'' means any person or entity that distributes copies +of the Document to the public. + +A section ``Entitled XYZ'' means a named subunit of the Document whose +title either is precisely XYZ or contains XYZ in parentheses following +text that translates XYZ in another language. (Here XYZ stands for a +specific section name mentioned below, such as ``Acknowledgements'', +``Dedications'', ``Endorsements'', or ``History''.) To ``Preserve the Title'' +of such a section when you modify the Document means that it remains a +section ``Entitled XYZ'' according to this definition. + +The Document may include Warranty Disclaimers next to the notice which +states that this License applies to the Document. These Warranty +Disclaimers are considered to be included by reference in this +License, but only as regards disclaiming warranties: any other +implication that these Warranty Disclaimers may have is void and has +no effect on the meaning of this License. + +@item +VERBATIM COPYING + +You may copy and distribute the Document in any medium, either +commercially or noncommercially, provided that this License, the +copyright notices, and the license notice saying this License applies +to the Document are reproduced in all copies, and that you add no other +conditions whatsoever to those of this License. You may not use +technical measures to obstruct or control the reading or further +copying of the copies you make or distribute. However, you may accept +compensation in exchange for copies. If you distribute a large enough +number of copies you must also follow the conditions in section 3. + +You may also lend copies, under the same conditions stated above, and +you may publicly display copies. + +@item +COPYING IN QUANTITY + +If you publish printed copies (or copies in media that commonly have +printed covers) of the Document, numbering more than 100, and the +Document's license notice requires Cover Texts, you must enclose the +copies in covers that carry, clearly and legibly, all these Cover +Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on +the back cover. Both covers must also clearly and legibly identify +you as the publisher of these copies. The front cover must present +the full title with all words of the title equally prominent and +visible. You may add other material on the covers in addition. +Copying with changes limited to the covers, as long as they preserve +the title of the Document and satisfy these conditions, can be treated +as verbatim copying in other respects. + +If the required texts for either cover are too voluminous to fit +legibly, you should put the first ones listed (as many as fit +reasonably) on the actual cover, and continue the rest onto adjacent +pages. + +If you publish or distribute Opaque copies of the Document numbering +more than 100, you must either include a machine-readable Transparent +copy along with each Opaque copy, or state in or with each Opaque copy +a computer-network location from which the general network-using +public has access to download using public-standard network protocols +a complete Transparent copy of the Document, free of added material. +If you use the latter option, you must take reasonably prudent steps, +when you begin distribution of Opaque copies in quantity, to ensure +that this Transparent copy will remain thus accessible at the stated +location until at least one year after the last time you distribute an +Opaque copy (directly or through your agents or retailers) of that +edition to the public. + +It is requested, but not required, that you contact the authors of the +Document well before redistributing any large number of copies, to give +them a chance to provide you with an updated version of the Document. + +@item +MODIFICATIONS + +You may copy and distribute a Modified Version of the Document under +the conditions of sections 2 and 3 above, provided that you release +the Modified Version under precisely this License, with the Modified +Version filling the role of the Document, thus licensing distribution +and modification of the Modified Version to whoever possesses a copy +of it. In addition, you must do these things in the Modified Version: + +@enumerate A +@item +Use in the Title Page (and on the covers, if any) a title distinct +from that of the Document, and from those of previous versions +(which should, if there were any, be listed in the History section +of the Document). You may use the same title as a previous version +if the original publisher of that version gives permission. + +@item +List on the Title Page, as authors, one or more persons or entities +responsible for authorship of the modifications in the Modified +Version, together with at least five of the principal authors of the +Document (all of its principal authors, if it has fewer than five), +unless they release you from this requirement. + +@item +State on the Title page the name of the publisher of the +Modified Version, as the publisher. + +@item +Preserve all the copyright notices of the Document. + +@item +Add an appropriate copyright notice for your modifications +adjacent to the other copyright notices. + +@item +Include, immediately after the copyright notices, a license notice +giving the public permission to use the Modified Version under the +terms of this License, in the form shown in the Addendum below. + +@item +Preserve in that license notice the full lists of Invariant Sections +and required Cover Texts given in the Document's license notice. + +@item +Include an unaltered copy of this License. + +@item +Preserve the section Entitled ``History'', Preserve its Title, and add +to it an item stating at least the title, year, new authors, and +publisher of the Modified Version as given on the Title Page. If +there is no section Entitled ``History'' in the Document, create one +stating the title, year, authors, and publisher of the Document as +given on its Title Page, then add an item describing the Modified +Version as stated in the previous sentence. + +@item +Preserve the network location, if any, given in the Document for +public access to a Transparent copy of the Document, and likewise +the network locations given in the Document for previous versions +it was based on. These may be placed in the ``History'' section. +You may omit a network location for a work that was published at +least four years before the Document itself, or if the original +publisher of the version it refers to gives permission. + +@item +For any section Entitled ``Acknowledgements'' or ``Dedications'', Preserve +the Title of the section, and preserve in the section all the +substance and tone of each of the contributor acknowledgements and/or +dedications given therein. + +@item +Preserve all the Invariant Sections of the Document, +unaltered in their text and in their titles. Section numbers +or the equivalent are not considered part of the section titles. + +@item +Delete any section Entitled ``Endorsements''. Such a section +may not be included in the Modified Version. + +@item +Do not retitle any existing section to be Entitled ``Endorsements'' or +to conflict in title with any Invariant Section. + +@item +Preserve any Warranty Disclaimers. +@end enumerate + +If the Modified Version includes new front-matter sections or +appendices that qualify as Secondary Sections and contain no material +copied from the Document, you may at your option designate some or all +of these sections as invariant. To do this, add their titles to the +list of Invariant Sections in the Modified Version's license notice. +These titles must be distinct from any other section titles. + +You may add a section Entitled ``Endorsements'', provided it contains +nothing but endorsements of your Modified Version by various +parties---for example, statements of peer review or that the text has +been approved by an organization as the authoritative definition of a +standard. + +You may add a passage of up to five words as a Front-Cover Text, and a +passage of up to 25 words as a Back-Cover Text, to the end of the list +of Cover Texts in the Modified Version. Only one passage of +Front-Cover Text and one of Back-Cover Text may be added by (or +through arrangements made by) any one entity. If the Document already +includes a cover text for the same cover, previously added by you or +by arrangement made by the same entity you are acting on behalf of, +you may not add another; but you may replace the old one, on explicit +permission from the previous publisher that added the old one. + +The author(s) and publisher(s) of the Document do not by this License +give permission to use their names for publicity for or to assert or +imply endorsement of any Modified Version. + +@item +COMBINING DOCUMENTS + +You may combine the Document with other documents released under this +License, under the terms defined in section 4 above for modified +versions, provided that you include in the combination all of the +Invariant Sections of all of the original documents, unmodified, and +list them all as Invariant Sections of your combined work in its +license notice, and that you preserve all their Warranty Disclaimers. + +The combined work need only contain one copy of this License, and +multiple identical Invariant Sections may be replaced with a single +copy. If there are multiple Invariant Sections with the same name but +different contents, make the title of each such section unique by +adding at the end of it, in parentheses, the name of the original +author or publisher of that section if known, or else a unique number. +Make the same adjustment to the section titles in the list of +Invariant Sections in the license notice of the combined work. + +In the combination, you must combine any sections Entitled ``History'' +in the various original documents, forming one section Entitled +``History''; likewise combine any sections Entitled ``Acknowledgements'', +and any sections Entitled ``Dedications''. You must delete all +sections Entitled ``Endorsements.'' + +@item +COLLECTIONS OF DOCUMENTS + +You may make a collection consisting of the Document and other documents +released under this License, and replace the individual copies of this +License in the various documents with a single copy that is included in +the collection, provided that you follow the rules of this License for +verbatim copying of each of the documents in all other respects. + +You may extract a single document from such a collection, and distribute +it individually under this License, provided you insert a copy of this +License into the extracted document, and follow this License in all +other respects regarding verbatim copying of that document. + +@item +AGGREGATION WITH INDEPENDENT WORKS + +A compilation of the Document or its derivatives with other separate +and independent documents or works, in or on a volume of a storage or +distribution medium, is called an ``aggregate'' if the copyright +resulting from the compilation is not used to limit the legal rights +of the compilation's users beyond what the individual works permit. +When the Document is included in an aggregate, this License does not +apply to the other works in the aggregate which are not themselves +derivative works of the Document. + +If the Cover Text requirement of section 3 is applicable to these +copies of the Document, then if the Document is less than one half of +the entire aggregate, the Document's Cover Texts may be placed on +covers that bracket the Document within the aggregate, or the +electronic equivalent of covers if the Document is in electronic form. +Otherwise they must appear on printed covers that bracket the whole +aggregate. + +@item +TRANSLATION + +Translation is considered a kind of modification, so you may +distribute translations of the Document under the terms of section 4. +Replacing Invariant Sections with translations requires special +permission from their copyright holders, but you may include +translations of some or all Invariant Sections in addition to the +original versions of these Invariant Sections. You may include a +translation of this License, and all the license notices in the +Document, and any Warranty Disclaimers, provided that you also include +the original English version of this License and the original versions +of those notices and disclaimers. In case of a disagreement between +the translation and the original version of this License or a notice +or disclaimer, the original version will prevail. + +If a section in the Document is Entitled ``Acknowledgements'', +``Dedications'', or ``History'', the requirement (section 4) to Preserve +its Title (section 1) will typically require changing the actual +title. + +@item +TERMINATION + +You may not copy, modify, sublicense, or distribute the Document +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense, or distribute it is void, and +will automatically terminate your rights under this License. + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, receipt of a copy of some or all of the same material does +not give you any rights to use it. + +@item +FUTURE REVISIONS OF THIS LICENSE + +The Free Software Foundation may publish new, revised versions +of the GNU Free Documentation License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. See +@uref{https://www.gnu.org/licenses/}. + +Each version of the License is given a distinguishing version number. +If the Document specifies that a particular numbered version of this +License ``or any later version'' applies to it, you have the option of +following the terms and conditions either of that specified version or +of any later version that has been published (not as a draft) by the +Free Software Foundation. If the Document does not specify a version +number of this License, you may choose any version ever published (not +as a draft) by the Free Software Foundation. If the Document +specifies that a proxy can decide which future versions of this +License can be used, that proxy's public statement of acceptance of a +version permanently authorizes you to choose that version for the +Document. + +@item +RELICENSING + +``Massive Multiauthor Collaboration Site'' (or ``MMC Site'') means any +World Wide Web server that publishes copyrightable works and also +provides prominent facilities for anybody to edit those works. A +public wiki that anybody can edit is an example of such a server. A +``Massive Multiauthor Collaboration'' (or ``MMC'') contained in the +site means any set of copyrightable works thus published on the MMC +site. + +``CC-BY-SA'' means the Creative Commons Attribution-Share Alike 3.0 +license published by Creative Commons Corporation, a not-for-profit +corporation with a principal place of business in San Francisco, +California, as well as future copyleft versions of that license +published by that same organization. + +``Incorporate'' means to publish or republish a Document, in whole or +in part, as part of another Document. + +An MMC is ``eligible for relicensing'' if it is licensed under this +License, and if all works that were first published under this License +somewhere other than this MMC, and subsequently incorporated in whole +or in part into the MMC, (1) had no cover texts or invariant sections, +and (2) were thus incorporated prior to November 1, 2008. + +The operator of an MMC Site may republish an MMC contained in the site +under CC-BY-SA on the same site at any time before August 1, 2009, +provided the MMC is eligible for relicensing. + +@end enumerate + +@page +@heading ADDENDUM: How to use this License for your documents + +To use this License in a document you have written, include a copy of +the License in the document and put the following copyright and +license notices just after the title page: + +@smallexample +@group + Copyright (C) @var{year} @var{your name}. + 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''. +@end group +@end smallexample + +If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, +replace the ``with@dots{}Texts.''@: line with this: + +@smallexample +@group + with the Invariant Sections being @var{list their titles}, with + the Front-Cover Texts being @var{list}, and with the Back-Cover Texts + being @var{list}. +@end group +@end smallexample + +If you have Invariant Sections without Cover Texts, or some other +combination of the three, merge those two alternatives to suit the +situation. + +If your document contains nontrivial examples of program code, we +recommend releasing these examples in parallel under your choice of +free software license, such as the GNU General Public License, +to permit their use in free software. + +@c Local Variables: +@c ispell-local-pdict: "ispell-dict" +@c End: diff --git a/manual/gnuboot.texi b/manual/gnuboot.texi new file mode 100644 index 0000000..65a9027 --- /dev/null +++ b/manual/gnuboot.texi @@ -0,0 +1,189 @@ +\input texinfo @c -*-texinfo-*- +@c %**start of header +@setfilename gnuboot.info +@include version.texi +@settitle GNU Boot @value{VERSION} + +@c Define a new index for options. +@defcodeindex op +@c Combine everything into one index (arbitrarily chosen to be the +@c concept index). +@syncodeindex op cp +@c %**end of header + +@copying + +Copyright @copyright{} 2024 Denis 'GNUtoo' Carikli. + +@quotation +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, with no Front-Cover Texts, and with no Back-Cover +Texts. A copy of the license is included in the section entitled +``GNU Free Documentation License''. +@end quotation +@end copying + +@dircategory Kernel +@direntry +* GNU Boot: (gnuboot). Boot software distribution +@end direntry + +@titlepage +@title GNU Boot manual (version @value{VERSION}) +@author GNU Boot Contributors (@email{gnuboot@@gnu.org}) +@page +@vskip 0pt plus 1filll +@insertcopying +@end titlepage + +@contents + + +@ifnottex +@node Top +@top GNU Boot + +This manual is for GNU Boot version @value{VERSION}. +@end ifnottex + +@node Table of contents + +@menu +* Overview:: General purpose and information. +* Helping GNU Boot:: How to contribute to GNU Boot +* GNU Free Documentation License:: Copying and sharing this documentation. +* Concept index:: Index of concepts. +@end menu + + +@node Overview +@chapter Overview + +This chapter will explain what is GNU Boot, and how it compares with +somewhat similar projects. + +@node What is GNU Boot +@section What is GNU Boot + +GNU Boot is a @dfn{boot software} @dfn{distribution}. What this means +will be explained below. + +@node boot software +@subsection boot software +@cindex @acronym{BIOS, Basic Input/Output System} +@cindex @acronym{UEFI, Unified Extensible Firmware Interface} +@cindex boot software + +If you take a modern laptop computer, and remove the storage devices +(like @acronym{SSD, Solid State Drive}, hard disks, etc) and then +power on the computer, it will typically show something on the screen. + +It often looks a bit like that: + +@verbatim ++--------------------------------------------------------------------+ +| | +| | +| | +| | +| | +| | +| [ Some company Logo ] | +| | +| | +| | +| | +| | +| | +| Press F2 for BIOS setup, Press F12 for the startup menu. | ++--------------------------------------------------------------------+ +@end verbatim + +What is being displayed on the screen is produced by software which is +often nonfree. + +It is often called @acronym{BIOS, Basic Input/Output System} or +@acronym{UEFI, Unified Extensible Firmware Interface} on computers +people are most familiar with. This software is typically stored +inside a memory chip inside the computer mainboard. In some computers, +this software can be replaced by free software. + +Depending on how you read the manual, right below you may or may not +see a picture of this memory chip on the mainboard of a ThinkPad X200. + +@image{images/SOIC-16,6in,, Picture of the memory chip of the ThinkPad X200 +mainboard.} + +@sp 2 + +The goal of this boot software is to initialize the hardware and load +an operating system (like GNU/Linux). + +@sp 1 + +This kind of ``boot software'' exists for a variety of reasons: + +@itemize + +@item The operating systems require certain hardware components like the +@acronym{RAM, Random Access Memory} to already work when they are +started. + +@item The operating system is stored on a storage device(s) (like +@acronym{SSD, Solid State Drive}, hard disks, etc) and part of it needs to be +loaded inside the @acronym{RAM, Random Access Memory} to +work. Something has to do the loading, and this is done in software +for flexibility and/or efficiency reasons. + +@item Finally, certain hardware components cannot be auto-detected and +something needs to tell the operating system what drivers to load, +which which settings. + +@end itemize + +GNU Boot provides such software. It enables to replace nonfree boot +software (typically nonfree @acronym{BIOS, Basic Input/Output System} +or @acronym{UEFI, Unified Extensible Firmware Interface}) on some +computers. + +@node distribution +@subsection distribution + +GNU Boot is only a distribution because it reuses various software to +produce something that can be installed. + +So it is similar to GNU/Linux distributions like Trisquel 11 +(aramo) that also reuse various software to produce something that +can be installed. + + +@node Helping GNU Boot +@chapter Helping GNU Boot + +The GNU Boot project needs help with this manual, specifically on +moving information from the GNU Boot website to this manual. + +In general there is also a lot of ways to help the GNU Boot project +(from reviewing website pages for very simple mistakes or outdated +information, testing GNU Boot images, etc). + +See the +@uref{https://www.gnu.org/software/gnuboot/web/git.html,Helping GNU +Boot} page on the GNU Boot website for the areas where we need help +and on how to help practically speaking (how to contact the project, +where to send bug reports, etc). + +@node GNU Free Documentation License +@appendix GNU Free Documentation License + +@include fdl-1.3.texi + + +@node Concept index +@unnumbered Concept index + +@printindex cp + +@bye diff --git a/resources/distros/guix/bordeaux.guix.gnu.org.pub b/resources/distros/guix/bordeaux.guix.gnu.org.pub new file mode 100644 index 0000000..67085c4 --- /dev/null +++ b/resources/distros/guix/bordeaux.guix.gnu.org.pub @@ -0,0 +1,6 @@ +(public-key + (ecc + (curve Ed25519) + (q #7D602902D3A2DBB83F8A0FB98602A754C5493B0B778C8D1DD4E0F41DE14DE34F#) + ) + ) diff --git a/website/.gitignore b/website/.gitignore index 28208c5..48d25bf 100644 --- a/website/.gitignore +++ b/website/.gitignore @@ -32,3 +32,25 @@ # History /history/git-history.jpg + +# Manual +/cmbx12.1037pk +/cmbx12.657pk +/cmbx12.720pk +/cmbx12.864pk +/cmmi10.657pk +/cmmi12.720pk +/cmr10.657pk +/cmsl10.657pk +/cmsltt10.540pk +/cmsy10.657pk +/cmti10.657pk +/cmtt10.657pk +/cmtt12.720pk +/gnuboot.aux +/gnuboot.cp +/gnuboot.cps +/gnuboot.log +/gnuboot.toc +/images/* +/pages/manual/* diff --git a/website/Makefile.am b/website/Makefile.am index 31da77b..b94a27a 100644 --- a/website/Makefile.am +++ b/website/Makefile.am @@ -12,6 +12,8 @@ # # You should have received a copy of the GNU General Public License # along with this program. If not, see . +SENTINEL = + .PHONY: all build check help publish serve website.tar.gz all: help @@ -76,6 +78,99 @@ pages/footer.include: pages/footer.include.tmpl pages/footer-git-commit.include site.cfg: site.cfg.tmpl sed -e "s#WEBSITE_PREFIX#$(WEBSITE_PREFIX)#g" "$^" > "$@" +if WANT_GUIX +# We can't use MAKEINFO as it's defined in configure.ac +MAKEINFO_CMD = $(GUIX_SHELL_CONTAINER) \ + --expose=`realpath ../manual/` \ + coreutils \ + diffutils \ + gcc-toolchain \ + grep \ + sed \ + tar \ + texinfo \ + texlive-bin \ + texlive-cm \ + texlive-epsf \ + texlive-kpathsea \ + texlive-latex-base \ + texlive-metafont \ + texlive-tex-texinfo \ + -- \ + makeinfo +else +MAKEINFO_CMD = makeinfo +endif + +../manual/version.texi: Makefile + @if git --no-pager name-rev --tags HEAD | awk '{print $$2}' | grep -q '^tags/' ; then \ + printf '@set VERSION %s' \ + `git describe --tag HEAD` > $@ ; \ + else \ + printf '@set VERSION %s' \ + `git --no-pager show --no-patch HEAD --pretty="%h"` > $@ ; \ + fi + +# If we use GNUBOOT_MANUAL_DEPENDENCIES, autoreconf 2.71 will output the +# following warning: +# Makefile.am:115: warning: variable 'GNUBOOT_MANUAL_DEPENDENCIES' is +# defined but no program or +# Makefile.am:115: library has 'GNUBOOT_MANUAL' as canonical name (possible +# typo) +# Some other variable names are also reserved by automake such as +# *_SOURCES, so we used GNUBOOT_MANUAL_FILES to avoid conflicts or +# potentially unintended side effects. +GNUBOOT_MANUAL_FILES = \ + ../manual/fdl-1.3.texi \ + ../manual/gnuboot.texi \ + ../manual/images/SOIC-16.png \ + ../manual/version.texi \ + Makefile \ + $(SENTINEL) + +pages/manual/gnuboot.%: $(GNUBOOT_MANUAL_FILES) + mkdir -p `dirname $@` + $(MAKEINFO_CMD) \ + --$(subst pages/manual/gnuboot.,,$@) \ + --no-split \ + -o $@ \ + ../manual/gnuboot.texi + +if WANT_GUIX +GM_CMD = $(GUIX_SHELL_CONTAINER) \ + --expose=`realpath ../manual/` \ + graphicsmagick \ + -- \ + gm +else +GM_CMD = gm +endif + +pages/manual/images/SOIC-16.png: ../manual/SOIC-16.jpeg + mkdir -p `dirname $@` + $(GM_CMD) convert $< $@ + +# In the manual we include SOIC-16.png as @image{images/SOIC-16, +# [...]}. This was done to make it easier to later on package the +# manual in FHS distributions like Trisquel as the info manual ends up +# in /usr/share/info/ while its images are expected to go in +# /usr/share/info/images instead. But then the manual also +# needs to be able to find its images during the compilation. +../manual/images/SOIC-16.png: pages/manual/images/SOIC-16.png + mkdir -p `dirname $@` + install -m 644 $< $@ + +pages/manual/images/SOIC-16.jpeg: ../manual/SOIC-16.jpeg + mkdir -p `dirname $@` + install -m 644 $< $@ + +GNUBOOT_MANUAL = \ + pages/manual/images/SOIC-16.jpeg \ + pages/manual/images/SOIC-16.png \ + pages/manual/gnuboot.html \ + pages/manual/gnuboot.pdf \ + $(SENTINEL) + if WANT_GUIX BUILD_SH_CMD = $(GUIX_SHELL_CONTAINER) \ --network \ @@ -95,7 +190,7 @@ else BUILD_SH_CMD = ./build.sh endif -build: site.cfg pages/footer.include +build: site.cfg pages/footer.include $(GNUBOOT_MANUAL) $(BUILD_SH_CMD) $(BUILD_OPTIONS) if WANT_GUIX diff --git a/website/README b/website/README index 5e45d44..3eb4164 100644 --- a/website/README +++ b/website/README @@ -1,17 +1,24 @@ -== Introduction == ++==============+ +| Introduction | ++==============+ This directory contains both the website in pages/ and build code to easily build and deploy the GNU Boot website with very few commands. -== Dependencies == ++==============+ +| Dependencies | ++==============+ +Without Guix +------------- If you don't want to install Guix just to test the website, you will -need to install the following dependencies: +need to install the following dependencies (tested under Trisquel 11): * autoconf * automake * coreutils * gawk * git +* graphicsmagick * graphviz * grep * gzip @@ -20,11 +27,17 @@ need to install the following dependencies: * pandoc * sed * tar +* texinfo +* texlive-binaries +* texlive-plain-generic +You can then use the following commands to build the website: $ ./autogen.sh $ ./configure --disable-guix $ make serve +With Guix +--------- And if you want to use Guix instead you only need the following dependencies instead: @@ -35,9 +48,9 @@ dependencies instead: * make * tar -For making sure that the build doesn't take days, you will also need -to make sure that bordeaux.guix.gnu.org is in the list of substitutes -(binary packages servers). +But for making sure that the build doesn't take days with Guix, you +will also need to make sure that bordeaux.guix.gnu.org is in the list +of substitutes (binary packages servers for Guix). This is needed because some older Guix packages (like the ones on Trisquel 11 or PureOS) don't have bordeaux enabled while installation @@ -54,14 +67,20 @@ $ guix repl force-bordeaux-substitute.scm check If instead you need to add it, it will print 'bordeaux.guix.gnu.org is disabled'. -You can add bordeaux.guix.gnu.org with the following command: +If you are in the same directory than this README, you can add +bordeaux.guix.gnu.org with the following command: +$ sudo guix archive --authorize < ../resources/distros/guix/bordeaux.guix.gnu.org.pub + +Or if you do not want to blindly trust the file above, you could +simply update Guix and get the file from Guix instead, but updating +Guix the first time can be quite long to do: $ guix pull $ sudo guix archive --authorize < ~/.config/guix/current/share/guix/bordeaux.guix.gnu.org.pub -You will also need to make it possible for the build system to check -if it is enabled as some people might want to bulid everything -themselves for security reasons, so we don't use bordeaux if it is not -already authorized: +You will then need to make it possible for the build system to check +if bordeaux is enabled as some people might want to bulid everything +themselves for security reasons, so we don't (and can't) use bordeaux +if it is not already authorized: $ sudo chmod +r /etc/guix/acl Once bordeaux is enabled you can use the following commands to build @@ -70,7 +89,12 @@ $ ./autogen.sh $ ./configure $ make serve -== Testing the website == +The first time it will be longer in the case you have a Guix older +than 1.4.0 (as it will also download Guix 1.4.0 in the process). + ++=====================+ +| Testing the website | ++=====================+ Here's how to deploy the website in a local webserver: $ ./autogen.sh @@ -94,7 +118,9 @@ external repositories that have your modifications, or you could also modify the build.sh script to use different git repositories and/or revisions. -== Deployment on https://gnu.org/software/gnuboot/ == ++=================================================+ +| Deployment on https://gnu.org/software/gnuboot/ | ++=================================================+ The deployment to https://gnu.org/software/gnuboot/ uses rsync. As gnu.org machine is behind a firewall, so you need to workaround @@ -161,8 +187,9 @@ References: SHA256:pmCf0NrBzSSYfg6DdgmlMzPWZzGpXXcPEz6LP1+o5Jc exists on the server". - -== License == ++=========+ +| License | ++=========+ This project is free software: - For the files that are in website/pages and the the site.cfg file in the same directory than this README see website/pages/license.md for diff --git a/website/configure.ac b/website/configure.ac index 88e4612..89a31f3 100644 --- a/website/configure.ac +++ b/website/configure.ac @@ -143,6 +143,11 @@ AS_IF([test x"$guix" = x"yes"], [AC_MSG_ERROR( [find was not found in PATH ($PATH)])]) + AC_CHECK_PROG([FOUND_GM], [gm], [gm]) + AS_IF([test x"$FOUND_GM" = x""], + [AC_MSG_ERROR( + [gm was not found in PATH ($PATH)])]) + AC_CHECK_PROG([FOUND_GREP], [grep], [grep]) AS_IF([test x"$FOUND_GREP" = x""], [AC_MSG_ERROR( @@ -173,6 +178,11 @@ AS_IF([test x"$guix" = x"yes"], [AC_MSG_ERROR( [false was not found in PATH ($PATH)])])]) + AC_CHECK_PROG([FOUND_MAKEINFO], [makeinfo], [makeinfo]) + AS_IF([test x"$FOUND_MAKEINFO" = x""], + [AC_MSG_ERROR( + [makeinfo was not found in PATH ($PATH)])]) + AC_CHECK_PROG([FOUND_PANDOC], [pandoc], [pandoc]) AS_IF([test x"$FOUND_PANDOC" = x""], [AC_MSG_ERROR( @@ -186,7 +196,12 @@ AS_IF([test x"$guix" = x"yes"], AC_CHECK_PROG([FOUND_TEST], [test], [test]) AS_IF([test x"$FOUND_TEST" = x""], [AC_MSG_ERROR( - [test was not found in PATH ($PATH)])])]) + [test was not found in PATH ($PATH)])]) + + AC_CHECK_PROG([FOUND_TEX], [tex], [tex]) + AS_IF([test x"$FOUND_TEX" = x""], + [AC_MSG_ERROR( + [tex was not found in PATH ($PATH)])])]) AC_OUTPUT AS_ECHO(["Configuration options:"]) diff --git a/website/pages/docs/index.md b/website/pages/docs/index.md index c3693ab..b4430b2 100644 --- a/website/pages/docs/index.md +++ b/website/pages/docs/index.md @@ -2,6 +2,19 @@ title: Documentation ... +Manuals +======= + +The GNU Boot project started creating a manual +([online](../manual/gnuboot.html), [pdf](../manual/gnuboot.pdf)) to +better organize the documentation about GNU Boot. It also enables to +target a wider diversity of users, contributors and maintainers. + +Note that the online manual can also be saved locally. In that case +it's a good idea to also save the +[SOIC-16.jpeg](../manual/images/SOIC-16.jpeg) picture in the same directory +to make the image(s) work. + General information ===================