sup rev 9

Tiny edits (typo receip? y/n)
author Paul Issott <paul@slitaz.org>
date Fri Feb 24 20:09:04 2017 +0000 (2017-02-24)
parents 01b65f9074e0
children f10893862ba5
files README libsup.sh po/clients/sup-clients.pot server/sup/sup.conf sup wok/sup-demo/README
line diff
     1.1 --- a/README	Fri Feb 24 09:10:02 2017 +0100
     1.2 +++ b/README	Fri Feb 24 20:09:04 2017 +0000
     1.3 @@ -3,20 +3,20 @@
     1.4  
     1.5  CURRENT : cook extract and install work nicely.
     1.6  
     1.7 -The goal is to have a user land packages management system using SHell scripts
     1.8 +The goal is to have a user-land packages management system using SHell scripts
     1.9  to pack and install files. The sup packages can install all kind of files such
    1.10 -as scripts, non free tools, icons, wallpapers, templates, pre-compiled binary,
    1.11 +as scripts, non free tools, icons, wallpapers, templates, pre-compiled binaries,
    1.12  etc. Sup is designed to handle software that can/should be installed in user
    1.13  space such as web frameworks.
    1.14  
    1.15 -This let user get involve in the project without coding skills, sup provide a
    1.16 +This lets users get involved in the project without coding skills, sup provides a
    1.17  cmdline tool and a GTK+ interface to install and build packages. The server
    1.18 -provide a CGI web interface to upload packages receipt and files. The build 
    1.19 -is a simple pack without compilations since the idea is to provide custom 
    1.20 +provides a CGI web interface to upload packages receipts and files. The build 
    1.21 +is a simple pack without compilation since the idea is to provide custom 
    1.22  tools using scripting languages or precompiled packages such as Firefox.
    1.23  
    1.24 -Sup will be also usefull in live mode with a persistent home mounted so users
    1.25 -will have installed sup packages without having a too big rootfs in RAM.
    1.26 +Sup will be also useful in live mode with a persistent home mounted so users
    1.27 +will have sup packages installed without having a too big rootfs in RAM.
    1.28  
    1.29  Quickstart
    1.30  --------------------------------------------------------------------------------
    1.31 @@ -31,12 +31,12 @@
    1.32       $ sup help
    1.33    
    1.34  
    1.35 -Where goes what ?
    1.36 +What goes where ?
    1.37  --------------------------------------------------------------------------------
    1.38  
    1.39    * sup         Client side cmdline tool to install and cook packages
    1.40                  --> /usr/bin/sup
    1.41 -  * sup-box     GTK+ Client side user iinterface to manage packages
    1.42 +  * sup-box     GTK+ Client side user interface to manage packages
    1.43                  --> /usr/bin/sup-box
    1.44    * libsup.sh   Shared SHell function between sup tools
    1.45                  --> /usr/lib/slitaz/libsup.sh
    1.46 @@ -46,7 +46,7 @@
    1.47  
    1.48  Development environment
    1.49  --------------------------------------------------------------------------------
    1.50 -It's easy to work on sup code, commands will talk by them self:
    1.51 +It's easy to work on sup code, commands will talk by themselves:
    1.52  
    1.53    --> Cmdline client
    1.54    $ hg clone http://hg.slitaz.org/sup
    1.55 @@ -59,28 +59,28 @@
    1.56  
    1.57  Developers coding style
    1.58  --------------------------------------------------------------------------------
    1.59 -Keep sup simple, clean and fast. Sup tools are written in SHell script, ther
    1.60 -use libtaz.sh and httphelper.sh functions. Sup use XDG directories paths to 
    1.61 -store packages information and build process:
    1.62 +Keep sup simple, clean and fast. Sup tools are written in SHell script, they
    1.63 +use libtaz.sh and httphelper.sh functions. Sup uses XDG directories paths to 
    1.64 +store packages' information and build process:
    1.65  	
    1.66    ~/.local         User data, executables and sup database
    1.67 -  ~/.cache         Non-essiential data such as tmp and build files
    1.68 +  ~/.cache         Non-essential data such as tmp and build files
    1.69    ~/.config        Peer user configuration files
    1.70  
    1.71  
    1.72  Packages format and max size
    1.73  --------------------------------------------------------------------------------
    1.74 -Sup packages are cpio archive compressed with lzma and with a .sup extension.
    1.75 +Sup packages are cpio archives compressed with lzma and with a .sup extension.
    1.76  The goal is to have lightweight packages with every big file downloaded from
    1.77  the web.
    1.78  
    1.79 -Sup use a minimal 'receipt' with an sup_install() function to dl any wanted 
    1.80 +Sup uses a minimal 'receipt' with a sup_install() function to dl any wanted 
    1.81  files, no pkg size or file list are created when packing. A list of installed
    1.82  files is generated at install.
    1.83  
    1.84 -Package can have a single receipt or a local/ folder with files to install. All
    1.85 -download and extracting must be done in the cache to build-up a list of files
    1.86 -before installing. The package folder tree should look like that:
    1.87 +Packages can have a single receipt or a local/ folder with files to install. All
    1.88 +downloading and extracting must be done in the cache to build up a list of files
    1.89 +before installing. The package folder tree should look like this:
    1.90  
    1.91    * receipt                    Sup package receipt
    1.92    * README                     Optional sup package desc/howto
    1.93 @@ -92,13 +92,13 @@
    1.94    |- local/share/applications  All .desktop files for menu entry
    1.95     ` config/                   For any configuration file in ~/.config
    1.96  
    1.97 -More directories into files/ can be added accourding to the needs and goal 
    1.98 -of the packages
    1.99 +More directories into files/ can be added according to the needs and goals
   1.100 +of the packages.
   1.101  
   1.102  Receipt variables and function
   1.103  --------------------------------------------------------------------------------
   1.104 -Her is the variables used or usable in sup receipt as well as the uniq function.
   1.105 -Checkout the sup-demo package for a receipt example.
   1.106 +Here is the variables used or usable in a sup receipt as well as the uniq function.
   1.107 +Check out the sup-demo package for a receipt example.
   1.108  
   1.109    * $build_date     Auto added by 'sup cook' to get the build date
   1.110    * $sup_size       Auto added by 'sup cook' to get installed size
   1.111 @@ -106,18 +106,18 @@
   1.112  
   1.113  Packages dependencies
   1.114  --------------------------------------------------------------------------------
   1.115 -Since sup is not run as root, less deps is better but some precompiled packages
   1.116 +Since sup is not run as root, less deps is better - but some precompiled packages
   1.117  will need some system wide tools/libraries, sup will not install any system wide
   1.118 -package but warn is dependencies are not installed if DEPENDS is set. 
   1.119 +packages but warns if dependencies are not installed if DEPENDS is set. 
   1.120  
   1.121  Sup packages can be very simple but also very complex, so feel free to use the 
   1.122 -receipt to warn or promt users to make an action.
   1.123 +receipt to warn or prompt users to make an action.
   1.124  
   1.125  
   1.126 -Cook sup packages to be uploaded to server
   1.127 +Cook sup packages to be uploaded to the server
   1.128  --------------------------------------------------------------------------------
   1.129 -Sup let users upload package to server. To cook your first one you may want to
   1.130 -the sup-demo package:
   1.131 +Sup lets users upload packages to the server. To cook your first one you may want to
   1.132 +use the sup-demo package:
   1.133  
   1.134    $ sup cook --init
   1.135    $ cp -rf /usr/share/sup/wok/sup-demo ~/.local/share/sup/wok
   1.136 @@ -126,13 +126,13 @@
   1.137  
   1.138  Mime type & Icon
   1.139  --------------------------------------------------------------------------------
   1.140 -The *.sup file are reconised by the system as sup packages using an mime type
   1.141 +The *.sup file are recognised by the system as sup packages using a mime type
   1.142  XML file installed in /usr/share/mime/packages/sup.xml. When data/mime/sup.xml
   1.143  is newly installed you can update the mime database:
   1.144  
   1.145    $ update-mime-database /usr/share/mime/
   1.146  
   1.147 -Sup use a generic icon: application-x-archive
   1.148 +Sup uses a generic icon: application-x-archive
   1.149  
   1.150  
   1.151  Translations
     2.1 --- a/libsup.sh	Fri Feb 24 09:10:02 2017 +0100
     2.2 +++ b/libsup.sh	Fri Feb 24 20:09:04 2017 +0000
     2.3 @@ -84,7 +84,7 @@
     2.4  	extract_sup "$supfile"
     2.5  	
     2.6  	# Execute sup_install() in files/ tree so packages maintainers just
     2.7 -	# have to dl and move files has they wher in $HOME
     2.8 +	# have to dl and move files where they were in $HOME
     2.9  	cd files
    2.10  	if grep -q "^sup_install" ../receip; then
    2.11  		gettext "Executing install function:"; colorize 33 " sup_install"
     3.1 --- a/po/clients/sup-clients.pot	Fri Feb 24 09:10:02 2017 +0100
     3.2 +++ b/po/clients/sup-clients.pot	Fri Feb 24 20:09:04 2017 +0000
     3.3 @@ -38,7 +38,7 @@
     3.4  msgstr ""
     3.5  
     3.6  #: sup:37
     3.7 -msgid "Display more output message"
     3.8 +msgid "Display more output messages"
     3.9  msgstr ""
    3.10  
    3.11  #: sup:64
     4.1 --- a/server/sup/sup.conf	Fri Feb 24 09:10:02 2017 +0100
     4.2 +++ b/server/sup/sup.conf	Fri Feb 24 20:09:04 2017 +0000
     4.3 @@ -1,7 +1,7 @@
     4.4  # TinyCM Plugin configuration
     4.5  
     4.6  PLUGIN="SliTaz User Packages"
     4.7 -SHORT_DESC="SUP online hug and services"
     4.8 +SHORT_DESC="SUP online hub and services"
     4.9  MAINTAINER="devel@slitaz.org"
    4.10  
    4.11  # Authenticated users
     5.1 --- a/sup	Fri Feb 24 09:10:02 2017 +0100
     5.2 +++ b/sup	Fri Feb 24 20:09:04 2017 +0000
     5.3 @@ -34,7 +34,7 @@
     5.4  
     5.5  $(boldify $(gettext "Options:"))
     5.6    --init     cook    $(gettext "Initialize sup build environment")
     5.7 -  --verbose  all     $(gettext "Display more output message")
     5.8 +  --verbose  all     $(gettext "Display more output messages")
     5.9  
    5.10  EOT
    5.11  	exit 0
    5.12 @@ -109,7 +109,7 @@
    5.13  		cp -rf ${wok}/${pkg} ${cache}/${supfile%.sup}
    5.14  		cd ${cache}/${supfile%.sup}
    5.15  		
    5.16 -		# Mouve to hidden dir: ~/.local and ~/.config
    5.17 +		# Move to hidden dir: ~/.local and ~/.config
    5.18  		for dir in local config; do
    5.19  			mv files/${dir} files/.${dir}
    5.20  		done
     6.1 --- a/wok/sup-demo/README	Fri Feb 24 09:10:02 2017 +0100
     6.2 +++ b/wok/sup-demo/README	Fri Feb 24 20:09:04 2017 +0000
     6.3 @@ -1,2 +1,2 @@
     6.4 -This optional README file ccan be used to give more information
     6.5 +This optional README file can be used to give more information
     6.6  about the package installation and usage