Differential D36976 Diff 111838 documentation/content/en/books/faq/_index.adoc

Changeset View

Standalone View

documentation/content/en/books/faq/_index.adoc

Show First 20 Lines • Show All 254 Lines • ▼ Show 20 Lines

Before submitting a problem report, read extref:{problem-reports}[Writing FreeBSD Problem Reports], an article on how to write good problem reports.

[[support]]

== Documentation and Support

[[books]]

=== What good books are there about FreeBSD?

The project produces a wide range of documentation, available online from this link: https://www.FreeBSD.org/docs/[https://www.FreeBSD.org/docs/].

grahamperrinUnsubmitted

Not Done

=== What good books are there about FreeBSD?

- The project produces a wide range of documentation, available online from this link: https://www.FreeBSD.org/docs/[https://www.FreeBSD.org/docs/].

+ https://www.freebsd.org/docs/[https://www.freebsd.org/docs/] includes links to publications and the FreeBSD documentation portal.

[[doc-formats]]

grahamperrin:

pauamma_gundo.comAuthorUnsubmitted

Done

Focusing on the layout question in this review.

pauamma_gundo.com: Focusing on the layout question in this review.

[[doc-formats]]

=== Is the documentation available in other formats, such as plain text (ASCII), or PDF?

=== Is the documentation available in other formats, such as PDF?

grahamperrinUnsubmitted

Not Done

[[doc-formats]]

- === Is the documentation available in other formats, such as PDF?

+ === Is documentation available in other formats and languages?

Yes.

grahamperrin:

Yes. The documentation is available in a number of different formats and compression schemes on the FreeBSD FTP site,

Yes.

The documentation is available in several formats on the FreeBSD FTP site,

in the https://download.freebsd.org/doc/[/doc/] directory.

grahamperrinUnsubmitted

Not Done

=== Is the documentation available in other formats, such as PDF?

- Yes.

- The documentation is available in several formats on the FreeBSD FTP site,

- in the https://download.freebsd.org/doc/[/doc/] directory.

+ Yes, at link:https://download.freebsd.org/doc/[https://download.freebsd.org/doc/].

The documentation is categorized in a number of different ways.

It might have been FTP in the past, but now it's HTTPS, and (I think) in this case, let's not be shy about making the address visible.

grahamperrin: It might have been FTP in the past, but now it's HTTPS, and (I think) in this case, let's not…

pauamma_gundo.comAuthorUnsubmitted

Done

