Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
added offline help file
  • Loading branch information
AdrianTM committed Aug 21, 2019
1 parent 71ee20c commit 53cb378
Show file tree
Hide file tree
Showing 17 changed files with 141 additions and 77 deletions.
6 changes: 6 additions & 0 deletions debian/changelog
@@ -1,3 +1,9 @@
mx-snapshot (19.8.1) mx; urgency=medium

* added offline help file

-- Adrian <adrian@mxlinux.org> Wed, 21 Aug 2019 15:21:04 -0400

mx-snapshot (19.8) mx; urgency=medium

* change to make it compatible with Buster base
Expand Down
1 change: 1 addition & 0 deletions debian/install
@@ -1,3 +1,4 @@
help usr/share/doc/mx-snapshot
license.html usr/share/doc/mx-snapshot
mx-snapshot usr/bin
mx-snapshot-exclude.list etc
Expand Down
32 changes: 32 additions & 0 deletions debs/mx-snapshot_19.8.1.dsc
@@ -0,0 +1,32 @@
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

Format: 3.0 (native)
Source: mx-snapshot
Binary: mx-snapshot
Architecture: any
Version: 19.8.1
Maintainer: Adrian <adrian@mxlinux.org>
Standards-Version: 3.9.8
Vcs-Git: git://github.com/AdrianTM/mx-snapshot
Build-Depends: debhelper (>= 9), libcmd, qt5-qmake, qtbase5-dev, qttools5-dev-tools
Package-List:
mx-snapshot deb admin optional arch=any
Checksums-Sha1:
295633a5263e833ce41630089ec911a579c7ef65 160580 mx-snapshot_19.8.1.tar.xz
Checksums-Sha256:
cb6deaacdbd88fa1fc76485507b5c347088af464310d2f3c2a8f75308c81263d 160580 mx-snapshot_19.8.1.tar.xz
Files:
cd9344e17287c0df55a33bed13b93fdb 160580 mx-snapshot_19.8.1.tar.xz

-----BEGIN PGP SIGNATURE-----

iQFHBAEBCAAxFiEE8ndToY6S45N+YzXncJOMeAZ57pgFAl1dmdETHGFkcmlhbkBt
eGxpbnV4Lm9yZwAKCRBwk4x4BnnumCcQB/9DgbzJaQ5vjTFL4hcxOTaJecvMwmeJ
/ht4pvlJpP2y7Ncy68QzQIDh73DdKaZs6HTQsoWYsJrPcV2pF0AZ1xvjqelZvqO0
znZNsROFFUYxTm2o4iaq44MtG1t4MpgE2/ImmNfjdO6WczlUDElYtss0iSTwRDsO
CVOZlbLLqPgNvr4ADX9xv2Qig8y8yO+AJn4iR9gfI4DJhkPsM/2qmo6/Z4qaOje1
LR1Om38BX5qfa48NjLnu8zUjcH3Ff/vZgo6anciH4pjjXgflOL0DTmzxxi+y4nDj
MPD2HHJ1KR3912kRIvuF+qVqbDsMZ9ZrRGCYrQqZ3hDDRDAmr7L3I5pH
=OylG
-----END PGP SIGNATURE-----
Binary file added debs/mx-snapshot_19.8.1.tar.xz
Binary file not shown.
43 changes: 43 additions & 0 deletions debs/mx-snapshot_19.8.1_amd64.changes
@@ -0,0 +1,43 @@
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

