Installing Local Documentation

ANSYS, Inc. Release 2024 R1

Southpointe January 2024
2600 Ansys Drive
Canonsburg, PA 15317 ANSYS, Inc. and
[email protected] ANSYS Europe,
Ltd. are UL
http://www.ansys.com registered ISO
(T) 724-746-3304 9001: 2015
(F) 724-514-9494 companies.
Copyright and Trademark Information

© 2024 ANSYS, Inc. Unauthorized use, distribution or duplication is prohibited.

ANSYS, Ansys Workbench, AUTODYN, CFX, FLUENT and any and all ANSYS, Inc. brand, product, service and feature
names, logos and slogans are registered trademarks or trademarks of ANSYS, Inc. or its subsidiaries located in the
United States or other countries. ICEM CFD is a trademark used by ANSYS, Inc. under license. CFX is a trademark
of Sony Corporation in Japan. All other brand, product, service and feature names or trademarks are the property
of their respective owners. FLEXlm and FLEXnet are trademarks of Flexera Software LLC.

Disclaimer Notice

THIS ANSYS SOFTWARE PRODUCT AND PROGRAM DOCUMENTATION INCLUDE TRADE SECRETS AND ARE CONFID-
ENTIAL AND PROPRIETARY PRODUCTS OF ANSYS, INC., ITS SUBSIDIARIES, OR LICENSORS. The software products
and documentation are furnished by ANSYS, Inc., its subsidiaries, or affiliates under a software license agreement
that contains provisions concerning non-disclosure, copying, length and nature of use, compliance with exporting
laws, warranties, disclaimers, limitations of liability, and remedies, and other provisions. The software products
and documentation may be used, disclosed, transferred, or copied only in accordance with the terms and conditions
of that software license agreement.

ANSYS, Inc. and ANSYS Europe, Ltd. are UL registered ISO 9001: 2015 companies.

U.S. Government Rights

For U.S. Government users, except as specifically granted by the ANSYS, Inc. software license agreement, the use,
duplication, or disclosure by the United States Government is subject to restrictions stated in the ANSYS, Inc.
software license agreement and FAR 12.212 (for non-DOD licenses).

Third-Party Software

See the legal information in the product help files for the complete Legal Notice for ANSYS proprietary software
and third-party software. If you are unable to access the Legal Notice, contact ANSYS, Inc.

Published in the U.S.A.

Table of Contents
Local Help Installation Instructions ........................................................................................................... 1
Installing from the Download Center on Windows ................................................................................... 1
Installing from the Download Center on Linux ......................................................................................... 2
Installing from the USB drive ................................................................................................................... 3

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. iii
Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
iv of ANSYS, Inc. and its subsidiaries and affiliates.
Local Help Installation Instructions
Ansys product documentation is now online, directly linked from the products. With online document-
ation, you have access to the best and latest content, updated as soon as it is available. You also gain
access to our help, tutorials, and videos in a single, convenient location, accessible from all your Internet-
connected devices.

If you do not have Internet access, or if you want to run help locally, you can download an installable
version of our product documentation from the Download Center. An installable version is also included
on the product installation media.

Your feedback is greatly appreciated as we continue to improve this new resource.

Note that documentation for the Electromagnetics Suite is available via the normal methods.

IMPORTANT NOTE: If you have already set the ANSYS_INTERNET_DOC environment variable for testing
earlier pre-release versions, you will need to unset it before running the local install. The environment
variable will take precedence over the local install and prevent the installation from correctly configuring
your system.

The following topics cover the basics of setting up local help:

Installing from the Download Center on Windows
Installing from the Download Center on Linux
Installing from the USB drive

Installing from the Download Center on Windows

1. Download the Local Help package from the Ansys Customer Portal at Downloads >Current Re-
lease>Documentation>ANSYS>Local Help.

2. Extract the package to a working directory of your choice.

3. Close all Windows applications and ensure that no Ansys processes are running before continuing.

4. Run <working directory>\setup.exe as administrator.

5. Follow the on-screen prompts. Be sure that “Ansys, Inc. Documentation Only” is selected on the
product selection screen.

6. Depending on your installation scenario, run the appropriate configuration described below:

• If you install the documentation to the same directory as your product installation, or if you install
the documentation on a machine with no product installation, you can now run the help normally.
No further configuration is needed.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1
Local Help Installation Instructions

Note: If multiple users are accessing the help, each additional user must point to the help install-
ation directory by running Start>All Programs>ANSYS2024 R1>Help>ANSYS Help Configuration
2024 R1.

• If you have an existing installation but install the documentation to a directory other than the
product installation, or if the user account used to install the local help is not the end user:

