Skip to content

Commit

Permalink
fix: break those links
Browse files Browse the repository at this point in the history
  • Loading branch information
@tefkah
tefkah committed Nov 28, 2021
1 parent 55e1c7c commit d22763c
Show file tree
Hide file tree
Showing 1,616 changed files with 18,552 additions and 18,551 deletions.
10 changes: 5 additions & 5 deletions docs/auctex/1 Introduction.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
slug: Introduction
---

| | | |
| :----------------------------- | -- | :----------------- |
| [• Summary](Summary) |    | Overview of AUCTeX |
| [• Installation](Installation) |    | Installing AUCTeX |
| [• Quick Start](Quick-Start) |    | |
| | | |
| :------------------------------------------ | -- | :----------------- |
| [• Summary](/docs/auctex/Summary) |    | Overview of AUCTeX |
| [• Installation](/docs/auctex/Installation) |    | Installing AUCTeX |
| [• Quick Start](/docs/auctex/Quick-Start) |    | |
6 changes: 3 additions & 3 deletions docs/auctex/1.1 Overview of AUCTeX.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ The most recent version is always available at [https://ftp.gnu.org/pub/gnu/auct

WWW users may want to check out the AUCTeX page at [https://www.gnu.org/software/auctex/](https://www.gnu.org/software/auctex/).

For comprehensive information about how to install AUCTeX See [Installation](Installation), or [Installation under MS Windows](Installation-under-MS-Windows), respectively.
For comprehensive information about how to install AUCTeX See [Installation](/docs/auctex/Installation), or [Installation under MS Windows](/docs/auctex/Installation-under-MS-Windows), respectively.

If you are considering upgrading AUCTeX, the recent changes are described in [Changes](Changes).
If you are considering upgrading AUCTeX, the recent changes are described in [Changes](/docs/auctex/Changes).

If you want to discuss AUCTeX with other users or its developers, there are several mailing lists you can use.

Send a mail with the subject “subscribe" to [[email protected]](mailto:[email protected]) in order to join the general discussion list for AUCTeX. Articles should be sent to [[email protected]](mailto:[email protected]). In a similar way, you can subscribe to the [[email protected]](mailto:[email protected]) list for just getting important announcements about AUCTeX. The list [[email protected]](mailto:[email protected]) is for bug reports which you should usually file with the `M-x TeX-submit-bug-report <RET>` command. If you want to address the developers of AUCTeX themselves with technical issues, they can be found on the discussion list [[email protected]](mailto:[email protected]).
Send a mail with the subject “subscribe" to [[email protected]](/docs/auctex/mailto:[email protected]) in order to join the general discussion list for AUCTeX. Articles should be sent to [[email protected]](/docs/auctex/mailto:[email protected]). In a similar way, you can subscribe to the [[email protected]](/docs/auctex/mailto:[email protected]) list for just getting important announcements about AUCTeX. The list [[email protected]](/docs/auctex/mailto:[email protected]) is for bug reports which you should usually file with the `M-x TeX-submit-bug-report <RET>` command. If you want to address the developers of AUCTeX themselves with technical issues, they can be found on the discussion list [[email protected]](/docs/auctex/mailto:[email protected]).
24 changes: 12 additions & 12 deletions docs/auctex/1.2 Installing AUCTeX.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@
slug: Installation
---

The modern and strongly recommended way of installing AUCTeX is by using the Emacs package manager integrated in Emacs 24 and greater (ELPA). Simply do `M-x list-packages RET`, mark the auctex package for installation with `i`, and hit `x` to execute the installation procedure. That’s all. This installation procedure has several advantages. Besides being platform and OS independent, you will receive intermediate releases between major AUCTeX releases conveniently. For past ELPA releases, see [https://elpa.gnu.org/packages/auctex.html](https://elpa.gnu.org/packages/auctex.html). Once the installation is completed, you can skip the rest of this section and proceed to [Quick Start](Quick-Start).
The modern and strongly recommended way of installing AUCTeX is by using the Emacs package manager integrated in Emacs 24 and greater (ELPA). Simply do `M-x list-packages RET`, mark the auctex package for installation with `i`, and hit `x` to execute the installation procedure. That’s all. This installation procedure has several advantages. Besides being platform and OS independent, you will receive intermediate releases between major AUCTeX releases conveniently. For past ELPA releases, see [https://elpa.gnu.org/packages/auctex.html](https://elpa.gnu.org/packages/auctex.html). Once the installation is completed, you can skip the rest of this section and proceed to [Quick Start](/docs/auctex/Quick-Start).

The remainder of this section is about installing AUCTeX from a release tarball or from a checkout of the AUCTeX repository.

Installing AUCTeX should be simple: merely `./configure`, `make`, and `make install` for a standard site-wide installation (most other installations can be done by specifying a ‘`--prefix=…`’ option).

On many systems, this will already activate the package, making its modes the default instead of the built-in modes of Emacs. If this is not the case, consult [Loading the package](Loading-the-package). Please read through this document fully before installing anything. The installation procedure has changed as compared to earlier versions. Users of MS Windows are asked to consult See [Installation under MS Windows](Installation-under-MS-Windows).
On many systems, this will already activate the package, making its modes the default instead of the built-in modes of Emacs. If this is not the case, consult [Loading the package](/docs/auctex/Loading-the-package). Please read through this document fully before installing anything. The installation procedure has changed as compared to earlier versions. Users of MS Windows are asked to consult See [Installation under MS Windows](/docs/auctex/Installation-under-MS-Windows).

| | | |
| :----------------------------------------------------------------------- | -- | :- |
| [• Prerequisites](Prerequisites) |    | |
| [• Configure](Configure) |    | |
| [• Build/install and uninstall](Build_002finstall-and-uninstall) |    | |
| [• Loading the package](Loading-the-package) |    | |
| [• Advice for package providers](Advice-for-package-providers) |    | |
| [• Advice for non-privileged users](Advice-for-non_002dprivileged-users) |    | |
| [• Installation under MS Windows](Installation-under-MS-Windows) |    | |
| [• Customizing](Customizing) |    | |
| | | |
| :------------------------------------------------------------------------------------ | -- | :- |
| [• Prerequisites](/docs/auctex/Prerequisites) |    | |
| [• Configure](/docs/auctex/Configure) |    | |
| [• Build/install and uninstall](/docs/auctex/Build_002finstall-and-uninstall) |    | |
| [• Loading the package](/docs/auctex/Loading-the-package) |    | |
| [• Advice for package providers](/docs/auctex/Advice-for-package-providers) |    | |
| [• Advice for non-privileged users](/docs/auctex/Advice-for-non_002dprivileged-users) |    | |
| [• Installation under MS Windows](/docs/auctex/Installation-under-MS-Windows) |    | |
| [• Customizing](/docs/auctex/Customizing) |    | |
2 changes: 1 addition & 1 deletion docs/auctex/1.2.1 Prerequisites.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ slug: Prerequisites

Strictly speaking, you can get away without it if you are building from the distribution tarball, have not modified any files and don’t need a printed version of the manual: the pregenerated info file is included in the tarball. At least version 4.0 is required.

For some known issues with various software, see [(preview-latex)Known problems](Known-problems) section ‘Known problems’ in the preview-latex manual.
For some known issues with various software, see [(preview-latex)Known problems](/docs/auctex/Known-problems) section ‘Known problems’ in the preview-latex manual.
4 changes: 2 additions & 2 deletions docs/auctex/1.2.2 Configure.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ All automatic placements for package components will be chosen from sensible exi

Only if no workable placement can be found there, in some cases an alternative search will be made in a prefix deduced from a suitable binary.

‘`/usr/local`’ is the default `prefix`, intended to be suitable for a site-wide installation. If you are packaging this as an operating system component for distribution, the setting ‘`/usr`’ will probably be the right choice. See [Advice for package providers](Advice-for-package-providers) for detail.
‘`/usr/local`’ is the default `prefix`, intended to be suitable for a site-wide installation. If you are packaging this as an operating system component for distribution, the setting ‘`/usr`’ will probably be the right choice. See [Advice for package providers](/docs/auctex/Advice-for-package-providers) for detail.

If you are planning to install the package as a single non-priviledged user, you will typically set `prefix` to your home directory. Consult [Advice for non-privileged users](Advice-for-non_002dprivileged-users) for addtional instructions.
If you are planning to install the package as a single non-priviledged user, you will typically set `prefix` to your home directory. Consult [Advice for non-privileged users](/docs/auctex/Advice-for-non_002dprivileged-users) for addtional instructions.

### `--with-emacs[=/path/to/emacs]`

Expand Down
2 changes: 1 addition & 1 deletion docs/auctex/1.2.4 Loading the package.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ If you explicitly used `--with-lispdir`, you may need to add the specified direc

before the above lines into your Emacs startup file.

For site-wide activation in GNU Emacs, see See [Advice for package providers](Advice-for-package-providers).
For site-wide activation in GNU Emacs, see See [Advice for package providers](/docs/auctex/Advice-for-package-providers).

Once activated, the modes provided by AUCTeX are used per default for all supported file types. If you want to change the modes for which it is operative instead of the default, use

Expand Down
2 changes: 1 addition & 1 deletion docs/auctex/1.2.5 Providing AUCTeX as a package.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ slug: Advice-for-package-providers

As a package provider, you should make sure that your users will be served best according to their intentions, and keep in mind that a system might be used by more than one user, with different preferences.

There are people that prefer the built-in Emacs modes for editing TeX files, in particular plain TeX users. There are various ways to tell AUCTeX even after auto-activation that it should not get used, and they are described in [Introduction to AUCTeX](Introduction).
There are people that prefer the built-in Emacs modes for editing TeX files, in particular plain TeX users. There are various ways to tell AUCTeX even after auto-activation that it should not get used, and they are described in [Introduction to AUCTeX](/docs/auctex/Introduction).

So if you have users that don’t want to use the preinstalled AUCTeX, they can easily get rid of it. Activating AUCTeX by default is therefore a good choice.

Expand Down
2 changes: 1 addition & 1 deletion docs/auctex/1.2.6 Installation for non-privileged users.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You often need to specify ‘`--with-lispdir`’ option as well. If you haven’

You’ll have to add something like ‘`/home/myself/share/emacs/site-lisp`’ to your `load-path` variable, if it isn’t there already.

In addition, you will have to tell ‘`configure`’ script where to install TeX-related files such as ‘`preview.sty`’ if preview-latex isn’t disabled. It is enough to specify ‘`--with-texmf-dir=‘$HOME/texmf’`’ for most typical cases, but you have to create the direcotry ‘`$HOME/texmf`’ in advance if it doesn’t exist. If this prescription doesn’t work, consider using one or more of the options ‘`--with-texmf-dir=/dir`’, ‘`--without-texmf-dir`’, ‘`--with-tex-dir=/dir`’ and ‘`--with-doc-dir=/dir`’. See [Configure](Configure) for detail of these options.
In addition, you will have to tell ‘`configure`’ script where to install TeX-related files such as ‘`preview.sty`’ if preview-latex isn’t disabled. It is enough to specify ‘`--with-texmf-dir=‘$HOME/texmf’`’ for most typical cases, but you have to create the direcotry ‘`$HOME/texmf`’ in advance if it doesn’t exist. If this prescription doesn’t work, consider using one or more of the options ‘`--with-texmf-dir=/dir`’, ‘`--without-texmf-dir`’, ‘`--with-tex-dir=/dir`’ and ‘`--with-doc-dir=/dir`’. See [Configure](/docs/auctex/Configure) for detail of these options.

Now here is another thing to ponder: perhaps you want to make it easy for other users to share parts of your personal Emacs configuration. In general, you can do this by writing ‘`~myself/`’ anywhere where you specify paths to something installed in your personal subdirectories, not merely ‘`~/`’, since the latter, when used by other users, will point to non-existent files.

Expand Down
10 changes: 5 additions & 5 deletions docs/auctex/1.2.7 Installation under MS Windows.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ The following are brief installation instructions for the impatient. In case you
Installation of AUCTeX under Windows is in itself not more complicated than on other platforms. However, meeting the prerequisites might require more work than on some other platforms, and feel less natural.
If you are experiencing any problems, even if you think they are of your own making, be sure to report them to [[email protected]](mailto:[email protected]) so that we can explain things better in future.
If you are experiencing any problems, even if you think they are of your own making, be sure to report them to [[email protected]](/docs/auctex/mailto:[email protected]) so that we can explain things better in future.
Windows is a problematic platform for installation scripts. The main problem is that the installation procedure requires consistent file names in order to find its way in the directory hierarchy, and Windows path names are a mess.
Expand All @@ -62,7 +62,7 @@ Ok, now here are the steps to perform:
If you don’t have a suitable unpacking tool, skip to the next step: this should provide you with a working ‘`unzip`’ command.
2. The installation of AUCTeX will require the MSYS tool set from [http://www.mingw.org/](http://www.mingw.org/) or the Cygwin tool set from [https://cygwin.com/](https://cygwin.com/). The latter is slower and larger (the download size of the base system is about 15 MB) but comes with a package manager that allows for updating the tool set and installing additional packages like, for example, the spell checker aspell.
2. The installation of AUCTeX will require the MSYS tool set from [http://www.mingw.org/](/docs/auctex/http://www.mingw.org/) or the Cygwin tool set from [https://cygwin.com/](https://cygwin.com/). The latter is slower and larger (the download size of the base system is about 15 MB) but comes with a package manager that allows for updating the tool set and installing additional packages like, for example, the spell checker aspell.
If Cygwin specific paths like ‘`/cygdrive/c`’ crop up in the course of the installation, using a non-Cygwin Emacs could conceivably cause trouble. Using Cygwin either for everything or nothing might save headaches, *if* things don’t work out.
Expand Down Expand Up @@ -102,7 +102,7 @@ Ok, now here are the steps to perform:
This option tells a place in `load-path` below which the files are situated. The startup files ‘`auctex.el`’ and ‘`preview-latex.el`’ will get installed here unless a subdirectory ‘`site-start.d`’ exists which will then be used instead. The other files from AUCTeX will be installed in a subdirectory called ‘`auctex`’.
If you think that you need a different setup, please refer to the full installation instructions in [Configure](Configure).
If you think that you need a different setup, please refer to the full installation instructions in [Configure](/docs/auctex/Configure).
### `--infodir=drive:/path/to/info/directory`
Expand All @@ -120,7 +120,7 @@ Ok, now here are the steps to perform:
This will specify the directory where your TeX installation sits. If your TeX installation does not conform to the TDS (TeX directory standard), you may need to specify more options to get everything in place.
For more information about any of the above and additional options, see [Configure](Configure).
For more information about any of the above and additional options, see [Configure](/docs/auctex/Configure).
Calling ‘`./configure --help=recursive`’ will tell about other options, but those are almost never required.
Expand Down Expand Up @@ -168,7 +168,7 @@ Ok, now here are the steps to perform:
If this barfs and tells you that image type ‘`png`’ is not supported, you can either add PNG support to your Emacs installation or choose another image format to be used by preview-latex.
Adding support for an image format usually involves the installation of a library, e.g. from [http://gnuwin32.sf.net/](http://gnuwin32.sf.net/). If you got your Emacs from [https://www.gnu.org/](https://www.gnu.org/) you might want to check its [README file](https://ftp.gnu.org/gnu/emacs/windows/README) for details.
Adding support for an image format usually involves the installation of a library, e.g. from [http://gnuwin32.sf.net/](/docs/auctex/http://gnuwin32.sf.net/). If you got your Emacs from [https://www.gnu.org/](https://www.gnu.org/) you might want to check its [README file](https://ftp.gnu.org/gnu/emacs/windows/README) for details.
A different image format can be chosen by setting the variable `preview-image-type`. While it is recommended to keep the ‘`dvipng`’ or ‘`png`’ setting, you can temporarily select a different format like ‘`pnm`’ to check if the lack of PNG support is the only problem with your Emacs installation.
Expand Down
Loading

0 comments on commit d22763c

Please sign in to comment.