git: cf00a3aa16 - main - handbook/wine: Style Fixes

Go to: [ bottom of page ] [ top of archives ] [ this month ]
From: Marc Fonvieille <blackend_at_FreeBSD.org>
Date: Mon, 22 Aug 2022 11:05:50 UTC
The branch main has been updated by blackend:

URL: https://cgit.FreeBSD.org/doc/commit/?id=cf00a3aa16d4db5bfbe688d6874513ef6dcbf43b

commit cf00a3aa16d4db5bfbe688d6874513ef6dcbf43b
Author:     Marc Fonvieille <blackend@FreeBSD.org>
AuthorDate: 2022-08-22 10:48:57 +0000
Commit:     Marc Fonvieille <blackend@FreeBSD.org>
CommitDate: 2022-08-22 10:48:57 +0000

    handbook/wine: Style Fixes
    
    - Add links to mentioned Handbook sections
    - tag some commands and usernames
    - Use of manual page links where needed
    - Use of package links where needed
    - s/su/sudo where needed
    - Fix some punctuations
    - Reword s/first stop/first step/
---
 .../content/en/books/handbook/wine/_index.adoc     | 27 +++++++++++-----------
 1 file changed, 14 insertions(+), 13 deletions(-)

diff --git a/documentation/content/en/books/handbook/wine/_index.adoc b/documentation/content/en/books/handbook/wine/_index.adoc
index d1e2084e82..a6036f89db 100644
--- a/documentation/content/en/books/handbook/wine/_index.adoc
+++ b/documentation/content/en/books/handbook/wine/_index.adoc
@@ -686,9 +686,9 @@ This is a good setup if there are relatively few applications to be shared betwe
 
 The steps to make install applications in this way are as follows:
 
-. First, set up a shared location on the system where the files will be stored, such as [.filename]#/mnt/windows-drive_d/#. Creating new directories is described in man page for the mkdir command.
-. Next, set permissions for this new directory to allow only desired users to access it. One approach to this is to create a new group such as "windows," add the desired users to that group (see the sub-section on groups in the Handbook's Users and Basic Account Management section), and set to the permissions on the directory to `770` (the section on Permissions in the FreeBSD Basics chapter of the Handbook illustrates this process).
-. Finally, add the location as a drive to the user's prefix using the winecfg as described in the above section on WINE Configuration in this chapter.
+. First, set up a shared location on the system where the files will be stored, such as [.filename]#/mnt/windows-drive_d/#. Creating new directories is described in the man:mkdir[1] manual page.
+. Next, set permissions for this new directory to allow only desired users to access it. One approach to this is to create a new group such as "windows," add the desired users to that group (see the sub-section on groups in the crossref:basics[users-groups,Users and Basic Account Management] section), and set to the permissions on the directory to `770` (the section on crossref:basics[permissions,Permissions] illustrates this process).
+. Finally, add the location as a drive to the user's prefix using the `winecfg` as described in the above section on WINE Configuration in this chapter.
 
 Once complete, applications can be installed to this location, and subsequently run using the assigned drive letter (or the standard UNIX(R)-style directory path).
 However, as noted above, only one user should be running these applications (which may be accessing files within their installation directory) at the same time.
@@ -699,11 +699,11 @@ Some applications may also exhibit unexpected behavior when run by a user who is
 
 If, on the other hand, there are many applications to be shared, or they require specific tuning in order to work correctly, a different approach may be required.
 In this method, a completely separate user is created specifically for the purposes of storing the WINE prefix and all its installed applications.
-Individual users are then granted permission to run programs as this user using the su command.
+Individual users are then granted permission to run programs as this user using the man:sudo[8] command.
 The result is that these users can launch a WINE application as they normally would, only it will act as though launched by the newly-created user, and therefore use the centrally-maintained prefix containing both settings and programs.
-To accomplish this, take the following steps.
+To accomplish this, take the following steps:
 
-Create a new user with the following command (as root), which will step through the required details:
+Create a new user with the following command (as `root`), which will step through the required details:
 
 [source,shell]
 ....
@@ -711,7 +711,8 @@ Create a new user with the following command (as root), which will step through
 ....
 
 Enter the username (e.g., _windows_) and Full name ("Microsoft Windows").
-Then accept the defaults for the remainder of the questions. Next, install the sudo utility using binary packages with the following:
+Then accept the defaults for the remainder of the questions.
+Next, install the `sudo` utility using binary packages with the following:
 
 [source,shell]
 ....
@@ -752,7 +753,7 @@ WINDOWS_USERS ALL = (windows) NOPASSWD: WINDOWS
 ....
 
 The result of these changes is the users named in the _User_Alias_ section are permitted to run the programs listed in the _Cmnd Alias_ section using the resources listed in the _Defaults_ section (the current display) as if they were the user listed in the final line of the file.
-In other words, users designates as _WINDOWS_USERS_ can run the wine and winecfg applications as user _windows_.
+In other words, users designates as _WINDOWS_USERS_ can run the WINE and `winecfg` applications as user _windows_.
 As a bonus, the configuration here means they will not be required to enter the password for the _windows_ user.
 
 Next provide access to the display back to the _windows_ user, as whom the WINE programs will be running:
@@ -793,12 +794,12 @@ However, multiple installs can be achieved using mechanisms like chroots/jails,
 ==== Can DOS Programs Be Run on WINE?
 
 They can, as "Console User Interface" applications as mentioned earlier in this section.
-However, there is an arguably better method for running DOS software: DOSBox.
-On the other hand, there's little reason not to at least try it.
+However, there is an arguably better method for running DOS software: package:emulators/dosbox[DOSBox].
+On the other hand, there is little reason not to at least try it.
 Simply create a new prefix, install the software, and if it does not work delete the prefix.
 
 [[should-the-wine-devel-packageport-be-installed-to-use-the-development-version-of-wine-instead-of-stable]]
-==== Should the "wine-devel" Package/Port be Installed to Use the Development Version of WINE Instead of Stable?
+==== Should the package:emulators/wine-devel[] Package/Port be Installed to Use the Development Version of WINE Instead of Stable?
 
 Yes, installing this version will install the "development" version of WINE.
 As with the 32- and 64-bit versions, they cannot be installed together with the stable versions unless additional measures are taken.
@@ -847,7 +848,7 @@ According to https://forums.freebsd.org/threads/make-wine-ui-fonts-look-good.682
 ==== Does Having Windows(R) Installed Elsewhere on a System Help WINE Operate?
 
 It may, depending on the application being run.
-As mentioned in the section describing winecfg, some built-in WINE DLLs and other libraries can be overridden by providing a path to an alternate version.
+As mentioned in the section describing `winecfg`, some built-in WINE DLLs and other libraries can be overridden by providing a path to an alternate version.
 Provided the Windows(R) partition or drive is mounted to the FreeBSD system and accessible to the user, configuring some of these overrides will use native Windows(R) libraries and may decrease the chance of unexpected behavior.
 
 [[application-specific]]
@@ -856,7 +857,7 @@ Provided the Windows(R) partition or drive is mounted to the FreeBSD system and
 [[where-is-the-best-place-to-see-if-application-x-works-on-wine]]
 ==== Where is the Best Place to see if Application X Works on WINE?
 
-The first stop in determining compatibility should be the https://appdb.winehq.org/[WINE AppDB].
+The first step in determining compatibility should be the https://appdb.winehq.org/[WINE AppDB].
 This is a compilation of reports of programs working (or not) on all supported platforms, although (as previously mentioned), solutions for one platform are often applicable to others.
 
 [[is-there-anything-that-will-help-games-run-better]]