Browse Source

Fixed doc generation

pull/46/head
Anairkoen Schno 5 years ago
parent
commit
b00a0bb56e
2 changed files with 13 additions and 10 deletions
  1. +12
    -9
      docs/articles/command-line.md
  2. +1
    -1
      docs/build.ps1

+ 12
- 9
docs/articles/command-line.md View File

@ -10,9 +10,7 @@ The installer has quite a few options, which are documented inline with the `-h`
This is what it currently looks like: This is what it currently looks like:
>
> [!code[IPA command line](_ipa_command_line.txt "the result of IPA.exe -h")]
>
[!code[IPA command line](_ipa_command_line.txt "the result of IPA.exe -h")]
# [The Game](#tab/game) # [The Game](#tab/game)
@ -21,7 +19,7 @@ The game *also* gets quite a few command line options, though there isn't anythi
Here's a quick list of what they are and what they do. Here's a quick list of what they are and what they do.
- `--debug` - `--debug`
>
> Enables the loading of debug information in Mono. The debugging information must be in the portable PDB format, > Enables the loading of debug information in Mono. The debugging information must be in the portable PDB format,
> in the same location as the DLL that it's for. > in the same location as the DLL that it's for.
> >
@ -29,8 +27,9 @@ Here's a quick list of what they are and what they do.
> >
> This overrides the config settings `Debug.ShowDebug` and `Debug.ShowCallSource`. > This overrides the config settings `Debug.ShowDebug` and `Debug.ShowCallSource`.
> >
- `--mono-debug` - `--mono-debug`
>
> Enables the built-in Mono soft debugger engine. > Enables the built-in Mono soft debugger engine.
> >
> By default, it acts as a client, and requires that there be a soft > By default, it acts as a client, and requires that there be a soft
@ -38,16 +37,18 @@ Here's a quick list of what they are and what they do.
> >
> Implies `--debug`. > Implies `--debug`.
> >
- `--server` - `--server`
>
> Does nothing on its own. > Does nothing on its own.
> >
> When paired with `--mono-debug`, this option makes the Mono soft debugger act in server mode. It begins listening on > When paired with `--mono-debug`, this option makes the Mono soft debugger act in server mode. It begins listening on
> port 10000 on any address, and will pause startup (with no window) until a debugger is connected. I reccommend using > port 10000 on any address, and will pause startup (with no window) until a debugger is connected. I reccommend using
> SDB, but that is a command line debugger and a lot of people don't care for those. > SDB, but that is a command line debugger and a lot of people don't care for those.
> >
- `--no-yeet` - `--no-yeet`
>
> Disables mod yeeting. > Disables mod yeeting.
> >
> By default, whenever BSIPA detects that the game is now running a newer version than previous runs, it will move all > By default, whenever BSIPA detects that the game is now running a newer version than previous runs, it will move all
@ -56,8 +57,9 @@ Here's a quick list of what they are and what they do.
> >
> Overrides the config setting `YeetMods`. > Overrides the config setting `YeetMods`.
> >
- `--condense-logs` - `--condense-logs`
>
> Reduces the number of log files BSIPA will output for a given session. > Reduces the number of log files BSIPA will output for a given session.
> >
> By default, BSIPA will create a subfolder in the `Logs` folder for each mod sublog, as well as each mod. This disables > By default, BSIPA will create a subfolder in the `Logs` folder for each mod sublog, as well as each mod. This disables
@ -66,7 +68,7 @@ Here's a quick list of what they are and what they do.
> Overrides the config setting `Debug.CondenseModLogs`. > Overrides the config setting `Debug.CondenseModLogs`.
> >
- `--no-updates` - `--no-updates`
>
> Disables automatic updating. > Disables automatic updating.
> >
> By default, BSIPA will check [BeatMods](http://beatmods.com) for all of the loaded mods to see if there is a new version > By default, BSIPA will check [BeatMods](http://beatmods.com) for all of the loaded mods to see if there is a new version
@ -74,3 +76,4 @@ Here's a quick list of what they are and what they do.
> >
> Overrides the config settings `Updates.AutoCheckUpdates` and `Updates.AutoUpdate`. > Overrides the config settings `Updates.AutoCheckUpdates` and `Updates.AutoUpdate`.
> >

+ 1
- 1
docs/build.ps1 View File

@ -71,7 +71,7 @@ if ((Test-Path $newtonsoftLoc -PathType Leaf) -and (Test-Path $selfConfigLoc -Pa
$ipaExe = "$ipaRoot/bin/Release/IPA.exe" $ipaExe = "$ipaRoot/bin/Release/IPA.exe"
# generate IPA.exe args file # generate IPA.exe args file
if (-not (Test-Path $ipaExe -PathType Leaf)) { if (-not (Test-Path $ipaExe -PathType Leaf)) {
msbuild -p:Configuration=Release -p:Platform=AnyCPU "$ipaRoot/IPA.csproj"
msbuild -p:Configuration=Release -p:Platform=AnyCPU -p:SolutionDir=.. "$ipaRoot/IPA.csproj"
} }
& $ipaExe --help > .\articles\_ipa_command_line.txt & $ipaExe --help > .\articles\_ipa_command_line.txt


Loading…
Cancel
Save