Format: 1.8
Date: Wed, 21 Aug 2019 15:21:04 -0400
Source: mx-snapshot
Binary: mx-snapshot
Architecture: source amd64
Version: 19.8.1
Distribution: mx
Urgency: medium
Maintainer: Adrian <adrian@mxlinux.org>
Changed-By: Adrian <adrian@mxlinux.org>
Description:
mx-snapshot - MX Snapshot
Changes:
mx-snapshot (19.8.1) mx; urgency=medium
.
* added offline help file
Checksums-Sha1:
dc2414180fb0bef6f3420d250465d12bcce7f53b 1190 mx-snapshot_19.8.1.dsc
295633a5263e833ce41630089ec911a579c7ef65 160580 mx-snapshot_19.8.1.tar.xz
5af8feca2d6a3f870eca1f5aabc8920e22a581ff 196206 mx-snapshot_19.8.1_amd64.deb
Checksums-Sha256:
451703a9af1846df294869afcc26ab14e2b1c1fef1c087da1ac819ff95f0d859 1190 mx-snapshot_19.8.1.dsc
cb6deaacdbd88fa1fc76485507b5c347088af464310d2f3c2a8f75308c81263d 160580 mx-snapshot_19.8.1.tar.xz
4b1afd7883de907eb70753b4dbaef774715e0465074b9ab0ab1bf1849baecde6 196206 mx-snapshot_19.8.1_amd64.deb
Files:
a687199a8cab06e69477dca7db1f6abb 1190 admin optional mx-snapshot_19.8.1.dsc
cd9344e17287c0df55a33bed13b93fdb 160580 admin optional mx-snapshot_19.8.1.tar.xz
0dd073ab34082cdac1c0a178513eb83a 196206 admin optional mx-snapshot_19.8.1_amd64.deb

-----BEGIN PGP SIGNATURE-----

iQFHBAEBCAAxFiEE8ndToY6S45N+YzXncJOMeAZ57pgFAl1dmdETHGFkcmlhbkBt
eGxpbnV4Lm9yZwAKCRBwk4x4BnnumJ8KCACFijiVk7DFsSh7iKSzYGTnsaBO3pB/
rwx7dp+kQgZ52/YenjOU3LD3WZNAzX1b6DX03xalVsO0dpDRkiQHTia3xpIyu3W6
YmJyKnVG/uWTUZQjVaTttEasD8hWVgvaMw9JcUGkDANwp8FS7sJuqUPpoIKKhMqQ
PPd4x2D/aUGEwUaYx4ONPQb1wurgl4Fk3pjl7hZeDCUIUxKlovYqb/YzgpM1jOh8
FCSl/0zNQib5T0bbHhoXKjBKqO/HrdsxmrXOTJyaqc8LIqrKWJJDY0i/HUCKimSI
8BKNzVaTFhOjUbZJkwqt7RRkKBd+8eMwRamqPR9RijbrlhqDEdOIXadJ
=1zQv
-----END PGP SIGNATURE-----
Binary file added debs/mx-snapshot_19.8.1_amd64.deb
Binary file not shown.
Binary file added debs/mx-snapshot_19.8.1_i386.deb
Binary file not shown.
32 changes: 0 additions & 32 deletions debs/mx-snapshot_19.8.dsc

This file was deleted.

Binary file removed debs/mx-snapshot_19.8.tar.xz
Binary file not shown.
43 changes: 0 additions & 43 deletions debs/mx-snapshot_19.8_amd64.changes

This file was deleted.

Binary file removed debs/mx-snapshot_19.8_amd64.deb
Binary file not shown.
Binary file removed debs/mx-snapshot_19.8_i386.deb
Binary file not shown.
Binary file added help/20.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added help/21.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
57 changes: 57 additions & 0 deletions help/mx-snapshot.html
@@ -0,0 +1,57 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>HELP: MX Save system to ISO (Snapshot)</title>
</head>
<body>
<h1>HELP: MX Save system to ISO (Snapshot)</h1>
<h2>Overview</h2>

<p>MX Snapshot takes care of two main situations:</p>

