Mon Jul 9 15:48:14 2012 UTC ()
Update documentation on how to handle setgid and games.


(wiz)
diff -r1.108 -r1.109 pkgsrc/doc/guide/files/fixes.xml

cvs diff -r1.108 -r1.109 pkgsrc/doc/guide/files/fixes.xml (expand / switch to unified diff)

--- pkgsrc/doc/guide/files/fixes.xml 2012/05/26 22:13:25 1.108
+++ pkgsrc/doc/guide/files/fixes.xml 2012/07/09 15:48:13 1.109
@@ -1,14 +1,14 @@ @@ -1,14 +1,14 @@
1<!-- $NetBSD: fixes.xml,v 1.108 2012/05/26 22:13:25 wiz Exp $ --> 1<!-- $NetBSD: fixes.xml,v 1.109 2012/07/09 15:48:13 wiz Exp $ -->
2 2
3<chapter id="fixes"> <?dbhtml filename="fixes.html"?> 3<chapter id="fixes"> <?dbhtml filename="fixes.html"?>
4<title>Making your package work</title> 4<title>Making your package work</title>
5 5
6<sect1 id="general-operation"> 6<sect1 id="general-operation">
7 <title>General operation</title> 7 <title>General operation</title>
8 8
9 <sect2 id="portability-of-packages"> 9 <sect2 id="portability-of-packages">
10 <title>Portability of packages</title> 10 <title>Portability of packages</title>
11 11
12 <para>One appealing feature of pkgsrc is that it runs on many 12 <para>One appealing feature of pkgsrc is that it runs on many
13 different platforms. As a result, it is important to ensure, 13 different platforms. As a result, it is important to ensure,
14 where possible, that packages in pkgsrc are portable. This 14 where possible, that packages in pkgsrc are portable. This
@@ -1302,36 +1302,33 @@ ${INSTALL_DATA_DIR} ${PREFIX}/dir2 @@ -1302,36 +1302,33 @@ ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1302 <quote>--with-html-dir=${PREFIX}/share/doc</quote>. 1302 <quote>--with-html-dir=${PREFIX}/share/doc</quote>.
1303 <filename>${PREFIX}/share/gtk-doc</filename> is preferred 1303 <filename>${PREFIX}/share/gtk-doc</filename> is preferred
1304 though.)</para> 1304 though.)</para>
1305 1305
1306 </sect2> 1306 </sect2>
1307 1307
1308 <sect2 id="installing-score-files"> 1308 <sect2 id="installing-score-files">
1309 <title>Installing highscore files</title> 1309 <title>Installing highscore files</title>
1310 1310
1311 <para>Certain packages, most of them in the games category, install 1311 <para>Certain packages, most of them in the games category, install
1312 a score file that allows all users on the system to record their 1312 a score file that allows all users on the system to record their
1313 highscores. In order for this to work, the binaries need to be 1313 highscores. In order for this to work, the binaries need to be
1314 installed setgid and the score files owned by the appropriate 1314 installed setgid and the score files owned by the appropriate
1315 group and/or owner (traditionally the "games" user/group). The 1315 group and/or owner (traditionally the "games" user/group). Set
 1316 <varname>USE_GAMESGROUP</varname> to yes to support this. The
1316 following variables, documented in more detail in 1317 following variables, documented in more detail in
1317 <filename>mk/defaults/mk.conf</filename>, control this 1318 <filename>mk/defaults/mk.conf</filename>, control this
1318 behaviour: <varname>SETGIDGAME</varname>, 1319 behaviour: <varname>GAMEDATAMODE</varname>,
1319 <varname>GAMEDATAMODE</varname>, <varname>GAMEGRP</varname>, 1320 <varname>GAMEDIRMODE</varname>, <varname>GAMES_GROUP</varname>,
1320 <varname>GAMEMODE</varname>, <varname>GAMEOWN</varname>.</para> 1321 <varname>GAMEMODE</varname>, <varname>GAME_USER</varname>.</para>
1321 
1322 <para>Note that per default, setgid installation of games is 
1323 disabled; setting <varname>SETGIDGAME=YES</varname> will set all 
1324 the other variables accordingly.</para> 
1325 1322
1326 <para>A package should therefore never hard code file ownership or 1323 <para>A package should therefore never hard code file ownership or
1327 access permissions but rely on <varname>INSTALL_GAME</varname> and 1324 access permissions but rely on <varname>INSTALL_GAME</varname> and
1328 <varname>INSTALL_GAME_DATA</varname> to set these 1325 <varname>INSTALL_GAME_DATA</varname> to set these
1329 correctly.</para> 1326 correctly.</para>
1330 </sect2> 1327 </sect2>
1331 1328
1332 <sect2 id="destdir-support"> 1329 <sect2 id="destdir-support">
1333 <title>Adding DESTDIR support to packages</title> 1330 <title>Adding DESTDIR support to packages</title>
1334 1331
1335 <para><varname>DESTDIR</varname> support means that a package 1332 <para><varname>DESTDIR</varname> support means that a package
1336 installs into a staging directory, not the final location of the 1333 installs into a staging directory, not the final location of the
1337 files. Then a binary package is created which can be used for 1334 files. Then a binary package is created which can be used for