KDevelop5/Manual/Running programs/en: Difference between revisions

From KDE Wiki Sandbox
(Importing a new version from external source)
(Updating to match new version of source page)
Line 3: Line 3:
== Running programs in KDevelop ==
== Running programs in KDevelop ==


Once you have built a program, you will want to run it. To do this, need to configure ''Launches'' for your projects. A ''Launch'' consists of the name of an executable, a set of command line parameters, and an execution environment (such as "run this program in a shell", or "run this program in the debugger").
Once you have built a program, you will want to run it. To do this, need to configure ''Launches'' for your project. A ''Launch'' consists of the name of an executable, a set of command line parameters, and an execution environment (such as "run this program in an external terminal", or "run this program in the debugger").
<span id="Setting up launches in KDevelop"></span>
<span id="Setting up launches in KDevelop"></span>
=== Setting up launches in KDevelop ===
=== Setting up launches in KDevelop ===


[[Image:kdevelop-2.png|thumb|400px|center]]
[[File:Kdevelop-nano-launch-config.png|500px|thumb|center]]


To set this up go to menu item <menuchoice>Run -> Configure launches</menuchoice>, highlight the project you want to add a launch for, and click on the {{Plus}} button. Then enter the name of the executable, and the path where you want to run the program. If running the executable depends on building the executable and/or other libraries first, then you may want to add them to the list at the bottom: select <menuchoice>Build</menuchoice> from the dropdown menu, then hit the {{Icon|folder}} symbol to the right of the textbox and select whatever target you want to have built. In the example above, I have selected the target <menuchoice>all</menuchoice> from project '''''1.deal.II''''' and '''''step-32''''' from project '''''1.step-32''''' to make sure both the base library and the application program have been compiled and are up to date before the program is actually executed. While you're there, you may as well also configure a debug launch by clicking on the <menuchoice>Debug</menuchoice> symbol and adding the name of the debugger program; if this is the system's default debugger (e.g. '''gdb''' on Linux), then you don't need to do this step.
To set this up go to menu item <menuchoice>Run -> Configure launches</menuchoice>, highlight the project you want to add a launch for, and click on the {{Plus}} button. Then enter the name and location of the executable, and the path where you want to run the program.  Any required command line arguments if any, can be specified in the <menuchoice>Arguments:</menuchoice> edit box. If running the executable depends on building the executable and/or other libraries first, then you may want to add them to the list at the bottom: select <menuchoice>Build</menuchoice> from the dropdown <menuchoice>Action:</menuchoice> menu, then hit the {{Icon|folder}} symbol to the right of the textbox and select whatever target you want to have built. While you're there, you may as well also configure a debug launch by clicking on the <menuchoice>Debug</menuchoice> symbol and adding the name of the debugger program; if this is the system's default debugger (e.g. '''gdb''' on Linux), then you don't need to do this step.


[[Image:kdevelop-3.png|thumb|650px|center]]
[[File:KDevelop-arguments-config.png.png|800px|thumb|center]]


You can now try to run the program: Select <menuchoice>Run -> Execute Launch</menuchoice> from '''KDevelop's''' main window menu (or hit <keycap>Shift + F9</keycap>) and your program should run in a separate subwindow of '''KDevelop'''. The picture above shows the result: The new <menuchoice>Run</menuchoice> tool subwindow at the bottom shows the output of the program that is being run, in this case of the '''''step-32''''' program.
If you need to build the executable or add libraries before running it,add the dependencies tab at the bottom of the page,
* select <menuchoice>Build</menuchoice> from the dropdown <menuchoice>Action:</menuchoice> menu.
* Select the {{Icon|folder}} symbol to the right of the textbox and select whatever target you want to have built.
* Click Ok.
 
To configure a debug launch:
*  Select on the <menuchoice>Debug</menuchoice> symbol under the selected launch configuration on the left tab.
*  add the path to the debugger program.
 
