Package: mono-gac
Version: 6.8.0.105+dfsg-3.6
Severity: minor
Tags: patch
Dear Maintainer,
here are some notes and editorial fixes for the manual.
The patch is in the attachment.
-.-
The difference between the formatted outputs can be seen with:
nroff -man <file1> > <out1>
nroff -man <file2> > <out2>
diff -u <out1> <out2>
and for groff, using
"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -man -Z - "
instead of "nroff -man"
Add the option "-t", if the file contains a table.
Read the output of "diff -u" with "less -R" or similar.
-.-.
If "man" (man-db) is used to check the manual for warnings,
the following must be set:
The option "-warnings=w"
The environmental variable:
export MAN_KEEP_STDERR=yes (or any non-empty value)
or
(produce only warnings):
export MANROFFOPT="-ww -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-.
Output from "mandoc -T lint gacutil.1": (possibly shortened list)
mandoc: gacutil.1:1:2: ERROR: skipping end of block that is not open: ..
mandoc: gacutil.1:1:5: STYLE: whitespace at end of input line
mandoc: gacutil.1:11:2: WARNING: missing date, using "": TH
mandoc: gacutil.1:15:2: WARNING: skipping paragraph macro: PP after SH
mandoc: gacutil.1:16:40: STYLE: whitespace at end of input line
mandoc: gacutil.1:32:2: WARNING: skipping paragraph macro: PP empty
mandoc: gacutil.1:44:74: STYLE: whitespace at end of input line
mandoc: gacutil.1:47:71: STYLE: whitespace at end of input line
mandoc: gacutil.1:57:2: STYLE: fill mode already enabled, skipping: fi
-.-.
chk_man: Next line: execute doclifter -w -v gacutil.1
gacutil.1 uses man macros...
gacutil.1:1: error - uninterpreted '.\"' command
"gacutil.1": warning - portability warning: nonportable requests 'end, .\"'
seen.
"gacutil.1", line 120: there were 1 errors during translation
-.-.
Remove space characters at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
1:..\"
16:.B gacutil [-user] [command] [options]
44:The -root option is used to specify the "libdir" value of an installation
47:To access assemblies installed to a prefix other than the mono prefix,
-.-.
Mark a full stop (.) and the exclamation mark (!) with "\&",
if it does not mean an end of a sentence.
This is a preventive action,
the paragraph could be reshaped, e.g., after changes.
When typing, one does not always notice when the line wraps after the
period.
There are too many examples of input lines in manual pages,
that end with an abbreviation point.
This marking is robust, and independent of the position on the line.
It corresponds to "\ " in TeX, and to "@:" in Texinfo.
36: Installs an assembly into the global assembly cache. <assembly_path>
-.-.
Remove space in the first column, if not indented.
Use ".in +<number>n" and ".in" to end it; ".nf" and ".fi" to end
it, for an extra indention.
gacutil.1:36: Installs an assembly into the global assembly cache.
<assembly_path>
-.-.
Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, u[2010]) in the output.
16:.B gacutil [-user] [command] [options]
34:.I -i <assembly_path> [-check_refs] [-package NAME] [-root ROOTDIR] [-gacdir
GACDIR]
39:The -package option can be used to also create a directory in in
44:The -root option is used to specify the "libdir" value of an installation
46:Typical automake usage is "-root $(DESTDIR)$(prefix)/lib".
50:The -gacdir option is included for backward compatibility but is not
51:recommended for new code. Use the -root option instead.
53:The -check_refs option is used to ensure that the assembly being
59:.I "-l" [assembly_name] [-root ROOTDIR] [-gacdir GACDIR]
65:.I "-u" <assembly_display_name> [-package NAME] [-root ROOTDIR] [-gacdir
GACDIR]
84:.I "-us" <assembly_path> [-package NAME] [-root ROOTDIR] [-gacdir GACDIR]
88:the GAC with a matching name, it is removed. Unlike the -u option this
91: Example: -us myDll.dll
94:.I "-ul" <assembly_list_file> [-package NAME] [-root ROOTDIR] [-gacdir
GACDIR]
99:Example -ul assembly_list.txt
-.-.
Find a repeated word
! 39 --> in
-.-.
Wrong distance between sentences.
Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").
The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.
Remember coding: Only one command ("sentence") on each (logical) line.
E-mail: Easier to quote exactly the relevant lines.
Generally: Easier to edit the sentence.
Patches: Less unaffected text.
Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
22:Notice that they are not directly available to the compiler. The
36: Installs an assembly into the global assembly cache. <assembly_path>
51:recommended for new code. Use the -root option instead.
55:assemblies. Assemblies being installed to the GAC should not reference
61:Lists the contents of the global assembly cache. When the
69:fully qualified) to remove from the global assembly cache. If a
71:uninstalled. As opposed to the install option that takes a filename,
77:Notice that you can have spaces in the command line. There is no need
80:Performs a greedy removal. If you only specify one
86:<assembly path> is the path to an assembly. The full assembly name
88:the GAC with a matching name, it is removed. Unlike the -u option this
-.-.
The name of a man page is typeset in bold and the section in roman
(see man-pages(7)).
114:Mono runtime configuration file. See the mono-config(5) manual page
-.-.
Add a zero (0) in front of a decimal fraction that begins with a period
(.)
8:.if t .sp .5v
-.-.
Name of a manual is set in bold, the section in roman.
See man-pages(7).
119:.BR mcs(1), mono(1)
-.-.
SYNOPSIS: put a space on both sides of "[" and "]" to increase
readability (?)
gacutil.1:.B gacutil [-user] [command] [options]
-.-.
Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z
-rCHECKSTYLE=0":
troff: backtrace: file '<stdin>':1
troff:<stdin>:1: warning: macro '.' not defined
troff: backtrace: file '<stdin>':44
troff:<stdin>:44: warning: trailing space in the line
troff: backtrace: file '<stdin>':47
troff:<stdin>:47: warning: trailing space in the line
-- System Information:
Debian Release: trixie/sid
APT prefers testing-proposed-updates
APT policy: (500, 'testing-proposed-updates'), (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.7.12-amd64 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1),
LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages mono-gac depends on:
ii mono-4.0-gac 6.8.0.105+dfsg-3.6
ii mono-runtime-common 6.8.0.105+dfsg-3.6
mono-gac recommends no packages.
mono-gac suggests no packages.
-- no debconf information
--- gacutil.1 2024-05-20 02:55:02.033501074 +0000
+++ gacutil.1.new 2024-05-20 04:09:36.594636792 +0000
@@ -1,102 +1,146 @@
-..\"
+.\"
.\" gacutil manual page.
.\" (C) 2004 Novell, Inc.
.\" Author:
.\" Miguel de Icaza (mig...@gnu.org)
.\"
.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
+.if t .sp 0.5v
.if n .sp
..
.TH Mono "gacutil"
.SH NAME
gacutil \- Global Assembly Cache management utility.
.SH SYNOPSIS
-.PP
-.B gacutil [-user] [command] [options]
+.B gacutil
+.RI [ \-user "] [" command "] [" options ]
.SH DESCRIPTION
\fIgacutil\fP is a tool used by developers to install versioned
assemblies into the system Global Assembly Cache (GAC) to become part
of the assemblies that are available for all applications at runtime.
.PP
-Notice that they are not directly available to the compiler. The
-convention is that assemblies must also be placed in a separate
+Notice that they are not directly available to the compiler.
+The convention is that assemblies must also be placed in a separate
directory to be accessed by the compiler. This is done with the
--package directive to gacutil.
+\-package directive to gacutil.
.PP
The tool allows for installation, removal, and listing of the
contents of the assembly cache.
.PP
The GAC is relative to the Mono installation prefix:
mono_prefix/lib/mono.
-.PP
.SH COMMANDS
-.I -i <assembly_path> [-check_refs] [-package NAME] [-root ROOTDIR] [-gacdir
GACDIR]
+.\".I \-i <assembly_path> [\-check_refs] [\-package NAME] [\-root ROOTDIR]
[\-gacdir GACDIR]
+.B \-i
+.I <assembly_path>
+.RB [ \-check_refs "] [" \-package
+.IR NAME ]
+.RB [ \-root
+.IR ROOTDIR ]
+.RB [ \-gacdir
+.IR GACDIR ]
.Sp
- Installs an assembly into the global assembly cache. <assembly_path>
-is the name of the file that contains the assembly manifest
+Installs an assembly into the global assembly cache.
+<assembly_path> is the name of the file that contains the assembly manifest
.Sp
-The -package option can be used to also create a directory in in
+The \-package option can be used to also create a directory in
prefix/lib/mono with the name NAME, and a symlink is created from
NAME/assembly_name to the assembly on the GAC. This is used so
developers can reference a set of libraries at once.
.Sp
-The -root option is used to specify the "libdir" value of an installation
+The \-root option is used to specify the "libdir" value of an installation
prefix which differs from the prefix of the system GAC.
-Typical automake usage is "-root $(DESTDIR)$(prefix)/lib".
-To access assemblies installed to a prefix other than the mono prefix,
+Typical automake usage is "\-root $(DESTDIR)$(prefix)/lib".
+To access assemblies installed to a prefix other than the mono prefix,
it is necessary to set the MONO_GAC_PREFIX environment variable.
.Sp
-The -gacdir option is included for backward compatibility but is not
-recommended for new code. Use the -root option instead.
+The \-gacdir option is included for backward compatibility but is not
+recommended for new code.
+Use the \-root option instead.
.Sp
-The -check_refs option is used to ensure that the assembly being
+The \-check_refs option is used to ensure that the assembly being
installed into the GAC does not reference any non strong named
-assemblies. Assemblies being installed to the GAC should not reference
+assemblies.
+Assemblies being installed to the GAC should not reference
non strong named assemblies, however the is an optional check.
-.fi
.PP
-.I "-l" [assembly_name] [-root ROOTDIR] [-gacdir GACDIR]
+.\".I "\-l" [assembly_name] [\-root ROOTDIR] [\-gacdir GACDIR]
+.br
+.B \-l
+.RI [ assembly_name ]
+.RB [ \-root
+.IR ROOTDIR ]
+.RB [ \-gacdir
+.IR GACDIR ]
.Sp
-Lists the contents of the global assembly cache. When the
-<assembly_name> parameter is specified only matching assemblies are
+Lists the contents of the global assembly cache.
+When the <assembly_name> parameter is specified only matching assemblies are
listed.
.PP
-.I "-u" <assembly_display_name> [-package NAME] [-root ROOTDIR] [-gacdir
GACDIR]
+.\".I "\-u" <assembly_display_name> [\-package NAME] [\-root ROOTDIR]
[\-gacdir GACDIR]
+.B \-u
+.I <assembly_display_name>
+.RB [ \-package
+.IR NAME ]
+.RB [ \-root
+.IR ROOTDIR ]
+.RB [ \-gacdir
+.IR GACDIR ]
.Sp
Uninstalls an assembly from the global assembly cache.
<assembly_display_name> is the name of the assembly (partial or
-fully qualified) to remove from the global assembly cache. If a
-partial name is specified all matching assemblies will be
-uninstalled. As opposed to the install option that takes a filename,
+fully qualified) to remove from the global assembly cache.
+If a partial name is specified all matching assemblies will be
+uninstalled.
+As opposed to the install option that takes a filename,
this takes as an argument the assembly name, which looks like this:
.nf
MyLibrary.Something, version=1.0.0.0,
publicKeyToken=xxxx,culture=neutral
.fi
.Sp
-Notice that you can have spaces in the command line. There is no need
-to quote them.
+Notice that you can have spaces in the command line.
+There is no need to quote them.
.Sp
-Performs a greedy removal. If you only specify one
-component like, "MyLibrary.Something", it will remove all versions of
-the library.
+Performs a greedy removal.
+If you only specify one component like,
+"MyLibrary.Something",
+it will remove all versions of the library.
+.Sp
+.\".I "\-us" <assembly_path> [\-package NAME] [\-root ROOTDIR] [\-gacdir
GACDIR]
+.B \-us
+.I <assembly_path>
+.RB [ \-package
+.IR NAME ]
+.RB [ \-root
+.IR ROOTDIR ]
+.RB [ \-gacdir
+.IR GACDIR ]
.Sp
-.I "-us" <assembly_path> [-package NAME] [-root ROOTDIR] [-gacdir GACDIR]
Uninstalls an assembly using the specified assembly's full name.
-<assembly path> is the path to an assembly. The full assembly name
+<assembly path> is the path to an assembly.
+The full assembly name
is retrieved from the specified assembly if there is an assembly in
-the GAC with a matching name, it is removed. Unlike the -u option this
-option takes a file name, like this:
+the GAC with a matching name, it is removed.
+Unlike the \-u option this option takes a file name, like this:
.nf
- Example: -us myDll.dll
+ Example: \-us myDll.dll
.fi
.Sp
-.I "-ul" <assembly_list_file> [-package NAME] [-root ROOTDIR] [-gacdir GACDIR]
+.\".I "\-ul" <assembly_list_file> [\-package NAME] [\-root ROOTDIR] [\-gacdir
GACDIR]
+.B \-ul
+.I <assembly_list_file>
+.RB [ \-package
+.IR NAME ]
+.RB [ \-root
+.IR ROOTDIR ]
+.RB [ \-gacdir
+.IR GACDIR ]
+.Sp
Uninstalls one or more assemblies from the global assembly cache.
<assembly_list_file> is the path to a test file containing a list of
assembly names on separate lines.
.nf
-Example -ul assembly_list.txt
+Example \-ul assembly_list.txt
.fi
.nf
assembly_list.txt contents:
@@ -111,11 +155,10 @@ mint live.
.PP
/etc/mono/config, ~/.mono/config
.PP
-Mono runtime configuration file. See the mono-config(5) manual page
-for more information.
+Mono runtime configuration file. See the
+.BR mono-config (5)
+manual page for more information.
.SH WEB SITE
Visit: http://www.go-mono.com for details
.SH SEE ALSO
-.BR mcs(1), mono(1)
-
-
+.BR mcs "(1), " mono(1)
