Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

override_config_file(3alleg4) [debian man page]

override_config_file(3alleg4)					  Allegro manual				     override_config_file(3alleg4)

NAME

       override_config_file - Specifies a file containing config overrides. Allegro game programming library.

SYNOPSIS

       #include <allegro.h>

       void override_config_file(const char *filename);

DESCRIPTION

       Specifies  a file containing config overrides. These settings will be used in addition to the parameters in the main config file, and where
       a variable is present in both files this version will take priority. This can be used by application programmers to override  some  of  the
       config  settings from their code, while still leaving the main config file free for the end user to customise. For example, you could spec-
       ify a particular sample frequency and IBK instrument file, but the user could still use an `allegro.cfg' file to specify the port  settings
       and irq numbers.

       The override config file will not only take precedence when reading, but will also be used for storing values. When you are done with using
       the override config file, you can call override_config_file with a NULL parameter, so config data will be directly read	from  the  current
       config file again.

       Note:  The override file is completely independent from the current configuration. You can e.g. call set_config_file, and the override file
       will still be active. Also the flush_config_file function will only affect the current config file (which  can  be  changed  with  set_con-
       fig_file),  never  the  overriding one specified with this function. The modified override config is written back to disk whenever you call
       override_config_file.

       Example:

	  override_config_file("my.cfg");
	  /* This will read from my.cfg, and if it doesn't find a
	   * setting, will read from the current config file instead.
	   */
	  language = get_config_string("system", "language", NULL);
	  /* This will always write to my.cfg, no matter if the
	   * settings is already present or not.
	   */
	  set_config_string("system", "language", "RU");
	  /* This forces the changed setting to be written back to
	   * disk. Else it is written back at the next call to
	   * override_config_file, or when Allegro shuts down.
	   */
	  override_config_file(NULL);

       Note that this function and override_config_data() are mutually exclusive, i.e. calling one will cancel the effects of the other.

SEE ALSO

       override_config_data(3alleg4), set_config_file(3alleg4)

Allegro 							   version 4.4.2				     override_config_file(3alleg4)

Check Out this Related Man Page

packfile_password(3alleg4)					  Allegro manual					packfile_password(3alleg4)

NAME

       packfile_password - Sets the global I/O encryption password. Allegro game programming library.

SYNOPSIS

       #include <allegro.h>

       void packfile_password(const char *password);

DESCRIPTION

       Sets the encryption password to be used for all read/write operations on files opened in future using Allegro's packfile functions (whether
       they are compressed or not), including all the save, load and config routines. Files written with an encryption	password  cannot  be  read
       unless  the  same  password  is	selected, so be careful: if you forget the key, nobody can make your data come back again! Pass NULL or an
       empty string to return to the normal, non-encrypted mode. If you are  using  this  function  to	prevent  people  getting  access  to  your
       datafiles,  be careful not to store an obvious copy of the password in your executable: if there are any strings like "I'm the password for
       the datafile", it would be fairly easy to get access to your data :-)

       Note #1: when writing a packfile, you can change the password to whatever you want after opening the  file,  without  affecting	the  write
       operation.   On	the contrary, when writing a sub-chunk of a packfile, you must make sure that the password that was active at the time the
       sub-chunk was opened is still active before closing the sub-chunk. This is guaranteed to be true if you didn't call the packfile_password()
       routine in the meantime. Read operations, either on packfiles or sub-chunks, have no such restriction.

       Note  #2:  as  explained above, the password is used for all read/write operations on files, including for several functions of the library
       that operate on files without explicitly using packfiles (e.g. load_bitmap()).  The unencrypted mode is mandatory in order for those  func-
       tions  to  work.  Therefore remember to call packfile_password(NULL) before using them if you previously changed the password. As a rule of
       thumb, always call packfile_password(NULL) when you are done with operations on packfiles.  The only exception to this is custom  packfiles
       created with pack_fopen_vtable().

SEE ALSO

       pack_fopen(3alleg4), load_datafile(3alleg4), pack_fopen_vtable(3alleg4)

Allegro 							   version 4.4.2					packfile_password(3alleg4)
Man Page