Start Lazarus 3.0 and Set Up Its First Help Source

You will launch the installed Lazarus IDE, confirm which package supplied it, and understand the first useful documentation step: adding downloaded HTML help through the IDE's Help menu. This guide describes the Lazarus 3.0 package installed on this machine, version 3.0+dfsg1-8build3. Allow about fifteen minutes, plus however long you need to obtain the documentation files.

The workflow is intentionally small. It checks the local installation, starts the graphical program from a desktop session, and leaves project files and system configuration alone. No command here needs sudo. The IDE itself is a graphical application, so a usable display session is the main prerequisite.

1. Confirm the installed program

Start with read-only checks in a terminal. They do not open a window or change any files:

$ command -v lazarus-ide-3.0
/usr/bin/lazarus-ide-3.0
$ dpkg-query -W -f='${Package} ${Version} ${Architecture}\n' lazarus-ide-3.0
lazarus-ide-3.0 3.0+dfsg1-8build3 amd64

Your architecture or package revision may differ. The useful result is that the command resolves to the installed executable and the package query succeeds. On this installation, /usr/bin/lazarus-ide-3.0 is a launcher for the packaged Lazarus 3.0 installation.

2. Launch the IDE from a graphical session

Run the command as your ordinary desktop user:

$ lazarus-ide-3.0

A Lazarus window should open. The manpage describes an editor, a form editor, online help and a debugger, with the windowing system providing the user interface. This command is a launcher, not a compiler-only command, so a remote text-only shell is not enough.

If the terminal reports that GTK cannot open a display, the command itself is installed but your shell does not have access to a graphical display. Log in to the desktop session and run it there, or use the display-forwarding method supported by your remote environment. Do not try sudo as a display fix. Running a graphical IDE as root can create root-owned settings and project files in your home directory.

Leave this terminal available while you test the window. If the IDE exits immediately, capture the terminal message and check the display session before changing any Lazarus settings.

3. Check the working areas before editing

The IDE is designed for repeated edit, compile and debug cycles. Before creating or opening a project, decide where its source should live and make sure your normal user can write there:

$ mkdir -p "$HOME/src/lazarus/example"
$ test -w "$HOME/src/lazarus/example" && echo 'directory is writable'
directory is writable

Replace the example path with a directory you control. The mkdir command changes your home directory, but it does not touch system files and can be undone with rmdir while the directory is empty. Do not create a project under /usr, /opt or another system-owned location just to avoid a write error. If an existing project is read-only, fix its ownership or choose a writable working copy through your normal administrative process.

Use the IDE's project and file dialogs for the next step. The installed manpage does not define a command-line project syntax, project-file format or build option set, so do not guess flags after the executable name. Those details belong to the Lazarus online manual or to the separate lazbuild(1) command listed in the manpage's cross-references.

4. Add HTML documentation through Help

The package does not provide help files by default. In the open IDE, obtain the Lazarus and Free Pascal documentation in HTML format from the project sources you trust. Then use the menu path Help -> Configure Help and add the local HTML documentation there.

The menu is a configuration change inside Lazarus, not a system-wide installation. Keep the downloaded files in a stable directory that your user can read. If you later move that directory, return to the same configuration screen and update the location. There is no need for elevated privileges.

5. Keep the first compile and debug cycle contained

Open or create a small project in the writable directory, make one narrow edit, and use the IDE's normal compile and debug controls. The manpage confirms that the IDE uses the Free Pascal Compiler, or FPC, and supports Linux among its main targets. It does not promise a particular project template, keyboard shortcut, compiler version or debugger configuration, so read the status messages shown by your installed IDE rather than copying a shortcut from another release.

Keep the first test separate from valuable source. If a build generates files beside the project, inspect the project directory afterwards:

$ find "$HOME/src/lazarus/example" -maxdepth 1 -type f -printf '%f\n' | sort

The listing is diagnostic only. Do not delete files until you know which ones are source, project metadata or build output. If you need to abandon a test, close the IDE, copy any source you want to keep, and remove only the disposable test directory after checking its contents.

Common traps

• No display: a successful package lookup does not create a graphical session. Run the IDE where GTK can reach a display.
• Missing help: no HTML help is installed by default. Configure a real local documentation directory through the Help menu.
• Wrong command: the manpage's synopsis is simply lazarus; the Debian-style installed name here is lazarus-ide-3.0. Use command -v before changing scripts.
• Root-owned files: do not prepend sudo to a desktop IDE launch or to project work in your home directory.
• Stale instructions: this quick-reference manpage is dated 19 April 2008 and warns that the online manual is updated more often. Treat undocumented flags and menu details as unverified until checked in the running IDE.