Mirandaboot.ini/en: Difference between revisions

From Miranda NG
Mirandaboot.ini/en
Jump to navigation Jump to search
No edit summary
(Updating to match new version of source page)
 
(16 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{PageLang|en}}{{Languages}}
<languages/>
{{DISPLAYTITLE:mirandaboot.ini}}
File '''mirandaboot.ini''' contains the information required to get Miranda NG up and running, i.e., everything before a database is loaded.
<pre style="overflow:auto;height:400px;">
;This file contains the information required to get Miranda up and running,
;i.e., everything before a database is loaded


;Settings relating to the location and loading of the database
__TOC__
[Database]


;ProfileDir
== Content of the file ==
;The directory to search for database files. If it's a relative path then
{{nbsp|5}}''See: [[mirandaboot.ini/Raw file|mirandaboot.ini]]''
;it's relative to the directory containing Miranda32.exe / Miranda64.exe.
;If no directory specified, Profiles subdirectory in Miranda executable
;directory is assumed. You can use environment variables.
;To comply with Windows security guidelines, it is recommended that you keep
;your profile in %APPDATA%\Miranda NG
ProfileDir=


;ShowProfileMgr
== Description of parameters ==
;Selects the test to use to decide whether to show the profile manager on
;startup
;"never": Only show it if the profile to use can't be guessed by any means
;"yes":  Always show it
;"smart": (default) Show it if the command line doesn't contain a db name
;        that exists or there is more or less than 1 db in the ProfileDir
ShowProfileMgr=smart


;DefaultProfile
=== [Database] ===
;Name of the profile to use if there's a choice. If Miranda is run with a
Settings related to the location and loading of the database.
;command line parameter then that is used instead of this setting.
;Default is empty.
;If ShowProfileMgr=never then this profile is run without question.
;Otherwise the profile manager is run as usual but initially this profile
;is selected.
;This string can contain environment variables, e.g., %USERNAME%
DefaultProfile=


;AutoCreate
==== ProfileDir ====
;"yes": If DefaultProfile or the command line parameter gives a profile
Allows you to specify the directory to search for database files. You can use environment variables.
;name that doesn't exist then that profile is created
;"no": (default) The profile manager is shown in this case
AutoCreate=no


;RememberPassword
If it's a relative path then it's relative to the directory containing Miranda*.exe file.
;if enabled, will store password into Windows Credential Manager
RememberPassword=0


;AutoExec is a system for batch addition of multiple settings to the database.
To comply with Windows security guidelines, it is recommended that you keep your profile in %APPDATA%\Miranda NG.
;See https://github.com/miranda-ng/miranda-ng/blob/master/docs/autoexec_sample.ini for documentation.
[AutoExec]


;Use
If you do not specify directory, then default will be used, which is <code>Profiles</code> subdirectory in Miranda NG root folder.
;"yes": Install .ini files automatically
ProfileDir=
;"no": Disable the autoexec system entirely
;"prompt": (default) Prompt the user before each installation
;This setting doesn't affect the decision of whether to display further prompts
Use=prompt


;Glob
;A global expression containing the files to watch for database settings.
;This will be checked just after database load and continuously all the
;time Miranda is running.
;If this contains a relative path, it's relative to the directory containing
;Miranda32.exe / Miranda64.exe.
;Default: autoexec_*.ini
Glob=autoexec_*.ini


;Safe
==== ShowProfileMgr ====
;A space-separated list of database module names known to be safe to alter.
Decides whether to show the profile manager on Miranda NG startup.
;Default: CLC Icons CLUI CList SkinSounds
Safe=CLC Icons CLUI CList SkinSounds


;Unsafe
Accepts values:
;A space-separated list of database module names that could be altered for
* <code>never</code> — Show it only if the profile to use can't be guessed by any means.
;malicious purposes (e.g., by faking a login server to steal passwords).
* <code>yes</code> — Show it always.
;Default: AIM Facebook GG ICQ IRC JABBER MRA MSN SKYPE Tlen TWITTER VKontakte XFire
* <code>smart</code> — (default) Show it if the command line doesn't contain a database name that exists and there is more or less than one database file in the [[#ProfileDir|ProfileDir]].
Unsafe=AIM Facebook GG ICQ IRC JABBER MRA MSN SKYPE Tlen TWITTER VKontakte XFire
ShowProfileMgr=smart


