Difference between revisions of "Code::Blocks command line arguments"

From Code::Blocks
(Update after (after [r13245]) add user variable command line arguments)
(→‎Command line arguments: Add missing arguments and remove duplicated ones)
 
(2 intermediate revisions by one other user not shown)
Line 28: Line 28:
  
 
{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
 
{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
−
 
+
|+
 
|- style="background: #ececec; border: 1px solid gray"
 
|- style="background: #ececec; border: 1px solid gray"
−
! Argument  
+
!
 +
! Argument
 
! Function
 
! Function
 
|-
 
|-
−
 
 
|-
 
|-
−
| ''<filename>''
+
|Windows
 +
|Windows(MSYS2, WSL)
 +
Linux, Unix, MacOS
 +
|
 +
|-
 +
|
 +
|''<filename>''
 
| Specifies the project *.cbp filename or workspace *.workspace filename. For instance ''<filename>'' may be ''c:\some\where\a\project.cbp''. Place this argument at end of command line, just before output redirection if any.
 
| Specifies the project *.cbp filename or workspace *.workspace filename. For instance ''<filename>'' may be ''c:\some\where\a\project.cbp''. Place this argument at end of command line, just before output redirection if any.
 
|-
 
|-
−
 
−
|-
 
−
| '''--file='''''<filename>[:line]''
 
−
| Open file in Code::Blocks and optionally jump to a specific line.
 
 
|-
 
|-
  
 
|-
 
|-
−
| '''/h''', '''--help''', '''/?''', '''--?'''
+
|'''/h''', '''/?'''
 +
|'''--help''', '''--?'''
 
| Shows a help message about the command line arguments.
 
| Shows a help message about the command line arguments.
 +
|-
 +
|
 +
|'''--safe-mode'''
 +
|Load in safe mode (all plugins will be disabled).
 
|-
 
|-
  
 
|-
 
|-
−
| '''/na''', '''--no-check-associations'''
+
|'''/na'''
 +
|'''--no-check-associations'''
 
| Don't perform any file association checks (Windows only).
 
| Don't perform any file association checks (Windows only).
 
|-
 
|-
  
 
|-
 
|-
−
| '''/nd''', '''--no-dde'''
+
|'''/nd'''
 +
|'''--no-dde'''
 
| Don't start a [http://en.wikipedia.org/wiki/Dynamic_Data_Exchange DDE] server (Windows only).
 
| Don't start a [http://en.wikipedia.org/wiki/Dynamic_Data_Exchange DDE] server (Windows only).
 
|-
 
|-
  
 
|-
 
|-
−
| '''/ns''', '''--no-splash-screen'''
+
|'''/ns'''
 +
|'''--no-splash-screen'''
 
| Hides the splash screen when the application is loading.
 
| Hides the splash screen when the application is loading.
 +
|-
 +
|
 +
|'''--multiple-instance'''
 +
|Allow running multiple instances.
 
|-
 
|-
  
 
|-
 
|-
−
| '''/d''', '''--debug-log'''
+
|'''/d'''
 +
|'''--debug-log'''
 
| Display application's debug log.
 
| Display application's debug log.
 +
|-
 +
|'''/nc'''
 +
|'''--no-crash-handler'''
 +
|Do not use the crash handler (useful for debugging C::B).
 
|-
 
|-
  
 
|-
 
|-
−
| '''--prefix='''''<str>''
+
|'''/v'''
 +
|'''--verbose'''
 +
| Show more debugging messages.
 +
|-
 +
|
 +
|'''--prefix''='''''<nowiki/>''<str>''
 
| Sets the shared data directory prefix.
 
| Sets the shared data directory prefix.
 
|-
 
|-
  
 
|-
 
|-
−
| '''/p''', '''--personality='''''<str>'', '''--profile='''''<str>''
+
|
 +
|'''--user-data-dir'''=<str>
 +
| Specify an alternative directory for user settings and user installed plugins
 +
|-
 +
|'''/p''' str
 +
|'''--personality='''''<str>'', '''--profile''='''''<nowiki/>''<str>''
 
| Sets the [[Personalities|personality]] to use. You can use ''ask'' as the parameter to list available personalities.
 
| Sets the [[Personalities|personality]] to use. You can use ''ask'' as the parameter to list available personalities.
 
|-
 
|-
−
 
+
|
 +
|'''--no-log'''
 +
|Turn off the application log.
 +
|-
 +
|
 +
|'''--log-to-file'''
 +
|Redirect application log to a file.
 +
|-
 +
|
 +
|'''--debug-log-to-file'''
 +
|Redirect application debug log to a file.
 +
|-
 +
|-
 +
|'''/S''' name
 +
|'''--set'''=name
 +
|Set <nowiki>''</nowiki>name<nowiki>''</nowiki> to current active set for global variables (after [r13245]).
 +
|-
 +
|'''/D''' str
 +
|
 +
|If ''str'' = "<set>.uservar.mem=val", set the member ''mem'' of uservariable ''uservar'' in ''set'' to value ''val''. This overrides the current set value (after [r13245]).
 
|-
 
|-
−
| '''--rebuild'''
+
|
 +
|'''--rebuild'''
 
| Clean and build the project / workspace.
 
| Clean and build the project / workspace.
 
|-
 
|-
  
 
|-
 
|-
−
| '''--build'''
+
|
 +
|'''--build'''
 
| Build the project / workspace.
 
| Build the project / workspace.
 
|-
 
|-
−
 
 
|-
 
|-
−
| '''--target='''''<str>''
+
|
−
| Sets target for batch build. For example --target="Release".
+
|'''--clean'''
 +
| Clean the project/workspace
 +
|-
 +
|
 +
|'''--target''='''''<nowiki/>''<str>''
 +
| Sets target for batch build,  for example --target="Release".
 
|-
 
|-
  
 
|-
 
|-
−
| '''--no-batch-window-close'''
+
|
 +
|'''--no-batch-window-close'''
 
| Keeps the batch log window visible after the batch build has completed.
 
| Keeps the batch log window visible after the batch build has completed.
 
|-
 
|-
  
 
|-
 
|-
−
| '''--batch-build-notify'''
+
|
 +
|'''--batch-build-notify'''
 
| Shows a message after the batch build has completed.
 
| Shows a message after the batch build has completed.
 
|-
 
|-
−
 
−
|-
 
−
|  '''--user-data-dir=<path>'''
 
−
| specify an alternative directory for user settings and user installed plugins
 
 
|-
 
|-
  
 
|-
 
|-
−
| '''--script=<str>'''
+
|
 +
|'''--script'''=<str>
 
| specify a script file to run after loading
 
| specify a script file to run after loading
 
|-
 
|-
  
 
|-
 
|-
−
| '''--target=<str>'''
+
|
−
| the target for the batch build
+
|'''--file='''<filename>[:line]
−
|-
+
| Open file in Code::Blocks and optionally jump to a specific line.
−
             
 
−
|-
 
−
|  '''--clean'''
 
−
| clean the project/workspace
 
 
|-
 
|-
−
 
 
|-
 
|-
−
|  '''--rebuild'''
 
−
| clean and then build the project/workspace
 
 
|-
 
|-
  
 
|-
 
|-
−
| '''--build'''
+
|
−
| just build the project/workspace
+
|'''--dbg-config'''=<str>
 +
| Selects the debugger config used for attaching.
 
|-
 
|-
−
 
 
|-
 
|-
−
|  '''--verbose'''
 
−
| Enable logging of c::b errors
 
 
|-
 
|-
−
|'''-S''' setName
+
|
−
|Set <nowiki>''</nowiki>setName<nowiki>''</nowiki> to current active set for global variables (after [r13245])
+
|'''--dbg-attach'''=<str>
−
|-
+
|''str'' is passed to debugger plugin which is used for attaching to a process.
−
|'''-D''' <set>.uservar.mem=val
 
−
|Set the member ''mem'' of uservariable ''uservar'' in set to value ''val''. This overrides the current set value (after [r13245])
 
−
|-
 
−
 
 
 
|-
 
|-
−
| '''>''' ''<build log file>''
+
|
 +
|'''>''' ''<build log file>''
 
| Placed in the very last position of command line, this may be used to redirect standard output to log file, this is not a codeblock option as such, but just a DOS/*nix shell usual standard output redirection
 
| Placed in the very last position of command line, this may be used to redirect standard output to log file, this is not a codeblock option as such, but just a DOS/*nix shell usual standard output redirection
 
|-
 
|-
  
 
|}
 
|}

Latest revision as of 13:18, 5 November 2024

Using command line arguments

Windows

  1. Find the Code::Blocks shortcut in the Desktop or Start menu.
  2. Right click on the icon and select Properties.
  3. Select the Shortcut tab.
  4. Append the command line arguments you want to use to the end of the Target text (behind the quote mark).
  5. Run Code::Blocks by using the shortcut you edited.

Example 

"C:\Program Files\CodeBlocks\codeblocks.exe" /na /nd

*nix

  1. Launch a terminal client, such as XTerm, Gnome Terminal or Konsole.
  2. Type "codeblocks" and then append the command line arguments you want to use.

Note: Code::Blocks can not run on a real console, X11 must be running and you must use a graphical terminal emulator.

Example 

codeblocks --no-splash-screen --debug-log

Command line arguments

Argument Function
Windows Windows(MSYS2, WSL)

Linux, Unix, MacOS

<filename> Specifies the project *.cbp filename or workspace *.workspace filename. For instance <filename> may be c:\some\where\a\project.cbp. Place this argument at end of command line, just before output redirection if any.
/h, /? --help, --? Shows a help message about the command line arguments.
--safe-mode Load in safe mode (all plugins will be disabled).
/na --no-check-associations Don't perform any file association checks (Windows only).
/nd --no-dde Don't start a DDE server (Windows only).
/ns --no-splash-screen Hides the splash screen when the application is loading.
--multiple-instance Allow running multiple instances.
/d --debug-log Display application's debug log.
/nc --no-crash-handler Do not use the crash handler (useful for debugging C::B).
/v --verbose Show more debugging messages.
--prefix=<str> Sets the shared data directory prefix.
--user-data-dir=<str> Specify an alternative directory for user settings and user installed plugins
/p str --personality=<str>, --profile=<str> Sets the personality to use. You can use ask as the parameter to list available personalities.
--no-log Turn off the application log.
--log-to-file Redirect application log to a file.
--debug-log-to-file Redirect application debug log to a file.
/S name --set=name Set ''name'' to current active set for global variables (after [r13245]).
/D str If str = "<set>.uservar.mem=val", set the member mem of uservariable uservar in set to value val. This overrides the current set value (after [r13245]).
--rebuild Clean and build the project / workspace.
--build Build the project / workspace.
--clean Clean the project/workspace
--target=<str> Sets target for batch build, for example --target="Release".
--no-batch-window-close Keeps the batch log window visible after the batch build has completed.
--batch-build-notify Shows a message after the batch build has completed.
--script=<str> specify a script file to run after loading
--file=<filename>[:line] Open file in Code::Blocks and optionally jump to a specific line.
--dbg-config=<str> Selects the debugger config used for attaching.
--dbg-attach=<str> str is passed to debugger plugin which is used for attaching to a process.
> <build log file> Placed in the very last position of command line, this may be used to redirect standard output to log file, this is not a codeblock option as such, but just a DOS/*nix shell usual standard output redirection
Retrieved from "https://wiki.codeblocks.org/index.php?title=Code::Blocks_command_line_arguments&oldid=9821"