From nobody Sun Aug 21 13:59:21 2022 X-Original-To: dev-commits-doc-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4M9cYP4dqVz4ZrNR for ; Sun, 21 Aug 2022 13:59:21 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4M9cYP45kcz4Jnw; Sun, 21 Aug 2022 13:59:21 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1661090361; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=6HY5bfOf3oWZLuzqXblGPPDcpexI6JUMq9+NAIklloM=; b=T1ay2/zta3psDSrwtr6QPr+LUyDTsKdxVRPk+hIcLg3IE6+baCYufzjLJ8NlkhLh06IXsl shmHEHeB+4tTOuyFlEaMHWICZZiZe5uNcZ+Duv2IktlIaqTtpLME+AB9JxeBdQPNbYjDZV YtgAdM7R5UH02oadBCh0OFw6JQJoJQZM0ueyfbwi1tCLvJ5h0pm5yLvTGGFTXCGRB58Yhy Zt7seUT5WdiLIyewS3w+F9JcBwuACU279PQG/qxQVqq9RjIgkGvEHHnT7ScfV75IaN9Ed8 +kxAyRDuyhgCs+pMrLuJDA+Z/6I8f0kPbqzd8JdjOPgrT51jugR1Uj0oZOwyUQ== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4M9cYP32W9z1CPg; Sun, 21 Aug 2022 13:59:21 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 27LDxLE3015457; Sun, 21 Aug 2022 13:59:21 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 27LDxLPG015456; Sun, 21 Aug 2022 13:59:21 GMT (envelope-from git) Date: Sun, 21 Aug 2022 13:59:21 GMT Message-Id: <202208211359.27LDxLPG015456@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Marc Fonvieille Subject: git: c770609b20 - main - handbook/wine: Some style fixes List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: blackend X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: c770609b200f43ff056354040d43f3b6e936694f Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1661090361; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=6HY5bfOf3oWZLuzqXblGPPDcpexI6JUMq9+NAIklloM=; b=BVuV95fyPL7j2A1s6gngUQIcS1p/HJQTyFuaUffRfbCq0gJvYXLdOp9/apiJLheKTUTwJD yZf5NuFUF28MIaHcn/uOusXx1avfzW4aeA65nqsd6oT4Y02QtVV0zEdI+Ipwb5Dr/RFUe1 gbrki5BUauxw0I0BKolpqnMd3HpVGwmQ1SCSKbv3Txcs8t9ALzo1sHeyoPNdvplYxwQQEE PUDWl3r+JUE4Yw3/GWaySmLKJc9sSmFhWWeFuMEeagNuTRHJr/JO33Z0mjm2zM7gA0YHZ3 ePwuobh5ydyIzGMRU1gDJw6mRSkmf0mYvZWMKY/S85aA0wOsQ5o6D41hKZsRqg== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1661090361; a=rsa-sha256; cv=none; b=jJEdOePo9PbsWpgtbyJXAF/uBCm4oTlcrWb9cifi/m9p1/XMc1zI7rqLoSmlrdQFQsVkI2 nucXvpE3GHSuj9b0VtxTFwTJFkcJqc7hUsRLMvQ2ozWY4KzlSOSvcpPyuB2cYSRqHGGX/r 6Gx709IU71VAegup3fITi8X1zyvY4u/lDpJDKe9h9QeplW6wuKCg2/CPkh9D4giQvI7o+Y GSBJi1/Zbh3eGAsSrhm1KCLqkVLOfcsJs81MTLcT/u5jkGBcL2tv5QeHBSX5PZcNaqEket rjM0fY8yQxwx3Z5wqxzCLhPTS9JFLcLmQVVlPP0XsghV0+E0pxHSsYXCbkS+aQ== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by blackend: URL: https://cgit.FreeBSD.org/doc/commit/?id=c770609b200f43ff056354040d43f3b6e936694f commit c770609b200f43ff056354040d43f3b6e936694f Author: Marc Fonvieille AuthorDate: 2022-08-21 13:49:43 +0000 Commit: Marc Fonvieille CommitDate: 2022-08-21 13:57:22 +0000 handbook/wine: Some style fixes - Avoid to start a wentence with a lower case; - Remove a contraction; - Add a missing colon; - Try to tag `winetrick` this helps the read (Note: We also should tag application names as before, i.e., with *Bold*). --- .../content/en/books/handbook/wine/_index.adoc | 36 +++++++++++----------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/documentation/content/en/books/handbook/wine/_index.adoc b/documentation/content/en/books/handbook/wine/_index.adoc index 7f68f76da7..d1e2084e82 100644 --- a/documentation/content/en/books/handbook/wine/_index.adoc +++ b/documentation/content/en/books/handbook/wine/_index.adoc @@ -354,7 +354,7 @@ Creating a prefix from the terminal requires the following command: % WINEPREFIX="/home/username/.wine-new" winecfg .... -This will run the winecfg program, which can be used to configure wine prefixes (more on this in a later section). +This will run the `winecfg` program, which can be used to configure wine prefixes (more on this in a later section). But by providing a directory path value for the `WINEPREFIX` environment variable, a new prefix is created at that location if one does not already exist. Supplying the same variable to the wine program will similarly cause the selected program to be run with the specified prefix: @@ -367,9 +367,9 @@ Supplying the same variable to the wine program will similarly cause the selecte [[configuring-wine-prefixes-with-winecfg]] === Configuring WINE Prefixes with winecfg -As described above WINE includes a tool called winecfg to configure prefixes from within a GUI. +As described above WINE includes a tool called `winecfg` to configure prefixes from within a GUI. It contains a variety of functions, which are detailed in the sections below. -When winecfg is run from within a prefix, or provided the location of a prefix within the `WINEPREFIX` variable, it enables the configuration of the selected prefix as described in the below sections. +When `winecfg` is run from within a prefix, or provided the location of a prefix within the `WINEPREFIX` variable, it enables the configuration of the selected prefix as described in the below sections. Selections made on the _Applications_ tab will affect the scope of changes made in the _Libraries_ and _Graphics_ tabs, which will be limited to the application selected. See the section on https://wiki.winehq.org/Wine_User%27s_Guide#Using_Winecfg[Using Winecfg] in the WINE Wiki for more details. @@ -398,7 +398,7 @@ WINE provides a set of open source library files as part of its distribution tha However, as noted earlier in this chapter, the WINE project is always trying to keep pace with new updates to these libraries. As a result, the versions that ship with WINE may be missing functionality that the latest Windows(R) programs are expecting. -However, winecfg makes it possible specify overrides for the built-in libraries, particularly there is a version of Windows(R) available on the same machine as the host FreeBSD installation. For each library to be overridden, do the following: +However, `winecfg` makes it possible specify overrides for the built-in libraries, particularly there is a version of Windows(R) available on the same machine as the host FreeBSD installation. For each library to be overridden, do the following: . Open the _New override for library_ drop-down and select the library to be replaced. . Click the _Add_ button. @@ -414,7 +414,7 @@ Be sure to select a file that is truly the corresponding version of the built-in image::wine-config-3.png[] -The _Graphics_ tab provides some options to make the windows of programs run via WINE operate smoothly with FreeBSD +The _Graphics_ tab provides some options to make the windows of programs run via WINE operate smoothly with FreeBSD: * Automatic mouse capture when windows are full-screen. * Allowing the FreeBSD window manager to decorate the windows, such as their title bars, for programs running via WINE. @@ -439,7 +439,7 @@ This tab allows configuration of the following items: image::wine-config-5.png[] The _Drives_ tab allows linking of directories in the host FreeBSD system to drive letters in the Windows(R) environment. -The default values in this tab should look familiar, as they're displaying the contents of [.filename]#dosdevices/# in the current WINE prefix. +The default values in this tab should look familiar, as they are displaying the contents of [.filename]#dosdevices/# in the current WINE prefix. Changes made via this dialog will reflect in [.filename]#dosdevices#, and properly-formatted links created in that directory will display in this tab. To create a new entry, such as for a CD-ROM (mounted at [.filename]#/mnt/cdrom#), take the following steps: @@ -474,21 +474,21 @@ It also allows entry of (entirely optional) user information, although this is n [[wine-management-guis]] == WINE Management GUIs -While the base install of WINE comes with a GUI configuration tool in winecfg, it is main purpose is just that: strictly configuring an existing WINE prefix. +While the base install of WINE comes with a GUI configuration tool in `winecfg`, it is main purpose is just that: strictly configuring an existing WINE prefix. There are, however, more advanced applications that will assist in the initial installation of applications as well as optimizing their WINE environments. The below sections include a selection of the most popular. [[winetricks]] === Winetricks -winetricks is a cross-platform, general purpose helper program for WINE. +The `winetricks` tool is a cross-platform, general purpose helper program for WINE. It is not developed by the WINE project proper, but rather maintained on https://github.com/Winetricks/winetricks[Github] by a group of contributors. It contains some automated "recipes" for getting common applications to work on WINE, both by optimizing the settings as well as acquiring some DLL libraries automatically. [[installing-winetricks]] ==== Installing winetricks -To install winetricks on a FreeBSD using binary packages, use the following commands (note winetricks requires either the i386-wine or i386-wine-devel package, and is therefore not installed automatically with other dependencies): +To install `winetricks` on a FreeBSD using binary packages, use the following commands (note `winetricks` requires either the i386-wine or i386-wine-devel package, and is therefore not installed automatically with other dependencies): [source,shell] .... @@ -510,15 +510,15 @@ If a manual installation is required, refer to the https://github.com/Winetricks [[using-winetricks]] ==== Using winetricks -Run winetricks with the following command: +Run `winetricks` with the following command: [source,shell] .... % winetricks .... -Note: this should be in a 32-bit prefix to run winetricks. -Launching winetricks displays a window with a number of choices, as follows: +Note: this should be in a 32-bit prefix to run `winetricks`. +Launching `winetricks` displays a window with a number of choices, as follows: image::winetricks-run-1.png[] @@ -527,7 +527,7 @@ Selecting either _Install an application_, _Install a benchmark_, or _Install a image::winetricks-run-2.png[] Selecting one or more items and clicking _OK_ will start their installation process(es). -Initially, some messages that appear to be errors may show up, but they're actually informational alerts as winetricks configures the WINE environment to get around known issues for the application: +Initially, some messages that appear to be errors may show up, but they're actually informational alerts as `winetricks` configures the WINE environment to get around known issues for the application: image::winetricks-app-install-1.png[] @@ -539,7 +539,7 @@ Once the installation completes, the new Windows application should be available image::winetricks-menu-1.png[] -In order to remove the application, run winetricks again, and select _Run an uninstaller_. +In order to remove the application, run `winetricks` again, and select _Run an uninstaller_. image::winetricks-uninstall-1.png[] @@ -555,7 +555,7 @@ image::winetricks-uninstall-3.png[] [[homura]] === Homura -Homura is an application similar to winetricks, although it was inspired by the https://lutris.net/[Lutris] gaming system for Linux. +Homura is an application similar to `winetricks`, although it was inspired by the https://lutris.net/[Lutris] gaming system for Linux. But while it is focused on games, there are also non-gaming applications available for install through Homura. [[installing-homura]] @@ -580,7 +580,7 @@ However, than the _emulators_ section of Ports or binary packages, look for it i [[using-homura]] ==== Using Homura -Homura's usage is quite similar to that of winetricks. +Homura's usage is quite similar to that of `winetricks`. When using it for the first time, launch it from the command line (or a desktop environment runner applet) with: [source,shell] @@ -602,7 +602,7 @@ Depending on the setup of the FreeBSD machine, Homura may display a message urgi image::homura-run-3.png[] The application's window should then appear, which amounts to a "main menu" with all its options. -Many of the items are the same as winetricks, although Homura offers some additional, helpful options such as opening its data folder (_Open Homura Folder_) or running a specified program (_Run a executable in prefix_). +Many of the items are the same as `winetricks`, although Homura offers some additional, helpful options such as opening its data folder (_Open Homura Folder_) or running a specified program (_Run a executable in prefix_). image::homura-install-1.png[] @@ -655,7 +655,7 @@ it is perfectly acceptable, even advantageous, to have both installed at the sam However, it is wise to ensure that they do not access any of the same WINE prefixes. Each of these solutions applies workarounds and makes changes to the registries based on known workarounds to existing WINE issues in order to make a given application run smoothly. -Allowing both winetricks and Homura to access the same prefix could lead to some of these being overwritten, with the result being some or all applications do not work as expected. +Allowing both `winetricks` and Homura to access the same prefix could lead to some of these being overwritten, with the result being some or all applications do not work as expected. [[wine-in-multi-user-os-installations]] == WINE in Multi-User FreeBSD Installations