diff options
author | Tobiasz Laskowski <tobil4sk@outlook.com> | 2025-02-24 23:15:28 +0000 |
---|---|---|
committer | Hisham Muhammad <hisham@gobolinux.org> | 2025-02-24 20:40:32 -0300 |
commit | 9f84d2461cd5daa53e6f925f30eaf1cbf3e6dfcd (patch) | |
tree | 300314a7b9b4ebec18b9250435e30d2c5fd25ba7 | |
parent | 28f9d98558f0f34a5f3d73b6bfa7a3f30856a5c9 (diff) | |
download | luarocks-9f84d2461cd5daa53e6f925f30eaf1cbf3e6dfcd.tar.gz luarocks-9f84d2461cd5daa53e6f925f30eaf1cbf3e6dfcd.tar.bz2 luarocks-9f84d2461cd5daa53e6f925f30eaf1cbf3e6dfcd.zip |
Fix markdown tables in windows install docs
-rw-r--r-- | docs/installation_instructions_for_windows.md | 71 |
1 files changed, 31 insertions, 40 deletions
diff --git a/docs/installation_instructions_for_windows.md b/docs/installation_instructions_for_windows.md index c19321b4..be7ff400 100644 --- a/docs/installation_instructions_for_windows.md +++ b/docs/installation_instructions_for_windows.md | |||
@@ -46,58 +46,49 @@ will be available for everyone. | |||
46 | All paths described above can be overridden with flags in the INSTALL.BAT script, | 46 | All paths described above can be overridden with flags in the INSTALL.BAT script, |
47 | or entries in the configuration file. | 47 | or entries in the configuration file. |
48 | 48 | ||
49 | {| | 49 | | Flag | Description | |
50 | | /P _dir_ || Where to install. Default is %PROGRAMFILES%\LuaRocks\_version_. Because LuaRocks contains 32bit executables, this will be in the c:\program files (x86)\ path on 64bit systems. | 50 | | ---- | ----------- | |
51 | |} | 51 | | /P _dir_ | Where to install. Default is %PROGRAMFILES%\LuaRocks\_version_. Because LuaRocks contains 32bit executables, this will be in the c:\program files (x86)\ path on 64bit systems. | |
52 | |||
52 | 53 | ||
53 | Configuring the destinations: | 54 | Configuring the destinations: |
54 | 55 | ||
55 | {| cellpadding=5px | 56 | | Flag | Description | |
56 | | /TREE _dir_ || Root of the local tree of installed rocks. Default is %PROGRAMFILES%\LuaRocks\systree. On 64bit systems this default depends on the Lua interpreter used. A 64bit interpreter will have the c:\program files\ path, where a 32bit interpreter on a 64bit system will follow the c:\program files (x86)\ path. | 57 | | ---- | ----------- | |
57 | |------------------------------------------------------------------------- | 58 | | /TREE _dir_ | Root of the local tree of installed rocks. Default is %PROGRAMFILES%\LuaRocks\systree. On 64bit systems this default depends on the Lua interpreter used. A 64bit interpreter will have the c:\program files\ path, where a 32bit interpreter on a 64bit system will follow the c:\program files (x86)\ path. | |
58 | | /SCRIPTS _dir_ || Where to install commandline scripts installed by rocks. Default is {TREE}/bin. | 59 | | /SCRIPTS _dir_ | Where to install commandline scripts installed by rocks. Default is {TREE}/bin. | |
59 | |------------------------------------------------------------------------- | 60 | | /CONFIG _dir_ | Location where the config file should be installed. Default is to follow /P option | |
60 | | /CONFIG _dir_ || Location where the config file should be installed. Default is to follow /P option | 61 | | /SELFCONTAINED | Creates a self contained installation in a single directory given by /P. Sets the /TREE and /CONFIG options to the same location as /P. And does not load registry info with option /NOREG. The only option NOT self contained is the user rock tree, so don't use that if you create a self contained installation. | |
61 | |------------------------------------------------------------------------- | 62 | |
62 | | /SELFCONTAINED || Creates a self contained installation in a single directory given by /P. Sets the /TREE and /CONFIG options to the same location as /P. And does not load registry info with option /NOREG. The only option NOT self contained is the user rock tree, so don't use that if you create a self contained installation. | ||
63 | |} | ||
64 | 63 | ||
65 | Configuring the Lua interpreter: | 64 | Configuring the Lua interpreter: |
66 | 65 | ||
67 | {| cellpadding=5px | 66 | | Flag | Description | |
68 | | /LV _version_ || Lua version to use; either 5.1, 5.2 or 5.3. Default is auto-detected. | 67 | | ---- | ----------- | |
69 | |------------------------------------------------------------------------- | 68 | | /LV _version_ | Lua version to use; either 5.1, 5.2 or 5.3. Default is auto-detected. | |
70 | | /LUA _dir_ || Location where Lua is installed - e.g. c:\lua\5.1\. If not provided, the installer will search the system path and some default locations for a valid Lua installation. This is the base directory, the installer will look for subdirectories bin, lib, include. Alternatively these can be specified explicitly using the /INC, /LIB, and /BIN options. | 69 | | /LUA _dir_ | Location where Lua is installed - e.g. c:\lua\5.1\. If not provided, the installer will search the system path and some default locations for a valid Lua installation. This is the base directory, the installer will look for subdirectories bin, lib, include. Alternatively these can be specified explicitly using the /INC, /LIB, and /BIN options. | |
71 | |------------------------------------------------------------------------- | 70 | | /INC _dir_ | Location of Lua includes - e.g. c:\lua\5.1\include. If provided overrides sub directory found using /LUA. | |
72 | | /INC _dir_ || Location of Lua includes - e.g. c:\lua\5.1\include. If provided overrides sub directory found using /LUA. | 71 | | /LIB _dir_ | Location of Lua libraries (.dll/.lib) - e.g. c:\lua\5.1\lib. If provided overrides sub directory found using /LUA. | |
73 | |------------------------------------------------------------------------- | 72 | | /BIN _dir_ | Location of Lua executables - e.g. c:\lua\5.1\bin. If provided overrides sub directory found using /LUA. | |
74 | | /LIB _dir_ || Location of Lua libraries (.dll/.lib) - e.g. c:\lua\5.1\lib. If provided overrides sub directory found using /LUA. | 73 | | /L | Install LuaRocks' own copy of Lua even if detected, this will always be a 5.1 installation. (/LUA, /INC, /LIB, /BIN cannot be used with /L) |
75 | |------------------------------------------------------------------------- | 74 | within an application. | |
76 | | /BIN _dir_ || Location of Lua executables - e.g. c:\lua\5.1\bin. If provided overrides sub directory found using /LUA. | 75 | |
77 | |------------------------------------------------------------------------- | ||
78 | | /L || Install LuaRocks' own copy of Lua even if detected, this will always be a 5.1 installation. (/LUA, /INC, /LIB, /BIN cannot be used with /L) | ||
79 | within an application. | ||
80 | |} | ||
81 | 76 | ||
82 | Compiler configuration: | 77 | Compiler configuration: |
83 | 78 | ||
84 | {| cellpadding=5px | 79 | | Flag | Description | |
85 | | /MW || Use mingw as build system instead of MSVC. | 80 | | --------------- | ----------- | |
86 | |} | 81 | | /MW | Use mingw as build system instead of MSVC. | |
87 | 82 | ||
88 | Other options: | 83 | Other options: |
89 | 84 | ||
90 | {| cellpadding=5px | 85 | | Flag | Description | |
91 | | /FORCECONFIG || Use a single config location. Do not use the LUAROCKS_CONFIG variable or the user's home directory. Useful to avoid conflicts when LuaRocks is embedded | 86 | | -------------- | ----------- | |
92 | |------------------------------------------------------------------------- | 87 | | /FORCECONFIG | Use a single config location. Do not use the LUAROCKS_CONFIG variable or the user's home directory. Useful to avoid conflicts when LuaRocks is embedded | |
93 | | /F || Force. Remove installation directory if it already exists. | 88 | | /F | Force. Remove installation directory if it already exists. | |
94 | |------------------------------------------------------------------------- | 89 | | /NOREG | Do not load registry info to register '.rockspec' extension with LuaRocks commands (right-click). | |
95 | | /NOREG || Do not load registry info to register '.rockspec' extension with LuaRocks commands (right-click). | 90 | | /NOADMIN | The installer requires admin priviledges. If not available it will elevate a new process. Use this switch to prevent elevation, but make sure the destination paths are all accessible for the current user. | |
96 | |------------------------------------------------------------------------- | 91 | | /Q | Do not prompt for confirmation of settings | |
97 | | /NOADMIN || The installer requires admin priviledges. If not available it will elevate a new process. Use this switch to prevent elevation, but make sure the destination paths are all accessible for the current user. | ||
98 | |------------------------------------------------------------------------- | ||
99 | | /Q || Do not prompt for confirmation of settings | ||
100 | |} | ||
101 | 92 | ||
102 | After installation, a default config file called config.lua will be installed at the directory defined by /CONFIG. For further configuration of LuaRocks paths, see the [Config file format](config_file_format.md). For more information on the structure of rocks trees see [rocks repositories](rocks_repositories.md). | 93 | After installation, a default config file called config.lua will be installed at the directory defined by /CONFIG. For further configuration of LuaRocks paths, see the [Config file format](config_file_format.md). For more information on the structure of rocks trees see [rocks repositories](rocks_repositories.md). |
103 | 94 | ||