<ul>
<li>A &#8220#8220;personal snapshot&#8221; and saves pretty much everything, used if you want to backup your current system including home. Excluded are only some cache and log folders that are listed in the exception file (that file can be examined from the program by clicking on the appropriate button). The program also tries to &#8220;generalize&#8221; the ISO, in a sense that it removes files that are machine specific like /etc/fstab (you might use the ISO on a machine that has different harddrive partitions), also Xorg config file is not saved (for example if you have Nvidia or ATI/AMD driver installed the snapshot won&#8217;t preserve that setting because you might use the ISO on a different machine that doesn&#8217;t have an Nvidia or ATI card). If you intend to use it as a backup on the same machine then comment out the appropriate xorg.conf line in the exclusion file. The user also has a number of checkboxes to help exclude some big folders, like Downloads, Desktop, Documents, Movies, Photos, etc.</li>
<li> A &#8220;system snapshot&#8221; with all the apps you installed and without all the apps you removed, but without stuff from /home. That&#8217;s what we call &#8220;reset accounts&#8221; snapshot because in addition to generalizing the ISO it also resets root password to &#8220;root&#8221; and creates a demo username with a &#8220;demo&#8221; password. /home/demo is generated at boot time and populated with files from /etc/skel. This option is meant to create a kind of respin ISO that can be used, for instance, to distribute to other people or to use as a base for a custom lab install. </li>
</ul>

<h2>Requirements</h2>

<img src="20.jpg" alt="snapshot" />

<p>The first screen shows the available space using the default settings. It is recommended that the free space for the snapshot be at least equal to the used space in / (root) and /home partitions. (The created ISO file will be compressed, so you might be able to do with a little bit less than that.) If that is not the case, use the buttons below to change to a directory with more free space.</p>

<h2>Settings options</h2>

<img src="21.jpg" alt="settings" />

<ul>
<li>Edit Configuration File button: allows direct editing of the mx-snapshot.conf file to specify special settings, like type of compression to use. The file is commented to aid in custom configurations. </li>
<li>Locations. You can change the location of the snapshot directory, which can be very useful if the default location does not have a great deal of available space.</li>
<li> Exclusions. To make the ISO smaller and speed up the process, you may want to exclude from the ISO directories you do not need. Common exclusions are available on the Settings screen, and others can be included by directly editing the exclusions file using the button provided.</li>
<li> Note that if in addition to customizing the app selection you want to customize the look of the Desktop, you will need to edit the /etc/skel files</li>
</ul>

<h2>Procedures</h2>

<p>Best procedure is to make the snapshot with all the programs closed &#8212; your machine will need memory and CPU to create the image and this would help.</p>

<ul>
<li>If you select &#8220;reset accounts for distribution to others&#8221; then you could continue working normally with non-demanding tasks while your snapshot is being taken, because /home is not going to be copied and files in /var /run (where programs write their logs and temporary files, locks) are excluded.</li>
<li> If you select &#8220;preserving accounts,&#8221; then some locks might be preserved that you don&#8217;t want. For example: some browsers create a lock file to make sure the user doesn&#8217;t start another instance, and some other programs might do the same. If you save those locks by mistake you might have problems starting the program even though it is not running (fixed by deleting the lock file).</li>
</ul>

<h2>Tips and tricks</h2>

<ul>
<li>If an install icon is missing from the the desktop, press F4 and use this command <em>sudo -E minstall</em></li>
</ul>

<p>Development history: Fsmithred (Refracta linux), anticapitalista, BitJam (antiX), Adrian</p>

<p>License: <a href="https://mxlinux.org/wiki/licenses/license-mx-snapshot/">here</a>.</p>

<p>v. 20180803</p>
</body>
</html>
2 changes: 1 addition & 1 deletion mainwindow.cpp
Expand Up @@ -994,7 +994,7 @@ void MainWindow::on_buttonHelp_clicked()
QLocale locale;
QString lang = locale.bcp47Name();

QString url = "https://mxlinux.org/wiki/help-files/help-mx-save-system-to-iso-snapshot";
QString url = "/usr/share/doc/mx-snapshot/help/mx-snapshot.html";

if (lang.startsWith("fr")) {
url = "https://mxlinux.org/french-wiki/help-files-fr/help-mx-instantane";
Expand Down
2 changes: 1 addition & 1 deletion version.h
@@ -1 +1 @@
#define VERSION "19.8"
#define VERSION "19.8.1"

0 comments on commit 53cb378

Please sign in to comment.