;OverrideSecurityFilename
;System admins may find it desirable to install settings without prompting
;the user. In that case all prompts and security will be overridden if
;the name of the ini matches the name given here.
;If this is used, make sure it's suitably random and hence not likely
;to be downloaded.
;Default is empty (no override possible)
OverrideSecurityFilename=


;OnCreateFilename
==== DefaultProfile ====
;Defines .ini file that will be executed every time new profile is created.
Name of the profile to use if there's a choice. It can contain environment variables, e.g., <code>%USERNAME%</code>.
;Default is empty (no override possible)
OnCreateFilename=


;Warn
If Miranda is run with a command line parameter then that parameter is used instead of this setting.
;"all": Warn the user before each setting change is made
;"notsafe": (default) Warn before each change to a setting in a group
;          that isn't listed in the 'Safe' setting
;"onlyunsafe": Warn before each change to a setting in a group that is
;              listed in the 'Unsafe' setting
;"none": Never warn the user
Warn=notsafe


;OnCompletion
If [[#ShowProfileMgr|ShowProfileMgr=never]] then this profile is run without a question. Otherwise the profile manager is run as usual but initially this profile is selected.
;What to do with the .ini file once it's imported
;"delete": Delete the file from the disk
;"recycle": (default) Move the file to the recycle bin (same as delete
;          if you've disabled Windows' recycle bin)
;"rename": Add the string in RenamePrefix to the beginning of the filename
;"leave": Leave the file as-is. Note that this could cause it to be
;        imported multiple times until it's moved
;"ask": Show a dialog to ask the user
OnCompletion=recycle


;RenamePrefix
Default value: It is empty.
;A string to add before the filename if the 'rename' option is used for
DefaultProfile=
;OnCompletion. This can include a path specifier to move the file, e.g., ..\
;Default: done_
RenamePrefix=done_


; decisions about how Miranda loads plugins
[PluginLoader]


; if enabled, will ask the user if they want to re-enable a disabled plugin
==== AutoCreate ====
AskAboutIgnoredPlugins=0
Accepts values:
* <code>yes</code> — If [[#DefaultProfile|DefaultProfile]] setting or the command line parameter gives a profile name that doesn't exist then that profile is created.
* <code>no</code> — (default) The profile manager is shown in this case.
AutoCreate=no


; language related settings
[Language]


; DefaultLanguage
==== RememberPassword ====
; Stores the name of the default language pack to be loaded at startup.
When set to <code>1</code> it will store password in Windows Credential Manager.
; If skipped, loads the first file that matches the langpack_*.txt mask.
 
; "default": Built-in English language
Default value: <code>0</code>
; DefaultLanguage=langpack_german.txt
RememberPassword=0
DefaultLanguage=
 
</pre>
 
[[Category:Help]]
==== SilentUpgrade ====
When set to <code>1</code> it will not show notification window about database upgrade.
 
Default value: <code>0</code>
SilentUpgrade=0
 
=== [AutoExec] ===
AutoExec is a system for batch addition of multiple settings to the database.
==== Use ====
Accepts values:
* <code>yes</code> — Install .ini files automatically.
* <code>no</code> — Disable the AutoExec system entirely.
* <code>prompt</code> — (default) Prompt the user before each installation. This setting doesn't affect the decision of whether to display further prompts.
Use=prompt
 
 
==== Glob ====
A global expression containing the files to watch for database settings. This will be checked just after database load and continuously all the time Miranda is running.
 
If this contains a relative path, it's relative to the directory containing Miranda*.exe file.
 
Default value: <code>autoexec_*.ini</code>
Glob=autoexec_*.ini
 
 
==== Safe ====
A space-separated list of database module names known to be safe to alter.
 
Default value: <code>CLC Icons CLUI CList SkinSounds</code>
Safe=CLC Icons CLUI CList SkinSounds
 
 
==== Unsafe ====
A space-separated list of database module names that could be altered for malicious purposes (e.g., by faking a login server to steal passwords).
 
Default value: <code>Facebook GG ICQ IRC JABBER SKYPE TWITTER VKontakte</code>
Unsafe=Facebook GG ICQ IRC JABBER SKYPE TWITTER
 
 
==== OverrideSecurityFilename ====
System administrators may find it desirable to install settings without prompting the user. In that case all prompts and security will be overridden if the name of the .ini file matches the name given here.
 
If this is used, make sure it's suitably random and hence not likely to be downloaded.
 
Default value: It is empty (no override possible).
OverrideSecurityFilename=
 
 
==== OnCreateFilename ====
Defines .ini file that will be executed every time new profile is created.
 
Default value: It is empty (no override possible).
OnCreateFilename=
 
 
==== Warn ====
Accepts values:
* <code>all</code> — Warn the user before each setting change is made.
* <code>notsafe</code> — (default) Warn before each change to a setting in a group that isn't listed in the [[#Safe|Safe]] setting.
* <code>onlyunsafe</code> — Warn before each change to a setting in a group that is listed in the [[#Unsafe|Unsafe]] setting.
* <code>none</code> — Never warn the user.
Warn=notsafe
 
 
==== OnCompletion ====
Defines what to do with the .ini file once it's imported.
 
Accepts values:
* <code>delete</code> — Delete the file from the disk.
* <code>recycle</code> — (default) Move the file to the recycle bin (same as <code>delete</code> if you've disabled Windows' recycle bin).
* <code>rename</code> — Add the string from the [[#RenamePrefix|RenamePrefix]] setting to the beginning of the filename.
* <code>leave</code> — Leave the file as-is. Note that this could cause it to be imported multiple times until it's moved.
* <code>ask</code> — Show a dialog to ask the user.
OnCompletion=recycle
 
==== RenamePrefix ====
A string to add before the filename if the <code>rename</code> option is used for [[#OnCompletion|OnCompletion]] setting. This can include a path specifier to move the file, e.g., <code>..\</code>
 
Default value: <code>done_</code>
RenamePrefix=done_
 
=== [PluginLoader] ===
Settings that determine how plugins are loaded.
 
==== AskAboutIgnoredPlugins ====
When set to <code>1</code>, will ask if re-enable a disabled plugin.
 
Default value: <code>0</code>
AskAboutIgnoredPlugins=0
 
=== [Language] ===
Language related settings.
 
==== DefaultLanguage ====
Stores the name of the default language pack to be loaded at startup. If skipped, loads the first file that matches the <code>langpack_*.txt</code> mask.
 
Example: <code>DefaultLanguage=langpack_german.txt</code>
 
It also accepts value of:
* <code>default</code> — Built-in English language.
 
Default value: It is empty.
DefaultLanguage=
 
 
=== [Interface] ===
Interface related settings.
==== DpiAware ====
{{Strong|Experimental!}} Enables HiDPI ("Retina Display") support when set to <code>1</code>.
 
Default value: <code>0</code>
DpiAware=0
 
[[Category:Help{{#translation:}}]]

Latest revision as of 22:16, 28 March 2022

File mirandaboot.ini contains the information required to get Miranda NG up and running, i.e., everything before a database is loaded.

Content of the file

     See: mirandaboot.ini

Description of parameters

[Database]

Settings related to the location and loading of the database.

ProfileDir

Allows you to specify the directory to search for database files. You can use environment variables.

If it's a relative path then it's relative to the directory containing Miranda*.exe file.

To comply with Windows security guidelines, it is recommended that you keep your profile in %APPDATA%\Miranda NG.

If you do not specify directory, then default will be used, which is Profiles subdirectory in Miranda NG root folder.

ProfileDir=


ShowProfileMgr

Decides whether to show the profile manager on Miranda NG startup.

Accepts values:

  • never — Show it only if the profile to use can't be guessed by any means.
  • yes — Show it always.
  • smart — (default) Show it if the command line doesn't contain a database name that exists and there is more or less than one database file in the ProfileDir.
ShowProfileMgr=smart


DefaultProfile

Name of the profile to use if there's a choice. It can contain environment variables, e.g., %USERNAME%.

If Miranda is run with a command line parameter then that parameter is used instead of this setting.

If ShowProfileMgr=never then this profile is run without a question. Otherwise the profile manager is run as usual but initially this profile is selected.

Default value: It is empty.

DefaultProfile=


AutoCreate

Accepts values:

  • yes — If DefaultProfile setting or the command line parameter gives a profile name that doesn't exist then that profile is created.
  • no — (default) The profile manager is shown in this case.
AutoCreate=no


RememberPassword

When set to 1 it will store password in Windows Credential Manager.

Default value: 0

RememberPassword=0


SilentUpgrade

When set to 1 it will not show notification window about database upgrade.

Default value: 0

SilentUpgrade=0

[AutoExec]

AutoExec is a system for batch addition of multiple settings to the database.

Use

Accepts values:

  • yes — Install .ini files automatically.
  • no — Disable the AutoExec system entirely.
  • prompt — (default) Prompt the user before each installation. This setting doesn't affect the decision of whether to display further prompts.
Use=prompt


Glob

A global expression containing the files to watch for database settings. This will be checked just after database load and continuously all the time Miranda is running.

If this contains a relative path, it's relative to the directory containing Miranda*.exe file.

Default value: autoexec_*.ini

Glob=autoexec_*.ini


Safe

A space-separated list of database module names known to be safe to alter.

Default value: CLC Icons CLUI CList SkinSounds

Safe=CLC Icons CLUI CList SkinSounds


Unsafe

A space-separated list of database module names that could be altered for malicious purposes (e.g., by faking a login server to steal passwords).

Default value: Facebook GG ICQ IRC JABBER SKYPE TWITTER VKontakte

Unsafe=Facebook GG ICQ IRC JABBER SKYPE TWITTER


OverrideSecurityFilename

System administrators may find it desirable to install settings without prompting the user. In that case all prompts and security will be overridden if the name of the .ini file matches the name given here.

If this is used, make sure it's suitably random and hence not likely to be downloaded.

Default value: It is empty (no override possible).

OverrideSecurityFilename=


OnCreateFilename

Defines .ini file that will be executed every time new profile is created.

Default value: It is empty (no override possible).

OnCreateFilename=


Warn

Accepts values:

  • all — Warn the user before each setting change is made.
  • notsafe — (default) Warn before each change to a setting in a group that isn't listed in the Safe setting.
  • onlyunsafe — Warn before each change to a setting in a group that is listed in the Unsafe setting.
  • none — Never warn the user.
Warn=notsafe


OnCompletion

Defines what to do with the .ini file once it's imported.

Accepts values:

  • delete — Delete the file from the disk.
  • recycle — (default) Move the file to the recycle bin (same as delete if you've disabled Windows' recycle bin).
  • rename — Add the string from the RenamePrefix setting to the beginning of the filename.
  • leave — Leave the file as-is. Note that this could cause it to be imported multiple times until it's moved.
  • ask — Show a dialog to ask the user.
OnCompletion=recycle

RenamePrefix

A string to add before the filename if the rename option is used for OnCompletion setting. This can include a path specifier to move the file, e.g., ..\

Default value: done_

RenamePrefix=done_

[PluginLoader]

Settings that determine how plugins are loaded.

AskAboutIgnoredPlugins

When set to 1, will ask if re-enable a disabled plugin.

Default value: 0

AskAboutIgnoredPlugins=0

[Language]

Language related settings.

DefaultLanguage

Stores the name of the default language pack to be loaded at startup. If skipped, loads the first file that matches the langpack_*.txt mask.

Example: DefaultLanguage=langpack_german.txt

It also accepts value of:

  • default — Built-in English language.

Default value: It is empty.

DefaultLanguage=


[Interface]

Interface related settings.

DpiAware

Experimental! Enables HiDPI ("Retina Display") support when set to 1.

Default value: 0

DpiAware=0