Just Solve the File Format Problem - User contributions [en]

DAFT

2020-11-04T17:33:02Z

Artoria2e5:

{{FormatInfo
|formattype=physical
|subcat=Bar codes
|image=Daft.png
|caption=DAFTFDATATFDTFAD or pbþoþpboboþpoþbp
}}
'''DAFT''' is a term used for a "generic" system of transcribing "four-state" bar codes such as those used in various postal systems (e.g., [[Intelligent Mail barcode]], [[Australia Post standard customer barcode]], and [[PostBar]]) without having to know the specific symbology which translates the raw codes into particular numbers or symbols. It is named after the four letters used to represent the different bar states:

* D: Descender
* A: Ascender
* F: Full-Height
* T: Tracker (short bar)

Various software to read or generate bar codes uses this system, allowing codes to be specified or transcribed independently of their specific coding system, which might not be known.

A more graphical alternative is using pbþo instead of DAFT, but nobody can really type the thorn letter.

== Developer libraries and modules ==
* [https://github.com/bwipp/postscriptbarcode/wiki/DAFT postscriptbarcode: DAFT]

== Utilities ==
* [http://barcode.tec-it.com/barcode-generator.aspx?group=BCGroup_Postal&barcode=DAFT Barcode generator: DAFT]

== Links ==
* [http://www.creo.com/files/Product%20Documentation/Technical%20Notes/DARWIN%20Software%20Version%203.0%20USPS%20intelligent%20mail%20barcodes.pdf Intelligent Mail Barcodes in Darwin v3.0]

DAFT

2020-11-04T17:27:59Z

Artoria2e5:

{{FormatInfo
|formattype=physical
|subcat=Bar codes
|image=Daft.png
}}
'''DAFT''' is a term used for a "generic" system of transcribing "four-state" bar codes such as those used in various postal systems (e.g., [[Intelligent Mail barcode]], [[Australia Post standard customer barcode]], and [[PostBar]]) without having to know the specific symbology which translates the raw codes into particular numbers or symbols. It is named after the four letters used to represent the different bar states:

* D: Descender
* A: Ascender
* F: Full-Height
* T: Tracker (short bar)

Various software to read or generate bar codes uses this system, allowing codes to be specified or transcribed independently of their specific coding system, which might not be known.

A more human-readable alternative is using pbþo instead, but nobody can really type the thorn letter.

== Developer libraries and modules ==
* [https://github.com/bwipp/postscriptbarcode/wiki/DAFT postscriptbarcode: DAFT]

== Utilities ==
* [http://barcode.tec-it.com/barcode-generator.aspx?group=BCGroup_Postal&barcode=DAFT Barcode generator: DAFT]

== Links ==
* [http://www.creo.com/files/Product%20Documentation/Technical%20Notes/DARWIN%20Software%20Version%203.0%20USPS%20intelligent%20mail%20barcodes.pdf Intelligent Mail Barcodes in Darwin v3.0]

Japanese postal barcode

2020-11-04T17:16:20Z

Artoria2e5: /* Utilities */

{{FormatInfo
|formattype=physical
|subcat=Bar codes
|image=Japanese-postal-barcode.png
}}
The '''Japanese postal barcode''' is used in mail sorting for Japan. It encodes an 7-digit postal/zip code plus an optional alphanumeric address code. The symbology allows the coding of the digits 0-9, letters A-Z, and hyphen. The address code is simply the alphanumeric portion of a street address.

This sort of bar code system is regarded as "four-state" because there are four types of bars, classified by presence of ascenders and/or descenders. This sort of system is transcribable using [[DAFT]] notation. These sorts of bar codes are used by a number of countries in their postal systems, though the specific symbologies by which they encode characters can vary.

== The scheme ==
The start and end bars are FD and DF. Each character takes up three bars. Padding with TDA is performed to fill 20 chars.

== Utilities ==
* [http://barcode.tec-it.com/barcode-generator.aspx?group=BCGroup_Postal&barcode=JapanesePostal Barcode generator: Japanese postal bar code]
** [http://www.tec-it.com/download/PDF/Barcode_Reference_EN.pdf TEC-IT Reference] (Covers general information and address storage)
* [https://github.com/pinekta/php-jp-customer-barcode-generator Barcode generator], in PHP

== Links ==
* [https://barcodeguide.seagullscientific.com/Content/Symbologies/Japanese_Postal.htm Barcode structure], seagull scientific (covers alphanumeric, but does not have exact values for each three-unit)
* [https://web.archive.org/web/20071009170325fw_/http://www.dlsoft.com/dlHelps/helps/barcodes/japanpost.htm Japan Post bar code info]
* [http://www.objectiflune.com/forum2/ubbthreads.php?ubb=showflat&Number=24459 Discussion of the encoding of these bar codes]
* [http://homepage1.nifty.com/tabotabo/pzips/jp_post_zip.htm Japanese postal/zip code directory]

Japanese postal barcode

2020-11-04T17:15:04Z

Artoria2e5: /* The scheme */

{{FormatInfo
|formattype=physical
|subcat=Bar codes
|image=Japanese-postal-barcode.png
}}
The '''Japanese postal barcode''' is used in mail sorting for Japan. It encodes an 7-digit postal/zip code plus an optional alphanumeric address code. The symbology allows the coding of the digits 0-9, letters A-Z, and hyphen. The address code is simply the alphanumeric portion of a street address.

This sort of bar code system is regarded as "four-state" because there are four types of bars, classified by presence of ascenders and/or descenders. This sort of system is transcribable using [[DAFT]] notation. These sorts of bar codes are used by a number of countries in their postal systems, though the specific symbologies by which they encode characters can vary.

== The scheme ==
The start and end bars are FD and DF. Each character takes up three bars. Padding with TDA is performed to fill 20 chars.

== Utilities ==
* [http://barcode.tec-it.com/barcode-generator.aspx?group=BCGroup_Postal&barcode=JapanesePostal Barcode generator: Japanese postal bar code]
** [http://www.tec-it.com/download/PDF/Barcode_Reference_EN.pdf TEC-IT Reference] (Covers general information and address storage)

== Links ==
* [https://barcodeguide.seagullscientific.com/Content/Symbologies/Japanese_Postal.htm Barcode structure], seagull scientific (covers alphanumeric, but does not have exact values for each three-unit)
* [https://web.archive.org/web/20071009170325fw_/http://www.dlsoft.com/dlHelps/helps/barcodes/japanpost.htm Japan Post bar code info]
* [http://www.objectiflune.com/forum2/ubbthreads.php?ubb=showflat&Number=24459 Discussion of the encoding of these bar codes]
* [http://homepage1.nifty.com/tabotabo/pzips/jp_post_zip.htm Japanese postal/zip code directory]

Japanese postal barcode

2020-11-04T17:11:11Z

Artoria2e5:

{{FormatInfo
|formattype=physical
|subcat=Bar codes
|image=Japanese-postal-barcode.png
}}
The '''Japanese postal barcode''' is used in mail sorting for Japan. It encodes an 7-digit postal/zip code plus an optional alphanumeric address code. The symbology allows the coding of the digits 0-9, letters A-Z, and hyphen. The address code is simply the alphanumeric portion of a street address.

This sort of bar code system is regarded as "four-state" because there are four types of bars, classified by presence of ascenders and/or descenders. This sort of system is transcribable using [[DAFT]] notation. These sorts of bar codes are used by a number of countries in their postal systems, though the specific symbologies by which they encode characters can vary.

== The scheme ==
There are no full descriptions of how the barcode works in English. The relevant article on Japanese Wikipedia, [[Wikipedia:ja:郵便追跡サービス]], has no information either. Someone with insider or reverse engineering knowledge is needed to figure this out.

The start and end bars are FD and DF. Each character takes up three bars. Padding with TDA is performed to fill 20 chars.

== Utilities ==
* [http://barcode.tec-it.com/barcode-generator.aspx?group=BCGroup_Postal&barcode=JapanesePostal Barcode generator: Japanese postal bar code]
** [http://www.tec-it.com/download/PDF/Barcode_Reference_EN.pdf TEC-IT Reference] (Covers general information and address storage)

== Links ==
* [https://barcodeguide.seagullscientific.com/Content/Symbologies/Japanese_Postal.htm Barcode structure], seagull scientific (covers alphanumeric, but does not have exact values for each three-unit)
* [https://web.archive.org/web/20071009170325fw_/http://www.dlsoft.com/dlHelps/helps/barcodes/japanpost.htm Japan Post bar code info]
* [http://www.objectiflune.com/forum2/ubbthreads.php?ubb=showflat&Number=24459 Discussion of the encoding of these bar codes]
* [http://homepage1.nifty.com/tabotabo/pzips/jp_post_zip.htm Japanese postal/zip code directory]

Japanese postal barcode

2020-11-04T17:08:58Z

Artoria2e5: /* Utilities */

{{FormatInfo
|formattype=physical
|subcat=Bar codes
|image=Japanese-postal-barcode.png
}}
The '''Japanese postal barcode''' is used in mail sorting for Japan. It encodes an 7-digit postal/zip code plus an optional alphanumeric address code. The symbology allows the coding of the digits 0-9, letters A-Z, and hyphen. An alternative mode allows for pre-encoding SHIFT-JIS (CP936) as alphanumerics.

This sort of bar code system is regarded as "four-state" because there are four types of bars, classified by presence of ascenders and/or descenders. This sort of system is transcribable using [[DAFT]] notation. These sorts of bar codes are used by a number of countries in their postal systems, though the specific symbologies by which they encode characters can vary.

== The scheme ==
There are no full descriptions of how the barcode works in English. The relevant article on Japanese Wikipedia, [[Wikipedia:ja:郵便追跡サービス]], has no information either. Someone with insider or reverse engineering knowledge is needed to figure this out.

The start and end bars are FD and DF. Each character takes up three bars. Padding with TDA is performed to fill 20 chars.

== Utilities ==
* [http://barcode.tec-it.com/barcode-generator.aspx?group=BCGroup_Postal&barcode=JapanesePostal Barcode generator: Japanese postal bar code]
** [http://www.tec-it.com/download/PDF/Barcode_Reference_EN.pdf TEC-IT Reference] (Covers general information and CP932 transcription)

== Links ==
* [https://barcodeguide.seagullscientific.com/Content/Symbologies/Japanese_Postal.htm Barcode structure], seagull scientific (covers alphanumeric, but does not have exact values for each three-unit)
* [https://web.archive.org/web/20071009170325fw_/http://www.dlsoft.com/dlHelps/helps/barcodes/japanpost.htm Japan Post bar code info]
* [http://www.objectiflune.com/forum2/ubbthreads.php?ubb=showflat&Number=24459 Discussion of the encoding of these bar codes]
* [http://homepage1.nifty.com/tabotabo/pzips/jp_post_zip.htm Japanese postal/zip code directory]

Japanese postal barcode

2020-11-04T17:08:32Z

Artoria2e5: /* Links */

{{FormatInfo
|formattype=physical
|subcat=Bar codes
|image=Japanese-postal-barcode.png
}}
The '''Japanese postal barcode''' is used in mail sorting for Japan. It encodes an 7-digit postal/zip code plus an optional alphanumeric address code. The symbology allows the coding of the digits 0-9, letters A-Z, and hyphen. An alternative mode allows for pre-encoding SHIFT-JIS (CP936) as alphanumerics.

This sort of bar code system is regarded as "four-state" because there are four types of bars, classified by presence of ascenders and/or descenders. This sort of system is transcribable using [[DAFT]] notation. These sorts of bar codes are used by a number of countries in their postal systems, though the specific symbologies by which they encode characters can vary.

== The scheme ==
There are no full descriptions of how the barcode works in English. The relevant article on Japanese Wikipedia, [[Wikipedia:ja:郵便追跡サービス]], has no information either. Someone with insider or reverse engineering knowledge is needed to figure this out.

The start and end bars are FD and DF. Each character takes up three bars. Padding with TDA is performed to fill 20 chars.

== Utilities ==
* [http://barcode.tec-it.com/barcode-generator.aspx?group=BCGroup_Postal&barcode=JapanesePostal Barcode generator: Japanese postal bar code]
** [http://www.tec-it.com/download/PDF/Barcode_Reference_EN.pdf TEC-IT Reference]

== Links ==
* [https://barcodeguide.seagullscientific.com/Content/Symbologies/Japanese_Postal.htm Barcode structure], seagull scientific (covers alphanumeric, but does not have exact values for each three-unit)
* [https://web.archive.org/web/20071009170325fw_/http://www.dlsoft.com/dlHelps/helps/barcodes/japanpost.htm Japan Post bar code info]
* [http://www.objectiflune.com/forum2/ubbthreads.php?ubb=showflat&Number=24459 Discussion of the encoding of these bar codes]
* [http://homepage1.nifty.com/tabotabo/pzips/jp_post_zip.htm Japanese postal/zip code directory]

Japanese postal barcode

2020-11-04T17:07:11Z

Artoria2e5: /* The scheme */

{{FormatInfo
|formattype=physical
|subcat=Bar codes
|image=Japanese-postal-barcode.png
}}
The '''Japanese postal barcode''' is used in mail sorting for Japan. It encodes an 7-digit postal/zip code plus an optional alphanumeric address code. The symbology allows the coding of the digits 0-9, letters A-Z, and hyphen. An alternative mode allows for pre-encoding SHIFT-JIS (CP936) as alphanumerics.

This sort of bar code system is regarded as "four-state" because there are four types of bars, classified by presence of ascenders and/or descenders. This sort of system is transcribable using [[DAFT]] notation. These sorts of bar codes are used by a number of countries in their postal systems, though the specific symbologies by which they encode characters can vary.

== The scheme ==
There are no full descriptions of how the barcode works in English. The relevant article on Japanese Wikipedia, [[Wikipedia:ja:郵便追跡サービス]], has no information either. Someone with insider or reverse engineering knowledge is needed to figure this out.

The start and end bars are FD and DF. Each character takes up three bars. Padding with TDA is performed to fill 20 chars.

== Utilities ==
* [http://barcode.tec-it.com/barcode-generator.aspx?group=BCGroup_Postal&barcode=JapanesePostal Barcode generator: Japanese postal bar code]
** [http://www.tec-it.com/download/PDF/Barcode_Reference_EN.pdf TEC-IT Reference]

== Links ==
* [https://web.archive.org/web/20071009170325fw_/http://www.dlsoft.com/dlHelps/helps/barcodes/japanpost.htm Japan Post bar code info]
* [http://www.objectiflune.com/forum2/ubbthreads.php?ubb=showflat&Number=24459 Discussion of the encoding of these bar codes]
* [http://homepage1.nifty.com/tabotabo/pzips/jp_post_zip.htm Japanese postal/zip code directory]

Japanese postal barcode

2020-11-04T17:00:58Z

Artoria2e5: /* The scheme */

{{FormatInfo
|formattype=physical
|subcat=Bar codes
|image=Japanese-postal-barcode.png
}}
The '''Japanese postal barcode''' is used in mail sorting for Japan. It encodes an 7-digit postal/zip code plus an optional alphanumeric address code. The symbology allows the coding of the digits 0-9, letters A-Z, and hyphen. An alternative mode allows for pre-encoding SHIFT-JIS (CP936) as alphanumerics.

This sort of bar code system is regarded as "four-state" because there are four types of bars, classified by presence of ascenders and/or descenders. This sort of system is transcribable using [[DAFT]] notation. These sorts of bar codes are used by a number of countries in their postal systems, though the specific symbologies by which they encode characters can vary.

== The scheme ==
There are no descriptions of how the barcode works in English. The relevant article on Japanese Wikipedia, [[Wikipedia:ja:郵便追跡サービス]], has no information either. Someone with insider or reverse engineering knowledge is needed to figure this out.

The code usually starts with FDFF and ends with FFDF, but this does not seem to hold for longer values. "TDA" stands for a padding control character.

== Utilities ==
* [http://barcode.tec-it.com/barcode-generator.aspx?group=BCGroup_Postal&barcode=JapanesePostal Barcode generator: Japanese postal bar code]
** [http://www.tec-it.com/download/PDF/Barcode_Reference_EN.pdf TEC-IT Reference]

== Links ==
* [https://web.archive.org/web/20071009170325fw_/http://www.dlsoft.com/dlHelps/helps/barcodes/japanpost.htm Japan Post bar code info]
* [http://www.objectiflune.com/forum2/ubbthreads.php?ubb=showflat&Number=24459 Discussion of the encoding of these bar codes]
* [http://homepage1.nifty.com/tabotabo/pzips/jp_post_zip.htm Japanese postal/zip code directory]

Japanese postal barcode

2020-11-04T17:00:20Z

Artoria2e5:

{{FormatInfo
|formattype=physical
|subcat=Bar codes
|image=Japanese-postal-barcode.png
}}
The '''Japanese postal barcode''' is used in mail sorting for Japan. It encodes an 7-digit postal/zip code plus an optional alphanumeric address code. The symbology allows the coding of the digits 0-9, letters A-Z, and hyphen. An alternative mode allows for pre-encoding SHIFT-JIS (CP936) as alphanumerics.

This sort of bar code system is regarded as "four-state" because there are four types of bars, classified by presence of ascenders and/or descenders. This sort of system is transcribable using [[DAFT]] notation. These sorts of bar codes are used by a number of countries in their postal systems, though the specific symbologies by which they encode characters can vary.

== The scheme ==
There are no descriptions of how the barcode works in English. The relevant article on Japanese Wikipedia, [[Wikipedia:ja:郵便追跡サービス]], has no information either.

The code usually starts with FDFF and ends with FFDF, but this does not seem to hold for longer values. "TDA" stands for a padding control character.

== Utilities ==
* [http://barcode.tec-it.com/barcode-generator.aspx?group=BCGroup_Postal&barcode=JapanesePostal Barcode generator: Japanese postal bar code]
** [http://www.tec-it.com/download/PDF/Barcode_Reference_EN.pdf TEC-IT Reference]

== Links ==
* [https://web.archive.org/web/20071009170325fw_/http://www.dlsoft.com/dlHelps/helps/barcodes/japanpost.htm Japan Post bar code info]
* [http://www.objectiflune.com/forum2/ubbthreads.php?ubb=showflat&Number=24459 Discussion of the encoding of these bar codes]
* [http://homepage1.nifty.com/tabotabo/pzips/jp_post_zip.htm Japanese postal/zip code directory]

Japanese postal barcode

2020-11-04T16:58:05Z

Artoria2e5: /* The scheme */

{{FormatInfo
|formattype=physical
|subcat=Bar codes
|image=Japanese-postal-barcode.png
}}
The '''Japanese postal barcode''' is used in mail sorting for Japan. It encodes an 7-digit postal/zip code plus an optional alphanumeric address code. The symbology allows the coding of the digits 0-9, letters A-Z, and hyphen. An alternative mode allows for pre-encoding SHIFT-JIS (CP936) as alphanumerics.

This sort of bar code system is regarded as "four-state" because there are four types of bars, classified by presence of ascenders and/or descenders. This sort of system is transcribable using [[DAFT]] notation. These sorts of bar codes are used by a number of countries in their postal systems, though the specific symbologies by which they encode characters can vary.

== The scheme ==
There are no descriptions of how the barcode works in English. The relevant article on Japanese Wikipedia, [[Wikipedia:ja:郵便追跡サービス]], has no information either.

The code always starts with FDFF and ends with FFDF. "TDA" stands for a padding control character.

== Utilities ==
* [http://barcode.tec-it.com/barcode-generator.aspx?group=BCGroup_Postal&barcode=JapanesePostal Barcode generator: Japanese postal bar code]
** [http://www.tec-it.com/download/PDF/Barcode_Reference_EN.pdf TEC-IT Reference]

== Links ==
* [https://web.archive.org/web/20071009170325fw_/http://www.dlsoft.com/dlHelps/helps/barcodes/japanpost.htm Japan Post bar code info]
* [http://www.objectiflune.com/forum2/ubbthreads.php?ubb=showflat&Number=24459 Discussion of the encoding of these bar codes]
* [http://homepage1.nifty.com/tabotabo/pzips/jp_post_zip.htm Japanese postal/zip code directory]

Japanese postal barcode

2020-11-04T16:54:20Z

Artoria2e5:

{{FormatInfo
|formattype=physical
|subcat=Bar codes
|image=Japanese-postal-barcode.png
}}
The '''Japanese postal barcode''' is used in mail sorting for Japan. It encodes an 7-digit postal/zip code plus an optional alphanumeric address code. The symbology allows the coding of the digits 0-9, letters A-Z, and hyphen. An alternative mode allows for pre-encoding SHIFT-JIS (CP936) as alphanumerics.

This sort of bar code system is regarded as "four-state" because there are four types of bars, classified by presence of ascenders and/or descenders. This sort of system is transcribable using [[DAFT]] notation. These sorts of bar codes are used by a number of countries in their postal systems, though the specific symbologies by which they encode characters can vary.

== The scheme ==
There are no descriptions of how the barcode works in English. The relevant article on Japanese Wikipedia, [[Wikipedia:ja:郵便追跡サービス]], has no information either.

Each character appears to occupy three bar units. "TDA" stands for a padding control character.

== Utilities ==
* [http://barcode.tec-it.com/barcode-generator.aspx?group=BCGroup_Postal&barcode=JapanesePostal Barcode generator: Japanese postal bar code]
** [http://www.tec-it.com/download/PDF/Barcode_Reference_EN.pdf TEC-IT Reference]

== Links ==
* [https://web.archive.org/web/20071009170325fw_/http://www.dlsoft.com/dlHelps/helps/barcodes/japanpost.htm Japan Post bar code info]
* [http://www.objectiflune.com/forum2/ubbthreads.php?ubb=showflat&Number=24459 Discussion of the encoding of these bar codes]
* [http://homepage1.nifty.com/tabotabo/pzips/jp_post_zip.htm Japanese postal/zip code directory]

Japanese postal barcode

2020-11-04T16:54:00Z

Artoria2e5:

{{FormatInfo
|formattype=physical
|subcat=Bar codes
|image=Japanese-postal-barcode.png
}}
The '''Japanese postal barcode''' is used in mail sorting for Japan. It encodes an 7-digit postal/zip code plus an optional alphanumeric address code. The symbology allows the coding of the digits 0-9, letters A-Z, and hyphen. An alternative mode allows for encoding SHIFT-JIS (CP936) as alphanumerics.

This sort of bar code system is regarded as "four-state" because there are four types of bars, classified by presence of ascenders and/or descenders. This sort of system is transcribable using [[DAFT]] notation. These sorts of bar codes are used by a number of countries in their postal systems, though the specific symbologies by which they encode characters can vary.

== Example codes ==
There are no descriptions of how the barcode works in English. The relevant article on Japanese Wikipedia, [[Wikipedia:ja:郵便追跡サービス]], has no information either.

Each character appears to occupy three bar units. "TDA" stands for a padding control character.

== Utilities ==
* [http://barcode.tec-it.com/barcode-generator.aspx?group=BCGroup_Postal&barcode=JapanesePostal Barcode generator: Japanese postal bar code]
** [http://www.tec-it.com/download/PDF/Barcode_Reference_EN.pdf TEC-IT Reference]

== Links ==
* [https://web.archive.org/web/20071009170325fw_/http://www.dlsoft.com/dlHelps/helps/barcodes/japanpost.htm Japan Post bar code info]
* [http://www.objectiflune.com/forum2/ubbthreads.php?ubb=showflat&Number=24459 Discussion of the encoding of these bar codes]
* [http://homepage1.nifty.com/tabotabo/pzips/jp_post_zip.htm Japanese postal/zip code directory]

Japanese postal barcode

2020-11-04T16:42:40Z

Artoria2e5:

Japanese postal barcode

2020-11-04T16:41:42Z

Artoria2e5: rescue dead link

Man page

2019-05-07T22:17:46Z

Artoria2e5: /* Writing a man page */

{{DISPLAYTITLE:man page}}
{{FormatInfo
|name=man page
|formattype=electronic
|subcat=Help files
|extensions={{ext|man}}, {{ext|1}}, {{ext|2}}, {{ext|3}}, {{ext|5}}, {{ext|7}}, {{ext|8}}, others
}}
'''Man page''' format is a text format for help files. It is widely used on Unix and related computer systems. It is based on [[troff]] format.

== How to display ==
Man pages can be displayed by a standard utility named '''man'''. They are usually first installed in a central location.

The '''man''' utility can display files directly, without needing them to be installed, but the way to do that depends on the implementation. To display a file named, say, xyzformat.5, at least one of the following commands is likely to work:

$ man xyzformat.5
$ man ./xyzformat.5
$ man -l xyzformat.5
$ nroff -man xyzformat.5
$ groff -man -Tutf8 xyzformat.5

If all else fails, read the manual:

$ man man

== Specifications ==
Typical man pages are written with the <tt>man</tt> or <tt>mdoc</tt> formats, occasionally with a bit of pure troff sprinkled in.
* <tt>man</tt>: https://www.mankier.com/7/man, or run <code>man 7 man</code>
** This page also lists a few troff directives sometimes seen in man pages. You will want to be able to process ''these'' too.'
** See also [https://man.openbsd.org/roff.7 roff(7)] for what BSDs consider necessary.
* <tt>mdoc</tt>: https://mandoc.bsd.lv/man/mdoc.7.html, or run <code>man 7 mandoc_mdoc</code>
** This is the semantic, "modern" way of writing manpages, and there are macros for the program name, the synopsis, ... everything.

== Writing a man page ==
Normally specific software is used to create a man page, however, one can do that via a regular text editor.

{| class='wikitable'
! code
! meaning
|-
| .TH
| First command (see below)
|-
| .SH
| Section header
|-
| .SS
| Subheading
|-
| .P
| Paragraph
|-
| .HP
| Paragraph with heading indent
|-
| .RS
| Start nested indentation
|-
| .RE
| End nested indentation
|-
| .I
| Italics
|-
| .B
| Bold
|-
| .\"
| Comment
|}

The first command (non-comment block) is often (but not necessarily) .TH, it's format consists of the following:

{| class='wikitable'
! block name
! meaning
! example
|-
| name
| Name of the command that is being documented
| command
|-
| section
| Manual section (depending on what the command is, if it is software, then 1)
| 1
|-
| centre-footer
| Usually a date of editing of the manual page
| "2015 April 23"
|-
| left-footer
| Text that goes in the bottom left
|
|-
| centre-header
| Text that goes in the top centre
|
|}

:Todo: There seems to be .IX block that often duplicates what other blocks do. What is it?
::OpenBSD roff(7) says it's a pod2man thing for table of contents.

== Software ==
* [http://primates.ximian.com/~flucifredi/man/ man]
* [http://man-db.nongnu.org/ man-db]
* [http://www.gnu.org/software/groff/ GNU troff (groff)]
* [http://mdocml.bsd.lv/ mandoc]

== Links ==
* [[Wikipedia:Man page|Wikipedia: Man page]]
* [https://github.com/rprieto/tldr tldr: Simplified and community-driven man pages]

[[Category:File formats with too many extensions]]

Man page

2019-05-07T22:17:01Z

Artoria2e5: /* Writing a man page */

{{DISPLAYTITLE:man page}}
{{FormatInfo
|name=man page
|formattype=electronic
|subcat=Help files
|extensions={{ext|man}}, {{ext|1}}, {{ext|2}}, {{ext|3}}, {{ext|5}}, {{ext|7}}, {{ext|8}}, others
}}
'''Man page''' format is a text format for help files. It is widely used on Unix and related computer systems. It is based on [[troff]] format.

== How to display ==
Man pages can be displayed by a standard utility named '''man'''. They are usually first installed in a central location.

The '''man''' utility can display files directly, without needing them to be installed, but the way to do that depends on the implementation. To display a file named, say, xyzformat.5, at least one of the following commands is likely to work:

$ man xyzformat.5
$ man ./xyzformat.5
$ man -l xyzformat.5
$ nroff -man xyzformat.5
$ groff -man -Tutf8 xyzformat.5

If all else fails, read the manual:

$ man man

== Specifications ==
Typical man pages are written with the <tt>man</tt> or <tt>mdoc</tt> formats, occasionally with a bit of pure troff sprinkled in.
* <tt>man</tt>: https://www.mankier.com/7/man, or run <code>man 7 man</code>
** This page also lists a few troff directives sometimes seen in man pages. You will want to be able to process ''these'' too.'
** See also [https://man.openbsd.org/roff.7 roff(7)] for what BSDs consider necessary.
* <tt>mdoc</tt>: https://mandoc.bsd.lv/man/mdoc.7.html, or run <code>man 7 mandoc_mdoc</code>
** This is the semantic, "modern" way of writing manpages, and there are macros for the program name, the synopsis, ... everything.

== Writing a man page ==
Normally specific software is used to create a man page, however, one can do that via a regular text editor.

{| class='wikitable'
! code
! meaning
|-
| .TH
| First command (see below)
|-
| .SH
| Section header
|-
| .SS
| Subheading
|-
| .P
| Paragraph
|-
| .HP
| Paragraph with heading indent
|-
| .RS
| Start nested indentation
|-
| .RE
| End nested indentation
|-
| .I
| Italics
|-
| .B
| Bold
|-
| .\"
| Comment
|}

The first command (non-comment block) is often (but not necessarily) .TH, it's format consists of the following:

{| class='wikitable'
! block name
! meaning
! example
|-
| name
| Name of the command that is being documented
| command
|-
| section
| Manual section (depending on what the command is, if it is software, then 1)
| 1
|-
| centre-footer
| Usually a date of editing of the manual page
| "2015 April 23"
|-
| left-footer
| Text that goes in the bottom left
|
|-
| centre-header
| Text that goes in the top centre
|
|}

:Todo: There seems to be .IX block that often duplicates what other blocks do. What is it?
::OpenBSD roff(7) says it's a pdf2man thing for table of contents.

== Software ==
* [http://primates.ximian.com/~flucifredi/man/ man]
* [http://man-db.nongnu.org/ man-db]
* [http://www.gnu.org/software/groff/ GNU troff (groff)]
* [http://mdocml.bsd.lv/ mandoc]

== Links ==
* [[Wikipedia:Man page|Wikipedia: Man page]]
* [https://github.com/rprieto/tldr tldr: Simplified and community-driven man pages]

[[Category:File formats with too many extensions]]

Man page

2019-05-07T22:10:08Z

Artoria2e5: /* Specifications */

{{DISPLAYTITLE:man page}}
{{FormatInfo
|name=man page
|formattype=electronic
|subcat=Help files
|extensions={{ext|man}}, {{ext|1}}, {{ext|2}}, {{ext|3}}, {{ext|5}}, {{ext|7}}, {{ext|8}}, others
}}
'''Man page''' format is a text format for help files. It is widely used on Unix and related computer systems. It is based on [[troff]] format.

== How to display ==
Man pages can be displayed by a standard utility named '''man'''. They are usually first installed in a central location.

The '''man''' utility can display files directly, without needing them to be installed, but the way to do that depends on the implementation. To display a file named, say, xyzformat.5, at least one of the following commands is likely to work:

$ man xyzformat.5
$ man ./xyzformat.5
$ man -l xyzformat.5
$ nroff -man xyzformat.5
$ groff -man -Tutf8 xyzformat.5

If all else fails, read the manual:

$ man man

== Specifications ==
Typical man pages are written with the <tt>man</tt> or <tt>mdoc</tt> formats, occasionally with a bit of pure troff sprinkled in.
* <tt>man</tt>: https://www.mankier.com/7/man, or run <code>man 7 man</code>
** This page also lists a few troff directives sometimes seen in man pages. You will want to be able to process ''these'' too.'
** See also [https://man.openbsd.org/roff.7 roff(7)] for what BSDs consider necessary.
* <tt>mdoc</tt>: https://mandoc.bsd.lv/man/mdoc.7.html, or run <code>man 7 mandoc_mdoc</code>
** This is the semantic, "modern" way of writing manpages, and there are macros for the program name, the synopsis, ... everything.

== Writing a man page ==
Normally specific software is used to create a man page, however, one can do that via a regular text editor.

{| class='wikitable'
! code
! meaning
|-
| .TH
| First command (see below)
|-
| .SH
| Section header
|-
| .SS
| Subheading
|-
| .P
| Paragraph
|-
| .HP
| Paragraph with heading indent
|-
| .RS
| Start nested indentation
|-
| .RE
| End nested indentation
|-
| .I
| Italics
|-
| .B
| Bold
|-
| .\"
| Comment
|}

The first command (non-comment block) is often (but not necessarily) .TH, it's format consists of the following:

{| class='wikitable'
! block name
! meaning
! example
|-
| name
| Name of the command that is being documented
| command
|-
| section
| Manual section (depending on what the command is, if it is software, then 1)
| 1
|-
| centre-footer
| Usually a date of editing of the manual page
| "2015 April 23"
|-
| left-footer
| Text that goes in the bottom left
|
|-
| centre-header
| Text that goes in the top centre
|
|}

:Todo: There seems to be .IX block that often duplicates what other blocks do. What is it?

== Software ==
* [http://primates.ximian.com/~flucifredi/man/ man]
* [http://man-db.nongnu.org/ man-db]
* [http://www.gnu.org/software/groff/ GNU troff (groff)]
* [http://mdocml.bsd.lv/ mandoc]

== Links ==
* [[Wikipedia:Man page|Wikipedia: Man page]]
* [https://github.com/rprieto/tldr tldr: Simplified and community-driven man pages]

[[Category:File formats with too many extensions]]

Man page

2019-05-07T21:48:05Z

Artoria2e5: /* Specifications */

{{DISPLAYTITLE:man page}}
{{FormatInfo
|name=man page
|formattype=electronic
|subcat=Help files
|extensions={{ext|man}}, {{ext|1}}, {{ext|2}}, {{ext|3}}, {{ext|5}}, {{ext|7}}, {{ext|8}}, others
}}
'''Man page''' format is a text format for help files. It is widely used on Unix and related computer systems. It is based on [[troff]] format.

== How to display ==
Man pages can be displayed by a standard utility named '''man'''. They are usually first installed in a central location.

The '''man''' utility can display files directly, without needing them to be installed, but the way to do that depends on the implementation. To display a file named, say, xyzformat.5, at least one of the following commands is likely to work:

$ man xyzformat.5
$ man ./xyzformat.5
$ man -l xyzformat.5
$ nroff -man xyzformat.5
$ groff -man -Tutf8 xyzformat.5

If all else fails, read the manual:

$ man man

== Specifications ==
Typical man pages are written with the <tt>man</tt> or <tt>mdoc</tt> formats, occasionally with a bit of pure troff sprinkled in.
* <tt>man</tt>: https://www.mankier.com/7/man, or run <code>man 7 man</code>
** This page also lists a few troff directives sometimes seen in man pages. You will want to be able to process ''these'' too.
* <tt>mdoc</tt>: https://mandoc.bsd.lv/man/mdoc.7.html, or run <code>man 7 mandoc_mdoc</code>
** This is the semantic, "modern" way of writing manpages, and there are macros for the program name, the synopsis, ... everything.

== Writing a man page ==
Normally specific software is used to create a man page, however, one can do that via a regular text editor.

{| class='wikitable'
! code
! meaning
|-
| .TH
| First command (see below)
|-
| .SH
| Section header
|-
| .SS
| Subheading
|-
| .P
| Paragraph
|-
| .HP
| Paragraph with heading indent
|-
| .RS
| Start nested indentation
|-
| .RE
| End nested indentation
|-
| .I
| Italics
|-
| .B
| Bold
|-
| .\"
| Comment
|}

The first command (non-comment block) is often (but not necessarily) .TH, it's format consists of the following:

{| class='wikitable'
! block name
! meaning
! example
|-
| name
| Name of the command that is being documented
| command
|-
| section
| Manual section (depending on what the command is, if it is software, then 1)
| 1
|-
| centre-footer
| Usually a date of editing of the manual page
| "2015 April 23"
|-
| left-footer
| Text that goes in the bottom left
|
|-
| centre-header
| Text that goes in the top centre
|
|}

:Todo: There seems to be .IX block that often duplicates what other blocks do. What is it?

== Software ==
* [http://primates.ximian.com/~flucifredi/man/ man]
* [http://man-db.nongnu.org/ man-db]
* [http://www.gnu.org/software/groff/ GNU troff (groff)]
* [http://mdocml.bsd.lv/ mandoc]

== Links ==
* [[Wikipedia:Man page|Wikipedia: Man page]]
* [https://github.com/rprieto/tldr tldr: Simplified and community-driven man pages]

[[Category:File formats with too many extensions]]

Man page

2019-05-07T21:43:06Z

Artoria2e5:

{{DISPLAYTITLE:man page}}
{{FormatInfo
|name=man page
|formattype=electronic
|subcat=Help files
|extensions={{ext|man}}, {{ext|1}}, {{ext|2}}, {{ext|3}}, {{ext|5}}, {{ext|7}}, {{ext|8}}, others
}}
'''Man page''' format is a text format for help files. It is widely used on Unix and related computer systems. It is based on [[troff]] format.

== How to display ==
Man pages can be displayed by a standard utility named '''man'''. They are usually first installed in a central location.

The '''man''' utility can display files directly, without needing them to be installed, but the way to do that depends on the implementation. To display a file named, say, xyzformat.5, at least one of the following commands is likely to work:

$ man xyzformat.5
$ man ./xyzformat.5
$ man -l xyzformat.5
$ nroff -man xyzformat.5
$ groff -man -Tutf8 xyzformat.5

If all else fails, read the manual:

$ man man

== Specifications ==
Typical man pages are written with the <tt>man</tt> or <tt>mdoc</tt> formats, occasionally with a bit of pure troff sprinkled in.
* <tt>man</tt>: https://www.mankier.com/7/man, or run <code>man 7 man</code>
** This page also lists a few troff directives sometimes seen in man pages.
* <tt>mdoc</tt>: https://mandoc.bsd.lv/man/mdoc.7.html, or run <code>man 7 mandoc_mdoc</code>
** This is the semantic, "modern" way of writing manpages, and there are macros for the program name, the synopsis, ... everything.

== Writing a man page ==
Normally specific software is used to create a man page, however, one can do that via a regular text editor.

{| class='wikitable'
! code
! meaning
|-
| .TH
| First command (see below)
|-
| .SH
| Section header
|-
| .SS
| Subheading
|-
| .P
| Paragraph
|-
| .HP
| Paragraph with heading indent
|-
| .RS
| Start nested indentation
|-
| .RE
| End nested indentation
|-
| .I
| Italics
|-
| .B
| Bold
|-
| .\"
| Comment
|}

The first command (non-comment block) is often (but not necessarily) .TH, it's format consists of the following:

{| class='wikitable'
! block name
! meaning
! example
|-
| name
| Name of the command that is being documented
| command
|-
| section
| Manual section (depending on what the command is, if it is software, then 1)
| 1
|-
| centre-footer
| Usually a date of editing of the manual page
| "2015 April 23"
|-
| left-footer
| Text that goes in the bottom left
|
|-
| centre-header
| Text that goes in the top centre
|
|}

:Todo: There seems to be .IX block that often duplicates what other blocks do. What is it?

== Software ==
* [http://primates.ximian.com/~flucifredi/man/ man]
* [http://man-db.nongnu.org/ man-db]
* [http://www.gnu.org/software/groff/ GNU troff (groff)]
* [http://mdocml.bsd.lv/ mandoc]

== Links ==
* [[Wikipedia:Man page|Wikipedia: Man page]]
* [https://github.com/rprieto/tldr tldr: Simplified and community-driven man pages]

[[Category:File formats with too many extensions]]