From dcc97a186d55b3fb990ac3e54d6ffb402858ec18 Mon Sep 17 00:00:00 2001 From: Alexandre Julliard Date: Tue, 16 Jul 2013 20:48:05 +0200 Subject: [PATCH] Standardize the BUGS, AVAILABILITY and SEE ALSO sections across all man pages. --- loader/wine.man.in | 53 +++++++++---------------- programs/msiexec/msiexec.man.in | 18 ++++++++- programs/notepad/notepad.man.in | 20 +++++++++- programs/regedit/regedit.man.in | 34 +++++++++++----- programs/regsvr32/regsvr32.man.in | 18 ++++++++- programs/wineboot/wineboot.man.in | 18 ++++++++- programs/winecfg/winecfg.man.in | 18 ++++++++- programs/wineconsole/wineconsole.man.in | 18 ++++++++- programs/winedbg/winedbg.man.in | 26 +++++++----- programs/winefile/winefile.man.in | 18 ++++++++- programs/winemine/winemine.man.in | 18 ++++++++- programs/winepath/winepath.man.in | 18 ++++++++- server/wineserver.man.in | 8 +++- tools/widl/widl.man.in | 22 ++++++---- tools/winebuild/winebuild.man.in | 20 +++++----- tools/winedump/winedump.man.in | 22 +++++++--- tools/winegcc/winegcc.man.in | 26 +++++++++--- tools/winemaker.man.in | 33 ++++++++------- tools/wmc/wmc.man.in | 21 +++++++--- tools/wrc/wrc.man.in | 19 +++++++-- 20 files changed, 333 insertions(+), 115 deletions(-) diff --git a/loader/wine.man.in b/loader/wine.man.in index aac5e7501dc..16b4ae30d00 100644 --- a/loader/wine.man.in +++ b/loader/wine.man.in @@ -257,7 +257,7 @@ debugger .TP .I @dlldir@ Directory containing -.BR wine 's +.BR wine shared libraries .TP .I $WINEPREFIX/dosdevices @@ -287,43 +287,28 @@ license is in the file in the top-level directory of the source distribution. .SH BUGS .PP -A status report on many applications is available from -.IR http://appdb.winehq.org . +A status report on many applications is available from the +.UR http://appdb.winehq.org +.B Wine Application Database +.UE . Please add entries to this list for applications you currently run, if -there is no entry for this application. +necessary. .PP -Bug reports may be posted to Wine Bugzilla -.IR http://bugs.winehq.org . -If you want to post a bug report, please see -.IR http://wiki.winehq.org/Bugs . -.PP -Problems and suggestions with this manpage can also be reported on -.IR http://bugs.winehq.org . +Bugs can be reported on the +.UR http://bugs.winehq.org +.B Wine bug tracker +.UE . .SH AVAILABILITY The most recent public version of .B wine -can be downloaded from -.IR http://www.winehq.org/download . -.PP -The latest snapshot of the code may be obtained via GIT. For information -on how to do this, please see -.I -http://www.winehq.org/site/git -.PP -WineHQ, the -.B wine -development headquarters, is at -.IR http://www.winehq.org . -This website contains a great deal of information about -.BR wine . -.PP -For further information about -.B wine -development, you might want to subscribe to the -.B wine -mailing lists at -.IR http://www.winehq.org/forums . - +is available through WineHQ, the +.UR http://www.winehq.org/ +.B Wine development headquarters +.UE . .SH "SEE ALSO" .BR wineserver (1), -.BR winedbg (1) +.BR winedbg (1), +.br +.UR http://www.winehq.org/help +.B Wine documentation and support +.UE . diff --git a/programs/msiexec/msiexec.man.in b/programs/msiexec/msiexec.man.in index 780839f98ea..efaa08ea128 100644 --- a/programs/msiexec/msiexec.man.in +++ b/programs/msiexec/msiexec.man.in @@ -100,5 +100,21 @@ Unregister MSI service. .IP "\fx/?\fR" Same as /h. +.SH BUGS +Bugs can be reported on the +.UR http://bugs.winehq.org +.B Wine bug tracker +.UE . +.SH AVAILABILITY +.B msiexec +is part of the Wine distribution, which is available through WineHQ, +the +.UR http://www.winehq.org/ +.B Wine development headquarters +.UE . .SH "SEE ALSO" -.BR wine(1), +.BR wine (1), +.br +.UR http://www.winehq.org/help +.B Wine documentation and support +.UE . diff --git a/programs/notepad/notepad.man.in b/programs/notepad/notepad.man.in index 98affc4dcaf..50638a5b782 100644 --- a/programs/notepad/notepad.man.in +++ b/programs/notepad/notepad.man.in @@ -2,10 +2,26 @@ .SH NAME notepad \- Wine text editor .SH SYNOPSIS -.BR "notepad "\fI[text file]\fR " +.BR "notepad "\fI[text\ file]\fR " .SH DESCRIPTION .B notepad is the Wine text editor, designed to be compatible with its Microsoft Windows counterpart. It supports ANSI, UTF-8 and UTF-16 files, and can read (but not write) files with Unix line endings. +.SH BUGS +Bugs can be reported on the +.UR http://bugs.winehq.org +.B Wine bug tracker +.UE . +.SH AVAILABILITY +.B notepad +is part of the Wine distribution, which is available through WineHQ, +the +.UR http://www.winehq.org/ +.B Wine development headquarters +.UE . .SH "SEE ALSO" -.BR wine(1) +.BR wine (1), +.br +.UR http://www.winehq.org/help +.B Wine documentation and support +.UE . diff --git a/programs/regedit/regedit.man.in b/programs/regedit/regedit.man.in index b2f70666a91..8c77949d67d 100644 --- a/programs/regedit/regedit.man.in +++ b/programs/regedit/regedit.man.in @@ -2,7 +2,7 @@ .SH NAME regedit \- Wine registry editor .SH SYNOPSIS -.BR "regedit "\fI[text file]\fR " +.BR "regedit "\fI[text\ file]\fR " .SH DESCRIPTION .B regedit is the Wine registry editor, designed to be compatible with its Microsoft Windows counterpart. @@ -14,19 +14,35 @@ The switches are case\-insensitive and can be prefixed either by '\-' or '/'. \fB\-E\fR \fIfile\fR [\fIregpath\fR] Exports the content of the specified registry key to the specified \fIfile\fR. It exports the whole registry if no key is specified. -.IP "\-D " regpath +.IP \fB\-D\fR\ regpath Deletes the specified registry key. -.IP \-S +.IP \fB\-S\fR Run regedit silently (ignored, CLI mode is always silent). This exists for compatibility with Windows regedit. -.IP \-V +.IP \fB\-V\fR Run regedit in advanced mode (ignored). This exists for compatibility with Windows regedit. -.IP "\-L " location +.IP \fB\-L\fR\ location Specifies the location of the system.dat registry file (ignored). This exists for compatibility with Windows regedit. -.IP "\-R " location +.IP \fB\-R\fR\ location Specifies the location of the user.dat registry file (ignored). This exists for compatibility with Windows regedit. -.IP \-? +.IP \fB\-?\fR Prints a help message. Any other options are ignored. -.IP \-C \fIfile.reg\fR +.IP \fB\-C\fR\ \fIfile.reg\fR Create registry from \fIfile\fR (unimplemented). +.SH BUGS +Bugs can be reported on the +.UR http://bugs.winehq.org +.B Wine bug tracker +.UE . +.SH AVAILABILITY +.B regedit +is part of the Wine distribution, which is available through WineHQ, +the +.UR http://www.winehq.org/ +.B Wine development headquarters +.UE . .SH "SEE ALSO" -.BR wine(1) +.BR wine (1), +.br +.UR http://www.winehq.org/help +.B Wine documentation and support +.UE . diff --git a/programs/regsvr32/regsvr32.man.in b/programs/regsvr32/regsvr32.man.in index 33c9f42eee1..a543cc5a88b 100644 --- a/programs/regsvr32/regsvr32.man.in +++ b/programs/regsvr32/regsvr32.man.in @@ -16,5 +16,21 @@ Run regsvr32 silently (will not show any GUI dialogs). Call DllInstall passing it an optional [cmdline]. When used with /u calls DllUninstall. .IP "\fl/n\fR" Do not call DllRegisterServer; this option must be used with [/i]. +.SH BUGS +Bugs can be reported on the +.UR http://bugs.winehq.org +.B Wine bug tracker +.UE . +.SH AVAILABILITY +.B regsvr32 +is part of the Wine distribution, which is available through WineHQ, +the +.UR http://www.winehq.org/ +.B Wine development headquarters +.UE . .SH "SEE ALSO" -.BR wine(1) +.BR wine (1), +.br +.UR http://www.winehq.org/help +.B Wine documentation and support +.UE . diff --git a/programs/wineboot/wineboot.man.in b/programs/wineboot/wineboot.man.in index 820ded3a13a..0a3c3552ccf 100644 --- a/programs/wineboot/wineboot.man.in +++ b/programs/wineboot/wineboot.man.in @@ -27,5 +27,21 @@ Shutdown only, don't reboot. .IP \-u,\ \-\-update Update the WINEPREFIX. +.SH BUGS +Bugs can be reported on the +.UR http://bugs.winehq.org +.B Wine bug tracker +.UE . +.SH AVAILABILITY +.B wineboot +is part of the Wine distribution, which is available through WineHQ, +the +.UR http://www.winehq.org/ +.B Wine development headquarters +.UE . .SH "SEE ALSO" -.BR wine(1) +.BR wine (1), +.br +.UR http://www.winehq.org/help +.B Wine documentation and support +.UE . diff --git a/programs/winecfg/winecfg.man.in b/programs/winecfg/winecfg.man.in index 0c562385c48..4fa677e3e34 100644 --- a/programs/winecfg/winecfg.man.in +++ b/programs/winecfg/winecfg.man.in @@ -9,5 +9,21 @@ is the Wine configuration editor. It allows you to change several settings, such (native versus builtin), enable a virtual desktop, setup disk drives, and change the Wine audio driver, among others. Many of these settings can be made on a per application basis, for example, preferring native riched20.dll for wordpad.exe, but not for notepad.exe. +.SH BUGS +Bugs can be reported on the +.UR http://bugs.winehq.org +.B Wine bug tracker +.UE . +.SH AVAILABILITY +.B winecfg +is part of the Wine distribution, which is available through WineHQ, +the +.UR http://www.winehq.org/ +.B Wine development headquarters +.UE . .SH "SEE ALSO" -.BR wine(1) +.BR wine (1), +.br +.UR http://www.winehq.org/help +.B Wine documentation and support +.UE . diff --git a/programs/wineconsole/wineconsole.man.in b/programs/wineconsole/wineconsole.man.in index 8ae52fa82a4..1d240e5cbad 100644 --- a/programs/wineconsole/wineconsole.man.in +++ b/programs/wineconsole/wineconsole.man.in @@ -11,5 +11,21 @@ console either in the current terminal (\fIcurses\fR) or in a newly made window .IP \-\-backend=\fR{\fIuser\fR|\fIcurses\fR} If \fIuser\fR is chosen, a new window will be created for the console. The \fIcurses\fR option will make wineconsole try to setup the current terminal as a Wine console. +.SH BUGS +Bugs can be reported on the +.UR http://bugs.winehq.org +.B Wine bug tracker +.UE . +.SH AVAILABILITY +.B wineconsole +is part of the Wine distribution, which is available through WineHQ, +the +.UR http://www.winehq.org/ +.B Wine development headquarters +.UE . .SH "SEE ALSO" -.BR wine(1) +.BR wine (1), +.br +.UR http://www.winehq.org/help +.B Wine documentation and support +.UE . diff --git a/programs/winedbg/winedbg.man.in b/programs/winedbg/winedbg.man.in index a7690b5df50..758aa7d6a84 100644 --- a/programs/winedbg/winedbg.man.in +++ b/programs/winedbg/winedbg.man.in @@ -408,17 +408,25 @@ Since no user input is possible, no commands are available. When used in \fBgdb\fR proxy mode, \fBWINE_GDB\fR specifies the name (and the path) of the executable to be used for \fBgdb\fR. \fB"gdb"\fR is used by default. -.SH FILES -No specific files are used (yet). -.SH BUGS -A lot. .SH AUTHORS The first version was written by Eric Youngdale. .PP See Wine developers list for the rest of contributors. +.SH BUGS +Bugs can be reported on the +.UR http://bugs.winehq.org +.B Wine bug tracker +.UE . +.SH AVAILABILITY +.B winedbg +is part of the Wine distribution, which is available through WineHQ, +the +.UR http://www.winehq.org/ +.B Wine development headquarters +.UE . .SH "SEE ALSO" -.BR winedbg " README file" -.nf -The Winelib User Guide -.nf -The Wine Developers Guide +.BR wine (1), +.br +.UR http://www.winehq.org/help +.B Wine documentation and support +.UE . diff --git a/programs/winefile/winefile.man.in b/programs/winefile/winefile.man.in index e8785f815a5..afa47989ca3 100644 --- a/programs/winefile/winefile.man.in +++ b/programs/winefile/winefile.man.in @@ -13,5 +13,21 @@ You can pass winefile either a Unix or Win32 path, for example: .RB "Using a Win32 path: " "winefile C:\(rs\(rswindows\(rs\(rs\" +.SH BUGS +Bugs can be reported on the +.UR http://bugs.winehq.org +.B Wine bug tracker +.UE . +.SH AVAILABILITY +.B winefile +is part of the Wine distribution, which is available through WineHQ, +the +.UR http://www.winehq.org/ +.B Wine development headquarters +.UE . .SH "SEE ALSO" -.BR wine(1) +.BR wine (1), +.br +.UR http://www.winehq.org/help +.B Wine documentation and support +.UE . diff --git a/programs/winemine/winemine.man.in b/programs/winemine/winemine.man.in index 004a53dab85..27fe2102f19 100644 --- a/programs/winemine/winemine.man.in +++ b/programs/winemine/winemine.man.in @@ -7,5 +7,21 @@ winemine \- Wine Minesweeper game .B winemine is the Wine Minesweeper game. The object of the game is to try to find all the hidden mines by uncovering the tiles to see how many mines each tile is adjacent to, without uncovering a mine. +.SH BUGS +Bugs can be reported on the +.UR http://bugs.winehq.org +.B Wine bug tracker +.UE . +.SH AVAILABILITY +.B winemine +is part of the Wine distribution, which is available through WineHQ, +the +.UR http://www.winehq.org/ +.B Wine development headquarters +.UE . .SH "SEE ALSO" -.BR wine(1) +.BR wine (1), +.br +.UR http://www.winehq.org/help +.B Wine documentation and support +.UE . diff --git a/programs/winepath/winepath.man.in b/programs/winepath/winepath.man.in index c27b7ee6fca..aada7b78506 100644 --- a/programs/winepath/winepath.man.in +++ b/programs/winepath/winepath.man.in @@ -28,5 +28,21 @@ separate output with \\0 character, instead of a newline. shows winepath help message and exit. .IP \-v,\ \\-\-version shows version information and exit. +.SH BUGS +Bugs can be reported on the +.UR http://bugs.winehq.org +.B Wine bug tracker +.UE . +.SH AVAILABILITY +.B winepath +is part of the Wine distribution, which is available through WineHQ, +the +.UR http://www.winehq.org/ +.B Wine development headquarters +.UE . .SH "SEE ALSO" -.BR wine (1) +.BR wine (1), +.br +.UR http://www.winehq.org/help +.B Wine documentation and support +.UE . diff --git a/server/wineserver.man.in b/server/wineserver.man.in index 27756f4a5ed..dc8b6a9b70f 100644 --- a/server/wineserver.man.in +++ b/server/wineserver.man.in @@ -97,7 +97,7 @@ is Alexandre Julliard. Many other people have contributed new features and bug fixes. Please check the file Changelog in the Wine distribution for the complete details. .SH BUGS -If you find a bug, please submit a bug report on the +Bugs can be reported on the .UR http://bugs.winehq.org .B Wine bug tracker .UE . @@ -109,4 +109,8 @@ the .B Wine development headquarters .UE . .SH "SEE ALSO" -.BR wine (1). +.BR wine (1), +.br +.UR http://www.winehq.org/help +.B Wine documentation and support +.UE . diff --git a/tools/widl/widl.man.in b/tools/widl/widl.man.in index 0e4baa52c75..82396ad7e18 100644 --- a/tools/widl/widl.man.in +++ b/tools/widl/widl.man.in @@ -120,7 +120,7 @@ Ignored, present for midl compatibility. Generate empty stubs for call_as/local methods in an object interface and write them to \fIfile\fR. .PP -.SH Debug +.SH DEBUG Debug level \fIn\fR is a bitmask with the following meaning: * 0x01 Tell which resource is parsed (verbose mode) * 0x02 Dump internal structures @@ -129,16 +129,24 @@ Debug level \fIn\fR is a bitmask with the following meaning: * 0x10 Preprocessor lex messages * 0x20 Preprocessor yacc trace .SH BUGS -.B widl -is incomplete. Please file bug reports for this application at -.I http://bugs.winehq.org. +Bugs can be reported on the +.UR http://bugs.winehq.org +.B Wine bug tracker +.UE . .SH AUTHORS .B widl was originally written by Ove Kaaven. It has been improved by Rob Shearman, Dan Hipschman, and others. For a complete list, see the git commit logs. This man page was originally written by Hannu Valtonen and then updated by Dan Hipschman. +.SH AVAILABILITY +.B widl +is part of the Wine distribution, which is available through WineHQ, +the +.UR http://www.winehq.org/ +.B Wine development headquarters +.UE . .SH "SEE ALSO" -The Winelib User Guide -.nf -The Wine Developers Guide +.UR http://www.winehq.org/help +.B Wine documentation and support +.UE . diff --git a/tools/winebuild/winebuild.man.in b/tools/winebuild/winebuild.man.in index 3762b742ac2..b64bd56a206 100644 --- a/tools/winebuild/winebuild.man.in +++ b/tools/winebuild/winebuild.man.in @@ -484,20 +484,22 @@ for the complete details. It is not yet possible to use a PE-format dll in an import specification; only Wine dlls can be imported. .PP -If you find a bug, please submit a bug report at +Bugs can be reported on the .UR http://bugs.winehq.org -.B http://bugs.winehq.org. -.UE +.B Wine bug tracker +.UE . .SH AVAILABILITY .B winebuild -is part of the wine distribution, which is available through WineHQ, +is part of the Wine distribution, which is available through WineHQ, the -.B wine -development headquarters, at .UR http://www.winehq.org/ -.B http://www.winehq.org/. -.UE +.B Wine development headquarters +.UE . .SH "SEE ALSO" .BR wine (1), .BR winegcc (1), -.BR wrc (1). +.BR wrc (1), +.br +.UR http://www.winehq.org/help +.B Wine documentation and support +.UE . diff --git a/tools/winedump/winedump.man.in b/tools/winedump/winedump.man.in index d632ec58a29..bae18ccaf1c 100644 --- a/tools/winedump/winedump.man.in +++ b/tools/winedump/winedump.man.in @@ -213,13 +213,25 @@ source tree. .SH BUGS C++ name demangling is not fully in sync with the implementation in msvcrt. It might be useful to submit your C++ name to the testsuite for msvcrt. +.PP +Bugs can be reported on the +.UR http://bugs.winehq.org +.B Wine bug tracker +.UE . .SH AUTHORS Jon P. Griffiths .nf Michael Stefaniuc +.SH AVAILABILITY +.B winedump +is part of the Wine distribution, which is available through WineHQ, +the +.UR http://www.winehq.org/ +.B Wine development headquarters +.UE . .SH "SEE ALSO" -.BR winedump "'s README file" -.nf -The Winelib User Guide -.nf -The Wine Developers Guide +.BR wine (1) +.br +.UR http://www.winehq.org/help +.B Wine documentation and support +.UE . diff --git a/tools/winegcc/winegcc.man.in b/tools/winegcc/winegcc.man.in index 2d3567e006d..2701b9670e2 100644 --- a/tools/winegcc/winegcc.man.in +++ b/tools/winegcc/winegcc.man.in @@ -78,13 +78,27 @@ due to lack of support for these features in the ELF version of gcc. Static linking is not currently supported against Wine's DLL. As a result, the -static, --static, and -Wl,-static options will generate an error. +.PP +Bugs can be reported on the +.UR http://bugs.winehq.org +.B Wine bug tracker +.UE . .SH AUTHORS .B winegcc was written by Dimitrie O. Paun. +.SH AVAILABILITY +.B winegcc +is part of the Wine distribution, which is available through WineHQ, +the +.UR http://www.winehq.org/ +.B Wine development headquarters +.UE . .SH "SEE ALSO" -.BR gcc(1), -.BR winebuild(1), -.BR wrc(1), -.BR wine(1), -.BR "Winelib User Guide", -.BR "Wine Developers Guide". +.BR gcc (1), +.BR winebuild (1), +.BR wrc (1), +.BR wine (1), +.br +.UR http://www.winehq.org/help +.B Wine documentation and support +.UE . diff --git a/tools/winemaker.man.in b/tools/winemaker.man.in index f0a17cf80a2..e41a843444e 100644 --- a/tools/winemaker.man.in +++ b/tools/winemaker.man.in @@ -220,7 +220,6 @@ $ make .PP .SH TODO / BUGS -.PP In some cases you will have to edit the Makefile or source files by yourself. .PP Assuming that the windows executable/library is available, we could @@ -235,20 +234,26 @@ executable: it must either be in the current directory or in the .PP Winemaker does not support message files and the message compiler yet. .PP - -.SH SEE ALSO -.PP -The Winelib User Guide: -.PP -http://www.winehq.org/docs/winelib-guide/index -.PP -.BR wine (1) -.PP - +Bugs can be reported on the +.UR http://bugs.winehq.org +.B Wine bug tracker +.UE . .SH AUTHORS François Gouget for CodeWeavers -.PP +.br Dimitrie O. Paun -.PP +.br André Hentschel -.PP +.SH AVAILABILITY +.B winemaker +is part of the Wine distribution, which is available through WineHQ, +the +.UR http://www.winehq.org/ +.B Wine development headquarters +.UE . +.SH SEE ALSO +.BR wine (1), +.br +.UR http://www.winehq.org/help +.B Wine documentation and support +.UE . diff --git a/tools/wmc/wmc.man.in b/tools/wmc/wmc.man.in index a135145de2b..e5eb3172320 100644 --- a/tools/wmc/wmc.man.in +++ b/tools/wmc/wmc.man.in @@ -102,13 +102,22 @@ recognize byte\-order\-marks (BOM) and decide what to do. Decimal output is completely lacking. Don't know whether it should be implemented because it is a, well, non-informative format change. It is recognized on the commandline for some form of compatibility. +.PP +Bugs can be reported on the +.UR http://bugs.winehq.org +.B Wine bug tracker +.UE . .SH AVAILABILITY .B wmc -is part of the wine distribution, which is available through -WineHQ, the -.B wine -development headquarters, at -.I http://www.winehq.org/. +is part of the Wine distribution, which is available through WineHQ, +the +.UR http://www.winehq.org/ +.B Wine development headquarters +.UE . .SH "SEE ALSO" .BR wine (1), -.BR wrc (1) +.BR wrc (1), +.br +.UR http://www.winehq.org/help +.B Wine documentation and support +.UE . diff --git a/tools/wrc/wrc.man.in b/tools/wrc/wrc.man.in index ed1fd820e5f..0eeed9cc956 100644 --- a/tools/wrc/wrc.man.in +++ b/tools/wrc/wrc.man.in @@ -209,10 +209,21 @@ There is no support for: Fonts are parsed and generated, but there is no support for the generation of the FONTDIR yet. The user must supply the FONTDIR resource in the source to match the FONT resources. +.PP +Bugs can be reported on the +.UR http://bugs.winehq.org +.B Wine bug tracker +.UE . .SH AVAILABILITY .B wrc -is part of the Wine distribution, which is available through -WineHQ, the Wine development headquarters, at -.I http://www.winehq.org/. +is part of the Wine distribution, which is available through WineHQ, +the +.UR http://www.winehq.org/ +.B Wine development headquarters +.UE . .SH "SEE ALSO" -.BR wine (1) +.BR wine (1), +.br +.UR http://www.winehq.org/help +.B Wine documentation and support +.UE .