if this is the system's default debugger (e.g. '''gdb''' on Linux), then you don't need to do this step.
 
[[File:Kdevelop-after-nano-run.png|650px|thumb|center]]
 
You can now try to run the program: Select <menuchoice>Run -> Execute Launch</menuchoice> from '''KDevelop's''' main window menu (or hit <keycap>Shift + F9</keycap>) and your program should run in an external ''terminal window'' of '''KDevelop'''. The picture above shows the result: The new <menuchoice>Run</menuchoice> tool subwindow at the bottom shows the output of the program that is being run, in this case the '''''nano''''' text editing program.


{{Note|1= If you have configured multiple launches, you can choose which one should run when you hit <keycap>Shift + F9</keycap> by going to <menuchoice>Run -> Current Launch Configuration</menuchoice>. There is a non-obvious way to edit the name of a configuration, however: in the dialog box you get when you select <menuchoice>Run -> Current Launch Configuration</menuchoice>, double-click on the name of the configuration in the tree view on the left, which will allow you to edit the configuration's name.}}
{{Note|1= If you have configured multiple launches, you can choose which one should run when you hit <keycap>Shift + F9</keycap> by going to <menuchoice>Run -> Current Launch Configuration</menuchoice>. There is a non-obvious way to edit the name of a configuration, however: in the dialog box you get when you select <menuchoice>Run -> Current Launch Configuration</menuchoice>, double-click on the name of the configuration in the tree view on the left, which will allow you to edit the configuration's name.}}
Line 24: Line 37:
|-
|-


| <keycap>F8</keycap>
| style="width: 15%"|<keycap>F8</keycap>  
| Build (call make)
| style="width: 85%"|Build (call make)
|-
|-


| <keycap>Shift + F9</keycap>
| <keycap>Shift + F9</keycap>  
| Run
| Run
|-
|-


| <keycap>F9</keycap>
| <keycap>F9</keycap>  
| Run program in the debugger; you may want to set breakpoints beforehand, for example by right-clicking with the mouse on a particular line in the source code
| Run program in the debugger; you may want to set breakpoints beforehand, for example by right-clicking with the mouse on a particular line in the source code
|-
|}
|}
{{Prevnext2
{{Prevnext2

Revision as of 10:01, 6 September 2020

Running programs in KDevelop

Once you have built a program, you will want to run it. To do this, need to configure Launches for your project. A Launch consists of the name of an executable, a set of command line parameters, and an execution environment (such as "run this program in an external terminal", or "run this program in the debugger").

Setting up launches in KDevelop

To set this up go to menu item Run -> Configure launches, highlight the project you want to add a launch for, and click on the button. Then enter the name and location of the executable, and the path where you want to run the program. Any required command line arguments if any, can be specified in the Arguments: edit box. If running the executable depends on building the executable and/or other libraries first, then you may want to add them to the list at the bottom: select Build from the dropdown Action: menu, then hit the symbol to the right of the textbox and select whatever target you want to have built. While you're there, you may as well also configure a debug launch by clicking on the Debug symbol and adding the name of the debugger program; if this is the system's default debugger (e.g. gdb on Linux), then you don't need to do this step.

If you need to build the executable or add libraries before running it,add the dependencies tab at the bottom of the page,

  • select Build from the dropdown Action: menu.
  • Select the symbol to the right of the textbox and select whatever target you want to have built.
  • Click Ok.

To configure a debug launch:

  • Select on the Debug symbol under the selected launch configuration on the left tab.
  • add the path to the debugger program.

if this is the system's default debugger (e.g. gdb on Linux), then you don't need to do this step.

You can now try to run the program: Select Run -> Execute Launch from KDevelop's main window menu (or hit Shift + F9) and your program should run in an external terminal window of KDevelop. The picture above shows the result: The new Run tool subwindow at the bottom shows the output of the program that is being run, in this case the nano text editing program.

Note
If you have configured multiple launches, you can choose which one should run when you hit Shift + F9 by going to Run -> Current Launch Configuration. There is a non-obvious way to edit the name of a configuration, however: in the dialog box you get when you select Run -> Current Launch Configuration, double-click on the name of the configuration in the tree view on the left, which will allow you to edit the configuration's name.


Some useful keyboard shortcuts

Running a program
F8 Build (call make)
Shift + F9 Run
F9 Run program in the debugger; you may want to set breakpoints beforehand, for example by right-clicking with the mouse on a particular line in the source code