git.sur5r.net Git - i3/i3/blob - PACKAGE-MAINTAINER

   1 Dear package maintainer,
   2
   3 thanks for packaging i3. By doing so, you are improving your distribution
   4 and i3 in general.
   5
   6 Please read the file DEPENDS now, so you know which libraries are necessary
   7 and where to get them from if your distribution does not already have
   8 packages for them.
   9
  10 Please make sure the manpage for i3 will be properly created and installed
  11 in your package.
  12
  13 Please check the i3-sensible-{editor,pager,terminal} scripts and modify them if
  14 necessary. The former two provide fallbacks in case $PAGER or $EDITOR is not
  15 set (which might be more common than you think, because they have to be set in
  16 ~/.xsession, not in the shell configuration!) while the latter tries to launch
  17 a terminal emulator. The scripts are most prominently used in i3-nagbar, which
  18 alerts the user when the configuration is broken for some reason. Also,
  19 i3-sensible-terminal is used in the default configuration.
  20
  21 If your distribution has a mechanism to get the preferred terminal, such as the
  22 x-terminal-emulator symlink in Debian, please use it in i3-sensible-terminal.
  23
  24 On debian, compilation and installing the manpages looks like this:
  25
  26         # Compilation
  27         $(MAKE)
  28         $(MAKE) -C man
  29
  30         # Installation
  31         $(MAKE) DESTDIR=$(CURDIR)/debian/i3-wm/ install
  32         mkdir -p $(CURDIR)/debian/i3-wm/usr/share/man/man1
  33         cp man/*.1 $(CURDIR)/debian/i3-wm/usr/share/man/man1
  34
  35 Please make sure that i3-migrate-config-to-v4 and i3-config-wizard are
  36 installed with i3. The Perl script is necessary to (automatically) convert v3
  37 configs to v4. The wizard provides the possibility to create a keysym-based
  38 config with the user’s preferred modifier and should be started on the first
  39 start of i3 (it will automatically exit if it finds a config file).
  40
  41 If you have any questions, ideas, hints, problems or whatever, please do not
  42 hesitate to contact me. I will help you out. Just drop me an E-Mail (find the
  43 address at http://michael.stapelberg.de/Kontakt, scroll down to bottom),
  44 contact me using the same address in jabber or ask on our IRC channel:
  45 (#i3 on irc.twice-irc.de).
  46
  47 Thanks again for your efforts,
  48 Michael