Agreed about not mentioning FTP, not about the URL alone as link text. (On second thought, I don't agree with the original either, for accessibility.)

pauamma_gundo.com: Agreed about not mentioning FTP, not about the URL alone as link text. (On second thought, I…

The documentation is categorized in a number of different ways.

These include:

grahamperrinUnsubmitted

Not Done

in the https://download.freebsd.org/doc/[/doc/] directory.

- The documentation is categorized in a number of different ways.

- These include:

+ Directories are organized according to:

* The document's name, such as `faq`, or `handbook`.

grahamperrin:

* The document's name, such as `faq`, or `handbook`.

grahamperrinUnsubmitted

Not Done

These include:

- * The document's name, such as `faq`, or `handbook`.

+ * Name, such as `faq`, or `handbook`.

* The document's language. Language names are based on the locale names found under [.filename]#/usr/share/locale# on a FreeBSD system, with the encodings removed as all documentation now uses UTF-8. The current languages are as follows:

grahamperrin:

* The document's language and encoding. These are based on the locale names found under [.filename]#/usr/share/locale# on a FreeBSD system. The current languages and encodings are as follows:

grahamperrinUnsubmitted

Done

* The document's name, such as `faq`, or `handbook`.

- * The document's language. These are based on the locale names found under [.filename]#/usr/share/locale# on a FreeBSD system, with the encodings removes as all documentation now uses UTF-8. The current languages are as follows:

+ * The document's language. This is based on the locale names found under [.filename]#/usr/share/locale# on a FreeBSD system, with the encodings removes as all documentation now uses UTF-8. The current languages are as follows:

[.informaltable]

language, singular.

grahamperrin: language, singular.

pauamma_gundo.comAuthorUnsubmitted

Done

Replaced "these" with its new referent.

pauamma_gundo.com: Replaced "these" with its new referent.

grahamperrinUnsubmitted

Not Done

grahamperrin: ?

pauamma_gundo.comAuthorUnsubmitted

Done

?

Not sure what that 2nd comment is asking.

pauamma_gundo.com: > ? Not sure what that 2nd comment is asking.

grahamperrinUnsubmitted

Not Done

* The document's name, such as `faq`, or `handbook`.

- * The document's language. Language names are based on the locale names found under [.filename]#/usr/share/locale# on a FreeBSD system, with the encodings removed as all documentation now uses UTF-8. The current languages are as follows:

+ * Language. Language names are based on the locale names found under [.filename]#/usr/share/locale# on a FreeBSD system, with the encodings removed as all documentation now uses UTF-8. The current languages are as follows:

[.informaltable]

grahamperrin:

pauamma_gundo.comAuthorUnsubmitted

Done

Going to keep the original wording, paralleling "The document's name" above.

pauamma_gundo.com: Going to keep the original wording, paralleling "The document's name" above.

[.informaltable]

[cols="1,1", frame="none", options="header"]

|===

| Name

| Meaning

|`en_US.ISO8859-1`

|`en`

|English (United States)

|English

|`bn_BD.ISO10646-1`

|`bn-bd`

|Bengali or Bangla (Bangladesh)

|`da_DK.ISO8859-1`

|`da`

|Danish (Denmark)

|Danish

|`de_DE.ISO8859-1`

|`de`

|German (Germany)

|German

|`el_GR.ISO8859-7`

|`el`

|Greek (Greece)

|Greek

|`es_ES.ISO8859-1`

|`es`

|Spanish (Spain)

|Spanish

|`fr_FR.ISO8859-1`

|`fr`

|French (France)

|French

|`hu_HU.ISO8859-2`

|`hu`

|Hungarian (Hungary)

|Hungarian

|`it_IT.ISO8859-15`

|`it`

|Italian (Italy)

|Italian

|`ja_JP.eucJP`

|`ja`

|Japanese (Japan, EUC encoding)

|Japanese

|`ko_KR.UTF-8`

|`ko`

|Korean (Korea, UTF-8 encoding)

|Korean

|`mn_MN.UTF-8`

|`mn`

|Mongolian (Mongolia, UTF-8 encoding)

|Mongolian

|`nl_NL.ISO8859-1`

|`nl`

|Dutch (Netherlands)

|Dutch

|`pl_PL.ISO8859-2`

|`pl`

|Polish (Poland)

|Polish

|`pt_BR.ISO8859-1`

|`pt-br`

|Portuguese (Brazil)

|`ru_RU.KOI8-R`

|`ru`

|Russian (Russia, KOI8-R encoding)

|Russian

|`tr_TR.ISO8859-9`

|`tr`

|Turkish (Turkey)

|Turkish

|`zh_CN.UTF-8`

|`zh-cn`

|Simplified Chinese (China, UTF-8 encoding)

|Simplified Chinese (China)

|`zh_TW.UTF-8`

|`zh-tw`

|Traditional Chinese (Taiwan, UTF-8 encoding)

|Traditional Chinese (Taiwan)

|===

[NOTE]

====

Some documents may not be available in all languages.

====

* The document's format. We produce the documentation in a number of different output formats. Each format has its own advantages and disadvantages. Some formats are better suited for online reading, while others are meant to be aesthetically pleasing when printed on paper. Having the documentation available in any of these formats ensures that our readers will be able to read the parts they are interested in, either on their monitor, or on paper after printing the documents. The currently available formats are:

grahamperrinUnsubmitted

Not Done

====

- * The document's format. We produce the documentation in a number of different output formats. Each format has its own advantages and disadvantages. Some formats are better suited for online reading, while others are meant to be aesthetically pleasing when printed on paper. Having the documentation available in any of these formats ensures that our readers will be able to read the parts they are interested in, either on their monitor, or on paper after printing the documents. The currently available formats are:

+ * Format.

[.informaltable]

Let's remind ourselves that the page is (or should be) – essentially – answers to questions about FreeBSD.

grahamperrin: Let's remind ourselves that the page is (or should be) – essentially – answers to questions…

pauamma_gundo.comAuthorUnsubmitted

Done

Will revisit later, along with the rest of the tersifying you suggested.

pauamma_gundo.com: Will revisit later, along with the rest of the tersifying you suggested.

[.informaltable]

[cols="1,1", frame="none", options="header"]

|===

| Format

| Meaning

|`html-split`

|A collection of small, linked, HTML files.

|`html`

|One large HTML file containing the entire document

|Depending on the document, one large HTML file containing the entire document or a collection of small linked HTML files, both together with images, stylesheets, and JavaScript

grahamperrinUnsubmitted

Done

|`html`

- |Depending on the document, one large HTML file containing the entire document or a collection of small linked HTML files, both together with images, stylesheets, and Javascript

+ |Depending on the document: one large HTML file containing the entire document, or a collection of small linked HTML files, each with images, stylesheets, and JavaScript

|`pdf`

grahamperrin:

|`pdf`

|Adobe's Portable Document Format

|`txt`

|Plain text

|===

* The compression and packaging scheme.

.. Where the format is `html-split`, the files are bundled up using man:tar[1]. The resulting [.filename]#.tar# is then compressed using the compression schemes detailed in the next point.

.. Where the format is `html`, the files are bundled up using man:tar[1]. The resulting [.filename]#.tar# is then compressed using man:gzip[1].

.. All the other formats generate one file. For example, [.filename]#article.pdf#, [.filename]#book.html#, and so on.

.. The PDF format generates one file. For example, [.filename]#explaining-bsd_en.pdf#, [.filename]#faq_en.pdf#, and so on.

These files are then compressed using either the `zip` or `bz2` compression schemes.

man:tar[1] can be used to uncompress these files.

So the PDF version of the Handbook, compressed using `bzip2` will be stored in a file called [.filename]#book.pdf.bz2# in the [.filename]#handbook/# directory.

After choosing the format and compression mechanism, download the compressed files, uncompress them, and then copy the appropriate documents into place.

After choosing the format, download the files, uncompress them if necessary, then copy the appropriate documents into place.

For example, the split HTML version of the FAQ, compressed using man:bzip2[1],

For example, the HTML version of the FAQ can be found in [.filename]#doc/en/books/faq/faq_en.tar.gz# To download and uncompress that file, type:

can be found in [.filename]#doc/en_US.ISO8859-1/books/faq/book.html-split.tar.bz2# To download and uncompress that file, type:

[source,shell]

....

# fetch https://download.freebsd.org/doc/en_US.ISO8859-1/books/faq/book.html-split.tar.bz2

% fetch https://download.freebsd.org/doc/en/books/faq/faq_en.tar.gz

# tar xvf book.html-split.tar.bz2

% tar xvf faq_en.tar.gz

....

If the file is compressed, tar will automatically detect the appropriate format and decompress it correctly,

resulting in a collection of [.filename]#.html# files.

resulting in a collection of files.

The main one is called [.filename]#index.html#, which will contain the table of contents, introductory material, and links to the other parts of the document.

The main one is called [.filename]#index.html#, which will contain the whole document, starting with the table of contents linking to the other parts of the document.

[[mailing]]

=== Where do I find info on the FreeBSD mailing lists? What FreeBSD news groups are available?

Refer to the extref:{handbook}eresources/[Handbook entry on mailing-lists, eresources-mail] and the extref:{handbook}eresources/[Handbook entry on newsgroups, eresources-news].

[[irc]]

=== Are there FreeBSD IRC (Internet Relay Chat) channels?

▲ Show 20 Lines • Show All 2,817 Lines • Show Last 20 Lines