• dashboard -configuration [<file>]

dashboard -configuration ~/.gdbinit.d/auto

dashboard -style prompt '(gdb)'

Modules Subcommands

• Every module adds its own subcommand dashboard <module> which is used to toggle the enable flag and to redisplay the dashboard.
• Modules may also declare additional subcommands, see help dashboard <module> from GDB.
• There are two additional predefined subcommands: -style and -output.

set auto-load safe-path /

Stylable Attributes

help dashboard -style

help dashboard <module> -style

• ANSI escape codes

python
 from pygments.styles import get_all_styles as styles
 for s in styles():
     print(s)
 end
 

python
 from pygments.styles import get_all_styles as styles
 for s in styles():
     c = 'dashboard -style syntax_highlighting {!r}'.format(s)
     gdb.execute(c)
     print(c)
     input()
 end
 

• Dividers

• label returns the module label which will appear in the divider.
• lines return a list of strings which will form the module content. When a module is temporarily unable to produce its content, it should return an empty list; its divider will then use the styles with the off qualifier.

• default is the initial value for this attribute.
• doc is the documentation of this attribute which will appear in the GDB help system. This key can be omitted.
• name is the name of the attribute of the Python object, defaults to the key value.
• type is the type of this attribute, it is used to coerce the value passed as an argument to the proper type, or raise an exception. This key defaults to the str type.
• check is a control callback which accept the coerced value and returns True if the value satisfies the constraint and False otherwise. This key is optional, when omitted no check is performed.

• action is the callback to be executed which accepts the raw input string from the GDB prompt. Callbacks may raise exceptions to notify erroneous situations which message will be shown automatically to the user.
• doc is the command documentation.
• completion is the completion policy, one of the gdb.COMPLETE_* constants defined in the reference manual. This key is optional and defaults to None which is equivalent to gdb.COMPLETE_NONE.

• Common Functions

• Example

class Notes(Dashboard.Module):
     """Simple user-defined notes."""
 
     def __init__(self):
         self.notes = []
 
     def label(self):
         return 'Notes'
 
     def lines(self, term_width, style_changed):
         out = []
         for note in self.notes:
             out.append(note)
             if self.divider:
                 out.append(divider())
         return out[:-1] if self.divider else out
 
     def add(self, arg):
         if arg:
             self.notes.append(arg)
         else:
             raise Exception('Cannot add an empty note')
 
     def clear(self, arg):
         self.notes = []
 
     def commands(self):
         return {
             'add': {
                 'action': self.add,
                 'doc': 'Add a note.'
             },
             'clear': {
                 'action': self.clear,
                 'doc': 'Remove all the notes.'
             }
         }
 
     def attributes(self):
         return {
             'divider': {
                 'doc': 'Divider visibility flag.',
                 'default': True,
                 'type': bool
             }
         }
 
 

dashboard notes
 dashboard notes add
 dashboard notes clear
 dashboard notes -style
 

Minimal Requirements:

Additional GDB front ends

• if the main debugging tool is GDB dashboard then it is recommended to prevent the front end from loading the .gdbinit file, they usually have an option to do so;
• otherwise it is possible to load GDB dashboard manually, that is, install as usual then:

mv ~/.gdbinit ~/.gdb-dashboard
 

source ~/.gdb-dashboard