From 5c5c4d207cada9bc2f23ea92e23d45696daf7f94 Mon Sep 17 00:00:00 2001 From: Basile Burg Date: Thu, 7 Dec 2017 14:30:35 +0100 Subject: [PATCH] update documentation --- docs/features_runnables.md | 1 + docs/index.md | 2 +- docs/menu_file.md | 7 ++++--- docs/options_application.md | 1 + docs/options_dub_build.md | 1 + 5 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/features_runnables.md b/docs/features_runnables.md index 1d2cd365..f6c4b100 100644 --- a/docs/features_runnables.md +++ b/docs/features_runnables.md @@ -40,6 +40,7 @@ Options are detected after the first non white character of the script line. In general the program output is redirected to the [messages](widgets_messages). This is true unless the _Compile file and run outside_ or the _Run compiled file outside_ actions are used. +Note that in this case the [consoleProgram global options](options_application) allows to define the terminal used. When the program is not run outside, the [process input widget](widgets_process_input) is used to pass input to the runnable. diff --git a/docs/index.md b/docs/index.md index 0075a8cd..8e281866 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,7 +10,7 @@ title: index ![](img/coedit_kde4_thumb.png) -This documentation is based on version 3, update 4. +This documentation is based on version 3.5.1 #### First steps diff --git a/docs/menu_file.md b/docs/menu_file.md index f98f82a0..086184fb 100644 --- a/docs/menu_file.md +++ b/docs/menu_file.md @@ -8,9 +8,10 @@ title: Widgets - application options ### File menu - reference -- **New empty file**: Adds a new, untyped, file to the source editor. -- **New runnable module**: adds a new file with a `main()` function. See [runnables modules](features_runnables). -- **New DUB script**: adds a new file with a `main()` function and an inline DUB description. The file can be executed as a script with **Run DUB single file package** or **Run DUB single file package outside**. +- **New empty module**: Creates a new empty module. +- **New runnable module**: Creates a new module with a `main()` function. See [runnables modules](features_runnables). +- **New module from clipboard**: Creates a new module, immediatly filled with the clipboard content. +- **New DUB script**: Creates a new module with a `main()` function and an embedded DUB receipt. The module can be executed as a script with **Run DUB single file package** or **Run DUB single file package outside**. - **Open file...**: Proposes to open a D source file from an open dialog. - **Open recent**: Displays the list of the most recently opened files. - **Close file**: Closes the current editor with an optional warning if its content is modified. diff --git a/docs/options_application.md b/docs/options_application.md index 3fa5cb5b..2cee74e4 100644 --- a/docs/options_application.md +++ b/docs/options_application.md @@ -17,6 +17,7 @@ The page exposes unsorted options. In the future some of them might be moved to - **additionalPATH**: Used to defined more paths were the background tools can be found. Each item must be separated by a path separator (`:` under Linux and `;` under Windows). - **autoCheckUpdates**: If checked and if a newer release is available then a dialog proposes to open the matching html page on github. - **autoSaveProjectFiles**: If checked the sources are automatically saved before compilation. +- **consoleProgram**: Allows to set the terminal emulator used to execute programs. By default XTerm is used and an error can occur if it's not setup. The setting is used by the [runnable modules](features_runnables), the [custom tools](widgets_custom_tools) and the project launcher. Under Windows this option is not used. - **coverModuleTests**: If checked then the coverage by the tests is measured and displayed in the messages after executing the action __File/Run file unittests__. - **dcdPort**: Sets the port used by the [completion daemon](features_dcd) server. `0` means the default value. - **dscanUnittests**: If checked the content of the `unittest` blocks are analyzed when using the action __File/Verify with Dscanner__. Do not activate if the results of the static analysis tend to generate irrelevant messages in the tests. diff --git a/docs/options_dub_build.md b/docs/options_dub_build.md index a96fb43d..0d3c0550 100644 --- a/docs/options_dub_build.md +++ b/docs/options_dub_build.md @@ -19,6 +19,7 @@ This category exposes the DUB options that are passed to the build tool each tim - **linkMode**: Specifies the way the compiler and linker are invoked. - **other**: Displays a list that can be filled with more switches. One item per line. - **parallel**: If checked, tries to build using several CPU. +- **showConsole**: If checked, the [consoleProgram set in the global options](options_application) is shown and used to execute DUB. See also [the official DUB command line reference](http://code.dlang.org/docs/commandline) for more detailed descriptions.