command line docs differ from command line

Working on new editor enhancements?
rootuid
User
User
Posts: 48
Joined: Sat Nov 23, 2013 11:46 am

command line docs differ from command line

Post by rootuid »

I'm using PureBasic 6.11 LTS - C Backend (MacOS X - arm64).

If I run

Code: Select all

$ ./PureBasic --help
I get the following information:

Code: Select all

Usage: purebasic [options] files...

Options:
  -v or --version             Display version information and quit
  -h or --help                Display commandline help

Launching the IDE:
  -p or --preferences <file>  Specify a file for the IDE preferences
  -t or --templates <file>    Specify a file for code templates
  -a or --tools <file>        Specify a file for the tools settings
  -H or --history <file>      Specify a file for the session history database
  -s or --sourcepath <path>   Specify the initial path for source files
  -e or --explorerpath <path> Specify the initial path for the explorer tool
  -l or --line <line>         Set the cursor to the given line

Building Projects:
  -b or --build <file>        Specify the project file to build
  -T or --target <name>       Specify a target to build
  -q or --quiet               Only show errors during the build
  -r or --readonly            Do not update the project file after the build
The documentation https://www.purebasic.com/documentation ... dline.html
however differs substantially

Code: Select all

General options:
  /VERSION                 displays the IDE version and exits
  /HELP or /?              displays a description of the command-line arguments
Options for launching the IDE:
  /P <Preferences file>    loads/saves all the configuration to/from the given file
  /T <Templates file>      loads/saves the code templates from/to the given file
  /A <tools file>          loads/saves the configuration of the external tool from/to this file
  /S <Source path>         overwrites the "Source path" setting from the preferences
  /E <Explorer path>       starts the Explorer tool with the given path
  /L <Line number>         moves the cursor to the given line number in the last opened file
  /H <HistoryDatabase>     specify the file to use for the session history database
  /NOEXT                   disables the registering of the .pb extension in the registry
  /LOCAL                   puts all preferences in the PureBasic directory instead of the user profile location
  /PORTABLE                the same as /LOCAL and /NOEXT combined
Options for building projects:
  /BUILD <file>            specifies the project file to build
  /TARGET <target>         specifies the target to build (the default is to build all targets)
  /QUIET                   hides all build messages except errors
  /READONLY                does not update the project file after compiling (with new access time and build counters)
The default files for /P /T and /A are saved in the %APPDATA%\PureBasic\ directory on the system.

The /NOEXT command is useful when you have several different PB versions at once (for testing of beta versions for example), but want the .pb extension to be associated with only one of them. The /PORTABLE command can be used to keep all configuration inside the local directory to easily copy PureBasic to different computers (or run it from USB sticks for example).

Example:
  PureBasic.exe Example.pb /PORTABLE
For example to build I use -b however the docs state /BUILD
Are the docs out of date?
User avatar
spikey
Enthusiast
Enthusiast
Posts: 769
Joined: Wed Sep 22, 2010 1:17 pm
Location: United Kingdom

Re: command line docs differ from command line

Post by spikey »

rootuid wrote: Mon Jul 15, 2024 7:10 pm I'm using PureBasic 6.11 LTS - C Backend (MacOS X - arm64).
Are the docs out of date?
The website shows the Windows version of the article. The same article appears in the local help and should be correct for your OS. It could do with a modification to show both sets of switches on the web, yes.
rootuid
User
User
Posts: 48
Joined: Sat Nov 23, 2013 11:46 am

Re: command line docs differ from command line

Post by rootuid »

As yes, the local pure basic help file is correct for my os, thanks.
Post Reply