a. Choose Start>All Programs>ANSYS 2024 R1>Help>ANSYS Help Configuration 2024 R1.

b. Select the Ansys Local Help option.

c. Click Browse and locate the \commonfiles\help directory where you installed the help files
(Example: C:\Local doc\ANSYS Inc\v241\commonfiles\help).

d. Click Select Folder. The message “Help files found. Click Save to use these files.” is displayed.

e. Click Save. You can now run the help normally.

If multiple users are accessing the help, each user must perform the steps above.

Installing from the Download Center on Linux

1. Download the Local Help package from the Ansys Customer Portal at Downloads >Current Re-
lease>Documentation>ANSYS>Local Help.

2. Extract the package to a working directory of your choice.

3. Run <working directory>/INSTALL.

4. Follow the on-screen prompts. Be sure that “Ansys, Inc. Documentation Only” is selected on the
product selection screen.

5. Depending on your installation scenario, run the appropriate configuration described below:

• If you install the documentation to the same directory as your product installation, or if you install
the documentation on a machine with no product installation, you can now run the help normally
by issuing following command from the v241 directory. No further configuration is needed.
Tools/mono/Linux64/bin/mono
commonfiles/help/HelpViewer/ANSYSHelpViewer.exe

Note: If multiple users are accessing the help, each additional user must point to the help install-
ation directory by performing the steps described below.

• If you have an existing installation but install the documentation to a directory other than the
product installation, or if the user account used to install the local help is not the end user:

a. Issue the following command from the v241 directory to configure the new help location:
Tools/mono/Linux64/bin/mono
commonfiles/help/HelpViewer/ANSYSHelpConfigurationTool.exe

b. Select the Ansys Local Help option.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
2 of ANSYS, Inc. and its subsidiaries and affiliates.
Installing from the USB drive

c. Enter the /commonfiles/help directory where you installed the help files (Example: /Local
doc/ANSYS Inc/v241/commonfiles/help). The message “Help files found. Click Save to use
these files.” is displayed.

d. Click Save. You can now run the help normally by issuing following command from the v241
directory:
Tools/mono/Linux64/bin/mono
commonfiles/help/HelpViewer/ANSYSHelpViewer.exe

If multiple users are accessing the help, each user must perform the steps above.

Installing from the USB drive

1. Run setup.exe (Windows) or INSTALL (Linux) from ansyslocalhelp/<platform>.

2. Follow the on-screen prompts. Be sure that “Ansys, Inc. Documentation Only” is selected on the
product selection screen.

3. Run the applicable configuration, if necessary:

Windows
• If you install the documentation to the same directory as your product installation, or if you install
the documentation on a machine with no product installation, you can now run the help normally.
No further configuration is needed.

• If you have an existing installation but install the documentation to a directory other than the
product installation, or if the user account used to install the local help is not the end user:

a. Choose Start>All Programs>ANSYS 24.1>Help>ANSYS Help Configuration 2024 R1.

b. Select the Ansys Local Help option.

c. Click Browse and locate the \commonfiles\help directory where you installed the help files
(Example: C:\Local doc\ANSYS Inc\v241\commonfiles\help).

d. Click Select Folder. The message “Help files found. Click Save to use these files.” is displayed.

e. Click Save. You can now run the help normally.

If multiple users are accessing the help, each user must perform the steps above.

Linux
• If you install the documentation to the same directory as your product installation, or if you install
the documentation on a machine with no product installation, you can now run the help normally
by issuing following command from the v241 directory. No further configuration is needed.
Tools/mono/Linux64/bin/mono
commonfiles/help/HelpViewer/ANSYSHelpViewer.exe

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 3
Local Help Installation Instructions

Note: If multiple users are accessing the help, each additional user must point to the help install-
ation directory by performing the steps described below.

• If you have an existing installation but install the documentation to a directory other than the
product installation, or if the user account used to install the local help is not the end user:

a. Issue the following command from the v241 directory to configure the new help location:
Tools/mono/Linux64/bin/mono
commonfiles/help/HelpViewer/ANSYSHelpConfigurationTool.exe

b. Select the Ansys Local Help option.

c. Enter the /commonfiles/help directory where you installed the help files (Example: /Local
doc/ANSYS Inc/v241/commonfiles/help). The message “Help files found. Click Save to use
these files.” is displayed.

d. Click Save. You can now run the help normally by issuing following command from the v241
directory:
Tools/mono/Linux64/bin/mono
commonfiles/help/HelpViewer/ANSYSHelpViewer.exe

If multiple users are accessing the help, each user must perform the steps above.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
4 of ANSYS, Inc. and its subsidiaries and affiliates.