summaryrefslogtreecommitdiffstats
path: root/man-common
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 14:30:35 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 14:30:35 +0000
commit378c18e5f024ac5a8aef4cb40d7c9aa9633d144c (patch)
tree44dfb6ca500d32cabd450649b322a42e70a30683 /man-common
parentInitial commit. (diff)
downloadutil-linux-upstream.tar.xz
util-linux-upstream.zip
Adding upstream version 2.38.1.upstream/2.38.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'man-common')
-rw-r--r--man-common/Makemodule.am10
-rw-r--r--man-common/bugreports.adoc3
-rw-r--r--man-common/colors.adoc17
-rw-r--r--man-common/footer-config.adoc4
-rw-r--r--man-common/footer-lib.adoc4
-rw-r--r--man-common/footer.adoc4
-rw-r--r--man-common/help-version.adoc5
-rw-r--r--man-common/in-bytes.adoc7
-rw-r--r--man-common/manpage-stub.adoc66
-rw-r--r--man-common/translation.adoc12
10 files changed, 132 insertions, 0 deletions
diff --git a/man-common/Makemodule.am b/man-common/Makemodule.am
new file mode 100644
index 0000000..c999ee7
--- /dev/null
+++ b/man-common/Makemodule.am
@@ -0,0 +1,10 @@
+ADOCFILES_COMMON += \
+ man-common/bugreports.adoc \
+ man-common/colors.adoc \
+ man-common/footer.adoc \
+ man-common/footer-config.adoc \
+ man-common/footer-lib.adoc \
+ man-common/help-version.adoc \
+ man-common/in-bytes.adoc \
+ man-common/manpage-stub.adoc \
+ man-common/translation.adoc
diff --git a/man-common/bugreports.adoc b/man-common/bugreports.adoc
new file mode 100644
index 0000000..0801bd2
--- /dev/null
+++ b/man-common/bugreports.adoc
@@ -0,0 +1,3 @@
+== REPORTING BUGS
+
+For bug reports, use the issue tracker at https://github.com/util-linux/util-linux/issues.
diff --git a/man-common/colors.adoc b/man-common/colors.adoc
new file mode 100644
index 0000000..a693f87
--- /dev/null
+++ b/man-common/colors.adoc
@@ -0,0 +1,17 @@
+== COLORS
+
+The output colorization is implemented by *terminal-colors.d*(5) functionality.
+Implicit coloring can be disabled by an empty file
+____
+_/etc/terminal-colors.d/{command}.disable_
+____
+for the *{command}* command or for all tools by
+____
+_/etc/terminal-colors.d/disable_
+____
+The user-specific _$XDG_CONFIG_HOME/terminal-colors.d_
+or _$HOME/.config/terminal-colors.d_ overrides the global setting.
+
+Note that the output colorization may be enabled by default, and in this case
+_terminal-colors.d_ directories do not have to exist yet.
+
diff --git a/man-common/footer-config.adoc b/man-common/footer-config.adoc
new file mode 100644
index 0000000..b016c53
--- /dev/null
+++ b/man-common/footer-config.adoc
@@ -0,0 +1,4 @@
+== AVAILABILITY
+
+// TRANSLATORS: Keep *{configfile}* untranslated, it will be replaced with the name of the configuration file.
+*{configfile}* is part of the util-linux package which can be downloaded from https://www.kernel.org/pub/linux/utils/util-linux/[Linux Kernel Archive].
diff --git a/man-common/footer-lib.adoc b/man-common/footer-lib.adoc
new file mode 100644
index 0000000..451ca07
--- /dev/null
+++ b/man-common/footer-lib.adoc
@@ -0,0 +1,4 @@
+== AVAILABILITY
+
+// TRANSLATORS: Keep *{lib}* and {firstversion} untranslated, will be replaced with the library name and the version of util-linux where the library appeared for the first time.
+The *{lib}* library is part of the util-linux package since version {firstversion}. It can be downloaded from https://www.kernel.org/pub/linux/utils/util-linux/[Linux Kernel Archive].
diff --git a/man-common/footer.adoc b/man-common/footer.adoc
new file mode 100644
index 0000000..c448f8c
--- /dev/null
+++ b/man-common/footer.adoc
@@ -0,0 +1,4 @@
+== AVAILABILITY
+
+// TRANSLATORS: Keep *{command}* untranslated, it will be replaced with the command name.
+The *{command}* command is part of the util-linux package which can be downloaded from https://www.kernel.org/pub/linux/utils/util-linux/[Linux Kernel Archive].
diff --git a/man-common/help-version.adoc b/man-common/help-version.adoc
new file mode 100644
index 0000000..7a3c04f
--- /dev/null
+++ b/man-common/help-version.adoc
@@ -0,0 +1,5 @@
+*-h*, *--help*::
+Display help text and exit.
+
+*-V*, *--version*::
+Print version and exit.
diff --git a/man-common/in-bytes.adoc b/man-common/in-bytes.adoc
new file mode 100644
index 0000000..3a69c6e
--- /dev/null
+++ b/man-common/in-bytes.adoc
@@ -0,0 +1,7 @@
+Print the sizes in bytes rather than in a human-readable format.
++
+By default, the unit, sizes are expressed in, is byte, and unit prefixes are in
+power of 2^10 (1024). Abbreviations of symbols are exhibited truncated in order
+to reach a better readability, by exhibiting alone the first letter of them;
+examples: "1 KiB" and "1 MiB" are respectively exhibited as "1 K" and "1 M",
+then omitting on purpose the mention "iB", which is part of these abbreviations.
diff --git a/man-common/manpage-stub.adoc b/man-common/manpage-stub.adoc
new file mode 100644
index 0000000..833f785
--- /dev/null
+++ b/man-common/manpage-stub.adoc
@@ -0,0 +1,66 @@
+//po4a: entry man manual
+////
+Please don't treat this file as a real man page! We provide it only to show how
+things should be formatted. Besides this example file, see the existing .adoc
+files for many more formatting options.
+The first line above is a hint for po4a that the :man manual: entry needs
+to be translated.
+As you can see here, use //// to write comment blocks. For a single comment
+line, just use //.
+Please don't wrap lines within a paragraph. Our translation tool po4a behaves
+a bit unpredictable in such cases.
+We also urgently recommend to test the creation of the *roff file to see possible
+issues.
+////
+= foobar(1)
+:doctype: manpage
+:man manual: User commands
+:man source: util-linux {release-version}
+:page-layout: base
+:command: foobar
+
+== NAME
+
+foobar - do nothing
+
+== SYNOPSIS
+
+*foobar* _options_ _file_
+
+== DESCRIPTION
+
+Describe *foobar* briefly.
+
+== OPTIONS
+
+//Format options bold and values italic:
+*-o*, *--option* _value_::
+This option has a value.
++
+For empty lines within a description (to keep the indentation) you can use the "plus" character at the beginning of an otherwise empty line.
+
+//Last but not least, don't forget the common options:
+include::man-common/help-version.adoc[]
+
+== NOTES
+
+Put your notes here which don't match any other paragraph.
+
+== AUTHORS
+
+// Format mail addresses as follows:
+mailto:john.doe@example.com[John Doe]
+// If you need more than one address, use a comma-separated list or leave empty lines between the entries.
+
+== SEE ALSO
+
+*foo*(1),
+*bar*(1)
+
+include::man-common/bugreports.adoc[]
+
+include::man-common/footer.adoc[]
+
+ifdef::translation[]
+include::man-common/translation.adoc[]
+endif::[]
diff --git a/man-common/translation.adoc b/man-common/translation.adoc
new file mode 100644
index 0000000..8164f58
--- /dev/null
+++ b/man-common/translation.adoc
@@ -0,0 +1,12 @@
+== TRANSLATION
+
+For the authors of this translation, see the header of the corresponding
+*.po file at GNU TP:
+http://translationproject.org/domain/util-linux-man.html
+
+////
+TRANSLATORS: Please replace %1 with the address of the mailing list of your
+translation team.
+////
+Report man page translation bugs to:
+<%1>